/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */ #include "remote/httpserverconnection.hpp" #include "remote/httphandler.hpp" #include "remote/httputility.hpp" #include "remote/apilistener.hpp" #include "remote/apifunction.hpp" #include "remote/jsonrpc.hpp" #include "base/application.hpp" #include "base/base64.hpp" #include "base/convert.hpp" #include "base/configtype.hpp" #include "base/defer.hpp" #include "base/exception.hpp" #include "base/io-engine.hpp" #include "base/logger.hpp" #include "base/objectlock.hpp" #include "base/timer.hpp" #include "base/tlsstream.hpp" #include "base/utility.hpp" #include #include #include #include #include #include #include #include #include #include #include #include using namespace icinga; auto const l_ServerHeader ("Icinga/" + Application::GetAppVersion()); HttpServerConnection::HttpServerConnection(const String& identity, bool authenticated, const Shared::Ptr& stream) : HttpServerConnection(identity, authenticated, stream, IoEngine::Get().GetIoContext()) { } HttpServerConnection::HttpServerConnection(const String& identity, bool authenticated, const Shared::Ptr& stream, boost::asio::io_context& io) : m_Stream(stream), m_Seen(Utility::GetTime()), m_IoStrand(io), m_ShuttingDown(false), m_HasStartedStreaming(false), m_CheckLivenessTimer(io) { if (authenticated) { m_ApiUser = ApiUser::GetByClientCN(identity); } { std::ostringstream address; auto endpoint (stream->lowest_layer().remote_endpoint()); address << '[' << endpoint.address() << "]:" << endpoint.port(); m_PeerAddress = address.str(); } } void HttpServerConnection::Start() { namespace asio = boost::asio; HttpServerConnection::Ptr keepAlive (this); IoEngine::SpawnCoroutine(m_IoStrand, [this, keepAlive](asio::yield_context yc) { ProcessMessages(yc); }); IoEngine::SpawnCoroutine(m_IoStrand, [this, keepAlive](asio::yield_context yc) { CheckLiveness(yc); }); } void HttpServerConnection::Disconnect() { namespace asio = boost::asio; HttpServerConnection::Ptr keepAlive (this); IoEngine::SpawnCoroutine(m_IoStrand, [this, keepAlive](asio::yield_context yc) { if (!m_ShuttingDown) { m_ShuttingDown = true; Log(LogInformation, "HttpServerConnection") << "HTTP client disconnected (from " << m_PeerAddress << ")"; /* * Do not swallow exceptions in a coroutine. * https://github.com/Icinga/icinga2/issues/7351 * We must not catch `detail::forced_unwind exception` as * this is used for unwinding the stack. * * Just use the error_code dummy here. */ boost::system::error_code ec; m_CheckLivenessTimer.cancel(); m_Stream->lowest_layer().cancel(ec); m_Stream->next_layer().async_shutdown(yc[ec]); m_Stream->lowest_layer().shutdown(m_Stream->lowest_layer().shutdown_both, ec); auto listener (ApiListener::GetInstance()); if (listener) { CpuBoundWork removeHttpClient (yc); listener->RemoveHttpClient(this); } } }); } void HttpServerConnection::StartStreaming() { namespace asio = boost::asio; m_HasStartedStreaming = true; HttpServerConnection::Ptr keepAlive (this); IoEngine::SpawnCoroutine(m_IoStrand, [this, keepAlive](asio::yield_context yc) { if (!m_ShuttingDown) { char buf[128]; asio::mutable_buffer readBuf (buf, 128); boost::system::error_code ec; do { m_Stream->async_read_some(readBuf, yc[ec]); } while (!ec); Disconnect(); } }); } bool HttpServerConnection::Disconnected() { return m_ShuttingDown; } static inline bool EnsureValidHeaders( AsioTlsStream& stream, boost::beast::flat_buffer& buf, boost::beast::http::parser& parser, boost::beast::http::response& response, bool& shuttingDown, boost::asio::yield_context& yc ) { namespace http = boost::beast::http; if (shuttingDown) return false; bool httpError = false; String errorMsg; boost::system::error_code ec; http::async_read_header(stream, buf, parser, yc[ec]); if (ec) { if (ec == boost::asio::error::operation_aborted) return false; errorMsg = ec.message(); httpError = true; } else { switch (parser.get().version()) { case 10: case 11: break; default: errorMsg = "Unsupported HTTP version"; } } if (!errorMsg.IsEmpty() || httpError) { response.result(http::status::bad_request); if (!httpError && parser.get()[http::field::accept] == "application/json") { HttpUtility::SendJsonBody(response, nullptr, new Dictionary({ { "error", 400 }, { "status", String("Bad Request: ") + errorMsg } })); } else { response.set(http::field::content_type, "text/html"); response.body() = String("

Bad Request

") + errorMsg + "

"; response.content_length(response.body().size()); } response.set(http::field::connection, "close"); boost::system::error_code ec; http::async_write(stream, response, yc[ec]); stream.async_flush(yc[ec]); return false; } return true; } static inline void HandleExpect100( AsioTlsStream& stream, boost::beast::http::request& request, boost::asio::yield_context& yc ) { namespace http = boost::beast::http; if (request[http::field::expect] == "100-continue") { http::response response; response.result(http::status::continue_); boost::system::error_code ec; http::async_write(stream, response, yc[ec]); stream.async_flush(yc[ec]); } } static inline bool HandleAccessControl( AsioTlsStream& stream, boost::beast::http::request& request, boost::beast::http::response& response, boost::asio::yield_context& yc ) { namespace http = boost::beast::http; auto listener (ApiListener::GetInstance()); if (listener) { auto headerAllowOrigin (listener->GetAccessControlAllowOrigin()); if (headerAllowOrigin) { CpuBoundWork allowOriginHeader (yc); auto allowedOrigins (headerAllowOrigin->ToSet()); if (!allowedOrigins.empty()) { auto& origin (request[http::field::origin]); if (allowedOrigins.find(std::string(origin)) != allowedOrigins.end()) { response.set(http::field::access_control_allow_origin, origin); } allowOriginHeader.Done(); response.set(http::field::access_control_allow_credentials, "true"); if (request.method() == http::verb::options && !request[http::field::access_control_request_method].empty()) { response.result(http::status::ok); response.set(http::field::access_control_allow_methods, "GET, POST, PUT, DELETE"); response.set(http::field::access_control_allow_headers, "Authorization, Content-Type, X-HTTP-Method-Override"); response.body() = "Preflight OK"; response.content_length(response.body().size()); response.set(http::field::connection, "close"); boost::system::error_code ec; http::async_write(stream, response, yc[ec]); stream.async_flush(yc[ec]); return false; } } } } return true; } static inline bool EnsureAcceptHeader( AsioTlsStream& stream, boost::beast::http::request& request, boost::beast::http::response& response, boost::asio::yield_context& yc ) { namespace http = boost::beast::http; if (request.method() != http::verb::get && request[http::field::accept] != "application/json") { response.result(http::status::bad_request); response.set(http::field::content_type, "text/html"); response.body() = "

Accept header is missing or not set to 'application/json'.

"; response.content_length(response.body().size()); response.set(http::field::connection, "close"); boost::system::error_code ec; http::async_write(stream, response, yc[ec]); stream.async_flush(yc[ec]); return false; } return true; } static inline bool EnsureAuthenticatedUser( AsioTlsStream& stream, boost::beast::http::request& request, ApiUser::Ptr& authenticatedUser, boost::beast::http::response& response, boost::asio::yield_context& yc ) { namespace http = boost::beast::http; if (!authenticatedUser) { Log(LogWarning, "HttpServerConnection") << "Unauthorized request: " << request.method_string() << ' ' << request.target(); response.result(http::status::unauthorized); response.set(http::field::www_authenticate, "Basic realm=\"Icinga 2\""); response.set(http::field::connection, "close"); if (request[http::field::accept] == "application/json") { HttpUtility::SendJsonBody(response, nullptr, new Dictionary({ { "error", 401 }, { "status", "Unauthorized. Please check your user credentials." } })); } else { response.set(http::field::content_type, "text/html"); response.body() = "

Unauthorized. Please check your user credentials.

"; response.content_length(response.body().size()); } boost::system::error_code ec; http::async_write(stream, response, yc[ec]); stream.async_flush(yc[ec]); return false; } return true; } static inline bool EnsureValidBody( AsioTlsStream& stream, boost::beast::flat_buffer& buf, boost::beast::http::parser& parser, ApiUser::Ptr& authenticatedUser, boost::beast::http::response& response, bool& shuttingDown, boost::asio::yield_context& yc ) { namespace http = boost::beast::http; { size_t maxSize = 1024 * 1024; Array::Ptr permissions = authenticatedUser->GetPermissions(); if (permissions) { CpuBoundWork evalPermissions (yc); ObjectLock olock(permissions); for (const Value& permissionInfo : permissions) { String permission; if (permissionInfo.IsObjectType()) { permission = static_cast(permissionInfo)->Get("permission"); } else { permission = permissionInfo; } static std::vector> specialContentLengthLimits { { "config/modify", 512 * 1024 * 1024 } }; for (const auto& limitInfo : specialContentLengthLimits) { if (limitInfo.second <= maxSize) { continue; } if (Utility::Match(permission, limitInfo.first)) { maxSize = limitInfo.second; } } } } parser.body_limit(maxSize); } if (shuttingDown) return false; boost::system::error_code ec; http::async_read(stream, buf, parser, yc[ec]); if (ec) { if (ec == boost::asio::error::operation_aborted) return false; /** * Unfortunately there's no way to tell an HTTP protocol error * from an error on a lower layer: * * */ response.result(http::status::bad_request); if (parser.get()[http::field::accept] == "application/json") { HttpUtility::SendJsonBody(response, nullptr, new Dictionary({ { "error", 400 }, { "status", String("Bad Request: ") + ec.message() } })); } else { response.set(http::field::content_type, "text/html"); response.body() = String("

Bad Request

") + ec.message() + "

"; response.content_length(response.body().size()); } response.set(http::field::connection, "close"); http::async_write(stream, response, yc[ec]); stream.async_flush(yc[ec]); return false; } return true; } static inline bool ProcessRequest( AsioTlsStream& stream, boost::beast::http::request& request, ApiUser::Ptr& authenticatedUser, boost::beast::http::response& response, HttpServerConnection& server, bool& hasStartedStreaming, boost::asio::yield_context& yc ) { namespace http = boost::beast::http; try { CpuBoundWork handlingRequest (yc); HttpHandler::ProcessRequest(stream, authenticatedUser, request, response, yc, server); } catch (const std::exception& ex) { if (hasStartedStreaming) { return false; } auto sysErr (dynamic_cast(&ex)); if (sysErr && sysErr->code() == boost::asio::error::operation_aborted) { throw; } http::response response; HttpUtility::SendJsonError(response, nullptr, 500, "Unhandled exception" , DiagnosticInformation(ex)); boost::system::error_code ec; http::async_write(stream, response, yc[ec]); stream.async_flush(yc[ec]); return true; } if (hasStartedStreaming) { return false; } boost::system::error_code ec; http::async_write(stream, response, yc[ec]); stream.async_flush(yc[ec]); return true; } void HttpServerConnection::ProcessMessages(boost::asio::yield_context yc) { namespace beast = boost::beast; namespace http = beast::http; namespace ch = std::chrono; try { /* Do not reset the buffer in the state machine. * EnsureValidHeaders already reads from the stream into the buffer, * EnsureValidBody continues. ProcessRequest() actually handles the request * and needs the full buffer. */ beast::flat_buffer buf; for (;;) { m_Seen = Utility::GetTime(); http::parser parser; http::response response; parser.header_limit(1024 * 1024); parser.body_limit(-1); response.set(http::field::server, l_ServerHeader); if (!EnsureValidHeaders(*m_Stream, buf, parser, response, m_ShuttingDown, yc)) { break; } m_Seen = Utility::GetTime(); auto start (ch::steady_clock::now()); auto& request (parser.get()); { auto method (http::string_to_verb(request["X-Http-Method-Override"])); if (method != http::verb::unknown) { request.method(method); } } HandleExpect100(*m_Stream, request, yc); auto authenticatedUser (m_ApiUser); if (!authenticatedUser) { CpuBoundWork fetchingAuthenticatedUser (yc); authenticatedUser = ApiUser::GetByAuthHeader(std::string(request[http::field::authorization])); } Log logMsg (LogInformation, "HttpServerConnection"); logMsg << "Request " << request.method_string() << ' ' << request.target() << " (from " << m_PeerAddress << "), user: " << (authenticatedUser ? authenticatedUser->GetName() : "") << ", agent: " << request[http::field::user_agent]; //operator[] - Returns the value for a field, or "" if it does not exist. Defer addRespCode ([&response, start, &logMsg]() { logMsg << ", status: " << response.result() << ") took " << ch::duration_cast(ch::steady_clock::now() - start).count() << "ms."; }); if (!HandleAccessControl(*m_Stream, request, response, yc)) { break; } if (!EnsureAcceptHeader(*m_Stream, request, response, yc)) { break; } if (!EnsureAuthenticatedUser(*m_Stream, request, authenticatedUser, response, yc)) { break; } if (!EnsureValidBody(*m_Stream, buf, parser, authenticatedUser, response, m_ShuttingDown, yc)) { break; } m_Seen = std::numeric_limits::max(); if (!ProcessRequest(*m_Stream, request, authenticatedUser, response, *this, m_HasStartedStreaming, yc)) { break; } if (request.version() != 11 || request[http::field::connection] == "close") { break; } } } catch (const std::exception& ex) { if (!m_ShuttingDown) { Log(LogCritical, "HttpServerConnection") << "Unhandled exception while processing HTTP request: " << ex.what(); } } Disconnect(); } void HttpServerConnection::CheckLiveness(boost::asio::yield_context yc) { boost::system::error_code ec; for (;;) { m_CheckLivenessTimer.expires_from_now(boost::posix_time::seconds(5)); m_CheckLivenessTimer.async_wait(yc[ec]); if (m_ShuttingDown) { break; } if (m_Seen < Utility::GetTime() - 10) { Log(LogInformation, "HttpServerConnection") << "No messages for HTTP connection have been received in the last 10 seconds."; Disconnect(); break; } } }