/* * ZeroTier One - Global Peer to Peer Ethernet * Copyright (C) 2011-2014 ZeroTier Networks LLC * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * * -- * * ZeroTier may be used and distributed under the terms of the GPLv3, which * are available at: http://www.gnu.org/licenses/gpl-3.0.html * * If you would like to embed ZeroTier into a commercial application or * redistribute it in a modified binary form, please contact ZeroTier Networks * LLC. Start here: http://www.zerotier.com/ */ #include #include #include #include #include "Network.hpp" #include "RuntimeEnvironment.hpp" #include "NodeConfig.hpp" #include "Switch.hpp" #include "Packet.hpp" #include "Buffer.hpp" #include "EthernetTap.hpp" #define ZT_NETWORK_CERT_WRITE_BUF_SIZE 131072 namespace ZeroTier { const char *Network::statusString(const Status s) throw() { switch(s) { case NETWORK_INITIALIZING: return "INITIALIZING"; case NETWORK_WAITING_FOR_FIRST_AUTOCONF: return "WAITING_FOR_FIRST_AUTOCONF"; case NETWORK_OK: return "OK"; case NETWORK_ACCESS_DENIED: return "ACCESS_DENIED"; case NETWORK_NOT_FOUND: return "NOT_FOUND"; case NETWORK_INITIALIZATION_FAILED: return "INITIALIZATION_FAILED"; } return "(invalid)"; } Network::~Network() { Thread::join(_setupThread); std::string devPersistentId; if (_tap) { devPersistentId = _tap->persistentId(); delete _tap; } if (_destroyOnDelete) { Utils::rm(std::string(_r->homePath + ZT_PATH_SEPARATOR_S + "networks.d" + ZT_PATH_SEPARATOR_S + idString() + ".conf")); Utils::rm(std::string(_r->homePath + ZT_PATH_SEPARATOR_S + "networks.d" + ZT_PATH_SEPARATOR_S + idString() + ".mcerts")); if (devPersistentId.length()) EthernetTap::deletePersistentTapDevice(_r,devPersistentId.c_str()); } else { // Causes flush of membership certs to disk clean(); _dumpMulticastCerts(); } } SharedPtr Network::newInstance(const RuntimeEnvironment *renv,NodeConfig *nc,uint64_t id) { /* We construct Network via a static method to ensure that it is immediately * wrapped in a SharedPtr<>. Otherwise if there is traffic on the Ethernet * tap device, a SharedPtr<> wrap can occur in the Ethernet frame handler * that then causes the Network instance to be deleted before it is finished * being constructed. C++ edge cases, how I love thee. */ SharedPtr nw(new Network()); nw->_id = id; nw->_nc = nc; nw->_mac = renv->identity.address().toMAC(); nw->_r = renv; nw->_tap = (EthernetTap *)0; nw->_lastConfigUpdate = 0; nw->_destroyOnDelete = false; nw->_netconfFailure = NETCONF_FAILURE_NONE; if (nw->controller() == renv->identity.address()) // netconf masters can't really join networks throw std::runtime_error("cannot join a network for which I am the netconf master"); nw->_setupThread = Thread::start(nw.ptr()); return nw; } bool Network::setConfiguration(const Dictionary &conf,bool saveToDisk) { Mutex::Lock _l(_lock); EthernetTap *t = _tap; if (!t) { TRACE("BUG: setConfiguration() called while tap is null!"); return false; // can't accept config in initialization state } try { SharedPtr newConfig(new NetworkConfig(conf)); if ((newConfig->networkId() == _id)&&(newConfig->issuedTo() == _r->identity.address())) { _config = newConfig; if (newConfig->staticIps().size()) t->setIps(newConfig->staticIps()); t->setDisplayName((std::string("ZeroTier One [") + newConfig->name() + "]").c_str()); _lastConfigUpdate = Utils::now(); _netconfFailure = NETCONF_FAILURE_NONE; if (saveToDisk) { std::string confPath(_r->homePath + ZT_PATH_SEPARATOR_S + "networks.d" + ZT_PATH_SEPARATOR_S + idString() + ".conf"); if (!Utils::writeFile(confPath.c_str(),conf.toString())) { LOG("error: unable to write network configuration file at: %s",confPath.c_str()); } else { Utils::lockDownFile(confPath.c_str(),false); } } return true; } else { LOG("ignored invalid configuration for network %.16llx (configuration contains mismatched network ID or issued-to address)",(unsigned long long)_id); } } catch (std::exception &exc) { LOG("ignored invalid configuration for network %.16llx (%s)",(unsigned long long)_id,exc.what()); } catch ( ... ) { LOG("ignored invalid configuration for network %.16llx (unknown exception)",(unsigned long long)_id); } return false; } void Network::requestConfiguration() { if (!_tap) return; // don't bother requesting until we are initialized if (controller() == _r->identity.address()) { // netconf master cannot be a member of its own nets LOG("unable to request network configuration for network %.16llx: I am the network master, cannot query self",(unsigned long long)_id); return; } TRACE("requesting netconf for network %.16llx from netconf master %s",(unsigned long long)_id,controller().toString().c_str()); Packet outp(controller(),_r->identity.address(),Packet::VERB_NETWORK_CONFIG_REQUEST); outp.append((uint64_t)_id); outp.append((uint16_t)0); // no meta-data _r->sw->send(outp,true); } void Network::addMembershipCertificate(const CertificateOfMembership &cert) { if (!cert) // sanity check return; Mutex::Lock _l(_lock); // We go ahead and accept certs provisionally even if _isOpen is true, since // that might be changed in short order if the user is fiddling in the UI. // These will be purged on clean() for open networks eventually. CertificateOfMembership &old = _membershipCertificates[cert.issuedTo()]; if (cert.timestamp() >= old.timestamp()) { TRACE("got new certificate for %s on network %.16llx",cert.issuedTo().toString().c_str(),cert.networkId()); old = cert; } } bool Network::isAllowed(const Address &peer) const { try { Mutex::Lock _l(_lock); if (!_config) return false; if (_config->isOpen()) return true; std::map::const_iterator pc(_membershipCertificates.find(peer)); if (pc == _membershipCertificates.end()) return false; // no certificate on file return _config->com().agreesWith(pc->second); // is other cert valid against ours? } catch (std::exception &exc) { TRACE("isAllowed() check failed for peer %s: unexpected exception: %s",peer.toString().c_str(),exc.what()); } catch ( ... ) { TRACE("isAllowed() check failed for peer %s: unexpected exception: unknown exception",peer.toString().c_str()); } return false; // default position on any failure } void Network::clean() { Mutex::Lock _l(_lock); if ((_config)&&(_config->isOpen())) { // Open (public) networks do not track certs or cert pushes at all. _membershipCertificates.clear(); _lastPushedMembershipCertificate.clear(); } else if (_config) { // Clean certificates that are no longer valid from the cache. for(std::map::iterator c=(_membershipCertificates.begin());c!=_membershipCertificates.end();) { if (_config->com().agreesWith(c->second)) ++c; else _membershipCertificates.erase(c++); } // Clean entries from the last pushed tracking map if they're so old as // to be no longer relevant. uint64_t forgetIfBefore = Utils::now() - (_config->com().timestampMaxDelta() * 3ULL); for(std::map::iterator lp(_lastPushedMembershipCertificate.begin());lp!=_lastPushedMembershipCertificate.end();) { if (lp->second < forgetIfBefore) _lastPushedMembershipCertificate.erase(lp++); else ++lp; } } } void Network::_CBhandleTapData(void *arg,const MAC &from,const MAC &to,unsigned int etherType,const Buffer<4096> &data) { if (((Network *)arg)->status() != NETWORK_OK) return; const RuntimeEnvironment *_r = ((Network *)arg)->_r; if (_r->shutdownInProgress) return; try { _r->sw->onLocalEthernet(SharedPtr((Network *)arg),from,to,etherType,data); } catch (std::exception &exc) { TRACE("unexpected exception handling local packet: %s",exc.what()); } catch ( ... ) { TRACE("unexpected exception handling local packet"); } } void Network::_pushMembershipCertificate(const Address &peer,bool force,uint64_t now) { uint64_t pushTimeout = _config->com().timestampMaxDelta() / 2; if (!pushTimeout) return; // still waiting on my own cert if (pushTimeout > 1000) pushTimeout -= 1000; uint64_t &lastPushed = _lastPushedMembershipCertificate[peer]; if ((force)||((now - lastPushed) > pushTimeout)) { lastPushed = now; TRACE("pushing membership cert for %.16llx to %s",(unsigned long long)_id,peer.toString().c_str()); Packet outp(peer,_r->identity.address(),Packet::VERB_NETWORK_MEMBERSHIP_CERTIFICATE); _config->com().serialize(outp); _r->sw->send(outp,true); } } void Network::threadMain() throw() { // Setup thread -- this exits when tap is constructed. It's here // because opening the tap can take some time on some platforms. try { #ifdef __WINDOWS__ // Windows tags interfaces by their network IDs, which are shoved into the // registry to mark persistent instance of the tap device. char tag[24]; Utils::snprintf(tag,sizeof(tag),"%.16llx",(unsigned long long)_id); #else // Unix tries to get the same device name next time, if possible. std::string tagstr; char lcentry[128]; Utils::snprintf(lcentry,sizeof(lcentry),"_dev_for_%.16llx",(unsigned long long)_id); tagstr = _nc->getLocalConfig(lcentry); const char *tag = (tagstr.length() > 0) ? tagstr.c_str() : (const char *)0; #endif _tap = new EthernetTap(_r,tag,_mac,ZT_IF_MTU,&_CBhandleTapData,this); #ifndef __WINDOWS__ std::string dn(_tap->deviceName()); if ((!tag)||(dn != tag)) _nc->putLocalConfig(lcentry,dn); #endif } catch (std::exception &exc) { delete _tap; _tap = (EthernetTap *)0; LOG("network %.16llx failed to initialize: %s",_id,exc.what()); _netconfFailure = NETCONF_FAILURE_INIT_FAILED; } catch ( ... ) { delete _tap; _tap = (EthernetTap *)0; LOG("network %.16llx failed to initialize: unknown error",_id); _netconfFailure = NETCONF_FAILURE_INIT_FAILED; } try { _restoreState(); requestConfiguration(); } catch ( ... ) { TRACE("BUG: exception in network setup thread in _restoreState() or requestConfiguration()!"); _lastConfigUpdate = 0; // call requestConfiguration() again } } void Network::_restoreState() { if (!_id) return; // sanity check Buffer buf; std::string idstr(idString()); std::string confPath(_r->homePath + ZT_PATH_SEPARATOR_S + "networks.d" + ZT_PATH_SEPARATOR_S + idstr + ".conf"); std::string mcdbPath(_r->homePath + ZT_PATH_SEPARATOR_S + "networks.d" + ZT_PATH_SEPARATOR_S + idstr + ".mcerts"); // Read configuration file containing last config from netconf master { std::string confs; if (Utils::readFile(confPath.c_str(),confs)) { try { if (confs.length()) setConfiguration(Dictionary(confs),false); } catch ( ... ) {} // ignore invalid config on disk, we will re-request from netconf master } else { // If the conf file isn't present, "touch" it so we'll remember // the existence of this network. FILE *tmp = fopen(confPath.c_str(),"wb"); if (tmp) fclose(tmp); } } // Read most recent multicast cert dump if ((_config)&&(!_config->isOpen())&&(Utils::fileExists(mcdbPath.c_str()))) { CertificateOfMembership com; Mutex::Lock _l(_lock); _membershipCertificates.clear(); FILE *mcdb = fopen(mcdbPath.c_str(),"rb"); if (mcdb) { try { char magic[6]; if ((fread(magic,6,1,mcdb) == 1)&&(!memcmp("ZTMCD0",magic,6))) { long rlen = 0; do { long rlen = (long)fread(buf.data() + buf.size(),1,ZT_NETWORK_CERT_WRITE_BUF_SIZE - buf.size(),mcdb); if (rlen < 0) rlen = 0; buf.setSize(buf.size() + (unsigned int)rlen); unsigned int ptr = 0; while ((ptr < (ZT_NETWORK_CERT_WRITE_BUF_SIZE / 2))&&(ptr < buf.size())) { ptr += com.deserialize(buf,ptr); if (com.issuedTo()) _membershipCertificates[com.issuedTo()] = com; } if (ptr) { memmove(buf.data(),buf.data() + ptr,buf.size() - ptr); buf.setSize(buf.size() - ptr); } } while (rlen > 0); fclose(mcdb); } else { fclose(mcdb); Utils::rm(mcdbPath); } } catch ( ... ) { // Membership cert dump file invalid. We'll re-learn them off the net. _membershipCertificates.clear(); fclose(mcdb); Utils::rm(mcdbPath); } } } } void Network::_dumpMulticastCerts() { Buffer buf; std::string mcdbPath(_r->homePath + ZT_PATH_SEPARATOR_S + "networks.d" + ZT_PATH_SEPARATOR_S + idString() + ".mcerts"); Mutex::Lock _l(_lock); if (!_config) return; if ((!_id)||(_config->isOpen())) { Utils::rm(mcdbPath); return; } FILE *mcdb = fopen(mcdbPath.c_str(),"wb"); if (!mcdb) return; if (fwrite("ZTMCD0",6,1,mcdb) != 1) { fclose(mcdb); Utils::rm(mcdbPath); return; } for(std::map::iterator c=(_membershipCertificates.begin());c!=_membershipCertificates.end();++c) { try { c->second.serialize(buf); if (buf.size() >= (ZT_NETWORK_CERT_WRITE_BUF_SIZE / 2)) { if (fwrite(buf.data(),buf.size(),1,mcdb) != 1) { fclose(mcdb); Utils::rm(mcdbPath); return; } buf.clear(); } } catch ( ... ) { // Sanity check... no cert will ever be big enough to overflow buf fclose(mcdb); Utils::rm(mcdbPath); return; } } if (buf.size()) { if (fwrite(buf.data(),buf.size(),1,mcdb) != 1) { fclose(mcdb); Utils::rm(mcdbPath); return; } } fclose(mcdb); Utils::lockDownFile(mcdbPath.c_str(),false); } } // namespace ZeroTier