openbmc_project/Certs/README.md

1 # BMC Certificate management
5 Certificate management allows to replace the existing certificate and private
7 and private key file. Certificate management allows the user to install both the
12 ### Signed Certificate upload Design flow(Pre-generated)
24     the certificate application handling Certificate Authority certificates.
27 - Certificate manager application also implements d-bus object
34 - Certificate manager scope is limited to manage the certificate and impacted
73 [Certificate Signing Request][csr](CSR) is a message sent from an applicant to a
84   Manager’s Certificate object upload interface. The Upload method internally
94 - CSR based Certificate validation is alway's based on private key in the
113 - Certificate Manager implements "/xyz/openbmc_project/Certs/CSR/Create"
186 ### Redfish Certificate Support
188 #### Certificate Upload
190 - Certificate Manager implements "xyz.openbmc_project.Certs.Install" interface
201   corresponding Certificate Manager D-Bus URI. e.g: HTTPS certificate collection
205   the Certificate Manager.
206 - Certificate Manager "Install" method validates, installs the certificate file
207   and creates a Certificate object.
208 - Certificate Manager initiates Reload of the Bmcweb service to trigger
214   received from the Certificate Manager.
217 - Certificate object D-Bus path mapped to corresponding Redfish certificate URI.
222 #### Certificate Replace
224 - Certificate Object implements "xyz.openbmc_project.Certs.Replace" interface to
228 - Redfish Certificate Collection URI is mapped to corresponding Certificate
232 - Bmcweb receives POST request for Replace Certificate, invokes the Replace
233   D-Bus method of the Certificate object asynchronously.
244 ### Errors thrown by Certificate Manager
251 #### Certificate Deletion