PacketDecoder.cpp 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028
  1. /*
  2. * ZeroTier One - Global Peer to Peer Ethernet
  3. * Copyright (C) 2011-2014 ZeroTier Networks LLC
  4. *
  5. * This program is free software: you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation, either version 3 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17. *
  18. * --
  19. *
  20. * ZeroTier may be used and distributed under the terms of the GPLv3, which
  21. * are available at: http://www.gnu.org/licenses/gpl-3.0.html
  22. *
  23. * If you would like to embed ZeroTier into a commercial application or
  24. * redistribute it in a modified binary form, please contact ZeroTier Networks
  25. * LLC. Start here: http://www.zerotier.com/
  26. */
  27. #include <stdio.h>
  28. #include <string.h>
  29. #include <stdlib.h>
  30. #include "../version.h"
  31. #include "Constants.hpp"
  32. #include "Defaults.hpp"
  33. #include "RuntimeEnvironment.hpp"
  34. #include "Topology.hpp"
  35. #include "PacketDecoder.hpp"
  36. #include "Switch.hpp"
  37. #include "Peer.hpp"
  38. #include "NodeConfig.hpp"
  39. #include "Service.hpp"
  40. #include "SoftwareUpdater.hpp"
  41. #include "SHA512.hpp"
  42. namespace ZeroTier {
  43. bool PacketDecoder::tryDecode(const RuntimeEnvironment *_r)
  44. {
  45. if ((!encrypted())&&(verb() == Packet::VERB_HELLO)) {
  46. // Unencrypted HELLOs are handled here since they are used to
  47. // populate our identity cache in the first place. _doHELLO() is special
  48. // in that it contains its own authentication logic.
  49. //TRACE("<< HELLO from %s(%s) (normal unencrypted HELLO)",source().toString().c_str(),_remoteAddress.toString().c_str());
  50. return _doHELLO(_r);
  51. }
  52. SharedPtr<Peer> peer = _r->topology->getPeer(source());
  53. if (peer) {
  54. // Resume saved intermediate decode state?
  55. if (_step == DECODE_WAITING_FOR_MULTICAST_FRAME_ORIGINAL_SENDER_LOOKUP) {
  56. // In this state we have already authenticated and decrypted the
  57. // packet and are waiting for the lookup of the original sender
  58. // for a multicast frame. So check to see if we've got it.
  59. return _doMULTICAST_FRAME(_r,peer);
  60. } else if (_step == DECODE_WAITING_FOR_NETWORK_MEMBERSHIP_CERTIFICATE_SIGNER_LOOKUP) {
  61. // In this state we have already authenticated and decoded the
  62. // packet and we're waiting for the identity of the cert's signer.
  63. return _doNETWORK_MEMBERSHIP_CERTIFICATE(_r,peer);
  64. } // else this is the initial decode pass, so validate packet et. al.
  65. if (!dearmor(peer->key())) {
  66. TRACE("dropped packet from %s(%s), MAC authentication failed (size: %u)",source().toString().c_str(),_remoteAddress.toString().c_str(),size());
  67. return true;
  68. }
  69. if (!uncompress()) {
  70. TRACE("dropped packet from %s(%s), compressed data invalid",source().toString().c_str(),_remoteAddress.toString().c_str());
  71. return true;
  72. }
  73. //TRACE("<< %s from %s(%s)",Packet::verbString(verb()),source().toString().c_str(),_remoteAddress.toString().c_str());
  74. switch(verb()) {
  75. //case Packet::VERB_NOP:
  76. default: // ignore unknown verbs, but if they pass auth check they are still valid
  77. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),verb(),0,Packet::VERB_NOP,Utils::now());
  78. return true;
  79. case Packet::VERB_HELLO:
  80. return _doHELLO(_r);
  81. case Packet::VERB_ERROR:
  82. return _doERROR(_r,peer);
  83. case Packet::VERB_OK:
  84. return _doOK(_r,peer);
  85. case Packet::VERB_WHOIS:
  86. return _doWHOIS(_r,peer);
  87. case Packet::VERB_RENDEZVOUS:
  88. return _doRENDEZVOUS(_r,peer);
  89. case Packet::VERB_FRAME:
  90. return _doFRAME(_r,peer);
  91. case Packet::VERB_EXT_FRAME:
  92. return _doEXT_FRAME(_r,peer);
  93. case Packet::VERB_MULTICAST_FRAME:
  94. return _doMULTICAST_FRAME(_r,peer);
  95. case Packet::VERB_MULTICAST_LIKE:
  96. return _doMULTICAST_LIKE(_r,peer);
  97. case Packet::VERB_NETWORK_MEMBERSHIP_CERTIFICATE:
  98. return _doNETWORK_MEMBERSHIP_CERTIFICATE(_r,peer);
  99. case Packet::VERB_NETWORK_CONFIG_REQUEST:
  100. return _doNETWORK_CONFIG_REQUEST(_r,peer);
  101. case Packet::VERB_NETWORK_CONFIG_REFRESH:
  102. return _doNETWORK_CONFIG_REFRESH(_r,peer);
  103. }
  104. } else {
  105. _step = DECODE_WAITING_FOR_SENDER_LOOKUP; // should already be this...
  106. _r->sw->requestWhois(source());
  107. return false;
  108. }
  109. }
  110. bool PacketDecoder::_doERROR(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  111. {
  112. try {
  113. Packet::Verb inReVerb = (Packet::Verb)(*this)[ZT_PROTO_VERB_ERROR_IDX_IN_RE_VERB];
  114. uint64_t inRePacketId = at<uint64_t>(ZT_PROTO_VERB_ERROR_IDX_IN_RE_PACKET_ID);
  115. Packet::ErrorCode errorCode = (Packet::ErrorCode)(*this)[ZT_PROTO_VERB_ERROR_IDX_ERROR_CODE];
  116. TRACE("ERROR %s from %s(%s) in-re %s",Packet::errorString(errorCode),source().toString().c_str(),_remoteAddress.toString().c_str(),Packet::verbString(inReVerb));
  117. switch(errorCode) {
  118. case Packet::ERROR_OBJ_NOT_FOUND:
  119. if (inReVerb == Packet::VERB_WHOIS) {
  120. if (_r->topology->isSupernode(source()))
  121. _r->sw->cancelWhoisRequest(Address(field(ZT_PROTO_VERB_ERROR_IDX_PAYLOAD,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH));
  122. } else if (inReVerb == Packet::VERB_NETWORK_CONFIG_REQUEST) {
  123. SharedPtr<Network> network(_r->nc->network(at<uint64_t>(ZT_PROTO_VERB_ERROR_IDX_PAYLOAD)));
  124. if ((network)&&(network->controller() == source()))
  125. network->setNotFound();
  126. }
  127. break;
  128. case Packet::ERROR_IDENTITY_COLLISION:
  129. // TODO: if it comes from a supernode, regenerate a new identity
  130. // if (_r->topology->isSupernode(source())) {}
  131. break;
  132. case Packet::ERROR_NEED_MEMBERSHIP_CERTIFICATE: {
  133. SharedPtr<Network> network(_r->nc->network(at<uint64_t>(ZT_PROTO_VERB_ERROR_IDX_PAYLOAD)));
  134. if (network)
  135. network->pushMembershipCertificate(source(),true,Utils::now());
  136. } break;
  137. case Packet::ERROR_NETWORK_ACCESS_DENIED_: {
  138. SharedPtr<Network> network(_r->nc->network(at<uint64_t>(ZT_PROTO_VERB_ERROR_IDX_PAYLOAD)));
  139. if ((network)&&(network->controller() == source()))
  140. network->setAccessDenied();
  141. } break;
  142. default:
  143. break;
  144. }
  145. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_ERROR,inRePacketId,inReVerb,Utils::now());
  146. } catch (std::exception &ex) {
  147. TRACE("dropped ERROR from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  148. } catch ( ... ) {
  149. TRACE("dropped ERROR from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  150. }
  151. return true;
  152. }
  153. bool PacketDecoder::_doHELLO(const RuntimeEnvironment *_r)
  154. {
  155. try {
  156. unsigned int protoVersion = (*this)[ZT_PROTO_VERB_HELLO_IDX_PROTOCOL_VERSION];
  157. unsigned int vMajor = (*this)[ZT_PROTO_VERB_HELLO_IDX_MAJOR_VERSION];
  158. unsigned int vMinor = (*this)[ZT_PROTO_VERB_HELLO_IDX_MINOR_VERSION];
  159. unsigned int vRevision = at<uint16_t>(ZT_PROTO_VERB_HELLO_IDX_REVISION);
  160. uint64_t timestamp = at<uint64_t>(ZT_PROTO_VERB_HELLO_IDX_TIMESTAMP);
  161. Identity id(*this,ZT_PROTO_VERB_HELLO_IDX_IDENTITY);
  162. if (protoVersion != ZT_PROTO_VERSION) {
  163. TRACE("dropped HELLO from %s(%s): protocol version mismatch (%u, expected %u)",source().toString().c_str(),_remoteAddress.toString().c_str(),protoVersion,(unsigned int)ZT_PROTO_VERSION);
  164. return true;
  165. }
  166. if (!id.locallyValidate()) {
  167. TRACE("dropped HELLO from %s(%s): identity invalid",source().toString().c_str(),_remoteAddress.toString().c_str());
  168. return true;
  169. }
  170. // Do we already have this peer?
  171. SharedPtr<Peer> peer(_r->topology->getPeer(id.address()));
  172. if (peer) {
  173. // Check to make sure this isn't a colliding identity (different key,
  174. // but same address). The odds are spectacularly low but it could happen.
  175. // Could also be a sign of someone doing something nasty.
  176. if (peer->identity() != id) {
  177. unsigned char key[ZT_PEER_SECRET_KEY_LENGTH];
  178. if (_r->identity.agree(id,key,ZT_PEER_SECRET_KEY_LENGTH)) {
  179. if (dearmor(key)) { // ensure packet is authentic, otherwise drop
  180. LOG("rejected HELLO from %s(%s): address already claimed",source().toString().c_str(),_remoteAddress.toString().c_str());
  181. Packet outp(source(),_r->identity.address(),Packet::VERB_ERROR);
  182. outp.append((unsigned char)Packet::VERB_HELLO);
  183. outp.append(packetId());
  184. outp.append((unsigned char)Packet::ERROR_IDENTITY_COLLISION);
  185. outp.armor(key,true);
  186. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  187. } else {
  188. LOG("rejected HELLO from %s(%s): packet failed authentication",source().toString().c_str(),_remoteAddress.toString().c_str());
  189. }
  190. } else {
  191. LOG("rejected HELLO from %s(%s): key agreement failed",source().toString().c_str(),_remoteAddress.toString().c_str());
  192. }
  193. return true;
  194. } else if (!dearmor(peer->key())) {
  195. LOG("rejected HELLO from %s(%s): packet failed authentication",source().toString().c_str(),_remoteAddress.toString().c_str());
  196. return true;
  197. } // else continue and respond
  198. } else {
  199. // If we don't have a peer record on file, check the identity cache (if
  200. // we have one) to see if we have a cached identity. Then check that for
  201. // collision before adding a new peer.
  202. Identity alreadyHaveCachedId(_r->topology->getIdentity(id.address()));
  203. if ((alreadyHaveCachedId)&&(id != alreadyHaveCachedId)) {
  204. unsigned char key[ZT_PEER_SECRET_KEY_LENGTH];
  205. if (_r->identity.agree(id,key,ZT_PEER_SECRET_KEY_LENGTH)) {
  206. if (dearmor(key)) { // ensure packet is authentic, otherwise drop
  207. LOG("rejected HELLO from %s(%s): address already claimed",source().toString().c_str(),_remoteAddress.toString().c_str());
  208. Packet outp(source(),_r->identity.address(),Packet::VERB_ERROR);
  209. outp.append((unsigned char)Packet::VERB_HELLO);
  210. outp.append(packetId());
  211. outp.append((unsigned char)Packet::ERROR_IDENTITY_COLLISION);
  212. outp.armor(key,true);
  213. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  214. } else {
  215. LOG("rejected HELLO from %s(%s): packet failed authentication",source().toString().c_str(),_remoteAddress.toString().c_str());
  216. }
  217. } else {
  218. LOG("rejected HELLO from %s(%s): key agreement failed",source().toString().c_str(),_remoteAddress.toString().c_str());
  219. }
  220. return true;
  221. } // else continue since identity is already known and matches
  222. // If this is a new peer, learn it
  223. SharedPtr<Peer> newPeer(new Peer(_r->identity,id));
  224. if (!dearmor(newPeer->key())) {
  225. LOG("rejected HELLO from %s(%s): packet failed authentication",source().toString().c_str(),_remoteAddress.toString().c_str());
  226. return true;
  227. }
  228. peer = _r->topology->addPeer(newPeer);
  229. }
  230. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_HELLO,0,Packet::VERB_NOP,Utils::now());
  231. peer->setRemoteVersion(vMajor,vMinor,vRevision);
  232. // If a supernode has a version higher than ours, this causes a software
  233. // update check to run now.
  234. if ((_r->updater)&&(_r->topology->isSupernode(peer->address())))
  235. _r->updater->sawRemoteVersion(vMajor,vMinor,vRevision);
  236. Packet outp(source(),_r->identity.address(),Packet::VERB_OK);
  237. outp.append((unsigned char)Packet::VERB_HELLO);
  238. outp.append(packetId());
  239. outp.append(timestamp);
  240. outp.append((unsigned char)ZT_PROTO_VERSION);
  241. outp.append((unsigned char)ZEROTIER_ONE_VERSION_MAJOR);
  242. outp.append((unsigned char)ZEROTIER_ONE_VERSION_MINOR);
  243. outp.append((uint16_t)ZEROTIER_ONE_VERSION_REVISION);
  244. outp.armor(peer->key(),true);
  245. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  246. } catch (std::exception &ex) {
  247. TRACE("dropped HELLO from %s(%s): %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  248. } catch ( ... ) {
  249. TRACE("dropped HELLO from %s(%s): unexpected exception",source().toString().c_str(),_remoteAddress.toString().c_str());
  250. }
  251. return true;
  252. }
  253. bool PacketDecoder::_doOK(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  254. {
  255. try {
  256. Packet::Verb inReVerb = (Packet::Verb)(*this)[ZT_PROTO_VERB_OK_IDX_IN_RE_VERB];
  257. uint64_t inRePacketId = at<uint64_t>(ZT_PROTO_VERB_OK_IDX_IN_RE_PACKET_ID);
  258. //TRACE("%s(%s): OK(%s)",source().toString().c_str(),_remoteAddress.toString().c_str(),Packet::verbString(inReVerb));
  259. switch(inReVerb) {
  260. case Packet::VERB_HELLO: {
  261. unsigned int latency = std::min((unsigned int)(Utils::now() - at<uint64_t>(ZT_PROTO_VERB_HELLO__OK__IDX_TIMESTAMP)),(unsigned int)0xffff);
  262. unsigned int vMajor = (*this)[ZT_PROTO_VERB_HELLO__OK__IDX_MAJOR_VERSION];
  263. unsigned int vMinor = (*this)[ZT_PROTO_VERB_HELLO__OK__IDX_MINOR_VERSION];
  264. unsigned int vRevision = at<uint16_t>(ZT_PROTO_VERB_HELLO__OK__IDX_REVISION);
  265. TRACE("%s(%s): OK(HELLO), version %u.%u.%u, latency %u",source().toString().c_str(),_remoteAddress.toString().c_str(),vMajor,vMinor,vRevision,latency);
  266. peer->addDirectLatencyMeasurment(latency);
  267. peer->setRemoteVersion(vMajor,vMinor,vRevision);
  268. // If a supernode has a version higher than ours, this causes a software
  269. // update check to run now. This might bum-rush download.zerotier.com, but
  270. // it's hosted on S3 so hopefully it can take it. This should cause updates
  271. // to propagate out very quickly.
  272. if ((_r->updater)&&(_r->topology->isSupernode(peer->address())))
  273. _r->updater->sawRemoteVersion(vMajor,vMinor,vRevision);
  274. } break;
  275. case Packet::VERB_WHOIS: {
  276. // Right now only supernodes are allowed to send OK(WHOIS) to prevent
  277. // poisoning attacks. Further decentralization will require some other
  278. // kind of trust mechanism.
  279. if (_r->topology->isSupernode(source())) {
  280. Identity id(*this,ZT_PROTO_VERB_WHOIS__OK__IDX_IDENTITY);
  281. if (id.locallyValidate())
  282. _r->sw->doAnythingWaitingForPeer(_r->topology->addPeer(SharedPtr<Peer>(new Peer(_r->identity,id))));
  283. }
  284. } break;
  285. case Packet::VERB_NETWORK_CONFIG_REQUEST: {
  286. SharedPtr<Network> nw(_r->nc->network(at<uint64_t>(ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_NETWORK_ID)));
  287. if ((nw)&&(nw->controller() == source())) {
  288. // OK(NETWORK_CONFIG_REQUEST) is only accepted from a network's
  289. // controller.
  290. unsigned int dictlen = at<uint16_t>(ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_DICT_LEN);
  291. std::string dict((const char *)field(ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST__OK__IDX_DICT,dictlen),dictlen);
  292. if (dict.length()) {
  293. nw->setConfiguration(Dictionary(dict));
  294. TRACE("got network configuration for network %.16llx from %s",(unsigned long long)nw->id(),source().toString().c_str());
  295. }
  296. }
  297. } break;
  298. default:
  299. break;
  300. }
  301. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_OK,inRePacketId,inReVerb,Utils::now());
  302. } catch (std::exception &ex) {
  303. TRACE("dropped OK from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  304. } catch ( ... ) {
  305. TRACE("dropped OK from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  306. }
  307. return true;
  308. }
  309. bool PacketDecoder::_doWHOIS(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  310. {
  311. try {
  312. if (payloadLength() == ZT_ADDRESS_LENGTH) {
  313. Identity id(_r->topology->getIdentity(Address(payload(),ZT_ADDRESS_LENGTH)));
  314. if (id) {
  315. Packet outp(source(),_r->identity.address(),Packet::VERB_OK);
  316. outp.append((unsigned char)Packet::VERB_WHOIS);
  317. outp.append(packetId());
  318. id.serialize(outp,false);
  319. outp.armor(peer->key(),true);
  320. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  321. //TRACE("sent WHOIS response to %s for %s",source().toString().c_str(),Address(payload(),ZT_ADDRESS_LENGTH).toString().c_str());
  322. } else {
  323. Packet outp(source(),_r->identity.address(),Packet::VERB_ERROR);
  324. outp.append((unsigned char)Packet::VERB_WHOIS);
  325. outp.append(packetId());
  326. outp.append((unsigned char)Packet::ERROR_OBJ_NOT_FOUND);
  327. outp.append(payload(),ZT_ADDRESS_LENGTH);
  328. outp.armor(peer->key(),true);
  329. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  330. //TRACE("sent WHOIS ERROR to %s for %s (not found)",source().toString().c_str(),Address(payload(),ZT_ADDRESS_LENGTH).toString().c_str());
  331. }
  332. } else {
  333. TRACE("dropped WHOIS from %s(%s): missing or invalid address",source().toString().c_str(),_remoteAddress.toString().c_str());
  334. }
  335. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_WHOIS,0,Packet::VERB_NOP,Utils::now());
  336. } catch ( ... ) {
  337. TRACE("dropped WHOIS from %s(%s): unexpected exception",source().toString().c_str(),_remoteAddress.toString().c_str());
  338. }
  339. return true;
  340. }
  341. bool PacketDecoder::_doRENDEZVOUS(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  342. {
  343. try {
  344. /*
  345. * At the moment, we only obey RENDEZVOUS if it comes from a designated
  346. * supernode. If relay offloading is implemented to scale the net, this
  347. * will need reconsideration.
  348. *
  349. * The reason is that RENDEZVOUS could technically be used to cause a
  350. * peer to send a weird encrypted UDP packet to an arbitrary IP:port.
  351. * The sender of RENDEZVOUS has no control over the content of this
  352. * packet, but it's still maybe something we want to not allow just
  353. * anyone to order due to possible DDOS or network forensic implications.
  354. * So if we diversify relays, we'll need some way of deciding whether the
  355. * sender is someone we should trust with a RENDEZVOUS hint.
  356. */
  357. if (_r->topology->isSupernode(source())) {
  358. Address with(field(ZT_PROTO_VERB_RENDEZVOUS_IDX_ZTADDRESS,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH);
  359. SharedPtr<Peer> withPeer(_r->topology->getPeer(with));
  360. if (withPeer) {
  361. unsigned int port = at<uint16_t>(ZT_PROTO_VERB_RENDEZVOUS_IDX_PORT);
  362. unsigned int addrlen = (*this)[ZT_PROTO_VERB_RENDEZVOUS_IDX_ADDRLEN];
  363. if ((port > 0)&&((addrlen == 4)||(addrlen == 16))) {
  364. InetAddress atAddr(field(ZT_PROTO_VERB_RENDEZVOUS_IDX_ADDRESS,addrlen),addrlen,port);
  365. TRACE("RENDEZVOUS from %s says %s might be at %s, starting NAT-t",source().toString().c_str(),with.toString().c_str(),atAddr.toString().c_str());
  366. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_RENDEZVOUS,0,Packet::VERB_NOP,Utils::now());
  367. _r->sw->contact(withPeer,atAddr);
  368. } else {
  369. TRACE("dropped corrupt RENDEZVOUS from %s(%s) (bad address or port)",source().toString().c_str(),_remoteAddress.toString().c_str());
  370. }
  371. } else {
  372. TRACE("ignored RENDEZVOUS from %s(%s) to meet unknown peer %s",source().toString().c_str(),_remoteAddress.toString().c_str(),with.toString().c_str());
  373. }
  374. } else {
  375. TRACE("ignored RENDEZVOUS from %s(%s): source not supernode",source().toString().c_str(),_remoteAddress.toString().c_str());
  376. }
  377. } catch (std::exception &ex) {
  378. TRACE("dropped RENDEZVOUS from %s(%s): %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  379. } catch ( ... ) {
  380. TRACE("dropped RENDEZVOUS from %s(%s): unexpected exception",source().toString().c_str(),_remoteAddress.toString().c_str());
  381. }
  382. return true;
  383. }
  384. bool PacketDecoder::_doFRAME(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  385. {
  386. try {
  387. SharedPtr<Network> network(_r->nc->network(at<uint64_t>(ZT_PROTO_VERB_FRAME_IDX_NETWORK_ID)));
  388. if (network) {
  389. if (size() > ZT_PROTO_VERB_FRAME_IDX_PAYLOAD) {
  390. if (!network->isAllowed(peer->address())) {
  391. TRACE("dropped FRAME from %s(%s): not a member of private network %.16llx",peer->address().toString().c_str(),_remoteAddress.toString().c_str(),(unsigned long long)network->id());
  392. _sendErrorNeedCertificate(_r,peer,network->id());
  393. return true;
  394. }
  395. unsigned int etherType = at<uint16_t>(ZT_PROTO_VERB_FRAME_IDX_ETHERTYPE);
  396. if (!network->config()->permitsEtherType(etherType)) {
  397. TRACE("dropped FRAME from %s(%s): ethertype %.4x not allowed on %.16llx",peer->address().toString().c_str(),_remoteAddress.toString().c_str(),(unsigned int)etherType,(unsigned long long)network->id());
  398. return true;
  399. }
  400. network->tapPut(MAC(peer->address(),network->id()),network->mac(),etherType,data() + ZT_PROTO_VERB_FRAME_IDX_PAYLOAD,size() - ZT_PROTO_VERB_FRAME_IDX_PAYLOAD);
  401. /* Source moves "closer" to us in multicast propagation priority when
  402. * we receive unicast frames from it. This is called "implicit social
  403. * ordering" in other docs. */
  404. _r->mc->bringCloser(network->id(),peer->address());
  405. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_FRAME,0,Packet::VERB_NOP,Utils::now());
  406. return true;
  407. }
  408. } else {
  409. TRACE("dropped FRAME from %s(%s): we are not connected to network %.16llx",source().toString().c_str(),_remoteAddress.toString().c_str(),at<uint64_t>(ZT_PROTO_VERB_FRAME_IDX_NETWORK_ID));
  410. }
  411. } catch (std::exception &ex) {
  412. TRACE("dropped FRAME from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  413. } catch ( ... ) {
  414. TRACE("dropped FRAME from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  415. }
  416. return true;
  417. }
  418. bool PacketDecoder::_doEXT_FRAME(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  419. {
  420. try {
  421. SharedPtr<Network> network(_r->nc->network(at<uint64_t>(ZT_PROTO_VERB_EXT_FRAME_IDX_NETWORK_ID)));
  422. if (network) {
  423. if (size() > ZT_PROTO_VERB_EXT_FRAME_IDX_PAYLOAD) {
  424. if ((*this)[ZT_PROTO_VERB_EXT_FRAME_IDX_FLAGS] != 0) {
  425. TRACE("dropped EXT_FRAME due to unknown flags");
  426. return true;
  427. }
  428. if (!network->isAllowed(peer->address())) {
  429. TRACE("dropped EXT_FRAME from %s(%s): not a member of private network %.16llx",peer->address().toString().c_str(),_remoteAddress.toString().c_str(),network->id());
  430. _sendErrorNeedCertificate(_r,peer,network->id());
  431. return true;
  432. }
  433. unsigned int etherType = at<uint16_t>(ZT_PROTO_VERB_EXT_FRAME_IDX_ETHERTYPE);
  434. if (!network->config()->permitsEtherType(etherType)) {
  435. TRACE("dropped EXT_FRAME from %s(%s): ethertype %.4x not allowed on network %.16llx",peer->address().toString().c_str(),_remoteAddress.toString().c_str(),(unsigned int)etherType,(unsigned long long)network->id());
  436. return true;
  437. }
  438. const MAC to(field(ZT_PROTO_VERB_EXT_FRAME_IDX_TO,ZT_PROTO_VERB_EXT_FRAME_LEN_TO),ZT_PROTO_VERB_EXT_FRAME_LEN_TO);
  439. const MAC from(field(ZT_PROTO_VERB_EXT_FRAME_IDX_FROM,ZT_PROTO_VERB_EXT_FRAME_LEN_FROM),ZT_PROTO_VERB_EXT_FRAME_LEN_FROM);
  440. if ((!from)||(from.isMulticast())||(from == network->mac())||(!to)) {
  441. TRACE("dropped EXT_FRAME from %s@%s(%s) to %s: invalid source or destination MAC",from.toString().c_str(),peer->address().toString().c_str(),_remoteAddress.toString().c_str(),to.toString().c_str());
  442. return true;
  443. }
  444. // If it's not from the sending peer, they must be allowed to bridge into this network
  445. if (from != MAC(peer->address(),network->id())) {
  446. if (network->permitsBridging(peer->address())) {
  447. network->learnBridgeRoute(from,peer->address());
  448. } else {
  449. TRACE("dropped EXT_FRAME from %s@%s(%s) to %s: sender not allowed to bridge into %.16llx",from.toString().c_str(),peer->address().toString().c_str(),_remoteAddress.toString().c_str(),to.toString().c_str(),network->id());
  450. return true;
  451. }
  452. } // else: it is valid to send a non-bridged packet this way instead of as FRAME, but this isn't done by current code
  453. // If it's not to us, we must be allowed to bridge into this network
  454. if (to != network->mac()) {
  455. if (!network->permitsBridging(_r->identity.address())) {
  456. TRACE("dropped EXT_FRAME from %s@%s(%s) to %s: I cannot bridge to %.16llx or bridging disabled on network",from.toString().c_str(),peer->address().toString().c_str(),_remoteAddress.toString().c_str(),to.toString().c_str(),network->id());
  457. return true;
  458. }
  459. }
  460. network->tapPut(from,to,etherType,data() + ZT_PROTO_VERB_EXT_FRAME_IDX_PAYLOAD,size() - ZT_PROTO_VERB_EXT_FRAME_IDX_PAYLOAD);
  461. /* Source moves "closer" to us in multicast propagation priority when
  462. * we receive unicast frames from it. This is called "implicit social
  463. * ordering" in other docs. */
  464. _r->mc->bringCloser(network->id(),peer->address());
  465. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_EXT_FRAME,0,Packet::VERB_NOP,Utils::now());
  466. }
  467. } else {
  468. TRACE("dropped EXT_FRAME from %s(%s): we are not connected to network %.16llx",source().toString().c_str(),_remoteAddress.toString().c_str(),at<uint64_t>(ZT_PROTO_VERB_FRAME_IDX_NETWORK_ID));
  469. }
  470. } catch (std::exception &ex) {
  471. TRACE("dropped EXT_FRAME from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  472. } catch ( ... ) {
  473. TRACE("dropped EXT_FRAME from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  474. }
  475. return true;
  476. }
  477. bool PacketDecoder::_doMULTICAST_FRAME(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  478. {
  479. try {
  480. Address origin(Address(field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_ORIGIN,ZT_PROTO_VERB_MULTICAST_FRAME_LEN_ORIGIN),ZT_ADDRESS_LENGTH));
  481. SharedPtr<Peer> originPeer(_r->topology->getPeer(origin));
  482. if (!originPeer) {
  483. // We must have the origin's identity in order to authenticate a multicast
  484. _r->sw->requestWhois(origin);
  485. _step = DECODE_WAITING_FOR_MULTICAST_FRAME_ORIGINAL_SENDER_LOOKUP; // causes processing to come back here
  486. return false;
  487. }
  488. // These fields change
  489. unsigned int depth = at<uint16_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_DEPTH);
  490. unsigned char *const fifo = field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_FIFO,ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_FIFO);
  491. unsigned char *const bloom = field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_BLOOM,ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_BLOOM);
  492. // These fields don't -- they're signed by the original sender
  493. const unsigned int flags = (*this)[ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FLAGS];
  494. const uint64_t nwid = at<uint64_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_NETWORK_ID);
  495. const uint16_t bloomNonce = at<uint16_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_BLOOM_NONCE);
  496. const unsigned int prefixBits = (*this)[ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_PREFIX_BITS];
  497. const unsigned int prefix = (*this)[ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_PREFIX];
  498. const uint64_t guid = at<uint64_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_GUID);
  499. const MAC sourceMac(field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_SOURCE_MAC,ZT_PROTO_VERB_MULTICAST_FRAME_LEN_SOURCE_MAC),ZT_PROTO_VERB_MULTICAST_FRAME_LEN_SOURCE_MAC);
  500. const MulticastGroup dest(MAC(field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_DEST_MAC,ZT_PROTO_VERB_MULTICAST_FRAME_LEN_DEST_MAC),ZT_PROTO_VERB_MULTICAST_FRAME_LEN_DEST_MAC),at<uint32_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_DEST_ADI));
  501. const unsigned int etherType = at<uint16_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_ETHERTYPE);
  502. const unsigned int frameLen = at<uint16_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME_LEN);
  503. const unsigned char *const frame = field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME,frameLen);
  504. const unsigned int signatureLen = at<uint16_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME + frameLen);
  505. const unsigned char *const signature = field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME + frameLen + 2,signatureLen);
  506. if ((!sourceMac)||(sourceMac.isMulticast())) {
  507. TRACE("dropped MULTICAST_FRAME from %s(%s): invalid source MAC %s",source().toString().c_str(),_remoteAddress.toString().c_str(),sourceMac.toString().c_str());
  508. return true;
  509. }
  510. /*
  511. TRACE("MULTICAST_FRAME @%.16llx #%.16llx from %s<%s> via %s(%s) to %s [ %s, %d bytes, depth %d ]",
  512. (unsigned long long)nwid,
  513. (unsigned long long)guid,
  514. sourceMac.toString().c_str(),origin.toString().c_str(),
  515. source().toString().c_str(),_remoteAddress.toString().c_str(),
  516. dest.toString().c_str(),
  517. Switch::etherTypeName(etherType),
  518. (int)frameLen,
  519. (int)depth);
  520. */
  521. SharedPtr<Network> network(_r->nc->network(nwid));
  522. /* Grab, verify, and learn certificate of network membership if any -- provided we are
  523. * a member of this network. Note: we can do this before verification of the actual
  524. * packet, since the certificate has its own separate signature. In other words a valid
  525. * COM does not imply a valid multicast; they are two separate things. The ability to
  526. * include the COM with the multicast is a performance optimization to allow peers to
  527. * distribute their COM along with their packets instead of as a separate transaction.
  528. * This causes network memberships to start working faster. */
  529. if (((flags & ZT_PROTO_VERB_MULTICAST_FRAME_FLAGS_HAS_MEMBERSHIP_CERTIFICATE))&&(network)) {
  530. CertificateOfMembership originCom(*this,ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME + frameLen + 2 + signatureLen);
  531. Address comSignedBy(originCom.signedBy());
  532. if ((originCom.networkId() == nwid)&&(comSignedBy == network->controller())) {
  533. SharedPtr<Peer> comSigningPeer(_r->topology->getPeer(comSignedBy));
  534. if (!comSigningPeer) {
  535. // Technically this should never happen because the COM should be signed by
  536. // the master for this network (in current usage) and we ought to already have
  537. // that cached. But handle it anyway.
  538. _r->sw->requestWhois(comSignedBy);
  539. _step = DECODE_WAITING_FOR_MULTICAST_FRAME_ORIGINAL_SENDER_LOOKUP; // causes processing to come back here
  540. return false;
  541. } else if (originCom.verify(comSigningPeer->identity())) {
  542. // The certificate is valid so learn it. As explained above this does not
  543. // imply validation of the multicast. That happens later. Look for a call
  544. // to network->isAllowed().
  545. network->addMembershipCertificate(originCom);
  546. } else {
  547. // Go ahead and drop the multicast though if the COM was invalid, since this
  548. // obviously signifies a problem.
  549. LOG("dropped MULTICAST_FRAME from %s(%s): included COM failed authentication check",source().toString().c_str(),_remoteAddress.toString().c_str());
  550. return true;
  551. }
  552. } else {
  553. // Go ahead and drop the multicast here too, since this also ought never to
  554. // happen and certainly indicates a problem.
  555. LOG("dropped MULTICAST_FRAME from %s(%s): included COM is not for this network",source().toString().c_str(),_remoteAddress.toString().c_str());
  556. return true;
  557. }
  558. }
  559. // Check the multicast frame's signature to verify that its original sender is
  560. // who it claims to be.
  561. const unsigned int signedPartLen = (ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME - ZT_PROTO_VERB_MULTICAST_FRAME_IDX__START_OF_SIGNED_PORTION) + frameLen;
  562. if (!originPeer->identity().verify(field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX__START_OF_SIGNED_PORTION,signedPartLen),signedPartLen,signature,signatureLen)) {
  563. LOG("dropped MULTICAST_FRAME from %s(%s): failed signature verification, claims to be from %s",source().toString().c_str(),_remoteAddress.toString().c_str(),origin.toString().c_str());
  564. return true;
  565. }
  566. // Security check to prohibit multicasts that are really Ethernet unicasts...
  567. // otherwise people could do weird things like multicast out a TCP SYN.
  568. if (!dest.mac().isMulticast()) {
  569. LOG("dropped MULTICAST_FRAME from %s(%s): %s is not a multicast/broadcast address",source().toString().c_str(),_remoteAddress.toString().c_str(),dest.mac().toString().c_str());
  570. return true;
  571. }
  572. #ifdef ZT_TRACE_MULTICAST
  573. // This code, if enabled, sends a UDP pingback to a logger for each multicast.
  574. char mct[1024],mctdepth[1024];
  575. unsigned int startingFifoItems = 0;
  576. for(unsigned int i=0;i<ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_FIFO;i+=ZT_ADDRESS_LENGTH) {
  577. if (Utils::isZero(fifo + i,ZT_ADDRESS_LENGTH))
  578. break;
  579. else ++startingFifoItems;
  580. }
  581. for(unsigned int i=0;i<depth;++i)
  582. mctdepth[i] = ' ';
  583. mctdepth[depth] = 0;
  584. Utils::snprintf(mct,sizeof(mct),
  585. "%.16llx %.2u %.3u%s %c %s <- %s via %s len:%u fifosize:%u",
  586. guid,
  587. prefix,
  588. depth,
  589. mctdepth,
  590. (_r->topology->amSupernode() ? 'S' : '-'),
  591. _r->identity.address().toString().c_str(),
  592. origin.toString().c_str(),
  593. source().toString().c_str(),
  594. frameLen,
  595. startingFifoItems);
  596. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  597. #endif
  598. // At this point the frame is basically valid, so we can call it a receive
  599. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_MULTICAST_FRAME,0,Packet::VERB_NOP,Utils::now());
  600. // This gets updated later in most cases but start with the global limit.
  601. unsigned int maxDepth = ZT_MULTICAST_GLOBAL_MAX_DEPTH;
  602. if ((origin == _r->identity.address())||(_r->mc->deduplicate(nwid,guid))) {
  603. // This is a boomerang or a duplicate of a multicast we've already seen. Ordinary
  604. // nodes drop these, while supernodes will keep propagating them since they can
  605. // act as bridges between sparse multicast networks more than once.
  606. if (!_r->topology->amSupernode()) {
  607. #ifdef ZT_TRACE_MULTICAST
  608. Utils::snprintf(mct,sizeof(mct),
  609. "%.16llx %.2u %.3u%s %c %s dropped: duplicate",
  610. guid,
  611. prefix,
  612. depth,
  613. mctdepth,
  614. (_r->topology->amSupernode() ? 'S' : '-'),
  615. _r->identity.address().toString().c_str());
  616. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  617. #endif
  618. TRACE("dropped MULTICAST_FRAME from %s(%s): duplicate",source().toString().c_str(),_remoteAddress.toString().c_str());
  619. return true;
  620. }
  621. } else {
  622. // If we are actually a member of this network (will just about always
  623. // be the case unless we're a supernode), check to see if we should
  624. // inject the packet. This also gives us an opportunity to check things
  625. // like multicast bandwidth constraints.
  626. if (network) {
  627. SharedPtr<NetworkConfig> nconf(network->config2());
  628. if (nconf) {
  629. // Learn real maxDepth from netconf
  630. maxDepth = std::min((unsigned int)ZT_MULTICAST_GLOBAL_MAX_DEPTH,nconf->multicastDepth());
  631. if (!maxDepth)
  632. maxDepth = ZT_MULTICAST_GLOBAL_MAX_DEPTH;
  633. if (!network->isAllowed(origin)) {
  634. // Papers, please...
  635. Packet outp(source(),_r->identity.address(),Packet::VERB_ERROR);
  636. outp.append((unsigned char)Packet::VERB_MULTICAST_FRAME);
  637. outp.append(packetId());
  638. outp.append((unsigned char)Packet::ERROR_NEED_MEMBERSHIP_CERTIFICATE);
  639. outp.append(nwid);
  640. outp.armor(peer->key(),true);
  641. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  642. TRACE("dropped MULTICAST_FRAME from %s(%s) into %.16llx: sender %s not allowed or we don't have a certificate",source().toString().c_str(),_remoteAddress.toString().c_str(),nwid,origin.toString().c_str());
  643. return true;
  644. }
  645. if (MAC(origin,network->id()) != sourceMac) {
  646. if (!nconf->permitsBridging(origin)) {
  647. #ifdef ZT_TRACE_MULTICAST
  648. Utils::snprintf(mct,sizeof(mct),
  649. "%.16llx %.2u %.3u%s %c %s dropped: bridging not allowed",
  650. guid,
  651. prefix,
  652. depth,
  653. mctdepth,
  654. (_r->topology->amSupernode() ? 'S' : '-'),
  655. _r->identity.address().toString().c_str());
  656. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  657. #endif
  658. TRACE("dropped MULTICAST_FRAME from %s(%s) into %.16llx: source mac %s doesn't belong to %s, and bridging is not supported on network",source().toString().c_str(),_remoteAddress.toString().c_str(),nwid,sourceMac.toString().c_str(),origin.toString().c_str());
  659. return true;
  660. }
  661. network->learnBridgeRoute(sourceMac,origin);
  662. }
  663. if (!nconf->permitsEtherType(etherType)) {
  664. #ifdef ZT_TRACE_MULTICAST
  665. Utils::snprintf(mct,sizeof(mct),
  666. "%.16llx %.2u %.3u%s %c %s dropped: ethertype not allowed",
  667. guid,
  668. prefix,
  669. depth,
  670. mctdepth,
  671. (_r->topology->amSupernode() ? 'S' : '-'),
  672. _r->identity.address().toString().c_str());
  673. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  674. #endif
  675. TRACE("dropped MULTICAST_FRAME from %s(%s) into %.16llx: ethertype %u is not allowed",source().toString().c_str(),nwid,_remoteAddress.toString().c_str(),etherType);
  676. return true;
  677. }
  678. if (!network->updateAndCheckMulticastBalance(origin,dest,frameLen)) {
  679. // Rate limits can only be checked by members of this network, but
  680. // there should be enough of them that over-limit multicasts get
  681. // their propagation aborted.
  682. #ifdef ZT_TRACE_MULTICAST
  683. Utils::snprintf(mct,sizeof(mct),
  684. "%.16llx %.2u %.3u%s %c %s dropped: rate limits exceeded",
  685. guid,
  686. prefix,
  687. depth,
  688. mctdepth,
  689. (_r->topology->amSupernode() ? 'S' : '-'),
  690. _r->identity.address().toString().c_str());
  691. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  692. #endif
  693. TRACE("dropped MULTICAST_FRAME from %s(%s): rate limits exceeded for sender %s",source().toString().c_str(),_remoteAddress.toString().c_str(),origin.toString().c_str());
  694. return true;
  695. }
  696. network->tapPut(sourceMac,dest.mac(),etherType,frame,frameLen);
  697. }
  698. }
  699. }
  700. // Depth of 0xffff means "do not forward." Check first since
  701. // incrementing this would integer overflow a 16-bit int.
  702. if (depth == 0xffff) {
  703. #ifdef ZT_TRACE_MULTICAST
  704. Utils::snprintf(mct,sizeof(mct),
  705. "%.16llx %.2u %.3u%s %c %s not forwarding: depth == 0xffff (do not forward)",
  706. guid,
  707. prefix,
  708. depth,
  709. mctdepth,
  710. (_r->topology->amSupernode() ? 'S' : '-'),
  711. _r->identity.address().toString().c_str());
  712. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  713. #endif
  714. TRACE("not forwarding MULTICAST_FRAME from %s(%s): depth == 0xffff (do not forward)",source().toString().c_str(),_remoteAddress.toString().c_str());
  715. return true;
  716. }
  717. // Check if graph traversal depth has exceeded configured maximum.
  718. if (++depth > maxDepth) {
  719. #ifdef ZT_TRACE_MULTICAST
  720. Utils::snprintf(mct,sizeof(mct),
  721. "%.16llx %.2u %.3u%s %c %s not forwarding: max propagation depth reached",
  722. guid,
  723. prefix,
  724. depth,
  725. mctdepth,
  726. (_r->topology->amSupernode() ? 'S' : '-'),
  727. _r->identity.address().toString().c_str());
  728. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  729. #endif
  730. TRACE("not forwarding MULTICAST_FRAME from %s(%s): max propagation depth reached",source().toString().c_str(),_remoteAddress.toString().c_str());
  731. return true;
  732. }
  733. // Update depth in packet with new incremented value
  734. setAt(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_DEPTH,(uint16_t)depth);
  735. // New FIFO with room for one extra, since head will be next hop
  736. unsigned char newFifo[ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_FIFO + ZT_ADDRESS_LENGTH];
  737. unsigned char *newFifoPtr = newFifo;
  738. unsigned char *const newFifoEnd = newFifo + sizeof(newFifo);
  739. // Copy old FIFO into new buffer, terminating at first NULL address
  740. for(unsigned char *f=fifo,*const fifoEnd=(fifo + ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_FIFO);f!=fifoEnd;) {
  741. unsigned char *nf = newFifoPtr;
  742. unsigned char *e = nf + ZT_ADDRESS_LENGTH;
  743. unsigned char *ftmp = f;
  744. unsigned char zeroCheckMask = 0;
  745. while (nf != e)
  746. zeroCheckMask |= (*(nf++) = *(ftmp++));
  747. if (zeroCheckMask) {
  748. f = ftmp;
  749. newFifoPtr = nf;
  750. } else break;
  751. }
  752. // Add any next hops we know about to FIFO
  753. #ifdef ZT_TRACE_MULTICAST
  754. unsigned char *beforeAdd = newFifoPtr;
  755. #endif
  756. _r->mc->getNextHops(nwid,dest,Multicaster::AddToPropagationQueue(&newFifoPtr,newFifoEnd,bloom,bloomNonce,origin,prefixBits,prefix));
  757. #ifdef ZT_TRACE_MULTICAST
  758. unsigned int numAdded = (unsigned int)(newFifoPtr - beforeAdd) / ZT_ADDRESS_LENGTH;
  759. #endif
  760. // Zero-terminate new FIFO if not completely full. We pad the remainder with
  761. // zeroes because this improves data compression ratios.
  762. while (newFifoPtr != newFifoEnd)
  763. *(newFifoPtr++) = (unsigned char)0;
  764. // First element in newFifo[] is next hop
  765. Address nextHop(newFifo,ZT_ADDRESS_LENGTH);
  766. if ((!nextHop)&&(!_r->topology->amSupernode())) {
  767. SharedPtr<Peer> supernode(_r->topology->getBestSupernode(&origin,1,true));
  768. if (supernode)
  769. nextHop = supernode->address();
  770. }
  771. if ((!nextHop)||(nextHop == _r->identity.address())) { // check against our addr is a sanity check
  772. #ifdef ZT_TRACE_MULTICAST
  773. Utils::snprintf(mct,sizeof(mct),
  774. "%.16llx %.2u %.3u%s %c %s not forwarding: no next hop",
  775. guid,
  776. prefix,
  777. depth,
  778. mctdepth,
  779. (_r->topology->amSupernode() ? 'S' : '-'),
  780. _r->identity.address().toString().c_str());
  781. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  782. #endif
  783. //TRACE("not forwarding MULTICAST_FRAME from %s(%s): no next hop",source().toString().c_str(),_remoteAddress.toString().c_str());
  784. return true;
  785. }
  786. // The rest of newFifo[] goes back into the packet
  787. memcpy(fifo,newFifo + ZT_ADDRESS_LENGTH,ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_FIFO);
  788. #ifdef ZT_TRACE_MULTICAST
  789. Utils::snprintf(mct,sizeof(mct),
  790. "%.16llx %.2u %.3u%s %c %s -> origin %s, sending to next hop %s, +fifosize:%u",
  791. guid,
  792. prefix,
  793. depth,
  794. mctdepth,
  795. (_r->topology->amSupernode() ? 'S' : '-'),
  796. _r->identity.address().toString().c_str(),
  797. origin.toString().c_str(),
  798. nextHop.toString().c_str(),
  799. numAdded);
  800. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  801. #endif
  802. // Send to next hop, reusing this packet as scratch space
  803. newInitializationVector();
  804. setDestination(nextHop);
  805. setSource(_r->identity.address());
  806. compress(); // note: bloom filters and empty FIFOs are highly compressable!
  807. _r->sw->send(*this,true);
  808. return true;
  809. } catch (std::exception &ex) {
  810. TRACE("dropped MULTICAST_FRAME from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  811. } catch ( ... ) {
  812. TRACE("dropped MULTICAST_FRAME from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  813. }
  814. return true;
  815. }
  816. bool PacketDecoder::_doMULTICAST_LIKE(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  817. {
  818. try {
  819. Address src(source());
  820. uint64_t now = Utils::now();
  821. // Iterate through 18-byte network,MAC,ADI tuples
  822. for(unsigned int ptr=ZT_PACKET_IDX_PAYLOAD;ptr<size();ptr+=18) {
  823. uint64_t nwid = at<uint64_t>(ptr);
  824. SharedPtr<Network> network(_r->nc->network(nwid));
  825. if ((_r->topology->amSupernode())||((network)&&(network->isAllowed(peer->address())))) {
  826. _r->mc->likesGroup(nwid,src,MulticastGroup(MAC(field(ptr + 8,6),6),at<uint32_t>(ptr + 14)),now);
  827. if (network)
  828. network->pushMembershipCertificate(peer->address(),false,now);
  829. }
  830. }
  831. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_MULTICAST_LIKE,0,Packet::VERB_NOP,now);
  832. } catch (std::exception &ex) {
  833. TRACE("dropped MULTICAST_LIKE from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  834. } catch ( ... ) {
  835. TRACE("dropped MULTICAST_LIKE from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  836. }
  837. return true;
  838. }
  839. bool PacketDecoder::_doNETWORK_MEMBERSHIP_CERTIFICATE(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  840. {
  841. try {
  842. CertificateOfMembership com;
  843. unsigned int ptr = ZT_PACKET_IDX_PAYLOAD;
  844. while (ptr < size()) {
  845. ptr += com.deserialize(*this,ptr);
  846. if ((com.hasRequiredFields())&&(com.signedBy())) {
  847. SharedPtr<Peer> signer(_r->topology->getPeer(com.signedBy()));
  848. if (signer) {
  849. if (com.verify(signer->identity())) {
  850. uint64_t nwid = com.networkId();
  851. SharedPtr<Network> network(_r->nc->network(nwid));
  852. if (network) {
  853. if (network->controller() == signer)
  854. network->addMembershipCertificate(com);
  855. }
  856. }
  857. } else {
  858. _r->sw->requestWhois(com.signedBy());
  859. _step = DECODE_WAITING_FOR_NETWORK_MEMBERSHIP_CERTIFICATE_SIGNER_LOOKUP;
  860. return false;
  861. }
  862. }
  863. }
  864. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_NETWORK_MEMBERSHIP_CERTIFICATE,0,Packet::VERB_NOP,Utils::now());
  865. } catch (std::exception &ex) {
  866. TRACE("dropped NETWORK_MEMBERSHIP_CERTIFICATE from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  867. } catch ( ... ) {
  868. TRACE("dropped NETWORK_MEMBERSHIP_CERTIFICATE from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  869. }
  870. return true;
  871. }
  872. bool PacketDecoder::_doNETWORK_CONFIG_REQUEST(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  873. {
  874. try {
  875. uint64_t nwid = at<uint64_t>(ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_NETWORK_ID);
  876. #ifndef __WINDOWS__
  877. if (_r->netconfService) {
  878. char tmp[128];
  879. unsigned int dictLen = at<uint16_t>(ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_DICT_LEN);
  880. Dictionary request;
  881. if (dictLen)
  882. request["meta"] = std::string((const char *)field(ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_DICT,dictLen),dictLen);
  883. request["type"] = "netconf-request";
  884. request["peerId"] = peer->identity().toString(false);
  885. Utils::snprintf(tmp,sizeof(tmp),"%.16llx",(unsigned long long)nwid);
  886. request["nwid"] = tmp;
  887. Utils::snprintf(tmp,sizeof(tmp),"%.16llx",(unsigned long long)packetId());
  888. request["requestId"] = tmp;
  889. if (!hops())
  890. request["from"] = _remoteAddress.toString();
  891. //TRACE("to netconf:\n%s",request.toString().c_str());
  892. _r->netconfService->send(request);
  893. } else {
  894. #endif // !__WINDOWS__
  895. Packet outp(source(),_r->identity.address(),Packet::VERB_ERROR);
  896. outp.append((unsigned char)Packet::VERB_NETWORK_CONFIG_REQUEST);
  897. outp.append(packetId());
  898. outp.append((unsigned char)Packet::ERROR_UNSUPPORTED_OPERATION);
  899. outp.append(nwid);
  900. outp.armor(peer->key(),true);
  901. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  902. #ifndef __WINDOWS__
  903. }
  904. #endif // !__WINDOWS__
  905. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_NETWORK_CONFIG_REQUEST,0,Packet::VERB_NOP,Utils::now());
  906. } catch (std::exception &exc) {
  907. TRACE("dropped NETWORK_CONFIG_REQUEST from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),exc.what());
  908. } catch ( ... ) {
  909. TRACE("dropped NETWORK_CONFIG_REQUEST from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  910. }
  911. return true;
  912. }
  913. bool PacketDecoder::_doNETWORK_CONFIG_REFRESH(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  914. {
  915. try {
  916. unsigned int ptr = ZT_PACKET_IDX_PAYLOAD;
  917. while ((ptr + sizeof(uint64_t)) <= size()) {
  918. uint64_t nwid = at<uint64_t>(ptr); ptr += sizeof(uint64_t);
  919. SharedPtr<Network> nw(_r->nc->network(nwid));
  920. if ((nw)&&(source() == nw->controller())) { // only respond to requests from controller
  921. TRACE("NETWORK_CONFIG_REFRESH from %s, refreshing network %.16llx",source().toString().c_str(),nwid);
  922. nw->requestConfiguration();
  923. }
  924. }
  925. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_NETWORK_CONFIG_REFRESH,0,Packet::VERB_NOP,Utils::now());
  926. } catch (std::exception &exc) {
  927. TRACE("dropped NETWORK_CONFIG_REFRESH from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),exc.what());
  928. } catch ( ... ) {
  929. TRACE("dropped NETWORK_CONFIG_REFRESH from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  930. }
  931. return true;
  932. }
  933. void PacketDecoder::_sendErrorNeedCertificate(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer,uint64_t nwid)
  934. {
  935. Packet outp(source(),_r->identity.address(),Packet::VERB_ERROR);
  936. outp.append((unsigned char)verb());
  937. outp.append(packetId());
  938. outp.append((unsigned char)Packet::ERROR_NEED_MEMBERSHIP_CERTIFICATE);
  939. outp.append(nwid);
  940. outp.armor(peer->key(),true);
  941. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  942. }
  943. } // namespace ZeroTier