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