/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */ #include "icinga-version.h" /* include VERSION */ // ensure to include base first #include "base/i2-base.hpp" #include "base/application.hpp" #include "base/json.hpp" #include "base/string.hpp" #include "base/logger.hpp" #include "base/exception.hpp" #include "base/utility.hpp" #include "base/defer.hpp" #include "base/io-engine.hpp" #include "base/stream.hpp" #include "base/tcpsocket.hpp" /* include global icinga::Connect */ #include "base/tlsstream.hpp" #include "base/base64.hpp" #include "remote/url.hpp" #include #include #include #include #include #include #include using namespace icinga; namespace po = boost::program_options; static bool l_Debug; /** * Prints an Icinga plugin API compliant output, including error handling. * * @param result * * @return Status code for exit() */ static int FormatOutput(const Dictionary::Ptr& result) { if (!result) { std::cerr << "UNKNOWN: No data received.\n"; return 3; } if (l_Debug) std::cout << "\tJSON Body:\n" << result->ToString() << '\n'; Array::Ptr payloads = result->Get("payload"); if (!payloads) { std::cerr << "UNKNOWN: Answer format error: Answer is missing 'payload'.\n"; return 3; } if (payloads->GetLength() == 0) { std::cerr << "UNKNOWN: Answer format error: 'payload' was empty.\n"; return 3; } if (payloads->GetLength() > 1) { std::cerr << "UNKNOWN: Answer format error: Multiple payloads are not supported."; return 3; } Dictionary::Ptr payload; try { payload = payloads->Get(0); } catch (const std::exception&) { std::cerr << "UNKNOWN: Answer format error: 'payload' was not a Dictionary.\n"; return 3; } Array::Ptr lines; try { lines = payload->Get("lines"); } catch (const std::exception&) { std::cerr << "UNKNOWN: Answer format error: 'payload' is missing 'lines'.\n"; return 3; } if (!lines) { std::cerr << "UNKNOWN: Answer format error: 'lines' is Null.\n"; return 3; } std::stringstream ssout; ObjectLock olock(lines); for (const Value& vline : lines) { Dictionary::Ptr line; try { line = vline; } catch (const std::exception&) { std::cerr << "UNKNOWN: Answer format error: 'lines' entry was not a Dictionary.\n"; return 3; } if (!line) { std::cerr << "UNKNOWN: Answer format error: 'lines' entry was Null.\n"; return 3; } ssout << payload->Get("command") << ' ' << line->Get("message") << " | "; if (!line->Contains("perf")) { ssout << '\n'; break; } Array::Ptr perfs = line->Get("perf"); ObjectLock olock(perfs); for (const Dictionary::Ptr& perf : perfs) { ssout << "'" << perf->Get("alias") << "'="; Dictionary::Ptr values = perf->Get("float_value"); if (perf->Contains("int_value")) values = perf->Get("int_value"); ssout << values->Get("value") << values->Get("unit") << ';' << values->Get("warning") << ';' << values->Get("critical"); if (values->Contains("minimum") || values->Contains("maximum")) { ssout << ';'; if (values->Contains("minimum")) ssout << values->Get("minimum"); if (values->Contains("maximum")) ssout << ';' << values->Get("maximum"); } ssout << ' '; } ssout << '\n'; } std::map stateMap = { { "OK", 0 }, { "WARNING", 1}, { "CRITICAL", 2}, { "UNKNOWN", 3} }; String state = static_cast(payload->Get("result")).ToUpper(); auto it = stateMap.find(state); if (it == stateMap.end()) { std::cerr << "UNKNOWN Answer format error: 'result' was not a known state.\n"; return 3; } std::cout << ssout.rdbuf(); return it->second; } /** * Connects to host:port and performs a TLS shandshake * * @param host To connect to. * @param port To connect to. * * @returns AsioTlsStream pointer for future HTTP connections. */ static std::shared_ptr Connect(const String& host, const String& port) { std::shared_ptr sslContext; try { sslContext = MakeAsioSslContext(Empty, Empty, Empty); //TODO: Add support for cert, key, ca parameters } catch(const std::exception& ex) { Log(LogCritical, "DebugConsole") << "Cannot make SSL context: " << ex.what(); throw; } std::shared_ptr stream = std::make_shared(IoEngine::Get().GetIoService(), *sslContext, host); try { icinga::Connect(stream->lowest_layer(), host, port); } catch (const std::exception& ex) { Log(LogWarning, "DebugConsole") << "Cannot connect to REST API on host '" << host << "' port '" << port << "': " << ex.what(); throw; } auto& tlsStream (stream->next_layer()); try { tlsStream.handshake(tlsStream.client); } catch (const std::exception& ex) { Log(LogWarning, "DebugConsole") << "TLS handshake with host '" << host << "' failed: " << ex.what(); throw; } return std::move(stream); } /** * Queries the given endpoint and host:port and retrieves data. * * @param host To connect to. * @param port To connect to. * @param password For auth header (required). * @param endpoint Caller must construct the full endpoint including the command query. * * @return Dictionary de-serialized from JSON data. */ static Dictionary::Ptr FetchData(const String& host, const String& port, const String& password, const String& endpoint) { namespace beast = boost::beast; namespace http = beast::http; std::shared_ptr tlsStream; try { tlsStream = Connect(host, port); } catch (const std::exception& ex) { std::cerr << "Connection error: " << ex.what(); throw ex; } Url::Ptr url; try { url = new Url(endpoint); } catch (const std::exception& ex) { std::cerr << "URL error: " << ex.what(); throw ex; } url->SetScheme("https"); url->SetHost(host); url->SetPort(port); // NSClient++ uses `time=1m&time=5m` instead of `time[]=1m&time[]=5m` url->SetArrayFormatUseBrackets(false); http::request request (http::verb::get, std::string(url->Format(true)), 10); request.set(http::field::user_agent, "Icinga/check_nscp_api/" + String(VERSION)); request.set(http::field::host, host + ":" + port); request.set(http::field::accept, "application/json"); request.set("password", password); if (l_Debug) { std::cout << "Sending request to " << url->Format(false, false) << "'.\n"; } try { http::write(*tlsStream, request); tlsStream->flush(); } catch (const std::exception& ex) { std::cerr << "Cannot write HTTP request to REST API at URL '" << url->Format(false, false) << "': " << ex.what(); throw ex; } /* We need to read the header and body manually, since the header will always throw an error. * Details: Missing status string in header, https://github.com/mickem/nscp/issues/610 * Inspiration: example_incremental_read from https://www.boost.org/doc/libs/1_66_0/libs/beast/example/doc/http_examples.hpp */ std::ostringstream msgbuf; beast::flat_buffer buffer; boost::system::error_code ec; /* Create a parser which has a buffer body for reading the input. * Ensure to pass ec for handling errors ourselves, and having the buffer ready. */ http::parser p; http::read(*tlsStream, buffer, p, ec); if (ec) { /* Ignore any bad_status/bad_reason errors since NSCP doesn't set them. */ if (ec != http::error::bad_status && ec != http::error::bad_reason) { String message = "Error reading HTTP response data: " + ec.message(); BOOST_THROW_EXCEPTION(ScriptError(message)); } else if (l_Debug) { std::cout << "NSCP just sent a wrong status reason, we've ignored it. See https://github.com/Icinga/icinga2/pull/7142" << std::endl; } } String rawResponse = beast::buffers_to_string(buffer.data()); if (l_Debug) std::cout << "Raw data: " << rawResponse << std::endl; /* At this stage we have the raw request. Since NSCP always returns HTTP/1.1 200 with missing OK for requests anyways, * we don't care about the header. Let's just extract the JSON body. */ std::vector lines = rawResponse.Split("\n"); size_t i = 0; for (i = 0; i < lines.size(); i++) { String line = lines[i].Trim(); if (l_Debug) std::cout << "Line: " << line << std::endl; if (line == "") // Empty line means that body is reached. break; } String body; size_t bodyIdx = ++i; // Avoid crashes with empty bodies. if (bodyIdx < lines.size()) body = lines[bodyIdx]; // Strip any control characters body.erase(boost::remove_if(body, ::iscntrl), body.End()); if (l_Debug) std::cout << "Received body from NSCP: '" << body << "'." << std::endl; // Add some rudimentary error handling. if (body.IsEmpty()) { String message = "No body received. Ensure that connection parameters are good and check the NSCP logs."; BOOST_THROW_EXCEPTION(ScriptError(message)); } Dictionary::Ptr jsonResponse; try { jsonResponse = JsonDecode(body); } catch (const std::exception& ex) { String message = "Cannot parse JSON response body '" + body + "', error: " + ex.what(); BOOST_THROW_EXCEPTION(ScriptError(message)); } return jsonResponse; } /** * Main function * * @param argc * @param argv * @return exit code */ int main(int argc, char **argv) { po::variables_map vm; po::options_description desc("Options"); desc.add_options() ("help,h", "Print usage message and exit") ("version,V", "Print version and exit") ("debug,d", "Verbose/Debug output") ("host,H", po::value()->required(), "REQUIRED: NSCP API Host") ("port,P", po::value()->default_value("8443"), "NSCP API Port (Default: 8443)") ("password", po::value()->required(), "REQUIRED: NSCP API Password") ("query,q", po::value()->required(), "REQUIRED: NSCP API Query endpoint") ("arguments,a", po::value>()->multitoken(), "NSCP API Query arguments for the endpoint"); po::command_line_parser parser(argc, argv); try { po::store( parser .options(desc) .style( po::command_line_style::unix_style | po::command_line_style::allow_long_disguise) .run(), vm); if (vm.count("version")) { std::cout << "Version: " << VERSION << '\n'; Application::Exit(0); } if (vm.count("help")) { std::cout << argv[0] << " Help\n\tVersion: " << VERSION << '\n'; std::cout << "check_nscp_api is a program used to query the NSClient++ API.\n"; std::cout << desc; std::cout << "For detailed information on possible queries and their arguments refer to the NSClient++ documentation.\n"; Application::Exit(0); } vm.notify(); } catch (const std::exception& e) { std::cout << e.what() << '\n' << desc << '\n'; Application::Exit(3); } l_Debug = vm.count("debug") > 0; // Initialize logger if (l_Debug) Logger::SetConsoleLogSeverity(LogDebug); else Logger::SetConsoleLogSeverity(LogWarning); // Create the URL string and escape certain characters since Url() follows RFC 3986 String endpoint = "/query/" + vm["query"].as(); if (!vm.count("arguments")) endpoint += '/'; else { endpoint += '?'; for (const String& argument : vm["arguments"].as>()) { String::SizeType pos = argument.FindFirstOf("="); if (pos == String::NPos) endpoint += Utility::EscapeString(argument, ACQUERY_ENCODE, false); else { String key = argument.SubStr(0, pos); String val = argument.SubStr(pos + 1); endpoint += Utility::EscapeString(key, ACQUERY_ENCODE, false) + "=" + Utility::EscapeString(val, ACQUERY_ENCODE, false); } endpoint += '&'; } } Dictionary::Ptr result; try { result = FetchData(vm["host"].as(), vm["port"].as(), vm["password"].as(), endpoint); } catch (const std::exception& ex) { std::cerr << "UNKNOWN - " << ex.what(); exit(3); } // Application::Exit() is the clean way to exit after calling InitializeBase() Application::Exit(FormatOutput(result)); return 255; }