summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2014-06-29 23:34:21 +0100
committerMatt Caswell <matt@openssl.org>2014-06-29 23:36:51 +0100
commit02e8d46119e524f0cdcdd57f673453a2f92fa961 (patch)
treeb4c19b286efabafd04b1d740e8749c185f38f16f /doc
parent105a3db56ee4960fd324f8fd653f53fba3e08472 (diff)
Clarified that the signature's buffer size, `s`, is not used as an
IN parameter. Under the old docs, the only thing stated was "at most EVP_PKEY_size(pkey) bytes will be written". It was kind of misleading since it appears EVP_PKEY_size(pkey) WILL be written regardless of the signature's buffer size. (cherry picked from commit 6e6ba36d980f67b6e5c7b139f78da7acbbf8ec76)
Diffstat (limited to 'doc')
-rw-r--r--doc/crypto/EVP_SignInit.pod8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/crypto/EVP_SignInit.pod b/doc/crypto/EVP_SignInit.pod
index 620a623ab6..14ecc775af 100644
--- a/doc/crypto/EVP_SignInit.pod
+++ b/doc/crypto/EVP_SignInit.pod
@@ -30,9 +30,11 @@ signature context B<ctx>. This function can be called several times on the
same B<ctx> to include additional data.
EVP_SignFinal() signs the data in B<ctx> using the private key B<pkey> and
-places the signature in B<sig>. The number of bytes of data written (i.e. the
-length of the signature) will be written to the integer at B<s>, at most
-EVP_PKEY_size(pkey) bytes will be written.
+places the signature in B<sig>. B<sig> must be at least EVP_PKEY_size(pkey)
+bytes in size. B<s> is an OUT paramter, and not used as an IN parameter.
+The number of bytes of data written (i.e. the length of the signature)
+will be written to the integer at B<s>, at most EVP_PKEY_size(pkey) bytes
+will be written.
EVP_SignInit() initializes a signing context B<ctx> to use the default
implementation of digest B<type>.