diff options
-rw-r--r-- | doc/build.info | 6 | ||||
-rw-r--r-- | doc/man3/EVP_PKEY_CTX_get0_pkey.pod | 56 | ||||
-rw-r--r-- | util/missingcrypto.txt | 2 |
3 files changed, 62 insertions, 2 deletions
diff --git a/doc/build.info b/doc/build.info index 3251d27258..c1d6a5f1dc 100644 --- a/doc/build.info +++ b/doc/build.info @@ -1179,6 +1179,10 @@ DEPEND[html/man3/EVP_PKEY_CTX_get0_libctx.html]=man3/EVP_PKEY_CTX_get0_libctx.po GENERATE[html/man3/EVP_PKEY_CTX_get0_libctx.html]=man3/EVP_PKEY_CTX_get0_libctx.pod DEPEND[man/man3/EVP_PKEY_CTX_get0_libctx.3]=man3/EVP_PKEY_CTX_get0_libctx.pod GENERATE[man/man3/EVP_PKEY_CTX_get0_libctx.3]=man3/EVP_PKEY_CTX_get0_libctx.pod +DEPEND[html/man3/EVP_PKEY_CTX_get0_pkey.html]=man3/EVP_PKEY_CTX_get0_pkey.pod +GENERATE[html/man3/EVP_PKEY_CTX_get0_pkey.html]=man3/EVP_PKEY_CTX_get0_pkey.pod +DEPEND[man/man3/EVP_PKEY_CTX_get0_pkey.3]=man3/EVP_PKEY_CTX_get0_pkey.pod +GENERATE[man/man3/EVP_PKEY_CTX_get0_pkey.3]=man3/EVP_PKEY_CTX_get0_pkey.pod DEPEND[html/man3/EVP_PKEY_CTX_new.html]=man3/EVP_PKEY_CTX_new.pod GENERATE[html/man3/EVP_PKEY_CTX_new.html]=man3/EVP_PKEY_CTX_new.pod DEPEND[man/man3/EVP_PKEY_CTX_new.3]=man3/EVP_PKEY_CTX_new.pod @@ -3098,6 +3102,7 @@ html/man3/EVP_PKEY2PKCS8.html \ html/man3/EVP_PKEY_ASN1_METHOD.html \ html/man3/EVP_PKEY_CTX_ctrl.html \ html/man3/EVP_PKEY_CTX_get0_libctx.html \ +html/man3/EVP_PKEY_CTX_get0_pkey.html \ html/man3/EVP_PKEY_CTX_new.html \ html/man3/EVP_PKEY_CTX_set1_pbe_pass.html \ html/man3/EVP_PKEY_CTX_set_hkdf_md.html \ @@ -3711,6 +3716,7 @@ man/man3/EVP_PKEY2PKCS8.3 \ man/man3/EVP_PKEY_ASN1_METHOD.3 \ man/man3/EVP_PKEY_CTX_ctrl.3 \ man/man3/EVP_PKEY_CTX_get0_libctx.3 \ +man/man3/EVP_PKEY_CTX_get0_pkey.3 \ man/man3/EVP_PKEY_CTX_new.3 \ man/man3/EVP_PKEY_CTX_set1_pbe_pass.3 \ man/man3/EVP_PKEY_CTX_set_hkdf_md.3 \ diff --git a/doc/man3/EVP_PKEY_CTX_get0_pkey.pod b/doc/man3/EVP_PKEY_CTX_get0_pkey.pod new file mode 100644 index 0000000000..26eef87cc1 --- /dev/null +++ b/doc/man3/EVP_PKEY_CTX_get0_pkey.pod @@ -0,0 +1,56 @@ +=pod + +=head1 NAME + +EVP_PKEY_CTX_get0_pkey, +EVP_PKEY_CTX_get0_peerkey +- functions for accessing the EVP_PKEY associated with an EVP_PKEY_CTX + +=head1 SYNOPSIS + + #include <openssl/evp.h> + + EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx); + EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx); + +=head1 DESCRIPTION + +EVP_PKEY_CTX_get0_pkey() is used to access the B<EVP_PKEY> +associated with the given B<EVP_PKEY_CTX> I<ctx>. +The B<EVP_PKEY> obtained is the one used for creating the B<EVP_PKEY_CTX> +using either L<EVP_PKEY_CTX_new(3)> or L<EVP_PKEY_CTX_new_from_pkey(3)>. + +EVP_PKEY_CTX_get0_peerkey() is used to access the peer B<EVP_PKEY> +associated with the given B<EVP_PKEY_CTX> I<ctx>. +The peer B<EVP_PKEY> obtained is the one set using +either L<EVP_PKEY_derive_set_peer(3)> or L<EVP_PKEY_derive_set_peer_ex(3)>. + +=head1 RETURN VALUES + +EVP_PKEY_CTX_get0_pkey() returns the B<EVP_PKEY> associated with the +EVP_PKEY_CTX or NULL if it is not set. + +EVP_PKEY_CTX_get0_peerkey() returns the peer B<EVP_PKEY> associated with the +EVP_PKEY_CTX or NULL if it is not set. + +The returned EVP_PKEY objects are owned by the EVP_PKEY_CTX, +and therefore should not explicitly be freed by the caller. + +These functions do not affect the EVP_PKEY reference count. +They merely act as getter functions, and should be treated as such. + +=head1 SEE ALSO + +L<EVP_PKEY_CTX_new(3)>, L<EVP_PKEY_CTX_new_from_pkey(3)>, +L<EVP_PKEY_derive_set_peer(3)>, L<EVP_PKEY_derive_set_peer_ex(3)> + +=head1 COPYRIGHT + +Copyright 2022 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 in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut diff --git a/util/missingcrypto.txt b/util/missingcrypto.txt index a603ff7545..3090d50473 100644 --- a/util/missingcrypto.txt +++ b/util/missingcrypto.txt @@ -588,8 +588,6 @@ EVP_MD_do_all(3) EVP_MD_do_all_sorted(3) EVP_PBE_cleanup(3) EVP_PBE_get(3) -EVP_PKEY_CTX_get0_peerkey(3) -EVP_PKEY_CTX_get0_pkey(3) EVP_PKEY_CTX_get_data(3) EVP_PKEY_CTX_get_operation(3) EVP_PKEY_CTX_hex2ctrl(3) |