Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Marri Devender Rao | ffad1ef | 2019-06-03 04:54:12 -0500 | [diff] [blame] | 3 | #include "watch.hpp" |
| 4 | |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 5 | #include <openssl/x509.h> |
| 6 | |
| 7 | #include <filesystem> |
| 8 | #include <phosphor-logging/elog.hpp> |
Marri Devender Rao | edd1131 | 2019-02-27 08:45:10 -0600 | [diff] [blame] | 9 | #include <xyz/openbmc_project/Certs/Certificate/server.hpp> |
Marri Devender Rao | 13bf74e | 2019-03-26 01:52:17 -0500 | [diff] [blame] | 10 | #include <xyz/openbmc_project/Certs/Replace/server.hpp> |
Zbigniew Kurzynski | a3bb38f | 2019-09-17 13:34:25 +0200 | [diff] [blame] | 11 | #include <xyz/openbmc_project/Object/Delete/server.hpp> |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 12 | |
| 13 | namespace phosphor |
| 14 | { |
| 15 | namespace certs |
| 16 | { |
Zbigniew Kurzynski | a3bb38f | 2019-09-17 13:34:25 +0200 | [diff] [blame] | 17 | using DeleteIface = sdbusplus::xyz::openbmc_project::Object::server::Delete; |
Marri Devender Rao | edd1131 | 2019-02-27 08:45:10 -0600 | [diff] [blame] | 18 | using CertificateIface = sdbusplus::server::object::object< |
| 19 | sdbusplus::xyz::openbmc_project::Certs::server::Certificate>; |
Marri Devender Rao | 13bf74e | 2019-03-26 01:52:17 -0500 | [diff] [blame] | 20 | using ReplaceIface = sdbusplus::xyz::openbmc_project::Certs::server::Replace; |
Zbigniew Kurzynski | a3bb38f | 2019-09-17 13:34:25 +0200 | [diff] [blame] | 21 | using CertIfaces = sdbusplus::server::object::object<CertificateIface, |
| 22 | ReplaceIface, DeleteIface>; |
Marri Devender Rao | edd1131 | 2019-02-27 08:45:10 -0600 | [diff] [blame] | 23 | |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 24 | using CertificateType = std::string; |
| 25 | using UnitsToRestart = std::string; |
| 26 | using CertInstallPath = std::string; |
| 27 | using CertUploadPath = std::string; |
| 28 | using InputType = std::string; |
| 29 | using InstallFunc = std::function<void(const std::string&)>; |
Marri Devender Rao | cd30c49 | 2019-06-12 01:40:17 -0500 | [diff] [blame] | 30 | using AppendPrivKeyFunc = std::function<void(const std::string&)>; |
Marri Devender Rao | ffad1ef | 2019-06-03 04:54:12 -0500 | [diff] [blame] | 31 | using CertWatchPtr = std::unique_ptr<Watch>; |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 32 | using namespace phosphor::logging; |
| 33 | |
| 34 | // for placeholders |
| 35 | using namespace std::placeholders; |
| 36 | namespace fs = std::filesystem; |
| 37 | |
Zbigniew Kurzynski | a3bb38f | 2019-09-17 13:34:25 +0200 | [diff] [blame] | 38 | class Manager; // Forward declaration for Certificate Manager. |
| 39 | |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 40 | // Supported Types. |
| 41 | static constexpr auto SERVER = "server"; |
| 42 | static constexpr auto CLIENT = "client"; |
| 43 | static constexpr auto AUTHORITY = "authority"; |
| 44 | |
| 45 | // RAII support for openSSL functions. |
| 46 | using X509_Ptr = std::unique_ptr<X509, decltype(&::X509_free)>; |
Kowalski, Kamil | db029c9 | 2019-07-08 17:09:39 +0200 | [diff] [blame] | 47 | using X509_STORE_CTX_Ptr = |
| 48 | std::unique_ptr<X509_STORE_CTX, decltype(&::X509_STORE_CTX_free)>; |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 49 | |
| 50 | /** @class Certificate |
| 51 | * @brief OpenBMC Certificate entry implementation. |
| 52 | * @details A concrete implementation for the |
| 53 | * xyz.openbmc_project.Certs.Certificate DBus API |
| 54 | * xyz.openbmc_project.Certs.Instal DBus API |
| 55 | */ |
Marri Devender Rao | edd1131 | 2019-02-27 08:45:10 -0600 | [diff] [blame] | 56 | class Certificate : public CertIfaces |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 57 | { |
| 58 | public: |
| 59 | Certificate() = delete; |
| 60 | Certificate(const Certificate&) = delete; |
| 61 | Certificate& operator=(const Certificate&) = delete; |
| 62 | Certificate(Certificate&&) = delete; |
| 63 | Certificate& operator=(Certificate&&) = delete; |
| 64 | virtual ~Certificate(); |
| 65 | |
| 66 | /** @brief Constructor for the Certificate Object |
| 67 | * @param[in] bus - Bus to attach to. |
| 68 | * @param[in] objPath - Object path to attach to |
| 69 | * @param[in] type - Type of the certificate |
| 70 | * @param[in] unit - Units to restart after a certificate is installed |
| 71 | * @param[in] installPath - Path of the certificate to install |
| 72 | * @param[in] uploadPath - Path of the certificate file to upload |
Marri Devender Rao | 8f80c35 | 2019-05-13 00:53:01 -0500 | [diff] [blame] | 73 | * @param[in] isSkipUnitReload - If true do not restart units |
Marri Devender Rao | ffad1ef | 2019-06-03 04:54:12 -0500 | [diff] [blame] | 74 | * @param[in] watchPtr - watch on self signed certificate pointer |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 75 | */ |
| 76 | Certificate(sdbusplus::bus::bus& bus, const std::string& objPath, |
| 77 | const CertificateType& type, const UnitsToRestart& unit, |
| 78 | const CertInstallPath& installPath, |
Marri Devender Rao | ffad1ef | 2019-06-03 04:54:12 -0500 | [diff] [blame] | 79 | const CertUploadPath& uploadPath, bool isSkipUnitReload, |
Zbigniew Kurzynski | a3bb38f | 2019-09-17 13:34:25 +0200 | [diff] [blame] | 80 | const CertWatchPtr& watchPtr, Manager& parent); |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 81 | |
Marri Devender Rao | 13bf74e | 2019-03-26 01:52:17 -0500 | [diff] [blame] | 82 | /** @brief Validate certificate and replace the existing certificate |
| 83 | * @param[in] filePath - Certificate file path. |
| 84 | */ |
| 85 | void replace(const std::string filePath) override; |
| 86 | |
Marri Devender Rao | ffad1ef | 2019-06-03 04:54:12 -0500 | [diff] [blame] | 87 | /** @brief Populate certificate properties by parsing certificate file |
| 88 | * @return void |
| 89 | */ |
| 90 | void populateProperties(); |
| 91 | |
Kowalski, Kamil | db029c9 | 2019-07-08 17:09:39 +0200 | [diff] [blame] | 92 | /** |
| 93 | * @brief Obtain certificate's subject hash |
| 94 | * |
| 95 | * @return certificate's subject hash |
| 96 | */ |
| 97 | const std::string& getHash() const; |
| 98 | |
Zbigniew Kurzynski | a3bb38f | 2019-09-17 13:34:25 +0200 | [diff] [blame] | 99 | /** |
| 100 | * @brief Delete the certificate |
| 101 | */ |
| 102 | void delete_() override; |
| 103 | |
Marri Devender Rao | 13bf74e | 2019-03-26 01:52:17 -0500 | [diff] [blame] | 104 | private: |
Kowalski, Kamil | db029c9 | 2019-07-08 17:09:39 +0200 | [diff] [blame] | 105 | /** |
| 106 | * @brief Populate certificate properties by parsing given certificate file |
| 107 | * |
| 108 | * @param[in] certPath Path to certificate that should be parsed |
| 109 | * |
| 110 | * @return void |
| 111 | */ |
| 112 | void populateProperties(const std::string& certPath); |
| 113 | |
Marri Devender Rao | 13bf74e | 2019-03-26 01:52:17 -0500 | [diff] [blame] | 114 | /** @brief Validate and Replace/Install the certificate file |
| 115 | * Install/Replace the existing certificate file with another |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 116 | * (possibly CA signed) Certificate file. |
| 117 | * @param[in] filePath - Certificate file path. |
Marri Devender Rao | 8f80c35 | 2019-05-13 00:53:01 -0500 | [diff] [blame] | 118 | * @param[in] isSkipUnitReload - If true do not restart units |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 119 | */ |
Marri Devender Rao | 8f80c35 | 2019-05-13 00:53:01 -0500 | [diff] [blame] | 120 | void install(const std::string& filePath, bool isSkipUnitReload); |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 121 | |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 122 | /** @brief Load Certificate file into the X509 structre. |
Marri Devender Rao | cd30c49 | 2019-06-12 01:40:17 -0500 | [diff] [blame] | 123 | * @param[in] filePath - Certificate and key full file path. |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 124 | * @return pointer to the X509 structure. |
| 125 | */ |
| 126 | X509_Ptr loadCert(const std::string& filePath); |
| 127 | |
Marri Devender Rao | cd30c49 | 2019-06-12 01:40:17 -0500 | [diff] [blame] | 128 | /** @brief Check and append private key to the certificate file |
| 129 | * If private key is not present in the certificate file append the |
| 130 | * certificate file with private key existing in the system. |
| 131 | * @param[in] filePath - Certificate and key full file path. |
| 132 | * @return void. |
| 133 | */ |
| 134 | void checkAndAppendPrivateKey(const std::string& filePath); |
| 135 | |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 136 | /** @brief Public/Private key compare function. |
| 137 | * Comparing private key against certificate public key |
| 138 | * from input .pem file. |
Marri Devender Rao | cd30c49 | 2019-06-12 01:40:17 -0500 | [diff] [blame] | 139 | * @param[in] filePath - Certificate and key full file path. |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 140 | * @return Return true if Key compare is successful, |
| 141 | * false if not |
| 142 | */ |
| 143 | bool compareKeys(const std::string& filePath); |
Marri Devender Rao | cd30c49 | 2019-06-12 01:40:17 -0500 | [diff] [blame] | 144 | |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 145 | /** @brief systemd unit reload or reset helper function |
| 146 | * Reload if the unit supports it and use a restart otherwise. |
| 147 | * @param[in] unit - service need to reload. |
| 148 | */ |
| 149 | void reloadOrReset(const UnitsToRestart& unit); |
| 150 | |
Kowalski, Kamil | db029c9 | 2019-07-08 17:09:39 +0200 | [diff] [blame] | 151 | /** |
| 152 | * @brief Extracts subject hash |
| 153 | * |
| 154 | * @param[in] storeCtx Pointer to X509_STORE_CTX containing certificate |
| 155 | * |
| 156 | * @return Subject hash as formatted string |
| 157 | */ |
| 158 | static inline std::string |
| 159 | getSubjectHash(const X509_STORE_CTX_Ptr& storeCtx); |
| 160 | |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 161 | /** @brief Type specific function pointer map **/ |
| 162 | std::unordered_map<InputType, InstallFunc> typeFuncMap; |
| 163 | |
| 164 | /** @brief sdbusplus handler */ |
| 165 | sdbusplus::bus::bus& bus; |
| 166 | |
| 167 | /** @brief object path */ |
| 168 | std::string objectPath; |
| 169 | |
| 170 | /** @brief Type of the certificate **/ |
| 171 | CertificateType certType; |
| 172 | |
| 173 | /** @brief Unit name associated to the service **/ |
| 174 | UnitsToRestart unitToRestart; |
| 175 | |
| 176 | /** @brief Certificate file installation path **/ |
| 177 | CertInstallPath certInstallPath; |
Marri Devender Rao | ffad1ef | 2019-06-03 04:54:12 -0500 | [diff] [blame] | 178 | |
Marri Devender Rao | cd30c49 | 2019-06-12 01:40:17 -0500 | [diff] [blame] | 179 | /** @brief Type specific function pointer map for appending private key */ |
| 180 | std::unordered_map<InputType, AppendPrivKeyFunc> appendKeyMap; |
| 181 | |
Marri Devender Rao | ffad1ef | 2019-06-03 04:54:12 -0500 | [diff] [blame] | 182 | /** @brief Certificate file create/update watch */ |
| 183 | const CertWatchPtr& certWatchPtr; |
Kowalski, Kamil | db029c9 | 2019-07-08 17:09:39 +0200 | [diff] [blame] | 184 | |
| 185 | /** @brief Stores certificate subject hash */ |
| 186 | std::string certHash; |
Zbigniew Kurzynski | a3bb38f | 2019-09-17 13:34:25 +0200 | [diff] [blame] | 187 | |
| 188 | /** @brief Reference to Certificate Manager */ |
| 189 | Manager& manager; |
Marri Devender Rao | 6ceec40 | 2019-02-01 03:15:19 -0600 | [diff] [blame] | 190 | }; |
| 191 | |
| 192 | } // namespace certs |
| 193 | } // namespace phosphor |