doc: document the params arguments to the initialisation functions.
authorPauli <pauli@openssl.org>
Wed, 14 Jul 2021 00:03:45 +0000 (10:03 +1000)
committerPauli <pauli@openssl.org>
Thu, 15 Jul 2021 06:46:18 +0000 (16:46 +1000)
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)

doc/man3/EVP_DigestSignInit.pod
doc/man3/EVP_DigestVerifyInit.pod

index b1eb4ae7e333011f183d4ba17280da22cdda3167..87480144654c53a05fc755636026efdcdea96648 100644 (file)
@@ -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
index 3f332c18015adc7e2c47a7c0c23ca273ce5d5304..c318656fc923de1bc7d345262e4556921f294ed2 100644 (file)
@@ -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