icinga2/lib/cli/agentsetupcommand.cpp
2014-10-22 19:27:21 +02:00

394 lines
12 KiB
C++

/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012-2014 Icinga Development Team (http://www.icinga.org) *
* *
* 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 2 *
* 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, write to the Free Software Foundation *
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
#include "cli/agentsetupcommand.hpp"
#include "cli/agentutility.hpp"
#include "cli/featureutility.hpp"
#include "cli/pkiutility.hpp"
#include "config/configcompilercontext.hpp"
#include "config/configcompiler.hpp"
#include "config/configitembuilder.hpp"
#include "base/logger.hpp"
#include "base/console.hpp"
#include "base/application.hpp"
#include "base/dynamictype.hpp"
#include <boost/foreach.hpp>
#include <boost/algorithm/string/classification.hpp>
#include <boost/algorithm/string/join.hpp>
#include <boost/algorithm/string/replace.hpp>
#include <boost/algorithm/string/split.hpp>
#include <iostream>
#include <fstream>
#include <vector>
using namespace icinga;
namespace po = boost::program_options;
REGISTER_CLICOMMAND("agent/setup", AgentSetupCommand);
String AgentSetupCommand::GetDescription(void) const
{
return "Sets up an Icinga 2 agent.";
}
String AgentSetupCommand::GetShortDescription(void) const
{
return "set up agent";
}
void AgentSetupCommand::InitParameters(boost::program_options::options_description& visibleDesc,
boost::program_options::options_description& hiddenDesc) const
{
visibleDesc.add_options()
("zone", po::value<std::string>(), "The name of the local zone")
("master_zone", po::value<std::string>(), "The name of the master zone")
("master_host", po::value<std::string>(), "The name of the master host for auto-signing the csr")
("endpoint", po::value<std::vector<std::string> >(), "Connect to remote endpoint(s) on host,port")
("listen", po::value<std::string>(), "Listen on host,port")
("ticket", po::value<std::string>(), "Generated ticket number for this request")
("trustedcert", po::value<std::string>(), "Trusted master certificate file")
("cn", po::value<std::string>(), "The certificate's common name")
("master", "Use setup for a master instance");
}
std::vector<String> AgentSetupCommand::GetArgumentSuggestions(const String& argument, const String& word) const
{
if (argument == "key" || argument == "cert" || argument == "trustedcert")
return GetBashCompletionSuggestions("file", word);
else if (argument == "host")
return GetBashCompletionSuggestions("hostname", word);
else if (argument == "port")
return GetBashCompletionSuggestions("service", word);
else
return CLICommand::GetArgumentSuggestions(argument, word);
}
/**
* The entry point for the "agent setup" CLI command.
*
* @returns An exit status.
*/
int AgentSetupCommand::Run(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap) const
{
if (!ap.empty()) {
Log(LogWarning, "cli")
<< "Ignoring parameters: " << boost::algorithm::join(ap, " ");
}
if (vm.count("master")) {
return SetupMaster(vm, ap);
} else {
return SetupAgent(vm, ap);
}
return 0;
}
int AgentSetupCommand::SetupMaster(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap)
{
/*
* 0. Ignore not required parameters
*/
if (vm.count("ticket"))
Log(LogWarning, "cli", "Master for Agent setup: Ignoring --ticket");
if (vm.count("endpoint"))
Log(LogWarning, "cli", "Master for Agent setup: Ignoring --endpoint");
if (vm.count("trustedcert"))
Log(LogWarning, "cli", "Master for Agent setup: Ignoring --trustedcert");
/*
* 1. Generate a new CA, if not already existing
*/
Log(LogInformation, "cli")
<< "Generating new CA.";
if (PkiUtility::NewCa() > 0) {
Log(LogWarning, "cli", "Found CA, skipping and using the existing one.");
}
/*
* 2. Generate a self signed certificate
*/
Log(LogInformation, "cli", "Generating new self-signed certificate.");
String local_pki_path = PkiUtility::GetLocalPkiPath();
if (!Utility::MkDirP(local_pki_path, 0700)) {
Log(LogCritical, "cli")
<< "Could not create local pki directory '" << local_pki_path << "'.";
return 1;
}
String cn = Utility::GetFQDN();
if (vm.count("cn"))
cn = vm["cn"].as<std::string>();
String key = local_pki_path + "/" + cn + ".key";
String cert = local_pki_path + "/" + cn + ".crt";
String ca = PkiUtility::GetLocalCaPath() + "/ca.crt";
if (PkiUtility::NewCert(cn, key, Empty, cert) > 0) {
Log(LogCritical, "cli", "Failed to create self-signed certificate");
}
/*
* 3. Copy certificates to /etc/icinga2/pki
*/
String pki_path = PkiUtility::GetPkiPath();
Log(LogInformation, "cli")
<< "Copying generated certificates to " << pki_path << ".";
String target_key = pki_path + "/" + cn + ".key";
String target_cert = pki_path + "/" + cn + ".crt";
String target_ca = pki_path + "/ca.crt";
/* does not overwrite existing files! */
Utility::CopyFile(key, target_key);
Utility::CopyFile(cert, target_cert);
Utility::CopyFile(ca, target_ca);
/*
* 4. read zones.conf and update with zone + endpoint information
*/
Log(LogInformation, "cli", "Generating zone and object configuration.");
AgentUtility::GenerateAgentMasterIcingaConfig(cn);
/*
* 5. enable the ApiListener config (verifiy its data)
*/
Log(LogInformation, "cli", "Enabling the APIListener feature.");
String api_path = FeatureUtility::GetFeaturesEnabledPath() + "/api.conf";
//TODO: verify that the correct attributes are set on the ApiListener object
//by reading the configuration (CompileFile) and fetching the object
std::vector<std::string> enable;
enable.push_back("api");
FeatureUtility::EnableFeatures(enable);
//TODO read --listen and set that as bind_host,port on ApiListener
/*
* 6. tell the user to set a safe salt in api.conf
*/
Log(LogInformation, "cli")
<< "Edit the api feature config file '" << api_path << "' and set a secure 'ticket_salt' attribute.";
/*
* 7. tell the user to reload icinga2
*/
Log(LogInformation, "cli", "Make sure to restart Icinga 2.");
return 0;
}
int AgentSetupCommand::SetupAgent(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap)
{
/*
* 1. require ticket number (generated on master)
*/
if (!vm.count("ticket")) {
Log(LogCritical, "cli")
<< "Please pass the ticket number generated on master\n"
<< "(Hint: 'icinga2 pki ticket --cn <masterhost> --salt <ticket_salt>').";
return 1;
}
String ticket = vm["ticket"].as<std::string>();
Log(LogInformation, "cli")
<< "Verifying ticket '" << ticket << "'.";
/*
* 2. require master host information for auto-signing requests
*/
if (!vm.count("master_host")) {
Log(LogCritical, "cli")
<< "Please pass the master host connection information for auto-signing using '--master_host <host>'";
return 1;
}
std::vector<String> tokens;
boost::algorithm::split(tokens, vm["master_host"].as<std::string>(), boost::is_any_of(","));
String master_host;
String master_port = "5665";
if (tokens.size() == 1 || tokens.size() == 2)
master_host = tokens[0];
if (tokens.size() == 2)
master_port = tokens[1];
Log(LogInformation, "cli")
<< "Verifying master host connection information: host '" << master_host << "', port '" << master_port << "'.";
/*
* 3. trusted cert must be passed (retrieved by the user with 'pki save-cert' before)
*/
if (!vm.count("trustedcert")) {
Log(LogCritical, "cli")
<< "Please pass the trusted cert retrieved from the master\n"
<< "(Hint: 'icinga2 pki save-cert --host <masterhost> --port <5665> --key local.key --cert local.crt --trustedcert master.crt').";
return 1;
}
String trustedcert = vm["trustedcert"].as<std::string>();
Log(LogInformation, "cli")
<< "Verifying trusted certificate from file '" << trustedcert << "'.";
/*
* 4. retrieve CN and pass it (defaults to FQDN)
*/
String cn = Utility::GetFQDN();
if (vm.count("cn"))
cn = vm["cn"].as<std::string>();
Log(LogInformation, "cli")
<< "Using the following CN (defaults to FQDN): '" << cn << "'.";
/*
* 4. pki request a signed certificate from the master
* Requires local ca & key/crt
*/
String local_pki_path = PkiUtility::GetLocalPkiPath();
String key = local_pki_path + "/" + cn + ".key";
String cert = local_pki_path + "/" + cn + ".crt";
String ca = PkiUtility::GetLocalCaPath() + "/ca.crt";
//TODO: local CA or any other one?
if (!Utility::PathExists(ca)) {
Log(LogCritical, "cli")
<< "CA file '" << ca << "' does not exist. Please generate a new CA first.\n"
<< "Hist: 'icinga2 pki new-ca'";
return 1;
}
if (!Utility::PathExists(key)) {
Log(LogCritical, "cli")
<< "Private key file '" << key << "' does not exist. Please generate a new certificate first.\n"
<< "Hist: 'icinga2 pki new-cert'";
return 1;
}
if (!Utility::PathExists(cert)) {
Log(LogCritical, "cli")
<< "Cert file '" << cert << "' does not exist. Please generate a new certificate first.\n"
<< "Hist: 'icinga2 pki new-cert'";
return 1;
}
String pki_path = PkiUtility::GetPkiPath();
Log(LogInformation, "cli", "Requesting a signed certificate from the master.");
String port = "5665";
PkiUtility::RequestCertificate(master_host, master_port, key, cert, ca, trustedcert, ticket);
/*
* 5. get public key signed by the master, private key and ca.crt and copy it to /etc/icinga2/pki
*/
//Log(LogInformation, "cli")
// << "Copying retrieved signed certificate, private key and ca.crt to pki path '" << pki_path << "'.";
//std::cout << ConsoleColorTag(Console_ForegroundRed | Console_Bold) << "PLACEHOLDER" << ConsoleColorTag(Console_Normal) << std::endl;
/*
* 6. enable the ApiListener config (verifiy its data)
*/
Log(LogInformation, "cli")
<< "Enabling the APIListener feature.";
std::vector<std::string> enable;
enable.push_back("api");
FeatureUtility::EnableFeatures(enable);
String api_path = FeatureUtility::GetFeaturesEnabledPath() + "/api.conf";
//TODO: verify that the correct attributes are set on the ApiListener object
//by reading the configuration (CompileFile) and fetching the object
/*
ConfigCompilerContext::GetInstance()->Reset();
ConfigCompiler::CompileFile(api_path);
DynamicType::Ptr dt = DynamicType::GetByName("ApiListener");
BOOST_FOREACH(const DynamicObject::Ptr& object, dt->GetObjects()) {
std::cout << JsonSerialize(object) << std::endl;
}*/
//TODO read --listen and set that as bind_host,port on ApiListener
/*
* 7. generate local zones.conf with zone+endpoint
*/
Log(LogInformation, "cli", "Generating zone and object configuration.");
std::vector<std::string> endpoints;
if (vm.count("endpoint")) {
endpoints = vm["endpoint"].as<std::vector<std::string> >();
} else {
endpoints.push_back("master-noconnect"); //no endpoint means no connection attempt. fake name required for master endpoint name
}
AgentUtility::GenerateAgentIcingaConfig(endpoints, cn);
/*
* 8. update constants.conf with NodeName = CN
*/
if (cn != Utility::GetFQDN()) {
Log(LogWarning, "cli")
<< "CN '" << cn << "' does not match the default FQDN '" << Utility::GetFQDN() << "'. Requires update for NodeName constant in constants.conf!";
}
//Log(LogInformation, "cli")
// << "Updating configuration with NodeName constant.";
//TODO requires parsing of constants.conf, editing the entry and dumping it again?
/*
* 9. tell the user to reload icinga2
*/
Log(LogInformation, "cli", "Make sure to restart Icinga 2.");
return 0;
}