diff options
author | Matt Caswell <matt@openssl.org> | 2021-10-08 14:43:17 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2021-10-22 08:44:59 +0100 |
commit | 60f5e48f44b0d4e4179960741e8b73e5c475d3e8 (patch) | |
tree | 8d5407f2a2c7d3960fc111563016a3bdd6db044f /doc | |
parent | 1974be5912fc10c4f589c328063aba7a09d3aa93 (diff) |
Add an additional note to EVP_DigestSign() documentation
Clarify what happens if it fails. Make it clear that you can pass a NULL
"sig" buffer to get the "siglen".
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16789)
(cherry picked from commit dc3f057ce1701d5fd77cc4fcc1d14afe3e3122a3)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/EVP_DigestSignInit.pod | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/man3/EVP_DigestSignInit.pod b/doc/man3/EVP_DigestSignInit.pod index 8748014465..c8385949fb 100644 --- a/doc/man3/EVP_DigestSignInit.pod +++ b/doc/man3/EVP_DigestSignInit.pod @@ -130,7 +130,11 @@ written to I<siglen>. EVP_DigestSign() signs I<tbslen> bytes of data at I<tbs> and places the signature in I<sig> and its length in I<siglen> in a similar way to -EVP_DigestSignFinal(). +EVP_DigestSignFinal(). In the event of a failure EVP_DigestSign() cannot be +called again without reinitialising the EVP_MD_CTX. If I<sig> is NULL before the +call then I<siglen> will be populated with the required size for the I<sig> +buffer. If I<sig> is non-NULL before the call then I<siglen> should contain the +length of the I<sig> buffer. =head1 RETURN VALUES |