diff options
| author | Tomas Mraz <tomas@openssl.org> | 2022-11-30 16:48:14 +0100 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2022-12-02 13:09:54 +0100 |
| commit | e3ce39ab3441fe6603f8740952af8fe94d40abf3 (patch) | |
| tree | 9179933a61512e8e941b17f5b8881d23eda02aa4 | |
| parent | d43941599186d4b3a29a5d62928a55cbc298ed03 (diff) | |
Clarify the EVP_PKEY_decrypt manual page
Fixes #19790
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19792)
(cherry picked from commit 8f48a978e5cce483eadfd0df20e34480f205511c)
| -rw-r--r-- | doc/man3/EVP_PKEY_decrypt.pod | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/man3/EVP_PKEY_decrypt.pod b/doc/man3/EVP_PKEY_decrypt.pod index 5c3d863201..b6f9bad5f1 100644 --- a/doc/man3/EVP_PKEY_decrypt.pod +++ b/doc/man3/EVP_PKEY_decrypt.pod @@ -18,19 +18,21 @@ EVP_PKEY_decrypt - decrypt using a public key algorithm =head1 DESCRIPTION The EVP_PKEY_decrypt_init() function initializes a public key algorithm -context using key B<pkey> for a decryption operation. +context using key I<pkey> for a decryption operation. The EVP_PKEY_decrypt_init_ex() function initializes a public key algorithm -context using key B<pkey> for a decryption operation and sets the -algorithm specific B<params>. +context using key I<pkey> for a decryption operation and sets the +algorithm specific I<params>. The EVP_PKEY_decrypt() function performs a public key decryption operation -using B<ctx>. The data to be decrypted is specified using the B<in> and -B<inlen> parameters. If B<out> is B<NULL> then the maximum size of the output -buffer is written to the B<outlen> parameter. If B<out> is not B<NULL> then -before the call the B<outlen> parameter should contain the length of the -B<out> buffer, if the call is successful the decrypted data is written to -B<out> and the amount of data written to B<outlen>. +using I<ctx>. The data to be decrypted is specified using the I<in> and +I<inlen> parameters. If I<out> is NULL then the minimum required size of +the output buffer is written to the I<*outlen> parameter. + +If I<out> is not NULL then before the call the I<*outlen> parameter must +contain the length of the I<out> buffer. If the call is successful the +decrypted data is written to I<out> and the amount of the decrypted data +written to I<*outlen>, otherwise an error is returned. =head1 NOTES |