2
0

PacketDecoder.cpp 46 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012
  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. }
  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); // legal, but why? :)
  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. TRACE("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. TRACE("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. TRACE("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. TRACE("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. TRACE("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. if (payloadLength() == ZT_ADDRESS_LENGTH) {
  312. Identity id(_r->topology->getIdentity(Address(payload(),ZT_ADDRESS_LENGTH)));
  313. if (id) {
  314. Packet outp(source(),_r->identity.address(),Packet::VERB_OK);
  315. outp.append((unsigned char)Packet::VERB_WHOIS);
  316. outp.append(packetId());
  317. id.serialize(outp,false);
  318. outp.armor(peer->key(),true);
  319. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  320. //TRACE("sent WHOIS response to %s for %s",source().toString().c_str(),Address(payload(),ZT_ADDRESS_LENGTH).toString().c_str());
  321. } else {
  322. Packet outp(source(),_r->identity.address(),Packet::VERB_ERROR);
  323. outp.append((unsigned char)Packet::VERB_WHOIS);
  324. outp.append(packetId());
  325. outp.append((unsigned char)Packet::ERROR_OBJ_NOT_FOUND);
  326. outp.append(payload(),ZT_ADDRESS_LENGTH);
  327. outp.armor(peer->key(),true);
  328. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  329. //TRACE("sent WHOIS ERROR to %s for %s (not found)",source().toString().c_str(),Address(payload(),ZT_ADDRESS_LENGTH).toString().c_str());
  330. }
  331. } else {
  332. TRACE("dropped WHOIS from %s(%s): missing or invalid address",source().toString().c_str(),_remoteAddress.toString().c_str());
  333. }
  334. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_WHOIS,0,Packet::VERB_NOP,Utils::now());
  335. return true;
  336. }
  337. bool PacketDecoder::_doRENDEZVOUS(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  338. {
  339. try {
  340. /*
  341. * At the moment, we only obey RENDEZVOUS if it comes from a designated
  342. * supernode. If relay offloading is implemented to scale the net, this
  343. * will need reconsideration.
  344. *
  345. * The reason is that RENDEZVOUS could technically be used to cause a
  346. * peer to send a weird encrypted UDP packet to an arbitrary IP:port.
  347. * The sender of RENDEZVOUS has no control over the content of this
  348. * packet, but it's still maybe something we want to not allow just
  349. * anyone to order due to possible DDOS or network forensic implications.
  350. * So if we diversify relays, we'll need some way of deciding whether the
  351. * sender is someone we should trust with a RENDEZVOUS hint.
  352. */
  353. if (_r->topology->isSupernode(source())) {
  354. Address with(field(ZT_PROTO_VERB_RENDEZVOUS_IDX_ZTADDRESS,ZT_ADDRESS_LENGTH),ZT_ADDRESS_LENGTH);
  355. SharedPtr<Peer> withPeer(_r->topology->getPeer(with));
  356. if (withPeer) {
  357. unsigned int port = at<uint16_t>(ZT_PROTO_VERB_RENDEZVOUS_IDX_PORT);
  358. unsigned int addrlen = (*this)[ZT_PROTO_VERB_RENDEZVOUS_IDX_ADDRLEN];
  359. if ((port > 0)&&((addrlen == 4)||(addrlen == 16))) {
  360. InetAddress atAddr(field(ZT_PROTO_VERB_RENDEZVOUS_IDX_ADDRESS,addrlen),addrlen,port);
  361. 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());
  362. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_RENDEZVOUS,0,Packet::VERB_NOP,Utils::now());
  363. _r->sw->contact(withPeer,atAddr);
  364. } else {
  365. TRACE("dropped corrupt RENDEZVOUS from %s(%s) (bad address or port)",source().toString().c_str(),_remoteAddress.toString().c_str());
  366. }
  367. } else {
  368. TRACE("ignored RENDEZVOUS from %s(%s) to meet unknown peer %s",source().toString().c_str(),_remoteAddress.toString().c_str(),with.toString().c_str());
  369. }
  370. } else {
  371. TRACE("ignored RENDEZVOUS from %s(%s): source not supernode",source().toString().c_str(),_remoteAddress.toString().c_str());
  372. }
  373. } catch (std::exception &ex) {
  374. TRACE("dropped RENDEZVOUS from %s(%s): %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  375. } catch ( ... ) {
  376. TRACE("dropped RENDEZVOUS from %s(%s): unexpected exception",source().toString().c_str(),_remoteAddress.toString().c_str());
  377. }
  378. return true;
  379. }
  380. bool PacketDecoder::_doFRAME(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  381. {
  382. try {
  383. SharedPtr<Network> network(_r->nc->network(at<uint64_t>(ZT_PROTO_VERB_FRAME_IDX_NETWORK_ID)));
  384. if (network) {
  385. if (size() > ZT_PROTO_VERB_FRAME_IDX_PAYLOAD) {
  386. if (!network->isAllowed(peer->address())) {
  387. 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());
  388. _sendErrorNeedCertificate(_r,peer,network->id());
  389. return true;
  390. }
  391. unsigned int etherType = at<uint16_t>(ZT_PROTO_VERB_FRAME_IDX_ETHERTYPE);
  392. if (!network->config()->permitsEtherType(etherType)) {
  393. 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());
  394. return true;
  395. }
  396. network->tapPut(MAC(peer->address(),network->id()),network->mac(),etherType,data() + ZT_PROTO_VERB_FRAME_IDX_PAYLOAD,size() - ZT_PROTO_VERB_FRAME_IDX_PAYLOAD);
  397. /* Source moves "closer" to us in multicast propagation priority when
  398. * we receive unicast frames from it. This is called "implicit social
  399. * ordering" in other docs. */
  400. _r->mc->bringCloser(network->id(),peer->address());
  401. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_FRAME,0,Packet::VERB_NOP,Utils::now());
  402. return true;
  403. }
  404. } else {
  405. 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));
  406. }
  407. } catch (std::exception &ex) {
  408. TRACE("dropped FRAME from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  409. } catch ( ... ) {
  410. TRACE("dropped FRAME from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  411. }
  412. return true;
  413. }
  414. bool PacketDecoder::_doEXT_FRAME(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  415. {
  416. try {
  417. SharedPtr<Network> network(_r->nc->network(at<uint64_t>(ZT_PROTO_VERB_EXT_FRAME_IDX_NETWORK_ID)));
  418. if (network) {
  419. if (size() > ZT_PROTO_VERB_EXT_FRAME_IDX_PAYLOAD) {
  420. if ((*this)[ZT_PROTO_VERB_EXT_FRAME_IDX_FLAGS] != 0) {
  421. TRACE("dropped EXT_FRAME due to unknown flags");
  422. return true;
  423. }
  424. if (!network->isAllowed(peer->address())) {
  425. 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());
  426. _sendErrorNeedCertificate(_r,peer,network->id());
  427. return true;
  428. }
  429. unsigned int etherType = at<uint16_t>(ZT_PROTO_VERB_EXT_FRAME_IDX_ETHERTYPE);
  430. if (!network->config()->permitsEtherType(etherType)) {
  431. 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());
  432. return true;
  433. }
  434. 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);
  435. 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);
  436. if ((!from)||(from.isMulticast())||(from == network->mac())||(!to)) {
  437. 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());
  438. return true;
  439. }
  440. // If it's not from the sending peer, they must be allowed to bridge into this network
  441. if (from != MAC(peer->address(),network->id())) {
  442. if (network->permitsBridging(peer->address())) {
  443. network->learnBridgeRoute(from,peer->address());
  444. } else {
  445. 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());
  446. return true;
  447. }
  448. } // else: it is valid to send a non-bridged packet this way instead of as FRAME, but this isn't done by current code
  449. // If it's not to us, we must be allowed to bridge into this network
  450. if (to != network->mac()) {
  451. if (!network->permitsBridging(_r->identity.address())) {
  452. 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());
  453. return true;
  454. }
  455. }
  456. network->tapPut(from,to,etherType,data() + ZT_PROTO_VERB_EXT_FRAME_IDX_PAYLOAD,size() - ZT_PROTO_VERB_EXT_FRAME_IDX_PAYLOAD);
  457. /* Source moves "closer" to us in multicast propagation priority when
  458. * we receive unicast frames from it. This is called "implicit social
  459. * ordering" in other docs. */
  460. _r->mc->bringCloser(network->id(),peer->address());
  461. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_EXT_FRAME,0,Packet::VERB_NOP,Utils::now());
  462. }
  463. } else {
  464. 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));
  465. }
  466. } catch (std::exception &ex) {
  467. TRACE("dropped EXT_FRAME from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  468. } catch ( ... ) {
  469. TRACE("dropped EXT_FRAME from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  470. }
  471. return true;
  472. }
  473. bool PacketDecoder::_doMULTICAST_FRAME(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  474. {
  475. try {
  476. Address origin(Address(field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_ORIGIN,ZT_PROTO_VERB_MULTICAST_FRAME_LEN_ORIGIN),ZT_ADDRESS_LENGTH));
  477. SharedPtr<Peer> originPeer(_r->topology->getPeer(origin));
  478. if (!originPeer) {
  479. // We must have the origin's identity in order to authenticate a multicast
  480. _r->sw->requestWhois(origin);
  481. _step = DECODE_WAITING_FOR_MULTICAST_FRAME_ORIGINAL_SENDER_LOOKUP; // causes processing to come back here
  482. return false;
  483. }
  484. // These fields change
  485. unsigned int depth = at<uint16_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_DEPTH);
  486. unsigned char *const fifo = field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_FIFO,ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_FIFO);
  487. unsigned char *const bloom = field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_BLOOM,ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_BLOOM);
  488. // These fields don't -- they're signed by the original sender
  489. const unsigned int flags = (*this)[ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FLAGS];
  490. const uint64_t nwid = at<uint64_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_NETWORK_ID);
  491. const uint16_t bloomNonce = at<uint16_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_BLOOM_NONCE);
  492. const unsigned int prefixBits = (*this)[ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_PREFIX_BITS];
  493. const unsigned int prefix = (*this)[ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_PREFIX];
  494. const uint64_t guid = at<uint64_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_GUID);
  495. 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);
  496. 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));
  497. const unsigned int etherType = at<uint16_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_ETHERTYPE);
  498. const unsigned int frameLen = at<uint16_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME_LEN);
  499. const unsigned char *const frame = field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME,frameLen);
  500. const unsigned int signatureLen = at<uint16_t>(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME + frameLen);
  501. const unsigned char *const signature = field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME + frameLen + 2,signatureLen);
  502. TRACE("MULTICAST_FRAME @%.16llx #%.16llx from %s<%s> via %s(%s) to %s [ %s, %d bytes, depth %d ]",
  503. (unsigned long long)nwid,
  504. (unsigned long long)guid,
  505. sourceMac.toString().c_str(),origin.toString().c_str(),
  506. source().toString().c_str(),_remoteAddress.toString().c_str(),
  507. dest.toString().c_str(),
  508. Switch::etherTypeName(etherType),
  509. (int)frameLen,
  510. (int)depth);
  511. SharedPtr<Network> network(_r->nc->network(nwid));
  512. /* Grab, verify, and learn certificate of network membership if any -- provided we are
  513. * a member of this network. Note: we can do this before verification of the actual
  514. * packet, since the certificate has its own separate signature. In other words a valid
  515. * COM does not imply a valid multicast; they are two separate things. The ability to
  516. * include the COM with the multicast is a performance optimization to allow peers to
  517. * distribute their COM along with their packets instead of as a separate transaction.
  518. * This causes network memberships to start working faster. */
  519. if (((flags & ZT_PROTO_VERB_MULTICAST_FRAME_FLAGS_HAS_MEMBERSHIP_CERTIFICATE))&&(network)) {
  520. CertificateOfMembership originCom(*this,ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME + frameLen + 2 + signatureLen);
  521. Address comSignedBy(originCom.signedBy());
  522. if ((originCom.networkId() == nwid)&&(comSignedBy == network->controller())) {
  523. SharedPtr<Peer> comSigningPeer(_r->topology->getPeer(comSignedBy));
  524. if (!comSigningPeer) {
  525. // Technically this should never happen because the COM should be signed by
  526. // the master for this network (in current usage) and we ought to already have
  527. // that cached. But handle it anyway.
  528. _r->sw->requestWhois(comSignedBy);
  529. _step = DECODE_WAITING_FOR_MULTICAST_FRAME_ORIGINAL_SENDER_LOOKUP; // causes processing to come back here
  530. return false;
  531. } else if (originCom.verify(comSigningPeer->identity())) {
  532. // The certificate is valid so learn it. As explained above this does not
  533. // imply validation of the multicast. That happens later. Look for a call
  534. // to network->isAllowed().
  535. network->addMembershipCertificate(originCom);
  536. } else {
  537. // Go ahead and drop the multicast though if the COM was invalid, since this
  538. // obviously signifies a problem.
  539. LOG("dropped MULTICAST_FRAME from %s(%s): included COM failed authentication check",source().toString().c_str(),_remoteAddress.toString().c_str());
  540. return true;
  541. }
  542. } else {
  543. // Go ahead and drop the multicast here too, since this also ought never to
  544. // happen and certainly indicates a problem.
  545. LOG("dropped MULTICAST_FRAME from %s(%s): included COM is not for this network",source().toString().c_str(),_remoteAddress.toString().c_str());
  546. return true;
  547. }
  548. }
  549. // Check the multicast frame's signature to verify that its original sender is
  550. // who it claims to be.
  551. const unsigned int signedPartLen = (ZT_PROTO_VERB_MULTICAST_FRAME_IDX_FRAME - ZT_PROTO_VERB_MULTICAST_FRAME_IDX__START_OF_SIGNED_PORTION) + frameLen;
  552. if (!originPeer->identity().verify(field(ZT_PROTO_VERB_MULTICAST_FRAME_IDX__START_OF_SIGNED_PORTION,signedPartLen),signedPartLen,signature,signatureLen)) {
  553. 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());
  554. return true;
  555. }
  556. // Security check to prohibit multicasts that are really Ethernet unicasts...
  557. // otherwise people could do weird things like multicast out a TCP SYN.
  558. if (!dest.mac().isMulticast()) {
  559. 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());
  560. return true;
  561. }
  562. #ifdef ZT_TRACE_MULTICAST
  563. // This code, if enabled, sends a UDP pingback to a logger for each multicast.
  564. char mct[1024],mctdepth[1024];
  565. unsigned int startingFifoItems = 0;
  566. for(unsigned int i=0;i<ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_FIFO;i+=ZT_ADDRESS_LENGTH) {
  567. if (Utils::isZero(fifo + i,ZT_ADDRESS_LENGTH))
  568. break;
  569. else ++startingFifoItems;
  570. }
  571. for(unsigned int i=0;i<depth;++i)
  572. mctdepth[i] = ' ';
  573. mctdepth[depth] = 0;
  574. Utils::snprintf(mct,sizeof(mct),
  575. "%.16llx %.2u %.3u%s %c %s <- %s via %s len:%u fifosize:%u",
  576. guid,
  577. prefix,
  578. depth,
  579. mctdepth,
  580. (_r->topology->amSupernode() ? 'S' : '-'),
  581. _r->identity.address().toString().c_str(),
  582. origin.toString().c_str(),
  583. source().toString().c_str(),
  584. frameLen,
  585. startingFifoItems);
  586. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  587. #endif
  588. // At this point the frame is basically valid, so we can call it a receive
  589. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_MULTICAST_FRAME,0,Packet::VERB_NOP,Utils::now());
  590. // This gets updated later in most cases but start with the global limit.
  591. unsigned int maxDepth = ZT_MULTICAST_GLOBAL_MAX_DEPTH;
  592. if ((origin == _r->identity.address())||(_r->mc->deduplicate(nwid,guid))) {
  593. // This is a boomerang or a duplicate of a multicast we've already seen. Ordinary
  594. // nodes drop these, while supernodes will keep propagating them since they can
  595. // act as bridges between sparse multicast networks more than once.
  596. if (!_r->topology->amSupernode()) {
  597. #ifdef ZT_TRACE_MULTICAST
  598. Utils::snprintf(mct,sizeof(mct),
  599. "%.16llx %.2u %.3u%s %c %s dropped: duplicate",
  600. guid,
  601. prefix,
  602. depth,
  603. mctdepth,
  604. (_r->topology->amSupernode() ? 'S' : '-'),
  605. _r->identity.address().toString().c_str());
  606. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  607. #endif
  608. TRACE("dropped MULTICAST_FRAME from %s(%s): duplicate",source().toString().c_str(),_remoteAddress.toString().c_str());
  609. return true;
  610. }
  611. } else {
  612. // If we are actually a member of this network (will just about always
  613. // be the case unless we're a supernode), check to see if we should
  614. // inject the packet. This also gives us an opportunity to check things
  615. // like multicast bandwidth constraints.
  616. if (network) {
  617. SharedPtr<NetworkConfig> nconf(network->config2());
  618. if (nconf) {
  619. // Learn real maxDepth from netconf
  620. maxDepth = std::min((unsigned int)ZT_MULTICAST_GLOBAL_MAX_DEPTH,nconf->multicastDepth());
  621. if (!maxDepth)
  622. maxDepth = ZT_MULTICAST_GLOBAL_MAX_DEPTH;
  623. if (!network->isAllowed(origin)) {
  624. // Papers, please...
  625. Packet outp(source(),_r->identity.address(),Packet::VERB_ERROR);
  626. outp.append((unsigned char)Packet::VERB_MULTICAST_FRAME);
  627. outp.append(packetId());
  628. outp.append((unsigned char)Packet::ERROR_NEED_MEMBERSHIP_CERTIFICATE);
  629. outp.append(nwid);
  630. outp.armor(peer->key(),true);
  631. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  632. 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());
  633. return true;
  634. }
  635. if (MAC(origin,network->id()) != sourceMac) {
  636. if (!nconf->permitsBridging(origin)) {
  637. #ifdef ZT_TRACE_MULTICAST
  638. Utils::snprintf(mct,sizeof(mct),
  639. "%.16llx %.2u %.3u%s %c %s dropped: bridging not allowed",
  640. guid,
  641. prefix,
  642. depth,
  643. mctdepth,
  644. (_r->topology->amSupernode() ? 'S' : '-'),
  645. _r->identity.address().toString().c_str());
  646. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  647. #endif
  648. 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());
  649. return true;
  650. }
  651. network->learnBridgeRoute(sourceMac,origin);
  652. }
  653. if (!nconf->permitsEtherType(etherType)) {
  654. #ifdef ZT_TRACE_MULTICAST
  655. Utils::snprintf(mct,sizeof(mct),
  656. "%.16llx %.2u %.3u%s %c %s dropped: ethertype not allowed",
  657. guid,
  658. prefix,
  659. depth,
  660. mctdepth,
  661. (_r->topology->amSupernode() ? 'S' : '-'),
  662. _r->identity.address().toString().c_str());
  663. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  664. #endif
  665. TRACE("dropped MULTICAST_FRAME from %s(%s) into %.16llx: ethertype %u is not allowed",source().toString().c_str(),nwid,_remoteAddress.toString().c_str(),etherType);
  666. return true;
  667. }
  668. if (!network->updateAndCheckMulticastBalance(origin,dest,frameLen)) {
  669. // Rate limits can only be checked by members of this network, but
  670. // there should be enough of them that over-limit multicasts get
  671. // their propagation aborted.
  672. #ifdef ZT_TRACE_MULTICAST
  673. Utils::snprintf(mct,sizeof(mct),
  674. "%.16llx %.2u %.3u%s %c %s dropped: rate limits exceeded",
  675. guid,
  676. prefix,
  677. depth,
  678. mctdepth,
  679. (_r->topology->amSupernode() ? 'S' : '-'),
  680. _r->identity.address().toString().c_str());
  681. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  682. #endif
  683. 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());
  684. return true;
  685. }
  686. network->tapPut(sourceMac,dest.mac(),etherType,frame,frameLen);
  687. }
  688. }
  689. }
  690. if (depth == 0xffff) {
  691. #ifdef ZT_TRACE_MULTICAST
  692. Utils::snprintf(mct,sizeof(mct),
  693. "%.16llx %.2u %.3u%s %c %s not forwarding: depth == 0xffff (do not forward)",
  694. guid,
  695. prefix,
  696. depth,
  697. mctdepth,
  698. (_r->topology->amSupernode() ? 'S' : '-'),
  699. _r->identity.address().toString().c_str());
  700. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  701. #endif
  702. TRACE("not forwarding MULTICAST_FRAME from %s(%s): depth == 0xffff (do not forward)",source().toString().c_str(),_remoteAddress.toString().c_str());
  703. return true;
  704. }
  705. if (++depth > maxDepth) {
  706. #ifdef ZT_TRACE_MULTICAST
  707. Utils::snprintf(mct,sizeof(mct),
  708. "%.16llx %.2u %.3u%s %c %s not forwarding: max propagation depth reached",
  709. guid,
  710. prefix,
  711. depth,
  712. mctdepth,
  713. (_r->topology->amSupernode() ? 'S' : '-'),
  714. _r->identity.address().toString().c_str());
  715. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  716. #endif
  717. TRACE("not forwarding MULTICAST_FRAME from %s(%s): max propagation depth reached",source().toString().c_str(),_remoteAddress.toString().c_str());
  718. return true;
  719. }
  720. // Update depth in packet with new incremented value
  721. setAt(ZT_PROTO_VERB_MULTICAST_FRAME_IDX_PROPAGATION_DEPTH,(uint16_t)depth);
  722. // New FIFO with room for one extra, since head will be next hop
  723. unsigned char newFifo[ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_FIFO + ZT_ADDRESS_LENGTH];
  724. unsigned char *newFifoPtr = newFifo;
  725. unsigned char *const newFifoEnd = newFifo + sizeof(newFifo);
  726. // Copy old FIFO into new buffer, terminating at first NULL address
  727. for(unsigned char *f=fifo,*const fifoEnd=(fifo + ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_FIFO);f!=fifoEnd;) {
  728. unsigned char *nf = newFifoPtr;
  729. unsigned char *e = nf + ZT_ADDRESS_LENGTH;
  730. unsigned char *ftmp = f;
  731. unsigned char zeroCheckMask = 0;
  732. while (nf != e)
  733. zeroCheckMask |= (*(nf++) = *(ftmp++));
  734. if (zeroCheckMask) {
  735. f = ftmp;
  736. newFifoPtr = nf;
  737. } else break;
  738. }
  739. // Add any next hops we know about to FIFO
  740. #ifdef ZT_TRACE_MULTICAST
  741. unsigned char *beforeAdd = newFifoPtr;
  742. #endif
  743. _r->mc->getNextHops(nwid,dest,Multicaster::AddToPropagationQueue(&newFifoPtr,newFifoEnd,bloom,bloomNonce,origin,prefixBits,prefix));
  744. #ifdef ZT_TRACE_MULTICAST
  745. unsigned int numAdded = (unsigned int)(newFifoPtr - beforeAdd) / ZT_ADDRESS_LENGTH;
  746. #endif
  747. // Zero-terminate new FIFO if not completely full. We pad the remainder with
  748. // zeroes because this improves data compression ratios.
  749. while (newFifoPtr != newFifoEnd)
  750. *(newFifoPtr++) = (unsigned char)0;
  751. // First element in newFifo[] is next hop
  752. Address nextHop(newFifo,ZT_ADDRESS_LENGTH);
  753. if ((!nextHop)&&(!_r->topology->amSupernode())) {
  754. SharedPtr<Peer> supernode(_r->topology->getBestSupernode(&origin,1,true));
  755. if (supernode)
  756. nextHop = supernode->address();
  757. }
  758. if ((!nextHop)||(nextHop == _r->identity.address())) { // check against our addr is a sanity check
  759. #ifdef ZT_TRACE_MULTICAST
  760. Utils::snprintf(mct,sizeof(mct),
  761. "%.16llx %.2u %.3u%s %c %s not forwarding: no next hop",
  762. guid,
  763. prefix,
  764. depth,
  765. mctdepth,
  766. (_r->topology->amSupernode() ? 'S' : '-'),
  767. _r->identity.address().toString().c_str());
  768. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  769. #endif
  770. //TRACE("not forwarding MULTICAST_FRAME from %s(%s): no next hop",source().toString().c_str(),_remoteAddress.toString().c_str());
  771. return true;
  772. }
  773. // The rest of newFifo[] goes back into the packet
  774. memcpy(fifo,newFifo + ZT_ADDRESS_LENGTH,ZT_PROTO_VERB_MULTICAST_FRAME_LEN_PROPAGATION_FIFO);
  775. #ifdef ZT_TRACE_MULTICAST
  776. Utils::snprintf(mct,sizeof(mct),
  777. "%.16llx %.2u %.3u%s %c %s -> origin %s, sending to next hop %s, +fifosize:%u",
  778. guid,
  779. prefix,
  780. depth,
  781. mctdepth,
  782. (_r->topology->amSupernode() ? 'S' : '-'),
  783. _r->identity.address().toString().c_str(),
  784. origin.toString().c_str(),
  785. nextHop.toString().c_str(),
  786. numAdded);
  787. _r->sm->sendUdp(ZT_DEFAULTS.multicastTraceWatcher,mct,strlen(mct));
  788. #endif
  789. // Send to next hop, reusing this packet as scratch space
  790. newInitializationVector();
  791. setDestination(nextHop);
  792. setSource(_r->identity.address());
  793. compress(); // note: bloom filters and empty FIFOs are highly compressable!
  794. _r->sw->send(*this,true);
  795. return true;
  796. } catch (std::exception &ex) {
  797. TRACE("dropped MULTICAST_FRAME from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  798. } catch ( ... ) {
  799. TRACE("dropped MULTICAST_FRAME from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  800. }
  801. return true;
  802. }
  803. bool PacketDecoder::_doMULTICAST_LIKE(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  804. {
  805. try {
  806. Address src(source());
  807. uint64_t now = Utils::now();
  808. // Iterate through 18-byte network,MAC,ADI tuples
  809. for(unsigned int ptr=ZT_PACKET_IDX_PAYLOAD;ptr<size();ptr+=18) {
  810. uint64_t nwid = at<uint64_t>(ptr);
  811. SharedPtr<Network> network(_r->nc->network(nwid));
  812. if ((_r->topology->amSupernode())||((network)&&(network->isAllowed(peer->address())))) {
  813. _r->mc->likesGroup(nwid,src,MulticastGroup(MAC(field(ptr + 8,6),6),at<uint32_t>(ptr + 14)),now);
  814. if (network)
  815. network->pushMembershipCertificate(peer->address(),false,now);
  816. }
  817. }
  818. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_MULTICAST_LIKE,0,Packet::VERB_NOP,now);
  819. } catch (std::exception &ex) {
  820. TRACE("dropped MULTICAST_LIKE from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  821. } catch ( ... ) {
  822. TRACE("dropped MULTICAST_LIKE from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  823. }
  824. return true;
  825. }
  826. bool PacketDecoder::_doNETWORK_MEMBERSHIP_CERTIFICATE(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  827. {
  828. try {
  829. CertificateOfMembership com;
  830. unsigned int ptr = ZT_PACKET_IDX_PAYLOAD;
  831. while (ptr < size()) {
  832. ptr += com.deserialize(*this,ptr);
  833. if ((com.hasRequiredFields())&&(com.signedBy())) {
  834. SharedPtr<Peer> signer(_r->topology->getPeer(com.signedBy()));
  835. if (signer) {
  836. if (com.verify(signer->identity())) {
  837. uint64_t nwid = com.networkId();
  838. SharedPtr<Network> network(_r->nc->network(nwid));
  839. if (network) {
  840. if (network->controller() == signer)
  841. network->addMembershipCertificate(com);
  842. }
  843. }
  844. } else {
  845. _r->sw->requestWhois(com.signedBy());
  846. _step = DECODE_WAITING_FOR_NETWORK_MEMBERSHIP_CERTIFICATE_SIGNER_LOOKUP;
  847. return false;
  848. }
  849. }
  850. }
  851. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_NETWORK_MEMBERSHIP_CERTIFICATE,0,Packet::VERB_NOP,Utils::now());
  852. } catch (std::exception &ex) {
  853. TRACE("dropped NETWORK_MEMBERSHIP_CERTIFICATE from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),ex.what());
  854. } catch ( ... ) {
  855. TRACE("dropped NETWORK_MEMBERSHIP_CERTIFICATE from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  856. }
  857. return true;
  858. }
  859. bool PacketDecoder::_doNETWORK_CONFIG_REQUEST(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  860. {
  861. try {
  862. uint64_t nwid = at<uint64_t>(ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_NETWORK_ID);
  863. #ifndef __WINDOWS__
  864. if (_r->netconfService) {
  865. char tmp[128];
  866. unsigned int dictLen = at<uint16_t>(ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_DICT_LEN);
  867. Dictionary request;
  868. if (dictLen)
  869. request["meta"] = std::string((const char *)field(ZT_PROTO_VERB_NETWORK_CONFIG_REQUEST_IDX_DICT,dictLen),dictLen);
  870. request["type"] = "netconf-request";
  871. request["peerId"] = peer->identity().toString(false);
  872. Utils::snprintf(tmp,sizeof(tmp),"%.16llx",(unsigned long long)nwid);
  873. request["nwid"] = tmp;
  874. Utils::snprintf(tmp,sizeof(tmp),"%.16llx",(unsigned long long)packetId());
  875. request["requestId"] = tmp;
  876. if (!hops())
  877. request["from"] = _remoteAddress.toString();
  878. //TRACE("to netconf:\n%s",request.toString().c_str());
  879. _r->netconfService->send(request);
  880. } else {
  881. #endif // !__WINDOWS__
  882. Packet outp(source(),_r->identity.address(),Packet::VERB_ERROR);
  883. outp.append((unsigned char)Packet::VERB_NETWORK_CONFIG_REQUEST);
  884. outp.append(packetId());
  885. outp.append((unsigned char)Packet::ERROR_UNSUPPORTED_OPERATION);
  886. outp.append(nwid);
  887. outp.armor(peer->key(),true);
  888. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  889. #ifndef __WINDOWS__
  890. }
  891. #endif // !__WINDOWS__
  892. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_NETWORK_CONFIG_REQUEST,0,Packet::VERB_NOP,Utils::now());
  893. } catch (std::exception &exc) {
  894. TRACE("dropped NETWORK_CONFIG_REQUEST from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),exc.what());
  895. } catch ( ... ) {
  896. TRACE("dropped NETWORK_CONFIG_REQUEST from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  897. }
  898. return true;
  899. }
  900. bool PacketDecoder::_doNETWORK_CONFIG_REFRESH(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer)
  901. {
  902. try {
  903. unsigned int ptr = ZT_PACKET_IDX_PAYLOAD;
  904. while ((ptr + sizeof(uint64_t)) <= size()) {
  905. uint64_t nwid = at<uint64_t>(ptr); ptr += sizeof(uint64_t);
  906. SharedPtr<Network> nw(_r->nc->network(nwid));
  907. if ((nw)&&(source() == nw->controller())) { // only respond to requests from controller
  908. TRACE("NETWORK_CONFIG_REFRESH from %s, refreshing network %.16llx",source().toString().c_str(),nwid);
  909. nw->requestConfiguration();
  910. }
  911. }
  912. peer->receive(_r,_fromSock,_remoteAddress,hops(),packetId(),Packet::VERB_NETWORK_CONFIG_REFRESH,0,Packet::VERB_NOP,Utils::now());
  913. } catch (std::exception &exc) {
  914. TRACE("dropped NETWORK_CONFIG_REFRESH from %s(%s): unexpected exception: %s",source().toString().c_str(),_remoteAddress.toString().c_str(),exc.what());
  915. } catch ( ... ) {
  916. TRACE("dropped NETWORK_CONFIG_REFRESH from %s(%s): unexpected exception: (unknown)",source().toString().c_str(),_remoteAddress.toString().c_str());
  917. }
  918. return true;
  919. }
  920. void PacketDecoder::_sendErrorNeedCertificate(const RuntimeEnvironment *_r,const SharedPtr<Peer> &peer,uint64_t nwid)
  921. {
  922. Packet outp(source(),_r->identity.address(),Packet::VERB_ERROR);
  923. outp.append((unsigned char)verb());
  924. outp.append(packetId());
  925. outp.append((unsigned char)Packet::ERROR_NEED_MEMBERSHIP_CERTIFICATE);
  926. outp.append(nwid);
  927. outp.armor(peer->key(),true);
  928. _fromSock->send(_remoteAddress,outp.data(),outp.size());
  929. }
  930. } // namespace ZeroTier