diff options
author | Pauli <pauli@openssl.org> | 2021-07-14 10:03:45 +1000 |
---|---|---|
committer | Pauli <pauli@openssl.org> | 2021-07-15 16:46:18 +1000 |
commit | 8e94c51b3279f7faae9161df5112414f915cd9f3 (patch) | |
tree | 2396fb665ca731d5cf8c97b0bd03de0378dcda4e /doc | |
parent | 56fdb70796010b8db598189d5c1e5a6b1479c2e6 (diff) |
doc: document the params arguments to the initialisation functions.
These were accidentally omitted when the arguments were added globally.
Fixes #16067
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16072)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/EVP_DigestSignInit.pod | 6 | ||||
-rw-r--r-- | doc/man3/EVP_DigestVerifyInit.pod | 6 |
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/man3/EVP_DigestSignInit.pod b/doc/man3/EVP_DigestSignInit.pod index b1eb4ae7e3..8748014465 100644 --- a/doc/man3/EVP_DigestSignInit.pod +++ b/doc/man3/EVP_DigestSignInit.pod @@ -11,7 +11,8 @@ EVP_DigestSignFinal, EVP_DigestSign - EVP signing functions int EVP_DigestSignInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx, const char *mdname, OSSL_LIB_CTX *libctx, - const char *props, EVP_PKEY *pkey); + const char *props, EVP_PKEY *pkey, + const OSSL_PARAM params[]); int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx, const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey); int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt); @@ -33,7 +34,8 @@ provider interprets the digest name is provider specific. The provider may implement that digest directly itself or it may (optionally) choose to fetch it (which could result in a digest from a different provider being selected). If the provider supports fetching the digest then it may use the I<props> argument for -the properties to be used during the fetch. +the properties to be used during the fetch. Finally, the passed parameters +I<params>, if not NULL, are set on the context before returning. The I<pkey> algorithm is used to fetch a B<EVP_SIGNATURE> method implicitly, to be used for the actual signing. See L<provider(7)/Implicit fetch> for diff --git a/doc/man3/EVP_DigestVerifyInit.pod b/doc/man3/EVP_DigestVerifyInit.pod index 3f332c1801..c318656fc9 100644 --- a/doc/man3/EVP_DigestVerifyInit.pod +++ b/doc/man3/EVP_DigestVerifyInit.pod @@ -11,7 +11,8 @@ EVP_DigestVerifyFinal, EVP_DigestVerify - EVP signature verification functions int EVP_DigestVerifyInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx, const char *mdname, OSSL_LIB_CTX *libctx, - const char *props, EVP_PKEY *pkey); + const char *props, EVP_PKEY *pkey, + const OSSL_PARAM params[]); int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx, const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey); int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt); @@ -32,7 +33,8 @@ provider interprets the digest name is provider specific. The provider may implement that digest directly itself or it may (optionally) choose to fetch it (which could result in a digest from a different provider being selected). If the provider supports fetching the digest then it may use the B<props> argument -for the properties to be used during the fetch. +for the properties to be used during the fetch. Finally, the passed parameters +I<params>, if not NULL, are set on the context before returning. The I<pkey> algorithm is used to fetch a B<EVP_SIGNATURE> method implicitly, to be used for the actual signing. See L<provider(7)/Implicit fetch> for |