Node.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763
  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 <stdlib.h>
  29. #include <string.h>
  30. #include <errno.h>
  31. #include <sys/stat.h>
  32. #include <map>
  33. #include <set>
  34. #include <utility>
  35. #include <algorithm>
  36. #include <list>
  37. #include <vector>
  38. #include <string>
  39. #include "Constants.hpp"
  40. #ifdef __WINDOWS__
  41. #include <WinSock2.h>
  42. #include <Windows.h>
  43. #include <ShlObj.h>
  44. #else
  45. #include <fcntl.h>
  46. #include <unistd.h>
  47. #include <signal.h>
  48. #include <sys/file.h>
  49. #endif
  50. #include "../version.h"
  51. #include "Node.hpp"
  52. #include "RuntimeEnvironment.hpp"
  53. #include "Logger.hpp"
  54. #include "Utils.hpp"
  55. #include "Defaults.hpp"
  56. #include "Identity.hpp"
  57. #include "Topology.hpp"
  58. #include "SocketManager.hpp"
  59. #include "Packet.hpp"
  60. #include "Switch.hpp"
  61. #include "EthernetTap.hpp"
  62. #include "CMWC4096.hpp"
  63. #include "NodeConfig.hpp"
  64. #include "Network.hpp"
  65. #include "MulticastGroup.hpp"
  66. #include "Mutex.hpp"
  67. #include "Multicaster.hpp"
  68. #include "Service.hpp"
  69. #include "SoftwareUpdater.hpp"
  70. #include "Buffer.hpp"
  71. #include "IpcConnection.hpp"
  72. #include "AntiRecursion.hpp"
  73. #include "RoutingTable.hpp"
  74. namespace ZeroTier {
  75. // ---------------------------------------------------------------------------
  76. struct _NodeControlClientImpl
  77. {
  78. void (*resultHandler)(void *,const char *);
  79. void *arg;
  80. IpcConnection *ipcc;
  81. std::string err;
  82. };
  83. static void _CBipcResultHandler(void *arg,IpcConnection *ipcc,IpcConnection::EventType event,const char *result)
  84. {
  85. if ((event == IpcConnection::IPC_EVENT_COMMAND)&&(result)) {
  86. if (strcmp(result,"200 auth OK"))
  87. ((_NodeControlClientImpl *)arg)->resultHandler(((_NodeControlClientImpl *)arg)->arg,result);
  88. }
  89. }
  90. Node::NodeControlClient::NodeControlClient(const char *hp,void (*resultHandler)(void *,const char *),void *arg,const char *authToken)
  91. throw() :
  92. _impl((void *)new _NodeControlClientImpl)
  93. {
  94. _NodeControlClientImpl *impl = (_NodeControlClientImpl *)_impl;
  95. impl->ipcc = (IpcConnection *)0;
  96. if (!hp)
  97. hp = ZT_DEFAULTS.defaultHomePath.c_str();
  98. std::string at;
  99. if (authToken)
  100. at = authToken;
  101. else if (!Utils::readFile(authTokenDefaultSystemPath(),at)) {
  102. if (!Utils::readFile(authTokenDefaultUserPath(),at)) {
  103. impl->err = "no authentication token specified and authtoken.secret not readable";
  104. return;
  105. }
  106. }
  107. std::string myid;
  108. if (Utils::readFile((std::string(hp) + ZT_PATH_SEPARATOR_S + "identity.public").c_str(),myid)) {
  109. std::string myaddr(myid.substr(0,myid.find(':')));
  110. if (myaddr.length() != 10)
  111. impl->err = "invalid address extracted from identity.public";
  112. else {
  113. try {
  114. impl->resultHandler = resultHandler;
  115. impl->arg = arg;
  116. impl->ipcc = new IpcConnection((std::string(ZT_IPC_ENDPOINT_BASE) + myaddr).c_str(),&_CBipcResultHandler,_impl);
  117. impl->ipcc->printf("auth %s"ZT_EOL_S,at.c_str());
  118. } catch ( ... ) {
  119. impl->ipcc = (IpcConnection *)0;
  120. impl->err = "failure connecting to running ZeroTier One service";
  121. }
  122. }
  123. } else impl->err = "unable to read identity.public";
  124. }
  125. Node::NodeControlClient::~NodeControlClient()
  126. {
  127. if (_impl) {
  128. delete ((_NodeControlClientImpl *)_impl)->ipcc;
  129. delete (_NodeControlClientImpl *)_impl;
  130. }
  131. }
  132. const char *Node::NodeControlClient::error() const
  133. throw()
  134. {
  135. if (((_NodeControlClientImpl *)_impl)->err.length())
  136. return ((_NodeControlClientImpl *)_impl)->err.c_str();
  137. return (const char *)0;
  138. }
  139. void Node::NodeControlClient::send(const char *command)
  140. throw()
  141. {
  142. try {
  143. if (((_NodeControlClientImpl *)_impl)->ipcc)
  144. ((_NodeControlClientImpl *)_impl)->ipcc->printf("%s"ZT_EOL_S,command);
  145. } catch ( ... ) {}
  146. }
  147. std::vector<std::string> Node::NodeControlClient::splitLine(const char *line)
  148. {
  149. return Utils::split(line," ","\\","\"");
  150. }
  151. const char *Node::NodeControlClient::authTokenDefaultUserPath()
  152. {
  153. static std::string dlp;
  154. static Mutex dlp_m;
  155. Mutex::Lock _l(dlp_m);
  156. #ifdef __WINDOWS__
  157. if (!dlp.length()) {
  158. char buf[16384];
  159. if (SUCCEEDED(SHGetFolderPathA(NULL,CSIDL_APPDATA,NULL,0,buf)))
  160. dlp = (std::string(buf) + "\\ZeroTier\\One\\authtoken.secret");
  161. }
  162. #else // not __WINDOWS__
  163. if (!dlp.length()) {
  164. const char *home = getenv("HOME");
  165. if (home) {
  166. #ifdef __APPLE__
  167. dlp = (std::string(home) + "/Library/Application Support/ZeroTier/One/authtoken.secret");
  168. #else
  169. dlp = (std::string(home) + "/.zeroTierOneAuthToken");
  170. #endif
  171. }
  172. }
  173. #endif // __WINDOWS__ or not __WINDOWS__
  174. return dlp.c_str();
  175. }
  176. const char *Node::NodeControlClient::authTokenDefaultSystemPath()
  177. {
  178. static std::string dsp;
  179. static Mutex dsp_m;
  180. Mutex::Lock _l(dsp_m);
  181. if (!dsp.length())
  182. dsp = (ZT_DEFAULTS.defaultHomePath + ZT_PATH_SEPARATOR_S"authtoken.secret");
  183. return dsp.c_str();
  184. }
  185. // ---------------------------------------------------------------------------
  186. struct _NodeImpl
  187. {
  188. RuntimeEnvironment renv;
  189. unsigned int udpPort,tcpPort;
  190. std::string reasonForTerminationStr;
  191. volatile Node::ReasonForTermination reasonForTermination;
  192. volatile bool started;
  193. volatile bool running;
  194. volatile bool resynchronize;
  195. // This function performs final node tear-down
  196. inline Node::ReasonForTermination terminate()
  197. {
  198. RuntimeEnvironment *_r = &renv;
  199. LOG("terminating: %s",reasonForTerminationStr.c_str());
  200. renv.shutdownInProgress = true;
  201. Thread::sleep(500);
  202. running = false;
  203. #ifndef __WINDOWS__
  204. delete renv.netconfService;
  205. #endif
  206. delete renv.updater; renv.updater = (SoftwareUpdater *)0;
  207. delete renv.nc; renv.nc = (NodeConfig *)0; // shut down all networks, close taps, etc.
  208. delete renv.topology; renv.topology = (Topology *)0; // now we no longer need routing info
  209. delete renv.sm; renv.sm = (SocketManager *)0; // close all sockets
  210. delete renv.sw; renv.sw = (Switch *)0; // order matters less from here down
  211. delete renv.mc; renv.mc = (Multicaster *)0;
  212. delete renv.antiRec; renv.antiRec = (AntiRecursion *)0;
  213. delete renv.prng; renv.prng = (CMWC4096 *)0;
  214. delete renv.log; renv.log = (Logger *)0; // but stop logging last of all
  215. return reasonForTermination;
  216. }
  217. inline Node::ReasonForTermination terminateBecause(Node::ReasonForTermination r,const char *rstr)
  218. {
  219. reasonForTerminationStr = rstr;
  220. reasonForTermination = r;
  221. return terminate();
  222. }
  223. };
  224. #ifndef __WINDOWS__ // "services" are not supported on Windows
  225. static void _netconfServiceMessageHandler(void *renv,Service &svc,const Dictionary &msg)
  226. {
  227. if (!renv)
  228. return; // sanity check
  229. const RuntimeEnvironment *_r = (const RuntimeEnvironment *)renv;
  230. try {
  231. //TRACE("from netconf:\n%s",msg.toString().c_str());
  232. const std::string &type = msg.get("type");
  233. if (type == "ready") {
  234. LOG("received 'ready' from netconf.service, sending netconf-init with identity information...");
  235. Dictionary initMessage;
  236. initMessage["type"] = "netconf-init";
  237. initMessage["netconfId"] = _r->identity.toString(true);
  238. _r->netconfService->send(initMessage);
  239. } else if (type == "netconf-response") {
  240. uint64_t inRePacketId = strtoull(msg.get("requestId").c_str(),(char **)0,16);
  241. uint64_t nwid = strtoull(msg.get("nwid").c_str(),(char **)0,16);
  242. Address peerAddress(msg.get("peer").c_str());
  243. if (peerAddress) {
  244. if (msg.contains("error")) {
  245. Packet::ErrorCode errCode = Packet::ERROR_INVALID_REQUEST;
  246. const std::string &err = msg.get("error");
  247. if (err == "OBJ_NOT_FOUND")
  248. errCode = Packet::ERROR_OBJ_NOT_FOUND;
  249. else if (err == "ACCESS_DENIED")
  250. errCode = Packet::ERROR_NETWORK_ACCESS_DENIED_;
  251. Packet outp(peerAddress,_r->identity.address(),Packet::VERB_ERROR);
  252. outp.append((unsigned char)Packet::VERB_NETWORK_CONFIG_REQUEST);
  253. outp.append(inRePacketId);
  254. outp.append((unsigned char)errCode);
  255. outp.append(nwid);
  256. _r->sw->send(outp,true);
  257. } else if (msg.contains("netconf")) {
  258. const std::string &netconf = msg.get("netconf");
  259. if (netconf.length() < 2048) { // sanity check
  260. Packet outp(peerAddress,_r->identity.address(),Packet::VERB_OK);
  261. outp.append((unsigned char)Packet::VERB_NETWORK_CONFIG_REQUEST);
  262. outp.append(inRePacketId);
  263. outp.append(nwid);
  264. outp.append((uint16_t)netconf.length());
  265. outp.append(netconf.data(),netconf.length());
  266. outp.compress();
  267. _r->sw->send(outp,true);
  268. }
  269. }
  270. }
  271. } else if (type == "netconf-push") {
  272. if (msg.contains("to")) {
  273. Dictionary to(msg.get("to")); // key: peer address, value: comma-delimited network list
  274. for(Dictionary::iterator t(to.begin());t!=to.end();++t) {
  275. Address ztaddr(t->first);
  276. if (ztaddr) {
  277. Packet outp(ztaddr,_r->identity.address(),Packet::VERB_NETWORK_CONFIG_REFRESH);
  278. char *saveptr = (char *)0;
  279. // Note: this loop trashes t->second, which is quasi-legal C++ but
  280. // shouldn't break anything as long as we don't try to use 'to'
  281. // for anything interesting after doing this.
  282. for(char *p=Utils::stok(const_cast<char *>(t->second.c_str()),",",&saveptr);(p);p=Utils::stok((char *)0,",",&saveptr)) {
  283. uint64_t nwid = Utils::hexStrToU64(p);
  284. if (nwid) {
  285. if ((outp.size() + sizeof(uint64_t)) >= ZT_UDP_DEFAULT_PAYLOAD_MTU) {
  286. _r->sw->send(outp,true);
  287. outp.reset(ztaddr,_r->identity.address(),Packet::VERB_NETWORK_CONFIG_REFRESH);
  288. }
  289. outp.append(nwid);
  290. }
  291. }
  292. if (outp.payloadLength())
  293. _r->sw->send(outp,true);
  294. }
  295. }
  296. }
  297. }
  298. } catch (std::exception &exc) {
  299. LOG("unexpected exception parsing response from netconf service: %s",exc.what());
  300. } catch ( ... ) {
  301. LOG("unexpected exception parsing response from netconf service: unknown exception");
  302. }
  303. }
  304. #endif // !__WINDOWS__
  305. Node::Node(
  306. const char *hp,
  307. EthernetTapFactory *tf,
  308. RoutingTable *rt,
  309. unsigned int udpPort,
  310. unsigned int tcpPort,
  311. bool resetIdentity)
  312. throw() :
  313. _impl(new _NodeImpl)
  314. {
  315. _NodeImpl *impl = (_NodeImpl *)_impl;
  316. if ((hp)&&(hp[0]))
  317. impl->renv.homePath = hp;
  318. else impl->renv.homePath = ZT_DEFAULTS.defaultHomePath;
  319. impl->renv.tapFactory = tf;
  320. impl->renv.routingTable = rt;
  321. if (resetIdentity) {
  322. // Forget identity and peer database, peer keys, etc.
  323. Utils::rm((impl->renv.homePath + ZT_PATH_SEPARATOR_S + "identity.public").c_str());
  324. Utils::rm((impl->renv.homePath + ZT_PATH_SEPARATOR_S + "identity.secret").c_str());
  325. Utils::rm((impl->renv.homePath + ZT_PATH_SEPARATOR_S + "peers.persist").c_str());
  326. // Truncate network config information in networks.d but leave the files since we
  327. // still want to remember any networks we have joined. This will force those networks
  328. // to be reconfigured with our newly regenerated identity after startup.
  329. std::string networksDotD(impl->renv.homePath + ZT_PATH_SEPARATOR_S + "networks.d");
  330. std::map< std::string,bool > nwfiles(Utils::listDirectory(networksDotD.c_str()));
  331. for(std::map<std::string,bool>::iterator nwf(nwfiles.begin());nwf!=nwfiles.end();++nwf) {
  332. FILE *trun = fopen((networksDotD + ZT_PATH_SEPARATOR_S + nwf->first).c_str(),"w");
  333. if (trun)
  334. fclose(trun);
  335. }
  336. }
  337. impl->udpPort = udpPort & 0xffff;
  338. impl->tcpPort = tcpPort & 0xffff;
  339. impl->reasonForTermination = Node::NODE_RUNNING;
  340. impl->started = false;
  341. impl->running = false;
  342. impl->resynchronize = false;
  343. }
  344. Node::~Node()
  345. {
  346. delete (_NodeImpl *)_impl;
  347. }
  348. static void _CBztTraffic(const SharedPtr<Socket> &fromSock,void *arg,const InetAddress &from,Buffer<ZT_SOCKET_MAX_MESSAGE_LEN> &data)
  349. {
  350. const RuntimeEnvironment *_r = (const RuntimeEnvironment *)arg;
  351. if ((_r->sw)&&(!_r->shutdownInProgress))
  352. _r->sw->onRemotePacket(fromSock,from,data);
  353. }
  354. Node::ReasonForTermination Node::run()
  355. throw()
  356. {
  357. _NodeImpl *impl = (_NodeImpl *)_impl;
  358. RuntimeEnvironment *_r = (RuntimeEnvironment *)&(impl->renv);
  359. impl->started = true;
  360. impl->running = true;
  361. try {
  362. #ifdef ZT_LOG_STDOUT
  363. _r->log = new Logger((const char *)0,(const char *)0,0);
  364. #else
  365. _r->log = new Logger((_r->homePath + ZT_PATH_SEPARATOR_S + "node.log").c_str(),(const char *)0,131072);
  366. #endif
  367. LOG("starting version %s",versionString());
  368. // Create non-crypto PRNG right away in case other code in init wants to use it
  369. _r->prng = new CMWC4096();
  370. bool gotId = false;
  371. std::string identitySecretPath(_r->homePath + ZT_PATH_SEPARATOR_S + "identity.secret");
  372. std::string identityPublicPath(_r->homePath + ZT_PATH_SEPARATOR_S + "identity.public");
  373. std::string idser;
  374. if (Utils::readFile(identitySecretPath.c_str(),idser))
  375. gotId = _r->identity.fromString(idser);
  376. if ((gotId)&&(!_r->identity.locallyValidate()))
  377. gotId = false;
  378. if (gotId) {
  379. // Make sure identity.public matches identity.secret
  380. idser = std::string();
  381. Utils::readFile(identityPublicPath.c_str(),idser);
  382. std::string pubid(_r->identity.toString(false));
  383. if (idser != pubid) {
  384. if (!Utils::writeFile(identityPublicPath.c_str(),pubid))
  385. return impl->terminateBecause(Node::NODE_UNRECOVERABLE_ERROR,"could not write identity.public (home path not writable?)");
  386. }
  387. } else {
  388. LOG("no identity found or identity invalid, generating one... this might take a few seconds...");
  389. _r->identity.generate();
  390. LOG("generated new identity: %s",_r->identity.address().toString().c_str());
  391. idser = _r->identity.toString(true);
  392. if (!Utils::writeFile(identitySecretPath.c_str(),idser))
  393. return impl->terminateBecause(Node::NODE_UNRECOVERABLE_ERROR,"could not write identity.secret (home path not writable?)");
  394. idser = _r->identity.toString(false);
  395. if (!Utils::writeFile(identityPublicPath.c_str(),idser))
  396. return impl->terminateBecause(Node::NODE_UNRECOVERABLE_ERROR,"could not write identity.public (home path not writable?)");
  397. }
  398. Utils::lockDownFile(identitySecretPath.c_str(),false);
  399. // Make sure networks.d exists
  400. {
  401. std::string networksDotD(_r->homePath + ZT_PATH_SEPARATOR_S + "networks.d");
  402. #ifdef __WINDOWS__
  403. CreateDirectoryA(networksDotD.c_str(),NULL);
  404. #else
  405. mkdir(networksDotD.c_str(),0700);
  406. #endif
  407. }
  408. // Load or generate config authentication secret
  409. std::string configAuthTokenPath(_r->homePath + ZT_PATH_SEPARATOR_S + "authtoken.secret");
  410. std::string configAuthToken;
  411. if (!Utils::readFile(configAuthTokenPath.c_str(),configAuthToken)) {
  412. configAuthToken = "";
  413. unsigned int sr = 0;
  414. for(unsigned int i=0;i<24;++i) {
  415. Utils::getSecureRandom(&sr,sizeof(sr));
  416. configAuthToken.push_back("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"[sr % 62]);
  417. }
  418. if (!Utils::writeFile(configAuthTokenPath.c_str(),configAuthToken))
  419. return impl->terminateBecause(Node::NODE_UNRECOVERABLE_ERROR,"could not write authtoken.secret (home path not writable?)");
  420. }
  421. Utils::lockDownFile(configAuthTokenPath.c_str(),false);
  422. _r->antiRec = new AntiRecursion();
  423. _r->mc = new Multicaster();
  424. _r->sw = new Switch(_r);
  425. _r->sm = new SocketManager(impl->udpPort,impl->tcpPort,&_CBztTraffic,_r);
  426. _r->topology = new Topology(_r,Utils::fileExists((_r->homePath + ZT_PATH_SEPARATOR_S + "iddb.d").c_str()));
  427. try {
  428. _r->nc = new NodeConfig(_r,configAuthToken.c_str());
  429. } catch (std::exception &exc) {
  430. return impl->terminateBecause(Node::NODE_UNRECOVERABLE_ERROR,"unable to initialize IPC socket: is ZeroTier One already running?");
  431. }
  432. _r->node = this;
  433. #ifdef ZT_AUTO_UPDATE
  434. if (ZT_DEFAULTS.updateLatestNfoURL.length()) {
  435. _r->updater = new SoftwareUpdater(_r);
  436. _r->updater->cleanOldUpdates(); // clean out updates.d on startup
  437. } else {
  438. LOG("WARNING: unable to enable software updates: latest .nfo URL from ZT_DEFAULTS is empty (does this platform actually support software updates?)");
  439. }
  440. #endif
  441. // Set initial supernode list
  442. _r->topology->setSupernodes(ZT_DEFAULTS.supernodes);
  443. } catch (std::bad_alloc &exc) {
  444. return impl->terminateBecause(Node::NODE_UNRECOVERABLE_ERROR,"memory allocation failure");
  445. } catch (std::runtime_error &exc) {
  446. return impl->terminateBecause(Node::NODE_UNRECOVERABLE_ERROR,exc.what());
  447. } catch ( ... ) {
  448. return impl->terminateBecause(Node::NODE_UNRECOVERABLE_ERROR,"unknown exception during initialization");
  449. }
  450. // Start external service subprocesses, which is only used by special nodes
  451. // right now and isn't available on Windows.
  452. #ifndef __WINDOWS__
  453. try {
  454. std::string netconfServicePath(_r->homePath + ZT_PATH_SEPARATOR_S + "services.d" + ZT_PATH_SEPARATOR_S + "netconf.service");
  455. if (Utils::fileExists(netconfServicePath.c_str())) {
  456. LOG("netconf.d/netconf.service appears to exist, starting...");
  457. _r->netconfService = new Service(_r,"netconf",netconfServicePath.c_str(),&_netconfServiceMessageHandler,_r);
  458. Dictionary initMessage;
  459. initMessage["type"] = "netconf-init";
  460. initMessage["netconfId"] = _r->identity.toString(true);
  461. _r->netconfService->send(initMessage);
  462. }
  463. } catch ( ... ) {
  464. LOG("unexpected exception attempting to start services");
  465. }
  466. #endif
  467. // Core I/O loop
  468. try {
  469. /* Shut down if this file exists but fails to open. This is used on Mac to
  470. * shut down automatically on .app deletion by symlinking this to the
  471. * Info.plist file inside the ZeroTier One application. This causes the
  472. * service to die when the user throws away the app, allowing uninstallation
  473. * in the natural Mac way. */
  474. std::string shutdownIfUnreadablePath(_r->homePath + ZT_PATH_SEPARATOR_S + "shutdownIfUnreadable");
  475. uint64_t lastNetworkAutoconfCheck = Utils::now() - 5000ULL; // check autoconf again after 5s for startup
  476. uint64_t lastPingCheck = 0;
  477. uint64_t lastClean = Utils::now(); // don't need to do this immediately
  478. uint64_t lastNetworkFingerprintCheck = 0;
  479. uint64_t lastMulticastCheck = 0;
  480. uint64_t lastSupernodePingCheck = 0;
  481. uint64_t lastBeacon = 0;
  482. long lastDelayDelta = 0;
  483. uint64_t networkConfigurationFingerprint = 0;
  484. _r->timeOfLastResynchronize = Utils::now();
  485. while (impl->reasonForTermination == NODE_RUNNING) {
  486. /* This is how the service automatically shuts down when the OSX .app is
  487. * thrown in the trash. It's not used on any other platform for now but
  488. * could do similar things. It's disabled on Windows since it doesn't really
  489. * work there. */
  490. #ifdef __UNIX_LIKE__
  491. if (Utils::fileExists(shutdownIfUnreadablePath.c_str(),false)) {
  492. FILE *tmpf = fopen(shutdownIfUnreadablePath.c_str(),"r");
  493. if (!tmpf)
  494. return impl->terminateBecause(Node::NODE_NORMAL_TERMINATION,"shutdownIfUnreadable exists but is not readable");
  495. fclose(tmpf);
  496. }
  497. #endif
  498. uint64_t now = Utils::now();
  499. bool resynchronize = false;
  500. // If it looks like the computer slept and woke, resynchronize.
  501. if (lastDelayDelta >= ZT_SLEEP_WAKE_DETECTION_THRESHOLD) {
  502. resynchronize = true;
  503. LOG("probable suspend/resume detected, pausing a moment for things to settle...");
  504. Thread::sleep(ZT_SLEEP_WAKE_SETTLE_TIME);
  505. }
  506. // If our network environment looks like it changed, resynchronize.
  507. if ((resynchronize)||((now - lastNetworkFingerprintCheck) >= ZT_NETWORK_FINGERPRINT_CHECK_DELAY)) {
  508. lastNetworkFingerprintCheck = now;
  509. uint64_t fp = _r->routingTable->networkEnvironmentFingerprint(_r->nc->networkTapDeviceNames());
  510. if (fp != networkConfigurationFingerprint) {
  511. LOG("netconf fingerprint change: %.16llx != %.16llx, resyncing with network",networkConfigurationFingerprint,fp);
  512. networkConfigurationFingerprint = fp;
  513. resynchronize = true;
  514. }
  515. }
  516. // Supernodes do not resynchronize unless explicitly ordered via SIGHUP.
  517. if ((resynchronize)&&(_r->topology->amSupernode()))
  518. resynchronize = false;
  519. // Check for SIGHUP / force resync.
  520. if (impl->resynchronize) {
  521. impl->resynchronize = false;
  522. resynchronize = true;
  523. LOG("resynchronize forced by user, syncing with network");
  524. }
  525. if (resynchronize) {
  526. _r->tcpTunnelingEnabled = false; // turn off TCP tunneling master switch at first, will be reenabled on persistent UDP failure
  527. _r->timeOfLastResynchronize = now;
  528. }
  529. /* Supernodes are pinged separately and more aggressively. The
  530. * ZT_STARTUP_AGGRO parameter sets a limit on how rapidly they are
  531. * tried, while PingSupernodesThatNeedPing contains the logic for
  532. * determining if they need PING. */
  533. if ((now - lastSupernodePingCheck) >= ZT_STARTUP_AGGRO) {
  534. lastSupernodePingCheck = now;
  535. uint64_t lastReceiveFromAnySupernode = 0; // function object result paramter
  536. _r->topology->eachSupernodePeer(Topology::FindMostRecentDirectReceiveTimestamp(lastReceiveFromAnySupernode));
  537. // Turn on TCP tunneling master switch if we haven't heard anything since before
  538. // the last resynchronize and we've been trying long enough.
  539. uint64_t tlr = _r->timeOfLastResynchronize;
  540. if ((lastReceiveFromAnySupernode < tlr)&&((now - tlr) >= ZT_TCP_TUNNEL_FAILOVER_TIMEOUT)) {
  541. TRACE("network still unreachable after %u ms, TCP TUNNELING ENABLED",(unsigned int)ZT_TCP_TUNNEL_FAILOVER_TIMEOUT);
  542. _r->tcpTunnelingEnabled = true;
  543. }
  544. _r->topology->eachSupernodePeer(Topology::PingSupernodesThatNeedPing(_r,now));
  545. }
  546. if (resynchronize) {
  547. /* Send NOP to all peers on resynchronize, directly to supernodes and
  548. * indirectly to regular nodes (to trigger RENDEZVOUS). Also clear
  549. * learned paths since they're likely no longer valid, and close
  550. * TCP sockets since they're also likely invalid. */
  551. _r->sm->closeTcpSockets();
  552. _r->topology->eachPeer(Topology::ResetActivePeers(_r,now));
  553. } else {
  554. /* Periodically check for changes in our local multicast subscriptions
  555. * and broadcast those changes to directly connected peers. */
  556. if ((now - lastMulticastCheck) >= ZT_MULTICAST_LOCAL_POLL_PERIOD) {
  557. lastMulticastCheck = now;
  558. try {
  559. std::map< SharedPtr<Network>,std::set<MulticastGroup> > toAnnounce;
  560. std::vector< SharedPtr<Network> > networks(_r->nc->networks());
  561. for(std::vector< SharedPtr<Network> >::const_iterator nw(networks.begin());nw!=networks.end();++nw) {
  562. if ((*nw)->updateMulticastGroups())
  563. toAnnounce.insert(std::pair< SharedPtr<Network>,std::set<MulticastGroup> >(*nw,(*nw)->multicastGroups()));
  564. }
  565. if (toAnnounce.size())
  566. _r->sw->announceMulticastGroups(toAnnounce);
  567. } catch (std::exception &exc) {
  568. LOG("unexpected exception announcing multicast groups: %s",exc.what());
  569. } catch ( ... ) {
  570. LOG("unexpected exception announcing multicast groups: (unknown)");
  571. }
  572. }
  573. /* Periodically ping all our non-stale direct peers unless we're a supernode.
  574. * Supernodes only ping each other (which is done above). */
  575. if ((!_r->topology->amSupernode())&&((now - lastPingCheck) >= ZT_PING_CHECK_DELAY)) {
  576. lastPingCheck = now;
  577. try {
  578. _r->topology->eachPeer(Topology::PingPeersThatNeedPing(_r,now));
  579. _r->topology->eachPeer(Topology::OpenPeersThatNeedFirewallOpener(_r,now));
  580. } catch (std::exception &exc) {
  581. LOG("unexpected exception running ping check cycle: %s",exc.what());
  582. } catch ( ... ) {
  583. LOG("unexpected exception running ping check cycle: (unkonwn)");
  584. }
  585. }
  586. }
  587. // Update network configurations when needed.
  588. if ((resynchronize)||((now - lastNetworkAutoconfCheck) >= ZT_NETWORK_AUTOCONF_CHECK_DELAY)) {
  589. lastNetworkAutoconfCheck = now;
  590. std::vector< SharedPtr<Network> > nets(_r->nc->networks());
  591. for(std::vector< SharedPtr<Network> >::iterator n(nets.begin());n!=nets.end();++n) {
  592. if ((now - (*n)->lastConfigUpdate()) >= ZT_NETWORK_AUTOCONF_DELAY)
  593. (*n)->requestConfiguration();
  594. }
  595. }
  596. // Do periodic tasks in submodules.
  597. if ((now - lastClean) >= ZT_DB_CLEAN_PERIOD) {
  598. lastClean = now;
  599. _r->mc->clean();
  600. _r->topology->clean();
  601. _r->nc->clean();
  602. if (_r->updater)
  603. _r->updater->checkIfMaxIntervalExceeded(now);
  604. }
  605. // Send beacons to physical local LANs
  606. if ((resynchronize)||((now - lastBeacon) >= ZT_BEACON_INTERVAL)) {
  607. lastBeacon = now;
  608. char bcn[ZT_PROTO_BEACON_LENGTH];
  609. void *bcnptr = bcn;
  610. *((uint32_t *)(bcnptr)) = _r->prng->next32();
  611. bcnptr = bcn + 4;
  612. *((uint32_t *)(bcnptr)) = _r->prng->next32();
  613. _r->identity.address().copyTo(bcn + ZT_PROTO_BEACON_IDX_ADDRESS,ZT_ADDRESS_LENGTH);
  614. TRACE("sending LAN beacon to %s",ZT_DEFAULTS.v4Broadcast.toString().c_str());
  615. _r->antiRec->logOutgoingZT(bcn,ZT_PROTO_BEACON_LENGTH);
  616. _r->sm->send(ZT_DEFAULTS.v4Broadcast,false,false,bcn,ZT_PROTO_BEACON_LENGTH);
  617. }
  618. // Sleep for loop interval or until something interesting happens.
  619. try {
  620. unsigned long delay = std::min((unsigned long)ZT_MAX_SERVICE_LOOP_INTERVAL,_r->sw->doTimerTasks());
  621. uint64_t start = Utils::now();
  622. _r->sm->poll(delay);
  623. lastDelayDelta = (long)(Utils::now() - start) - (long)delay; // used to detect sleep/wake
  624. } catch (std::exception &exc) {
  625. LOG("unexpected exception running Switch doTimerTasks: %s",exc.what());
  626. } catch ( ... ) {
  627. LOG("unexpected exception running Switch doTimerTasks: (unknown)");
  628. }
  629. }
  630. } catch ( ... ) {
  631. LOG("FATAL: unexpected exception in core loop: unknown exception");
  632. return impl->terminateBecause(Node::NODE_UNRECOVERABLE_ERROR,"unexpected exception during outer main I/O loop");
  633. }
  634. return impl->terminate();
  635. }
  636. const char *Node::reasonForTermination() const
  637. throw()
  638. {
  639. if ((!((_NodeImpl *)_impl)->started)||(((_NodeImpl *)_impl)->running))
  640. return (const char *)0;
  641. return ((_NodeImpl *)_impl)->reasonForTerminationStr.c_str();
  642. }
  643. void Node::terminate(ReasonForTermination reason,const char *reasonText)
  644. throw()
  645. {
  646. ((_NodeImpl *)_impl)->reasonForTermination = reason;
  647. ((_NodeImpl *)_impl)->reasonForTerminationStr = ((reasonText) ? reasonText : "");
  648. ((_NodeImpl *)_impl)->renv.sm->whack();
  649. }
  650. void Node::resync()
  651. throw()
  652. {
  653. ((_NodeImpl *)_impl)->resynchronize = true;
  654. ((_NodeImpl *)_impl)->renv.sm->whack();
  655. }
  656. class _VersionStringMaker
  657. {
  658. public:
  659. char vs[32];
  660. _VersionStringMaker()
  661. {
  662. Utils::snprintf(vs,sizeof(vs),"%d.%d.%d",(int)ZEROTIER_ONE_VERSION_MAJOR,(int)ZEROTIER_ONE_VERSION_MINOR,(int)ZEROTIER_ONE_VERSION_REVISION);
  663. }
  664. ~_VersionStringMaker() {}
  665. };
  666. static const _VersionStringMaker __versionString;
  667. const char *Node::versionString() throw() { return __versionString.vs; }
  668. unsigned int Node::versionMajor() throw() { return ZEROTIER_ONE_VERSION_MAJOR; }
  669. unsigned int Node::versionMinor() throw() { return ZEROTIER_ONE_VERSION_MINOR; }
  670. unsigned int Node::versionRevision() throw() { return ZEROTIER_ONE_VERSION_REVISION; }
  671. } // namespace ZeroTier