aboutsummaryrefslogtreecommitdiff
path: root/doc/man3/EVP_PKEY_decapsulate.pod
diff options
context:
space:
mode:
authorEnji Cooper <ngie@FreeBSD.org>2025-03-06 17:49:50 +0000
committerEnji Cooper <ngie@FreeBSD.org>2025-03-06 17:49:50 +0000
commit1c34280346af8284acdc0eae39496811d37df25d (patch)
treedbe4218057c550b3be955f331fc1198c6cab5f3f /doc/man3/EVP_PKEY_decapsulate.pod
parent108164cf95d9594884c2dcccba2691335e6f221b (diff)
Diffstat (limited to 'doc/man3/EVP_PKEY_decapsulate.pod')
-rw-r--r--doc/man3/EVP_PKEY_decapsulate.pod9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/man3/EVP_PKEY_decapsulate.pod b/doc/man3/EVP_PKEY_decapsulate.pod
index 819291627bb8..cd6f5f0221a2 100644
--- a/doc/man3/EVP_PKEY_decapsulate.pod
+++ b/doc/man3/EVP_PKEY_decapsulate.pod
@@ -25,10 +25,13 @@ specifying the private key to use.
The EVP_PKEY_decapsulate() function performs a private key decapsulation
operation using I<ctx>. The data to be decapsulated is specified using the
I<wrapped> and I<wrappedlen> parameters.
-If I<unwrapped> is NULL then the maximum size of the output secret buffer
+If I<unwrapped> is NULL then the size of the output secret buffer
is written to I<*unwrappedlen>. If I<unwrapped> is not NULL and the
call is successful then the decapsulated secret data is written to I<unwrapped>
-and the amount of data written to I<*unwrappedlen>.
+and the amount of data written to I<*unwrappedlen>. Note that, if I<unwrappedlen>
+is not NULL in this call, the value it points to must be initialised to the length of
+I<unwrapped>, so that the call can validate it is of sufficient size to hold the
+result of the operation.
=head1 NOTES
@@ -57,7 +60,7 @@ Decapsulate data using RSA:
unsigned char *secret = NULL;;
ctx = EVP_PKEY_CTX_new_from_pkey(libctx, rsa_priv_key, NULL);
- if (ctx = NULL)
+ if (ctx == NULL)
/* Error */
if (EVP_PKEY_decapsulate_init(ctx, NULL) <= 0)
/* Error */