path: root/service/ControlPlane.cpp

/*
 * ZeroTier One - Network Virtualization Everywhere
 * Copyright (C) 2011-2015  ZeroTier, Inc.
 *
 * 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 <http://www.gnu.org/licenses/>.
 *
 * --
 *
 * 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 "ControlPlane.hpp"
#include "OneService.hpp"

#include "../version.h"
#include "../include/ZeroTierOne.h"

#include "../ext/http-parser/http_parser.h"

#include "../node/InetAddress.hpp"
#include "../node/Node.hpp"
#include "../node/Utils.hpp"

#define ZT_BUILD_IN_WEB_UI

namespace ZeroTier {

static std::string _jsonEscape(const char *s)
{
	std::string buf;
	for(const char *p=s;(*p);++p) {
		switch(*p) {
			case '\t': buf.append("\\t");  break;
			case '\b': buf.append("\\b");  break;
			case '\r': buf.append("\\r");  break;
			case '\n': buf.append("\\n");  break;
			case '\f': buf.append("\\f");  break;
			case '"':  buf.append("\\\""); break;
			case '\\': buf.append("\\\\"); break;
			case '/':  buf.append("\\/");  break;
			default:   buf.push_back(*p);  break;
		}
	}
	return buf;
}
static std::string _jsonEscape(const std::string &s) { return _jsonEscape(s.c_str()); }
static std::string _jsonEnumerate(const ZT1_MulticastGroup *mg,unsigned int count)
{
	std::string buf;
	char tmp[128];
	buf.push_back('[');
	for(unsigned int i=0;i<count;++i) {
		if (i > 0)
			buf.push_back(',');
		Utils::snprintf(tmp,sizeof(tmp),"\"%.2x:%.2x:%.2x:%.2x:%.2x:%.2x\\/%.8lx\"",
			(unsigned int)((mg->mac >> 40) & 0xff),
			(unsigned int)((mg->mac >> 32) & 0xff),
			(unsigned int)((mg->mac >> 24) & 0xff),
			(unsigned int)((mg->mac >> 16) & 0xff),
			(unsigned int)((mg->mac >> 8) & 0xff),
			(unsigned int)(mg->mac & 0xff),
			mg->adi);
		buf.append(tmp);
	}
	buf.push_back(']');
	return buf;
}
static std::string _jsonEnumerate(const struct sockaddr_storage *ss,unsigned int count)
{
	std::string buf;
	buf.push_back('[');
	for(unsigned int i=0;i<count;++i) {
		if (i > 0)
			buf.push_back(',');
		buf.push_back('"');
		buf.append(_jsonEscape(reinterpret_cast<const InetAddress *>(ss)->toString()));
		buf.push_back('"');
	}
	buf.push_back(']');
	return buf;
}
static std::string _jsonEnumerate(const ZT1_PeerPhysicalPath *pp,unsigned int count)
{
	char tmp[1024];
	std::string buf;
	buf.push_back('[');
	for(unsigned int i=0;i<count;++i) {
		if (i > 0)
			buf.push_back(',');
		buf.append("{\"address\":\"");
		buf.append(_jsonEscape(reinterpret_cast<const InetAddress *>(&(pp[i].address))->toString()));
		Utils::snprintf(tmp,sizeof(tmp),"\",\"lastSend\":%llu,\"lastReceive\":%llu,\"fixed\":%s,\"active\":%s,\"preferred\":%s}",
			pp[i].lastSend,
			pp[i].lastReceive,
			(pp[i].fixed == 0) ? "false" : "true",
			(pp[i].active == 0) ? "false" : "true",
			(pp[i].preferred == 0) ? "false" : "true");
		buf.append(tmp);
	}
	buf.push_back(']');
	return buf;
}
static void _jsonAppend(std::string &buf,const ZT1_VirtualNetworkConfig *nc,const std::string &portDeviceName)
{
	char json[65536];
	const char *nstatus = "",*ntype = "";
	switch(nc->status) {
		case ZT1_NETWORK_STATUS_REQUESTING_CONFIGURATION: nstatus = "REQUESTING_CONFIGURATION"; break;
		case ZT1_NETWORK_STATUS_OK:                       nstatus = "OK"; break;
		case ZT1_NETWORK_STATUS_ACCESS_DENIED:            nstatus = "ACCESS_DENIED"; break;
		case ZT1_NETWORK_STATUS_NOT_FOUND:                nstatus = "NOT_FOUND"; break;
		case ZT1_NETWORK_STATUS_PORT_ERROR:               nstatus = "PORT_ERROR"; break;
		case ZT1_NETWORK_STATUS_CLIENT_TOO_OLD:           nstatus = "CLIENT_TOO_OLD"; break;
	}
	switch(nc->type) {
		case ZT1_NETWORK_TYPE_PRIVATE:                    ntype = "PRIVATE"; break;
		case ZT1_NETWORK_TYPE_PUBLIC:                     ntype = "PUBLIC"; break;
	}
	Utils::snprintf(json,sizeof(json),
		"{"
		"\"nwid\": \"%.16llx\","
		"\"mac\": \"%.2x:%.2x:%.2x:%.2x:%.2x:%.2x\","
		"\"name\": \"%s\","
		"\"status\": \"%s\","
		"\"type\": \"%s\","
		"\"mtu\": %u,"
		"\"dhcp\": %s,"
		"\"bridge\": %s,"
		"\"broadcastEnabled\": %s,"
		"\"portError\": %d,"
		"\"netconfRevision\": %lu,"
		"\"multicastSubscriptions\": %s,"
		"\"assignedAddresses\": %s,"
		"\"portDeviceName\": \"%s\""
		"}",
		nc->nwid,
		(unsigned int)((nc->mac >> 40) & 0xff),(unsigned int)((nc->mac >> 32) & 0xff),(unsigned int)((nc->mac >> 24) & 0xff),(unsigned int)((nc->mac >> 16) & 0xff),(unsigned int)((nc->mac >> 8) & 0xff),(unsigned int)(nc->mac & 0xff),
		_jsonEscape(nc->name).c_str(),
		nstatus,
		ntype,
		nc->mtu,
		(nc->dhcp == 0) ? "false" : "true",
		(nc->bridge == 0) ? "false" : "true",
		(nc->broadcastEnabled == 0) ? "false" : "true",
		nc->portError,
		nc->netconfRevision,
		_jsonEnumerate(nc->multicastSubscriptions,nc->multicastSubscriptionCount).c_str(),
		_jsonEnumerate(nc->assignedAddresses,nc->assignedAddressCount).c_str(),
		_jsonEscape(portDeviceName).c_str());
	buf.append(json);
}
static void _jsonAppend(std::string &buf,const ZT1_Peer *peer)
{
	char json[65536];
	const char *prole = "";
	switch(peer->role) {
		case ZT1_PEER_ROLE_LEAF:      prole = "LEAF"; break;
		case ZT1_PEER_ROLE_HUB:       prole = "HUB"; break;
		case ZT1_PEER_ROLE_SUPERNODE: prole = "SUPERNODE"; break;
	}
	Utils::snprintf(json,sizeof(json),
		"{"
		"\"address\": \"%.10llx\","
		"\"lastUnicastFrame\": %llu,"
		"\"lastMulticastFrame\": %llu,"
		"\"versionMajor\": %d,"
		"\"versionMinor\": %d,"
		"\"versionRev\": %d,"
		"\"version\": \"%d.%d.%d\","
		"\"latency\": %u,"
		"\"role\": \"%s\","
		"\"paths\": %s"
		"}",
		peer->address,
		peer->lastUnicastFrame,
		peer->lastMulticastFrame,
		peer->versionMajor,
		peer->versionMinor,
		peer->versionRev,
		peer->versionMajor,peer->versionMinor,peer->versionRev,
		peer->latency,
		prole,
		_jsonEnumerate(peer->paths,peer->pathCount).c_str());
	buf.append(json);
}

ControlPlane::ControlPlane(OneService *svc,Node *n) :
	_svc(svc),
	_node(n)
{
}

ControlPlane::~ControlPlane()
{
}

unsigned int ControlPlane::handleRequest(
	const InetAddress &fromAddress,
	unsigned int httpMethod,
	const std::string &path,
	const std::map<std::string,std::string> &headers,
	const std::string &body,
	std::string &responseBody,
	std::string &responseContentType)
{
	char json[65536];
	unsigned int scode = 404;
	std::vector<std::string> ps(Utils::split(path.c_str(),"/","",""));
	std::map<std::string,std::string> urlArgs;

	if (!((fromAddress.ipsEqual(InetAddress::LO4))||(fromAddress.ipsEqual(InetAddress::LO6))))
		return 403; // Forbidden: we only allow access from localhost right now

	/* Note: this is kind of restricted in what it'll take. It does not support
	 * URL encoding, and /'s in URL args will screw it up. But the only URL args
	 * it really uses in ?jsonp=funcionName, and otherwise it just takes simple
	 * paths to simply-named resources. */
	if (ps.size() > 0) {
		std::size_t qpos = ps[ps.size() - 1].find('?');
		if (qpos != std::string::npos) {
			std::string args(ps[ps.size() - 1].substr(qpos + 1));
			ps[ps.size() - 1] = ps[ps.size() - 1].substr(0,qpos);
			std::vector<std::string> asplit(Utils::split(args.c_str(),"&","",""));
			for(std::vector<std::string>::iterator a(asplit.begin());a!=asplit.end();++a) {
				std::size_t eqpos = a->find('=');
				if (eqpos == std::string::npos)
					urlArgs[*a] = "";
				else urlArgs[a->substr(0,eqpos)] = a->substr(eqpos + 1);
			}
		}
	} else {
		ps.push_back(std::string("index.html"));
	}

	bool isAuth = false;
	{
		Mutex::Lock _l(_authTokens_m);
		std::map<std::string,std::string>::const_iterator ah(headers.find("x-zt1-auth"));
		if ((ah != headers.end())&&(_authTokens.count(ah->second) > 0))
			isAuth = true;
		else {
			ah = urlArgs.find("auth");
			if ((ah != urlArgs.end())&&(_authTokens.count(ah->second) > 0))
				isAuth = true;
		}
	}

	if (httpMethod == HTTP_GET) {

		std::string ext;
		std::size_t dotIdx = ps[0].find_last_of('.');
		if (dotIdx != std::string::npos)
			ext = ps[0].substr(dotIdx);

		if ((ps.size() == 1)&&(ext.length() >= 2)&&(ext[0] == '.')) {
#ifdef ZT_BUILD_IN_WEB_UI
			// .anything == static page -- also the only thing you can get without isAuth == true
			if (ext == ".html")
				responseContentType = "text/html";
			else if (ext == ".js")
				responseContentType = "application/javascript";
			else if (ext == ".json")
				responseContentType = "application/json";
			else if (ext == ".css")
				responseContentType = "text/css";
			else if (ext == ".png")
				responseContentType = "image/png";
			else if (ext == ".jpg")
				responseContentType = "image/jpeg";
			else if (ext == ".gif")
				responseContentType = "image/gif";
			else if (ext == ".txt")
				responseContentType = "text/plain";
			else if (ext == ".xml")
				responseContentType = "text/xml";
			else if (ext == ".svg")
				responseContentType = "image/svg+xml";
			else responseContentType = "application/octet-stream";
			responseBody = "<html><body>Hello World!</body></html>";
			scode = 200;
#endif // ZT_BUILD_IN_WEB_UI
		} else if (isAuth) {
			if (ps[0] == "status") {
				responseContentType = "application/json";
				ZT1_NodeStatus status;
				_node->status(&status);
				Utils::snprintf(json,sizeof(json),
					"{"
					"\"address\":\"%.10llx\","
					"\"publicIdentity\":\"%s\","
					"\"online\":%s,"
					"\"versionMajor\":%d,"
					"\"versionMinor\":%d,"
					"\"versionRev\":%d,"
					"\"version\":\"%d.%d.%d\""
					"}",
					status.address,
					status.publicIdentity,
					(status.online) ? "true" : "false",
					ZEROTIER_ONE_VERSION_MAJOR,
					ZEROTIER_ONE_VERSION_MINOR,
					ZEROTIER_ONE_VERSION_REVISION,
					ZEROTIER_ONE_VERSION_MAJOR,ZEROTIER_ONE_VERSION_MINOR,ZEROTIER_ONE_VERSION_REVISION);
				responseBody = json;
				scode = 200;
			} else if (ps[0] == "config") {
				responseContentType = "application/json";
				responseBody = "{}"; // TODO
				scode = 200;
			} else if (ps[0] == "network") {
				ZT1_VirtualNetworkList *nws = _node->networks();
				if (nws) {
					if (ps.size() == 1) {
						// Return [array] of all networks
						responseContentType = "application/json";
						responseBody = "[";
						for(unsigned long i=0;i<nws->networkCount;++i) {
							if (i > 0)
								responseBody.push_back(',');
							_jsonAppend(responseBody,&(nws->networks[i]),_svc->portDeviceName(nws->networks[i].nwid));
						}
						responseBody.push_back(']');
						scode = 200;
					} else if (ps.size() == 2) {
						// Return a single network by ID or 404 if not found
						uint64_t wantnw = Utils::hexStrToU64(ps[1].c_str());
						for(unsigned long i=0;i<nws->networkCount;++i) {
							if (nws->networks[i].nwid == wantnw) {
								responseContentType = "application/json";
								_jsonAppend(responseBody,&(nws->networks[i]),_svc->portDeviceName(nws->networks[i].nwid));
								scode = 200;
								break;
							}
						}
					} // else 404
					_node->freeQueryResult((void *)nws);
				} else scode = 500;
			} else if (ps[0] == "peer") {
				ZT1_PeerList *pl = _node->peers();
				if (pl) {
					if (ps.size() == 1) {
						// Return [array] of all peers
						responseContentType = "application/json";
						responseBody = "[";
						for(unsigned long i=0;i<pl->peerCount;++i) {
							if (i > 0)
								responseBody.push_back(',');
							_jsonAppend(responseBody,&(pl->peers[i]));
						}
						responseBody.push_back(']');
						scode = 200;
					} else if (ps.size() == 2) {
						// Return a single peer by ID or 404 if not found
						uint64_t wantp = Utils::hexStrToU64(ps[1].c_str());
						for(unsigned long i=0;i<pl->peerCount;++i) {
							if (pl->peers[i].address == wantp) {
								responseContentType = "application/json";
								_jsonAppend(responseBody,&(pl->peers[i]));
								scode = 200;
								break;
							}
						}
					} // else 404
					_node->freeQueryResult((void *)pl);
				} else scode = 500;
			} // else 404
		} else scode = 401; // isAuth == false

	} else if ((httpMethod == HTTP_POST)||(httpMethod == HTTP_PUT)) {

		if (isAuth) {
			if (ps[0] == "config") {
				// TODO
			} else if (ps[0] == "network") {
				if ((ps.size() > 1)&&(ps[1] == "controller")) {
					// TODO
				} else {
					if (ps.size() == 2) {
						uint64_t wantnw = Utils::hexStrToU64(ps[1].c_str());
						_node->join(wantnw); // does nothing if we are a member
						ZT1_VirtualNetworkList *nws = _node->networks();
						if (nws) {
							for(unsigned long i=0;i<nws->networkCount;++i) {
								if (nws->networks[i].nwid == wantnw) {
									responseContentType = "application/json";
									_jsonAppend(responseBody,&(nws->networks[i]),_svc->portDeviceName(nws->networks[i].nwid));
									scode = 200;
									break;
								}
							}
							_node->freeQueryResult((void *)nws);
						} else scode = 500;
					} // else 404
				}
			} // else 404
		} else scode = 401; // isAuth == false

	} else if (httpMethod == HTTP_DELETE) {

		if (isAuth) {
			if (ps[0] == "config") {
				// TODO
			} else if (ps[0] == "network") {
				if ((ps.size() > 1)&&(ps[1] == "controller")) {
					// TODO
				} else {
					ZT1_VirtualNetworkList *nws = _node->networks();
					if (nws) {
						if (ps.size() == 2) {
							uint64_t wantnw = Utils::hexStrToU64(ps[1].c_str());
							for(unsigned long i=0;i<nws->networkCount;++i) {
								if (nws->networks[i].nwid == wantnw) {
									_node->leave(wantnw);
									responseBody = "true";
									responseContentType = "application/json";
									scode = 200;
									break;
								}
							}
						} // else 404
						_node->freeQueryResult((void *)nws);
					} else scode = 500;
				}
			} // else 404
		} else scode = 401; // isAuth = false

	} else {
		scode = 400;
		responseBody = "Method not supported.";
	}

	// Wrap result in jsonp function call if the user included a jsonp= url argument
	std::map<std::string,std::string>::const_iterator jsonp(urlArgs.find("jsonp"));
	if ((jsonp != urlArgs.end())&&(responseContentType == "application/json")) {
		if (responseBody.length() > 0)
			responseBody = jsonp->second + "(" + responseBody + ");";
		else responseBody = jsonp->second + "(null);";
		responseContentType = "application/javascript";
	}

	return scode;
}

} // namespace ZeroTier