openbmc/phosphor-certificate-manager/certs_manager.hpp

44      *         - Default constructor is not possible due to member
46      *         - Move operations due to 'this' being registered as the
49      *         - copy
50      *         - Destructor.
60      *  @param[in] bus - Bus to attach to.
61      *  @param[in] event - sd event handler.
62      *  @param[in] path - Path to attach at.
63      *  @param[in] type - Type of the certificate.
64      *  @param[in] unit - Unit consumed by this certificate.
65      *  @param[in] installPath - Certificate installation path.
75      *  @param[in] filePath - Certificate key file path.
84      *  @param[in] path - Path of the file that contains a list of root
87      *  @return D-Bus object path to created objects.
95      *  @param[in] path - Path of file that contains multiple root certificates.
97      *  @return D-Bus object path to created objects.
121      *  @param[in] alternativeNames - Additional hostnames of the component that
123      *  @param[in] challengePassword - The challenge password to be applied to
125      *  @param[in] city - The city or locality of the organization making the
127      *  @param[in] commonName - The fully qualified domain name of the component
129      *  @param[in] contactPerson - The name of the user making the request.
130      *  @param[in] country - The country of the organization making the request.
131      *  @param[in] email - The email address of the contact within the
133      *  @param[in] givenName - The given name of the user making the request.
134      *  @param[in] initials - The initials of the user making the request.
135      *  @param[in] keyBitLength - The length of the key in bits, if needed based
137      *  @param[in] keyCurveId - The curve ID to be used with the key, if needed
139      *  @param[in] keyPairAlgorithm - The type of key pair for use with signing
140      *      algorithms. Valid built-in algorithm names for private key
142      *  @param[in] keyUsage - Key usage extensions define the purpose of the
145      *      - ClientAuthentication: The public key is used for TLS WWW client
147      *      - CodeSigning: The public key is used for the signing of executable
149      *      - CRLSigning: The public key is used for verifying signatures on
151      *      - DataEncipherment: The public key is used for directly enciphering
152      *          raw user data without the use of an intermediate symmetric
154      *      - DecipherOnly: The public key could be used for deciphering data
156      *      - DigitalSignature: The public key is used for verifying digital
158      *      - EmailProtection: The public key is used for email protection.
159      *      - EncipherOnly: Thepublic key could be used for enciphering data
161      *      - KeyCertSign: The public key is used for verifying signatures on
163      *      - KeyEncipherment: The public key is used for enciphering private or
165      *      - NonRepudiation: The public key is used to verify digital
167      *          used to provide a non-repudiation service that protects against
169      *      - OCSPSigning: The public key is used for signing OCSP responses.
170      *      - ServerAuthentication: The public key is used for TLS WWW server
172      *      - Timestamping: The public key is used for binding the hash of an
174      *  @param[in] organization - The legal name of the organization. This
177      *  @param[in] organizationalUnit - The name of the unit or division of the
179      *  @param[in] state - The state or province where the organization is
181      *  @param[in] surname - The surname of the user making the request.
182      *  @param[in] unstructuredName - The unstructured name of the subject.
184      *  @return path[std::string] - The object path of the D-Bus object
206      *  @param[in] unit - service need to reload.
222      *  @param[in]  keyBitLength - KeyBit length.
229      *  @param[in]  p_KeyCurveId - Curve ID
237      *  @param[in] pKey     - pointer to private key
238      *  @param[in] privKeyFileName - private key filename
245      *  @param[in] x509Name - Structure used in setting certificate properties
246      *  @param[in] field - field name
247      *  @param[in] bytes - field value in bytes
253      *  @param[in] usage - key usage value
258     /** @brief Create CSR D-Bus object by reading the data in the CSR file
259      *  @param[in] statis - SUCCESS/FAILURE In CSR generation.
265      *  @param[in] filePath - CSR file path.
266      *  @param[in] x509Req - OpenSSL Request Pointer.
284      *  @param[in]  keyBitLength - Key bit length
297      *  @param[in] certFilePath - Path to the file with certificate for
299      *  @param[in] certToDrop - Pointer to the certificate from the internal