#ifndef I2PCONTROL_H__ #define I2PCONTROL_H__ #include #include #include #include #include #include namespace i2p { namespace client { const char I2P_CONTROL_DEFAULT_PASSWORD[] = "itoopie"; const uint64_t I2P_CONTROL_TOKEN_LIFETIME = 600; // Token lifetime in seconds const char I2P_CONTROL_PROPERTY_ID[] = "id"; const char I2P_CONTROL_PROPERTY_METHOD[] = "method"; const char I2P_CONTROL_PROPERTY_PARAMS[] = "params"; const char I2P_CONTROL_PROPERTY_RESULT[] = "result"; // methods const char I2P_CONTROL_METHOD_AUTHENTICATE[] = "Authenticate"; const char I2P_CONTROL_METHOD_ECHO[] = "Echo"; const char I2P_CONTROL_METHOD_I2PCONTROL[] = "I2PControl"; const char I2P_CONTROL_METHOD_ROUTER_INFO[] = "RouterInfo"; const char I2P_CONTROL_METHOD_ROUTER_MANAGER[] = "RouterManager"; const char I2P_CONTROL_METHOD_NETWORK_SETTING[] = "NetworkSetting"; // params const char I2P_CONTROL_PARAM_API[] = "API"; const char I2P_CONTROL_PARAM_PASSWORD[] = "Password"; const char I2P_CONTROL_PARAM_TOKEN[] = "Token"; const char I2P_CONTROL_PARAM_ECHO[] = "Echo"; const char I2P_CONTROL_PARAM_RESULT[] = "Result"; // I2PControl const char I2P_CONTROL_I2PCONTROL_ADDRESS[] = "i2pcontrol.address"; const char I2P_CONTROL_I2PCONTROL_PASSWORD[] = "i2pcontrol.password"; const char I2P_CONTROL_I2PCONTROL_PORT[] = "i2pcontrol.port"; // RouterInfo requests const char I2P_CONTROL_ROUTER_INFO_UPTIME[] = "i2p.router.uptime"; const char I2P_CONTROL_ROUTER_INFO_VERSION[] = "i2p.router.version"; const char I2P_CONTROL_ROUTER_INFO_STATUS[] = "i2p.router.status"; const char I2P_CONTROL_ROUTER_INFO_NETDB_KNOWNPEERS[] = "i2p.router.netdb.knownpeers"; const char I2P_CONTROL_ROUTER_INFO_NETDB_ACTIVEPEERS[] = "i2p.router.netdb.activepeers"; const char I2P_CONTROL_ROUTER_INFO_NET_STATUS[] = "i2p.router.net.status"; const char I2P_CONTROL_ROUTER_INFO_TUNNELS_PARTICIPATING[] = "i2p.router.net.tunnels.participating"; const char I2P_CONTROL_ROUTER_INFO_BW_IB_1S[] = "i2p.router.net.bw.inbound.1s"; const char I2P_CONTROL_ROUTER_INFO_BW_OB_1S[] = "i2p.router.net.bw.outbound.1s"; // RouterManager requests const char I2P_CONTROL_ROUTER_MANAGER_SHUTDOWN[] = "Shutdown"; const char I2P_CONTROL_ROUTER_MANAGER_SHUTDOWN_GRACEFUL[] = "ShutdownGraceful"; const char I2P_CONTROL_ROUTER_MANAGER_RESEED[] = "Reseed"; /** * "Null" I2P control implementation, does not do actual networking. * @note authentication tokens are per-session * @note I2PControlSession must always be used as a std::shared_ptr * @warning an I2PControlSession must be destroyed before its io_service */ class I2PControlSession : public std::enable_shared_from_this { public: enum class ErrorCode { None = 0, // JSON-RPC2 MethodNotFound = 32601, InvalidParameters = 32602, InvalidRequest = 32600, InternalError = 32603, ParseError = 32700, // I2PControl specific InvalidPassword = 32001, NoToken = 32002, NonexistantToken = 32003, ExpiredToken = 32004, UnspecifiedVersion = 32005, UnsupportedVersion = 32006 }; class Response { std::string id; std::string version; ErrorCode error; std::map parameters; public: Response(const std::string& version = "2.0"); std::string toJsonString() const; /** * Set an ouptut parameter to a specified string. * @todo escape quotes */ void setParam(const std::string& param, const std::string& value); void setParam(const std::string& param, int value); void setParam(const std::string& param, double value); void setError(ErrorCode code); void setId(const std::string& identifier); std::string getErrorMsg() const; }; /** * Sets up the appropriate handlers. * @param ios the parent io_service object, must remain valid throughout * the lifetime of this I2PControlSession. */ I2PControlSession(boost::asio::io_service& ios); /** * Starts the I2PControlSession. * In essence, this starts the expireTokensTimer. * @note should always be called after construction */ void start(); /** * Cancels all operations that are waiting. * @note it's a good idea to call this before destruction (shared_ptr reset) */ void stop(); /** * Handle a json string with I2PControl instructions. */ Response handleRequest(std::stringstream& request); private: // For convenience typedef boost::property_tree::ptree PropertyTree; // Handler types typedef void (I2PControlSession::*MethodHandler)( const PropertyTree& pt, Response& results ); typedef void (I2PControlSession::*RequestHandler)(Response& results); /** * Tries to authenticate by checking whether the given token is valid. * Sets the appropriate error code in the given response. */ bool authenticate(const PropertyTree& pt, Response& response); /** * Generate a random authentication token. * @return 8 random bytes as a hexadecimal string */ std::string generateToken() const; void startExpireTokensJob(); /** * Expire tokens that are too old. */ void expireTokens(const boost::system::error_code& error); // Method handlers void handleAuthenticate(const PropertyTree& pt, Response& response); void handleEcho(const PropertyTree& pt, Response& response); void handleI2PControl(const PropertyTree& pt, Response& response); void handleRouterInfo(const PropertyTree& pt, Response& response); void handleRouterManager(const PropertyTree& pt, Response& response); void handleNetworkSetting(const PropertyTree& pt, Response& response); // RouterInfo handlers void handleUptime(Response& response); void handleVersion(Response& response); void handleStatus(Response& response); void handleNetDbKnownPeers(Response& response); void handleNetDbActivePeers(Response& response); void handleNetStatus(Response& response); void handleTunnelsParticipating(Response& response); void handleInBandwidth1S(Response& response); void handleOutBandwidth1S(Response& response); // RouterManager handlers void handleShutdown(Response& response); void handleShutdownGraceful(Response& response); void handleReseed(Response& response); std::string password; std::map tokens; std::mutex tokensMutex; std::map methodHandlers; std::map routerInfoHandlers; std::map routerManagerHandlers; std::map networkSettingHandlers; boost::asio::io_service& service; boost::asio::deadline_timer shutdownTimer; boost::asio::deadline_timer expireTokensTimer; }; } } #endif // I2PCONTROL_H__