summaryrefslogtreecommitdiff
path: root/doc/man3/EVP_PKEY_CTX_get0_libctx.pod
diff options
context:
space:
mode:
authorMatt Caswell <matt@openssl.org>2020-10-12 17:12:03 +0100
committerMatt Caswell <matt@openssl.org>2020-10-15 10:00:28 +0100
commit29000e43ea257bf54f6ccb2064b3744853b821b2 (patch)
tree37790003f0f3683ec8cc8836499afb2844b90fa9 /doc/man3/EVP_PKEY_CTX_get0_libctx.pod
parent0d30e15a57fdd9c27a9148c17289a1005345f0c7 (diff)
downloadopenssl-new-29000e43ea257bf54f6ccb2064b3744853b821b2.tar.gz
Make evp_pkey_ctx_get0_libctx/propq public API
These were previously added as an internal API. But since the CMS code needs them, other code might do too. Reviewed-by: Shane Lontis <shane.lontis@oracle.com> (Merged from https://github.com/openssl/openssl/pull/13088)
Diffstat (limited to 'doc/man3/EVP_PKEY_CTX_get0_libctx.pod')
-rw-r--r--doc/man3/EVP_PKEY_CTX_get0_libctx.pod45
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/man3/EVP_PKEY_CTX_get0_libctx.pod b/doc/man3/EVP_PKEY_CTX_get0_libctx.pod
new file mode 100644
index 0000000000..2536ae820e
--- /dev/null
+++ b/doc/man3/EVP_PKEY_CTX_get0_libctx.pod
@@ -0,0 +1,45 @@
+=pod
+
+=head1 NAME
+
+EVP_PKEY_CTX_get0_libctx,
+EVP_PKEY_CTX_get0_propq
+- functions for getting OPENSSL_CTX and property query data from an EVP_PKEY_CTX
+
+=head1 SYNOPSIS
+
+ #include <openssl/evp.h>
+
+ OPENSSL_CTX *EVP_PKEY_CTX_get0_libctx(EVP_PKEY_CTX *ctx);
+ const char *EVP_PKEY_CTX_get0_propq(EVP_PKEY_CTX *ctx);
+
+=head1 DESCRIPTION
+
+The EVP_PKEY_CTX_get0_libctx() and EVP_PKEY_CTX_get0_propq() functions obtain
+the OPENSSL_CTX and property query string values respectively that were
+associated with the EVP_PKEY_CTX when it was constructed.
+
+=head1 RETURN VALUES
+
+EVP_PKEY_CTX_get0_libctx() and EVP_PKEY_CTX_get0_propq() functions return the
+OPENSSL_CTX and property query string associated with the EVP_PKEY_CTX or NULL
+if they are not set. The returned values should not be freed by the caller.
+
+=head1 SEE ALSO
+
+L<EVP_PKEY_CTX_new(3)>
+
+=head1 HISTORY
+
+All functions were added in OpenSSL 3.0.
+
+=head1 COPYRIGHT
+
+Copyright 2020 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