Debian Codegraph @

upstream/debian-unstable/man3/EVP_PKEY_CTX_get0_pkey.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_PKEY 3SSL"
58 .TH EVP_PKEY_CTX_GET0_PKEY 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_pkey,
65 EVP_PKEY_CTX_get0_peerkey
66 \&\- functions for accessing the EVP_PKEY associated with an EVP_PKEY_CTX
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/evp.h>
71 \&
72 \& EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx);
73 \& EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 \&\fBEVP_PKEY_CTX_get0_pkey()\fR is used to access the \fBEVP_PKEY\fR
78 associated with the given \fBEVP_PKEY_CTX\fR \fIctx\fR.
79 The \fBEVP_PKEY\fR obtained is the one used for creating the \fBEVP_PKEY_CTX\fR
80 using either \fBEVP_PKEY_CTX_new\fR\|(3) or \fBEVP_PKEY_CTX_new_from_pkey\fR\|(3).
81 .PP
82 \&\fBEVP_PKEY_CTX_get0_peerkey()\fR is used to access the peer \fBEVP_PKEY\fR
83 associated with the given \fBEVP_PKEY_CTX\fR \fIctx\fR.
84 The peer \fBEVP_PKEY\fR obtained is the one set using
85 either \fBEVP_PKEY_derive_set_peer\fR\|(3) or \fBEVP_PKEY_derive_set_peer_ex\fR\|(3).
86 .SH "RETURN VALUES"
87 .IX Header "RETURN VALUES"
88 \&\fBEVP_PKEY_CTX_get0_pkey()\fR returns the \fBEVP_PKEY\fR associated with the
89 EVP_PKEY_CTX or NULL if it is not set.
90 .PP
91 \&\fBEVP_PKEY_CTX_get0_peerkey()\fR returns the peer \fBEVP_PKEY\fR associated with the
92 EVP_PKEY_CTX or NULL if it is not set.
93 .PP
94 The returned EVP_PKEY objects are owned by the EVP_PKEY_CTX,
95 and therefore should not explicitly be freed by the caller.
96 .PP
97 These functions do not affect the EVP_PKEY reference count.
98 They merely act as getter functions, and should be treated as such.
99 .SH "SEE ALSO"
100 .IX Header "SEE ALSO"
101 \&\fBEVP_PKEY_CTX_new\fR\|(3), \fBEVP_PKEY_CTX_new_from_pkey\fR\|(3),
102 \&\fBEVP_PKEY_derive_set_peer\fR\|(3), \fBEVP_PKEY_derive_set_peer_ex\fR\|(3)
103 .SH COPYRIGHT
104 .IX Header "COPYRIGHT"
105 Copyright 2022\-2023 The OpenSSL Project Authors. All Rights Reserved.
106 .PP
107 Licensed under the Apache License 2.0 (the "License").
108 You may not use this file except in compliance with the License.
109 You can obtain a copy in the file LICENSE in the source distribution or at
110 <https://www.openssl.org/source/license.html>.