Debian Codegraph @

upstream/debian-unstable/man3/SSL_get_peer_tmp_key.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 "SSL_GET_PEER_TMP_KEY 3SSL"
58 .TH SSL_GET_PEER_TMP_KEY 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 SSL_get_peer_tmp_key, SSL_get_server_tmp_key, SSL_get_tmp_key \- get information
65 about temporary keys used during a handshake
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ssl.h>
70 \&
71 \& long SSL_get_peer_tmp_key(SSL *ssl, EVP_PKEY **key);
72 \& long SSL_get_server_tmp_key(SSL *ssl, EVP_PKEY **key);
73 \& long SSL_get_tmp_key(SSL *ssl, EVP_PKEY **key);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 \&\fBSSL_get_peer_tmp_key()\fR returns the temporary key provided by the peer and
78 used during key exchange. For example, if ECDHE is in use, then this represents
79 the peer's public ECDHE key. On success a pointer to the key is stored in
80 \&\fB*key\fR. It is the caller's responsibility to free this key after use using
81 \&\fBEVP_PKEY_free\fR\|(3).
82 .PP
83 \&\fBSSL_get_server_tmp_key()\fR is a backwards compatibility alias for
84 \&\fBSSL_get_peer_tmp_key()\fR.
85 Under that name it worked just on the client side of the connection, its
86 behaviour on the server end is release-dependent.
87 .PP
88 \&\fBSSL_get_tmp_key()\fR returns the equivalent information for the local
89 end of the connection.
90 .SH "RETURN VALUES"
91 .IX Header "RETURN VALUES"
92 All these functions return 1 on success and 0 otherwise.
93 .SH NOTES
94 .IX Header "NOTES"
95 This function is implemented as a macro.
96 .SH "SEE ALSO"
97 .IX Header "SEE ALSO"
98 \&\fBssl\fR\|(7), \fBEVP_PKEY_free\fR\|(3)
99 .SH HISTORY
100 .IX Header "HISTORY"
101 \&\fBSSL_get_peer_tmp_key()\fR, \fBSSL_get_tmp_key()\fR were added in OpenSSL 1.1.1a.
102 .SH COPYRIGHT
103 .IX Header "COPYRIGHT"
104 Copyright 2017\-2025 The OpenSSL Project Authors. All Rights Reserved.
105 .PP
106 Licensed under the Apache License 2.0 (the "License"). You may not use
107 this file except in compliance with the License. You can obtain a copy
108 in the file LICENSE in the source distribution or at
109 <https://www.openssl.org/source/license.html>.