Debian Codegraph @

upstream/debian-unstable/man3/EVP_PKEY_CTX_get0_libctx.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_PKEY_CTX_GET0_LIBCTX 3SSL"
58 .TH EVP_PKEY_CTX_GET0_LIBCTX 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_PKEY_CTX_get0_libctx,
65 EVP_PKEY_CTX_get0_propq,
66 EVP_PKEY_CTX_get0_provider
67 \&\- functions for getting diverse information from an EVP_PKEY_CTX
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& #include <openssl/evp.h>
72 \&
73 \& OSSL_LIB_CTX *EVP_PKEY_CTX_get0_libctx(EVP_PKEY_CTX *ctx);
74 \& const char *EVP_PKEY_CTX_get0_propq(const EVP_PKEY_CTX *ctx);
75 \& const OSSL_PROVIDER *EVP_PKEY_CTX_get0_provider(const EVP_PKEY_CTX *ctx);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 \&\fBEVP_PKEY_CTX_get0_libctx()\fR and \fBEVP_PKEY_CTX_get0_propq()\fR obtain the
80 OSSL_LIB_CTX and property query string values respectively that were
81 associated with the EVP_PKEY_CTX when it was constructed.
82 .PP
83 \&\fBEVP_PKEY_CTX_get0_provider()\fR returns the provider associated with the
84 ongoing \fBEVP_PKEY_CTX\fR operation. If the operation is performed by
85 en \fBENGINE\fR, this function returns NULL.
86 .SH "RETURN VALUES"
87 .IX Header "RETURN VALUES"
88 \&\fBEVP_PKEY_CTX_get0_libctx()\fR and \fBEVP_PKEY_CTX_get0_propq()\fR functions return the
89 OSSL_LIB_CTX and property query string associated with the EVP_PKEY_CTX or NULL
90 if they are not set. The returned values should not be freed by the caller.
91 .PP
92 \&\fBEVP_PKEY_CTX_get0_provider()\fR returns a provider if an operation performed by
93 a provider is ongoing, otherwise NULL.
94 .SH "SEE ALSO"
95 .IX Header "SEE ALSO"
96 \&\fBEVP_PKEY_CTX_new\fR\|(3)
97 .SH HISTORY
98 .IX Header "HISTORY"
99 All functions were added in OpenSSL 3.0.
100 .SH COPYRIGHT
101 .IX Header "COPYRIGHT"
102 Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved.
103 .PP
104 Licensed under the Apache License 2.0 (the "License"). You may not use
105 this file except in compliance with the License. You can obtain a copy
106 in the file LICENSE in the source distribution or at
107 <https://www.openssl.org/source/license.html>.