diff options
Diffstat (limited to 'doc/man3/EVP_PKEY_decapsulate.pod')
| -rw-r--r-- | doc/man3/EVP_PKEY_decapsulate.pod | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/man3/EVP_PKEY_decapsulate.pod b/doc/man3/EVP_PKEY_decapsulate.pod index 529e318f9eba..819291627bb8 100644 --- a/doc/man3/EVP_PKEY_decapsulate.pod +++ b/doc/man3/EVP_PKEY_decapsulate.pod @@ -3,7 +3,7 @@ =head1 NAME EVP_PKEY_decapsulate_init, EVP_PKEY_decapsulate -- Key decapsulation using a private key algorithm +- Key decapsulation using a KEM algorithm with a private key =head1 SYNOPSIS @@ -11,7 +11,7 @@ EVP_PKEY_decapsulate_init, EVP_PKEY_decapsulate int EVP_PKEY_decapsulate_init(EVP_PKEY_CTX *ctx, const OSSL_PARAM params[]); int EVP_PKEY_decapsulate(EVP_PKEY_CTX *ctx, - unsigned char *secret, size_t *secretlen, + unsigned char *unwrapped, size_t *unwrappedlen, const unsigned char *wrapped, size_t wrappedlen); =head1 DESCRIPTION @@ -19,18 +19,20 @@ EVP_PKEY_decapsulate_init, EVP_PKEY_decapsulate The EVP_PKEY_decapsulate_init() function initializes a private key algorithm context I<ctx> for a decapsulation operation and then sets the I<params> on the context in the same way as calling L<EVP_PKEY_CTX_set_params(3)>. +Note that I<ctx> usually is produced using L<EVP_PKEY_CTX_new_from_pkey(3)>, +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<secret> is I<NULL> then the maximum size of the output secret buffer -is written to the I<*secretlen> parameter. If I<secret> is not B<NULL> and the -call is successful then the decapsulated secret data is written to I<secret> and -the amount of data written to I<secretlen>. +If I<unwrapped> is NULL then the maximum 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>. =head1 NOTES -After the call to EVP_PKEY_decapsulate_init() algorithm specific parameters +After the call to EVP_PKEY_decapsulate_init() algorithm-specific parameters for the operation may be set or modified using L<EVP_PKEY_CTX_set_params(3)>. =head1 RETURN VALUES @@ -79,7 +81,7 @@ Decapsulate data using RSA: =head1 SEE ALSO -L<EVP_PKEY_CTX_new(3)>, +L<EVP_PKEY_CTX_new_from_pkey(3)>, L<EVP_PKEY_encapsulate(3)>, L<EVP_KEM-RSA(7)>, @@ -89,7 +91,7 @@ These functions were added in OpenSSL 3.0. =head1 COPYRIGHT -Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2020-2023 The OpenSSL Project Authors. All Rights Reserved. Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy |