]> granicus.if.org Git - icinga2/commitdiff
Implemented cli command + documentation.
authorAndrew Jaffie <ajaffie@gmail.com>
Fri, 27 Jul 2018 22:25:33 +0000 (18:25 -0400)
committerMichael Friedrich <michael.friedrich@icinga.com>
Fri, 7 Jun 2019 08:33:55 +0000 (10:33 +0200)
doc/06-distributed-monitoring.md
doc/11-cli-commands.md
lib/cli/CMakeLists.txt
lib/cli/caremovecommand.cpp [new file with mode: 0644]
lib/cli/caremovecommand.hpp [new file with mode: 0644]

index dca0aea9546e6934db6d46d7bcede87e8574595a..41e0468fdd04b63bddf52ab07322d6f128c9918e 100644 (file)
@@ -451,6 +451,14 @@ information/cli: Signed certificate for 'CN = icinga2-client2.localdomain'.
 > `ca list` cannot be used as historical inventory. Certificate
 > signing requests older than 1 week are automatically deleted.
 
+You can also remove an undesired CSR using the `ca remove` command using the
+syntax as the `ca sign` command.
+
+```
+[root@pym ~]# icinga2 ca remove 5c31ca0e2269c10363a97e40e3f2b2cd56493f9194d5b1852541b835970da46e
+information/cli: Certificate 5c31ca0e2269c10363a97e40e3f2b2cd56493f9194d5b1852541b835970da46e removed.
+```
+
 ## Client/Satellite Setup <a id="distributed-monitoring-setup-satellite-client"></a>
 
 This section describes the setup of a satellite and/or client connected to an
index dff5bc39023e9a959033e2b9f7067c115054bfd6..f9197f0ee6a527eef32363c573423b10666c2501 100644 (file)
@@ -21,6 +21,7 @@ Usage:
 Supported commands:
   * api setup (setup for API)
   * ca list (lists all certificate signing requests)
+  * ca remove (removes an outstanding certificate request)  
   * ca sign (signs an outstanding certificate request)
   * console (Icinga debug console)
   * daemon (starts Icinga 2)
index 7a5e9188751f134fcf612d0d7309d32f7402a39a..980429171ceb0625d64f50c6af516c2f7a08b9d3 100644 (file)
@@ -5,6 +5,7 @@ set(cli_SOURCES
   apisetupcommand.cpp apisetupcommand.hpp
   apisetuputility.cpp apisetuputility.hpp
   calistcommand.cpp calistcommand.hpp
+  caremovecommand.cpp caremovecommand.hpp
   casigncommand.cpp casigncommand.hpp
   clicommand.cpp clicommand.hpp
   consolecommand.cpp consolecommand.hpp
diff --git a/lib/cli/caremovecommand.cpp b/lib/cli/caremovecommand.cpp
new file mode 100644 (file)
index 0000000..ab6e0f8
--- /dev/null
@@ -0,0 +1,72 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012-2018 Icinga Development Team (https://www.icinga.com/)  *
+ *                                                                            *
+ * 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/caremovecommand.hpp"
+#include "remote/apilistener.hpp"
+#include "base/logger.hpp"
+#include "base/application.hpp"
+#include "base/tlsutility.hpp"
+
+using namespace icinga;
+
+REGISTER_CLICOMMAND("ca/remove", CARemoveCommand);
+
+String CARemoveCommand::GetDescription() const
+{
+       return "Removes an outstanding certificate request.";
+}
+
+String CARemoveCommand::GetShortDescription() const
+{
+       return "removes an outstanding certificate request";
+}
+
+int CARemoveCommand::GetMinArguments() const
+{
+       return 1;
+}
+
+ImpersonationLevel CARemoveCommand::GetImpersonationLevel() const
+{
+       return ImpersonateIcinga;
+}
+
+/**
+ * The entry point for the "ca remove" CLI command.
+ *
+ * @returns An exit status.
+ */
+int CARemoveCommand::Run(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap) const
+{
+       String requestFile = ApiListener::GetCertificateRequestsDir() + "/" + ap[0] + ".json";
+
+       if (!Utility::PathExists(requestFile)) {
+               Log(LogCritical, "cli")
+                       << "No request exists for fingerprint '" << ap[0] << "'.";
+               return 1;
+       }
+
+       if(remove(requestFile.CStr()) != 0)
+               return 1;
+
+       Log(LogInformation, "cli")
+               << "Certificate " << ap[0] << " removed.";
+
+       return 0;
+}
diff --git a/lib/cli/caremovecommand.hpp b/lib/cli/caremovecommand.hpp
new file mode 100644 (file)
index 0000000..fabfd69
--- /dev/null
@@ -0,0 +1,47 @@
+/******************************************************************************
+ * Icinga 2                                                                   *
+ * Copyright (C) 2012-2018 Icinga Development Team (https://www.icinga.com/)  *
+ *                                                                            *
+ * 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.             *
+ ******************************************************************************/
+
+#ifndef CAREMOVECOMMAND_H
+#define CAREMOVECOMMAND_H
+
+#include "cli/clicommand.hpp"
+
+namespace icinga
+{
+
+/**
+ * The "ca remove" command.
+ *
+ * @ingroup cli
+ */
+class CARemoveCommand final : public CLICommand
+{
+public:
+       DECLARE_PTR_TYPEDEFS(CARemoveCommand);
+
+       String GetDescription() const override;
+       String GetShortDescription() const override;
+       int GetMinArguments() const override;
+       ImpersonationLevel GetImpersonationLevel() const override;
+       int Run(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap) const override;
+};
+
+}
+
+#endif /* CASIGNCOMMAND_H */