diff options
author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2022-03-15 18:40:32 +0100 |
---|---|---|
committer | Dr. David von Oheimb <dev@ddvo.net> | 2022-03-18 20:20:12 +0100 |
commit | 92cae9b42de1eec3da7ef6ccb36188ff61f3e0df (patch) | |
tree | 084dc67ed20f1da20001fd61e05123d35fb87669 /doc | |
parent | 52a42f54eb9afb599d32c85100d59db46c23ffcc (diff) |
OSSL_CMP_CTX_new.pod: make references to private key consistent with OSSL_CMP_MSG_get0_header.pod
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: David von Oheimb <david.von.oheimb@siemens.com>
(Merged from https://github.com/openssl/openssl/pull/17887)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/OSSL_CMP_CTX_new.pod | 8 | ||||
-rw-r--r-- | doc/man3/OSSL_CMP_MSG_get0_header.pod | 3 |
2 files changed, 6 insertions, 5 deletions
diff --git a/doc/man3/OSSL_CMP_CTX_new.pod b/doc/man3/OSSL_CMP_CTX_new.pod index f40c9a0f93..ac60ac650c 100644 --- a/doc/man3/OSSL_CMP_CTX_new.pod +++ b/doc/man3/OSSL_CMP_CTX_new.pod @@ -248,7 +248,7 @@ The following options can be set: ("indirect method") Note that a signature-based POPO can only be produced if a private key - is provided as the newPkey or client pkey component of the CMP context. + is provided as the newPkey or client's pkey component of the CMP context. =item B<OSSL_CMP_OPT_DIGEST_ALGNID> @@ -449,7 +449,7 @@ The reference counts of those certificates handled successfully are increased. OSSL_CMP_CTX_get0_untrusted(OSSL_CMP_CTX *ctx) returns a pointer to the list of untrusted certs, which may be empty if unset. -OSSL_CMP_CTX_set1_cert() sets the certificate related to the private key +OSSL_CMP_CTX_set1_cert() sets the certificate related to the client's private key used for CMP message protection. Therefore the public key of this I<cert> must correspond to the private key set before or thereafter via OSSL_CMP_CTX_set1_pkey(). @@ -477,7 +477,7 @@ Calling this function is optional; by default a chain construction is performed on demand that is equivalent to calling this function with the I<candidates> and I<own_trusted> arguments being NULL. -OSSL_CMP_CTX_set1_pkey() sets the private key corresponding to the +OSSL_CMP_CTX_set1_pkey() sets the client's private key corresponding to the CMP signer certificate set via OSSL_CMP_CTX_set1_cert(). This key is used create signature-based protection (protectionAlg = MSG_SIG_ALG) of outgoing messages @@ -528,7 +528,7 @@ The I<priv> parameter must be 0 if and only if the given key is a public key. OSSL_CMP_CTX_get0_newPkey() gives the key to use for certificate enrollment dependent on fields of the CMP context structure: the newPkey (which may be a private or public key) if present, -else the public key in the p10CSR if present, else the client private key. +else the public key in the p10CSR if present, else the client's private key. If the I<priv> parameter is not 0 and the selected key does not have a private component then NULL is returned. diff --git a/doc/man3/OSSL_CMP_MSG_get0_header.pod b/doc/man3/OSSL_CMP_MSG_get0_header.pod index 6bc0d26188..113dea06b5 100644 --- a/doc/man3/OSSL_CMP_MSG_get0_header.pod +++ b/doc/man3/OSSL_CMP_MSG_get0_header.pod @@ -65,7 +65,8 @@ The public key included is the first available value of these: =item the public key of any reference certificate given in I<ctx>, or -=item the public key derived from any client private key set via L<OSSL_CMP_CTX_set1_pkey(3)>. +=item the public key derived from any client's private key +set via L<OSSL_CMP_CTX_set1_pkey(3)>. =back |