updated ZTO version

zerotierone/node/Topology.hpp

@@ -33,10 +33,12 @@
 #include "Address.hpp"
 #include "Identity.hpp"
 #include "Peer.hpp"
+#include "Path.hpp"
 #include "Mutex.hpp"
 #include "InetAddress.hpp"
 #include "Hashtable.hpp"
 #include "World.hpp"
+#include "CertificateOfRepresentation.hpp"
 
 namespace ZeroTier {
 
@@ -49,7 +51,6 @@ class Topology
 {
 public:
 	Topology(const RuntimeEnvironment *renv);
-	~Topology();
 
 	/**
 	 * Add a peer to database
@@ -82,13 +83,29 @@ public:
 	 */
 	inline SharedPtr<Peer> getPeerNoCache(const Address &zta)
 	{
-		Mutex::Lock _l(_lock);
+		Mutex::Lock _l(_peers_m);
 		const SharedPtr<Peer> *const ap = _peers.get(zta);
 		if (ap)
 			return *ap;
 		return SharedPtr<Peer>();
 	}
 
+	/**
+	 * Get a Path object for a given local and remote physical address, creating if needed
+	 *
+	 * @param l Local address or NULL for 'any' or 'wildcard'
+	 * @param r Remote address
+	 * @return Pointer to canonicalized Path object
+	 */
+	inline SharedPtr<Path> getPath(const InetAddress &l,const InetAddress &r)
+	{
+		Mutex::Lock _l(_paths_m);
+		SharedPtr<Path> &p = _paths[Path::HashKey(l,r)];
+		if (!p)
+			p.setToUnsafe(new Path(l,r));
+		return p;
+	}
+
 	/**
 	 * Get the identity of a peer
 	 *
@@ -108,35 +125,21 @@ public:
 	void saveIdentity(const Identity &id);
 
 	/**
-	 * Get the current favorite root server
+	 * Get the current best upstream peer
 	 *
 	 * @return Root server with lowest latency or NULL if none
 	 */
-	inline SharedPtr<Peer> getBestRoot() { return getBestRoot((const Address *)0,0,false); }
+	inline SharedPtr<Peer> getUpstreamPeer() { return getUpstreamPeer((const Address *)0,0,false); }
 
 	/**
-	 * Get the best root server, avoiding root servers listed in an array
-	 *
-	 * This will get the best root server (lowest latency, etc.) but will
-	 * try to avoid the listed root servers, only using them if no others
-	 * are available.
+	 * Get the current best upstream peer, avoiding those in the supplied avoid list
 	 *
 	 * @param avoid Nodes to avoid
 	 * @param avoidCount Number of nodes to avoid
 	 * @param strictAvoid If false, consider avoided root servers anyway if no non-avoid root servers are available
 	 * @return Root server or NULL if none available
 	 */
-	SharedPtr<Peer> getBestRoot(const Address *avoid,unsigned int avoidCount,bool strictAvoid);
-
-	/**
-	 * @param id Identity to check
-	 * @return True if this is a designated root server in this world
-	 */
-	inline bool isRoot(const Identity &id) const
-	{
-		Mutex::Lock _l(_lock);
-		return (std::find(_rootAddresses.begin(),_rootAddresses.end(),id.address()) != _rootAddresses.end());
-	}
+	SharedPtr<Peer> getUpstreamPeer(const Address *avoid,unsigned int avoidCount,bool strictAvoid);
 
 	/**
 	 * @param id Identity to check
@@ -145,46 +148,144 @@ public:
 	bool isUpstream(const Identity &id) const;
 
 	/**
-	 * @return Vector of root server addresses
+	 * @param addr Address to check
+	 * @return True if we should accept a world update from this address
 	 */
-	inline std::vector<Address> rootAddresses() const
+	bool shouldAcceptWorldUpdateFrom(const Address &addr) const;
+
+	/**
+	 * @param ztaddr ZeroTier address
+	 * @return Peer role for this device
+	 */
+	ZT_PeerRole role(const Address &ztaddr) const;
+
+	/**
+	 * Check for prohibited endpoints
+	 *
+	 * Right now this returns true if the designated ZT address is a root and if
+	 * the IP (IP only, not port) does not equal any of the IPs defined in the
+	 * current World. This is an extra little security feature in case root keys
+	 * get appropriated or something.
+	 *
+	 * Otherwise it returns false.
+	 *
+	 * @param ztaddr ZeroTier address
+	 * @param ipaddr IP address
+	 * @return True if this ZT/IP pair should not be allowed to be used
+	 */
+	bool isProhibitedEndpoint(const Address &ztaddr,const InetAddress &ipaddr) const;
+
+	/**
+	 * Gets upstreams to contact and their stable endpoints (if known)
+	 *
+	 * @param eps Hash table to fill with addresses and their stable endpoints
+	 */
+	inline void getUpstreamsToContact(Hashtable< Address,std::vector<InetAddress> > &eps) const
 	{
-		Mutex::Lock _l(_lock);
-		return _rootAddresses;
+		Mutex::Lock _l(_upstreams_m);
+		for(std::vector<World::Root>::const_iterator i(_planet.roots().begin());i!=_planet.roots().end();++i) {
+			std::vector<InetAddress> &ips = eps[i->identity.address()];
+			for(std::vector<InetAddress>::const_iterator j(i->stableEndpoints.begin());j!=i->stableEndpoints.end();++j) {
+				if (std::find(ips.begin(),ips.end(),*j) == ips.end())
+					ips.push_back(*j);
+			}
+		}
+		for(std::vector<World>::const_iterator m(_moons.begin());m!=_moons.end();++m) {
+			for(std::vector<World::Root>::const_iterator i(m->roots().begin());i!=m->roots().end();++i) {
+				std::vector<InetAddress> &ips = eps[i->identity.address()];
+				for(std::vector<InetAddress>::const_iterator j(i->stableEndpoints.begin());j!=i->stableEndpoints.end();++j) {
+					if (std::find(ips.begin(),ips.end(),*j) == ips.end())
+						ips.push_back(*j);
+				}
+			}
+		}
+		for(std::vector< std::pair<uint64_t,Address> >::const_iterator m(_moonSeeds.begin());m!=_moonSeeds.end();++m)
+			eps[m->second];
 	}
 
 	/**
-	 * @return Current World (copy)
+	 * @return Vector of active upstream addresses (including roots)
 	 */
-	inline World world() const
+	inline std::vector<Address> upstreamAddresses() const
 	{
-		Mutex::Lock _l(_lock);
-		return _world;
+		Mutex::Lock _l(_upstreams_m);
+		return _upstreamAddresses;
 	}
 
 	/**
-	 * @return Current world ID
+	 * @return Current moons
 	 */
-	inline uint64_t worldId() const
+	inline std::vector<World> moons() const
 	{
-		return _world.id(); // safe to read without lock, and used from within eachPeer() so don't lock
+		Mutex::Lock _l(_upstreams_m);
+		return _moons;
 	}
 
 	/**
-	 * @return Current world timestamp
+	 * @return Moon IDs we are waiting for from seeds
 	 */
-	inline uint64_t worldTimestamp() const
+	inline std::vector<uint64_t> moonsWanted() const
 	{
-		return _world.timestamp(); // safe to read without lock, and used from within eachPeer() so don't lock
+		Mutex::Lock _l(_upstreams_m);
+		std::vector<uint64_t> mw;
+		for(std::vector< std::pair<uint64_t,Address> >::const_iterator s(_moonSeeds.begin());s!=_moonSeeds.end();++s) {
+			if (std::find(mw.begin(),mw.end(),s->first) == mw.end())
+				mw.push_back(s->first);
+		}
+		return mw;
+	}
+
+	/**
+	 * @return Current planet
+	 */
+	inline World planet() const
+	{
+		Mutex::Lock _l(_upstreams_m);
+		return _planet;
+	}
+
+	/**
+	 * @return Current planet's world ID
+	 */
+	inline uint64_t planetWorldId() const
+	{
+		return _planet.id(); // safe to read without lock, and used from within eachPeer() so don't lock
+	}
+
+	/**
+	 * @return Current planet's world timestamp
+	 */
+	inline uint64_t planetWorldTimestamp() const
+	{
+		return _planet.timestamp(); // safe to read without lock, and used from within eachPeer() so don't lock
 	}
 
 	/**
 	 * Validate new world and update if newer and signature is okay
 	 *
-	 * @param newWorld Potential new world definition revision
-	 * @return True if an update actually occurred
+	 * @param newWorld A new or updated planet or moon to learn
+	 * @param alwaysAcceptNew If true, always accept new moons even if we're not waiting for one
+	 * @return True if it was valid and newer than current (or totally new for moons)
 	 */
-	bool worldUpdateIfValid(const World &newWorld);
+	bool addWorld(const World &newWorld,bool alwaysAcceptNew);
+
+	/**
+	 * Add a moon
+	 *
+	 * This loads it from moons.d if present, and if not adds it to
+	 * a list of moons that we want to contact.
+	 *
+	 * @param id Moon ID
+	 * @param seed If non-NULL, an address of any member of the moon to contact
+	 */
+	void addMoon(const uint64_t id,const Address &seed);
+
+	/**
+	 * Remove a moon
+	 *
+	 * @param id Moon's world ID
+	 */
+	void removeMoon(const uint64_t id);
 
 	/**
 	 * Clean and flush database
@@ -198,7 +299,7 @@ public:
 	inline unsigned long countActive(uint64_t now) const
 	{
 		unsigned long cnt = 0;
-		Mutex::Lock _l(_lock);
+		Mutex::Lock _l(_peers_m);
 		Hashtable< Address,SharedPtr<Peer> >::Iterator i(const_cast<Topology *>(this)->_peers);
 		Address *a = (Address *)0;
 		SharedPtr<Peer> *p = (SharedPtr<Peer> *)0;
@@ -211,20 +312,13 @@ public:
 	/**
 	 * Apply a function or function object to all peers
 	 *
-	 * Note: explicitly template this by reference if you want the object
-	 * passed by reference instead of copied.
-	 *
-	 * Warning: be careful not to use features in these that call any other
-	 * methods of Topology that may lock _lock, otherwise a recursive lock
-	 * and deadlock or lock corruption may occur.
-	 *
 	 * @param f Function to apply
 	 * @tparam F Function or function object type
 	 */
 	template<typename F>
 	inline void eachPeer(F f)
 	{
-		Mutex::Lock _l(_lock);
+		Mutex::Lock _l(_peers_m);
 		Hashtable< Address,SharedPtr<Peer> >::Iterator i(_peers);
 		Address *a = (Address *)0;
 		SharedPtr<Peer> *p = (SharedPtr<Peer> *)0;
@@ -244,14 +338,14 @@ public:
 	 */
 	inline std::vector< std::pair< Address,SharedPtr<Peer> > > allPeers() const
 	{
-		Mutex::Lock _l(_lock);
+		Mutex::Lock _l(_peers_m);
 		return _peers.entries();
 	}
 
 	/**
-	 * @return True if I am a root server in the current World
+	 * @return True if I am a root server in a planet or moon
 	 */
-	inline bool amRoot() const throw() { return _amRoot; }
+	inline bool amRoot() const { return _amRoot; }
 
 	/**
 	 * Get the outbound trusted path ID for a physical address, or 0 if none
@@ -294,7 +388,7 @@ public:
 	{
 		if (count > ZT_MAX_TRUSTED_PATHS)
 			count = ZT_MAX_TRUSTED_PATHS;
-		Mutex::Lock _l(_lock);
+		Mutex::Lock _l(_trustedPaths_m);
 		for(unsigned int i=0;i<count;++i) {
 			_trustedPathIds[i] = ids[i];
 			_trustedPathNetworks[i] = networks[i];
@@ -302,22 +396,49 @@ public:
 		_trustedPathCount = count;
 	}
 
+	/**
+	 * @return Current certificate of representation (copy)
+	 */
+	inline CertificateOfRepresentation certificateOfRepresentation() const
+	{
+		Mutex::Lock _l(_upstreams_m);
+		return _cor;
+	}
+
+	/**
+	 * @param buf Buffer to receive COR
+	 */
+	template<unsigned int C>
+	void appendCertificateOfRepresentation(Buffer<C> &buf)
+	{
+		Mutex::Lock _l(_upstreams_m);
+		_cor.serialize(buf);
+	}
+
 private:
 	Identity _getIdentity(const Address &zta);
-	void _setWorld(const World &newWorld);
+	void _memoizeUpstreams();
 
 	const RuntimeEnvironment *const RR;
 
 	uint64_t _trustedPathIds[ZT_MAX_TRUSTED_PATHS];
 	InetAddress _trustedPathNetworks[ZT_MAX_TRUSTED_PATHS];
 	unsigned int _trustedPathCount;
-	World _world;
-	Hashtable< Address,SharedPtr<Peer> > _peers;
-	std::vector< Address > _rootAddresses;
-	std::vector< SharedPtr<Peer> > _rootPeers;
-	bool _amRoot;
+	Mutex _trustedPaths_m;
 
-	Mutex _lock;
+	Hashtable< Address,SharedPtr<Peer> > _peers;
+	Mutex _peers_m;
+
+	Hashtable< Path::HashKey,SharedPtr<Path> > _paths;
+	Mutex _paths_m;
+
+	World _planet;
+	std::vector<World> _moons;
+	std::vector< std::pair<uint64_t,Address> > _moonSeeds;
+	std::vector<Address> _upstreamAddresses;
+	CertificateOfRepresentation _cor;
+	bool _amRoot;
+	Mutex _upstreams_m; // locks worlds, upstream info, moon info, etc.
 };
 
 } // namespace ZeroTier