PacketDecoder.cpp 46 KB

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