openbmc/phosphor-certificate-manager/certificate.hpp

9 #include <xyz/openbmc_project/Certs/Certificate/server.hpp>
22 // Certificate types
66     sdbusplus::xyz::openbmc_project::Certs::server::Certificate,
74 class Manager; // Forward declaration for Certificate Manager.
76 /** @class Certificate
77  *  @brief OpenBMC Certificate entry implementation.
79  *  xyz.openbmc_project.Certs.Certificate DBus API
82 class Certificate : public internal::CertificateInterface  class
85     Certificate() = delete;
86     Certificate(const Certificate&) = delete;
87     Certificate& operator=(const Certificate&) = delete;
88     Certificate(Certificate&&) = delete;
89     Certificate& operator=(Certificate&&) = delete;
90     virtual ~Certificate();
92     /** @brief Constructor for the Certificate Object
95      *  @param[in] type - Type of the certificate
96      *  @param[in] installPath - Path of the certificate to install
97      *  @param[in] uploadPath - Path of the certificate file to upload
98      *  @param[in] watchPtr - watch on self signed certificate
99      *  @param[in] parent - the manager that owns the certificate
100      *  @param[in] restore - the certificate is created in the restore path
102     Certificate(sdbusplus::bus_t& bus, const std::string& objPath,
107     /** @brief Constructor for the Certificate Object; a variant for authorities
111      *  @param[in] type - Type of the certificate
112      *  @param[in] installPath - Path of the certificate to install
113      *  @param[in] x509Store - an initialized X509 store used for certificate
114      * validation; Certificate object doesn't own it
115      *  @param[in] pem - Content of the certificate file to upload; it shall be
116      * a single PEM encoded x509 certificate
117      *  @param[in] watchPtr - watch on self signed certificate
119      * Certificate object
120      *  @param[in] restore - the certificate is created in the restore path
122     Certificate(sdbusplus::bus_t& bus, const std::string& objPath,
127     /** @brief Validate and Replace/Install the certificate file
128      *  Install/Replace the existing certificate file with another
129      *  (possibly CA signed) Certificate file.
130      *  @param[in] filePath - Certificate file path.
131      *  @param[in] restore - the certificate is created in the restore path
135     /** @brief Validate and Replace/Install the certificate file
136      *  Install/Replace the existing certificate file with another
137      *  (possibly CA signed) Certificate file.
138      *  @param[in] x509Store - an initialized X509 store used for certificate
139      * validation; Certificate object doesn't own it
140      *  @param[in] pem - a string buffer which stores a PEM encoded certificate.
141      *  @param[in] restore - the certificate is created in the restore path
145     /** @brief Validate certificate and replace the existing certificate
146      *  @param[in] filePath - Certificate file path.
150     /** @brief Populate certificate properties by parsing certificate file
155      * @brief Obtain certificate ID.
157      * @return Certificate ID.
162      * @brief Check if provided certificate is the same as the current one.
164      * @param[in] certPath - File path for certificate to check.
172      * @brief Update certificate storage.
177      * @brief Delete the certificate
191      * @brief Copies the certificate from sourceFilePath to installFilePath
221      * @brief Populate certificate properties by parsing given certificate
224      * @param[in] cert The given certificate object
230     /** @brief Check and append private key to the certificate file
231      *         If private key is not present in the certificate file append the
232      *         certificate file with private key existing in the system.
233      *  @param[in] filePath - Certificate and key full file path.
239      *         Comparing private key against certificate public key
241      *  @param[in] filePath - Certificate and key full file path.
248      * @brief Generate authority certificate file path corresponding with
251      * Prepare authority certificate file path for provided certificate.
252      * OpenSSL puts some restrictions on the certificate file name pattern.
253      * Certificate full file name needs to consists of basic file name which
254      * is certificate subject name hash and file name extension which is an
261      * @param[in] certSrcFilePath - Certificate source file path.
262      * @param[in] certDstDirPath - Certificate destination directory path.
264      * @return Authority certificate file path.
270      * @brief Generate authority certificate file path based on provided
271      * certificate source file path.
273      * @param[in] certSrcFilePath - Certificate source file path.
275      * @return Authority certificate file path.
280      * @brief Generate certificate file path based on provided certificate
283      * @param[in] certSrcFilePath - Certificate source file path.
285      * @return Certificate file path.
295     /** @brief Type of the certificate */
298     /** @brief Stores certificate ID */
301     /** @brief Stores certificate file path */
304     /** @brief Certificate file installation path */
311     /** @brief Certificate file create/update watch
312      * Note that Certificate object doesn't own the pointer
316     /** @brief Reference to Certificate Manager */