Debian Codegraph @

upstream/debian-unstable/man3/SSL_get_current_cipher.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_CURRENT_CIPHER 3SSL"
58 .TH SSL_GET_CURRENT_CIPHER 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_current_cipher, SSL_get_cipher_name, SSL_get_cipher,
65 SSL_get_cipher_bits, SSL_get_cipher_version,
66 SSL_get_pending_cipher \- get SSL_CIPHER of a connection
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/ssl.h>
71 \&
72 \& const SSL_CIPHER *SSL_get_current_cipher(const SSL *ssl);
73 \& const SSL_CIPHER *SSL_get_pending_cipher(const SSL *ssl);
74 \&
75 \& const char *SSL_get_cipher_name(const SSL *s);
76 \& const char *SSL_get_cipher(const SSL *s);
77 \& int SSL_get_cipher_bits(const SSL *s, int *np);
78 \& const char *SSL_get_cipher_version(const SSL *s);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 \&\fBSSL_get_current_cipher()\fR returns a pointer to an SSL_CIPHER object containing
83 the description of the actually used cipher of a connection established with
84 the \fBssl\fR object. \fBssl\fR \fBMUST NOT\fR be NULL.
85 See \fBSSL_CIPHER_get_name\fR\|(3) for more details.
86 .PP
87 \&\fBSSL_get_cipher_name()\fR obtains the
88 name of the currently used cipher.
89 \&\fBSSL_get_cipher()\fR is identical to \fBSSL_get_cipher_name()\fR.
90 \&\fBSSL_get_cipher_bits()\fR is a
91 macro to obtain the number of secret/algorithm bits used and
92 \&\fBSSL_get_cipher_version()\fR returns the protocol name.
93 .PP
94 \&\fBSSL_get_pending_cipher()\fR returns a pointer to an SSL_CIPHER object containing
95 the description of the cipher (if any) that has been negotiated for future use
96 on the connection established with the \fBssl\fR object, but is not yet in use.
97 This may be the case during handshake processing, when control flow can be
98 returned to the application via any of several callback methods. The internal
99 sequencing of handshake processing and callback invocation is not guaranteed
100 to be stable from release to release, and at present only the callback set
101 by \fBSSL_CTX_set_alpn_select_cb()\fR is guaranteed to have a non-NULL return value.
102 Other callbacks may be added to this list over time.
103 .SH "RETURN VALUES"
104 .IX Header "RETURN VALUES"
105 \&\fBSSL_get_current_cipher()\fR returns the cipher actually used, or NULL if
106 no session has been established.
107 .PP
108 \&\fBSSL_get_pending_cipher()\fR returns the cipher to be used at the next change
109 of cipher suite, or NULL if no such cipher is known.
110 .SH NOTES
111 .IX Header "NOTES"
112 SSL_get_cipher, SSL_get_cipher_bits, SSL_get_cipher_version, and
113 SSL_get_cipher_name are implemented as macros.
114 .SH "SEE ALSO"
115 .IX Header "SEE ALSO"
116 \&\fBssl\fR\|(7), \fBSSL_CIPHER_get_name\fR\|(3)
117 .SH COPYRIGHT
118 .IX Header "COPYRIGHT"
119 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
120 .PP
121 Licensed under the Apache License 2.0 (the "License"). You may not use
122 this file except in compliance with the License. You can obtain a copy
123 in the file LICENSE in the source distribution or at
124 <https://www.openssl.org/source/license.html>.