summaryrefslogtreecommitdiffstats
path: root/doc/man3/EVP_DigestInit.pod
diff options
context:
space:
mode:
authorPauli <paul.dale@oracle.com>2019-09-13 11:37:40 +0200
committerPauli <paul.dale@oracle.com>2019-09-14 02:55:13 +0200
commit7b6b194b5281649ad5c50ecead0f3725d2d2a6a0 (patch)
tree0b94c72ad402d7e65103eff2a5aa84b659286e41 /doc/man3/EVP_DigestInit.pod
parentUse param types for parameter descriptions. Mention a size_t limit to those ... (diff)
downloadopenssl-7b6b194b5281649ad5c50ecead0f3725d2d2a6a0.tar.xz
openssl-7b6b194b5281649ad5c50ecead0f3725d2d2a6a0.zip
Use param types instead of native types in the param descriptions
Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9891)
Diffstat (limited to 'doc/man3/EVP_DigestInit.pod')
-rw-r--r--doc/man3/EVP_DigestInit.pod9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/man3/EVP_DigestInit.pod b/doc/man3/EVP_DigestInit.pod
index cc38235274..7f5a1e5db2 100644
--- a/doc/man3/EVP_DigestInit.pod
+++ b/doc/man3/EVP_DigestInit.pod
@@ -339,12 +339,13 @@ EVP_MD_CTX_set_params() can be used with the following OSSL_PARAM keys:
=over 4
-=item OSSL_PARAM_DIGEST_KEY_XOFLEN <size_t>
+=item OSSL_PARAM_DIGEST_KEY_XOFLEN <unsigned integer>
Sets the digest length for extendable output functions.
-It is used by the SHAKE algorithm.
+It is used by the SHAKE algorithm and should not exceed what can be given
+using a B<size_t>.
-=item OSSL_PARAM_DIGEST_KEY_PAD_TYPE <int>
+=item OSSL_PARAM_DIGEST_KEY_PAD_TYPE <integer>
Sets the pad type.
It is used by the MDC2 algorithm.
@@ -355,7 +356,7 @@ EVP_MD_CTX_get_params() can be used with the following OSSL_PARAM keys:
=over 4
-=item OSSL_PARAM_DIGEST_KEY_MICALG <utf8string>.
+=item OSSL_PARAM_DIGEST_KEY_MICALG <UTF8 string>.
Gets the digest Message Integrity Check algorithm string. This is used when
creating S/MIME multipart/signed messages, as specified in RFC 3851.