xref: /freebsd-src/crypto/openssl/doc/man3/EVP_PKEY_CTX_get0_libctx.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre ProncheryEVP_PKEY_CTX_get0_libctx,
6*b077aed3SPierre ProncheryEVP_PKEY_CTX_get0_propq,
7*b077aed3SPierre ProncheryEVP_PKEY_CTX_get0_provider
8*b077aed3SPierre Pronchery- functions for getting diverse information from an EVP_PKEY_CTX
9*b077aed3SPierre Pronchery
10*b077aed3SPierre Pronchery=head1 SYNOPSIS
11*b077aed3SPierre Pronchery
12*b077aed3SPierre Pronchery #include <openssl/evp.h>
13*b077aed3SPierre Pronchery
14*b077aed3SPierre Pronchery OSSL_LIB_CTX *EVP_PKEY_CTX_get0_libctx(EVP_PKEY_CTX *ctx);
15*b077aed3SPierre Pronchery const char *EVP_PKEY_CTX_get0_propq(const EVP_PKEY_CTX *ctx);
16*b077aed3SPierre Pronchery const OSSL_PROVIDER *EVP_PKEY_CTX_get0_provider(const EVP_PKEY_CTX *ctx);
17*b077aed3SPierre Pronchery
18*b077aed3SPierre Pronchery=head1 DESCRIPTION
19*b077aed3SPierre Pronchery
20*b077aed3SPierre ProncheryEVP_PKEY_CTX_get0_libctx() and EVP_PKEY_CTX_get0_propq() obtain the
21*b077aed3SPierre ProncheryOSSL_LIB_CTX and property query string values respectively that were
22*b077aed3SPierre Proncheryassociated with the EVP_PKEY_CTX when it was constructed.
23*b077aed3SPierre Pronchery
24*b077aed3SPierre ProncheryEVP_PKEY_CTX_get0_provider() returns the provider associated with the
25*b077aed3SPierre Proncheryongoing B<EVP_PKEY_CTX> operation.  If the operation is performed by
26*b077aed3SPierre Proncheryen B<ENGINE>, this function returns NULL.
27*b077aed3SPierre Pronchery
28*b077aed3SPierre Pronchery=head1 RETURN VALUES
29*b077aed3SPierre Pronchery
30*b077aed3SPierre ProncheryEVP_PKEY_CTX_get0_libctx() and EVP_PKEY_CTX_get0_propq() functions return the
31*b077aed3SPierre ProncheryOSSL_LIB_CTX and property query string associated with the EVP_PKEY_CTX or NULL
32*b077aed3SPierre Proncheryif they are not set. The returned values should not be freed by the caller.
33*b077aed3SPierre Pronchery
34*b077aed3SPierre ProncheryEVP_PKEY_CTX_get0_provider() returns a provider if an operation performed by
35*b077aed3SPierre Proncherya provider is ongoing, otherwise NULL.
36*b077aed3SPierre Pronchery
37*b077aed3SPierre Pronchery=head1 SEE ALSO
38*b077aed3SPierre Pronchery
39*b077aed3SPierre ProncheryL<EVP_PKEY_CTX_new(3)>
40*b077aed3SPierre Pronchery
41*b077aed3SPierre Pronchery=head1 HISTORY
42*b077aed3SPierre Pronchery
43*b077aed3SPierre ProncheryAll functions were added in OpenSSL 3.0.
44*b077aed3SPierre Pronchery
45*b077aed3SPierre Pronchery=head1 COPYRIGHT
46*b077aed3SPierre Pronchery
47*b077aed3SPierre ProncheryCopyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
48*b077aed3SPierre Pronchery
49*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
50*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
51*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
52*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
53*b077aed3SPierre Pronchery
54*b077aed3SPierre Pronchery=cut
55