jcs.org
jcs's openbsd hax
openbsd
1.\" $OpenBSD: SSL_get_current_cipher.3,v 1.5 2025/06/08 22:52:00 schwarze Exp $
2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
3.\"
4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
5.\" Copyright (c) 2000, 2005, 2016 The OpenSSL Project. All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in
16.\" the documentation and/or other materials provided with the
17.\" distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\" software must display the following acknowledgment:
21.\" "This product includes software developed by the OpenSSL Project
22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\" endorse or promote products derived from this software without
26.\" prior written permission. For written permission, please contact
27.\" openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\" nor may "OpenSSL" appear in their names without prior written
31.\" permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\" acknowledgment:
35.\" "This product includes software developed by the OpenSSL Project
36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: June 8 2025 $
52.Dt SSL_GET_CURRENT_CIPHER 3
53.Os
54.Sh NAME
55.Nm SSL_get_current_cipher ,
56.Nm SSL_get_cipher ,
57.Nm SSL_get_cipher_name ,
58.Nm SSL_get_cipher_bits ,
59.Nm SSL_get_cipher_version
60.Nd get SSL_CIPHER of a connection
61.Sh SYNOPSIS
62.Lb libssl libcrypto
63.In openssl/ssl.h
64.Ft const SSL_CIPHER *
65.Fn SSL_get_current_cipher "const SSL *ssl"
66.Ft const char *
67.Fn SSL_get_cipher "const SSL *ssl"
68.Ft const char *
69.Fn SSL_get_cipher_name "const SSL *ssl"
70.Ft int
71.Fn SSL_get_cipher_bits "const SSL *ssl" "int *np"
72.Ft char *
73.Fn SSL_get_cipher_version "const SSL *ssl"
74.Sh DESCRIPTION
75.Fn SSL_get_current_cipher
76returns a pointer to an
77.Vt SSL_CIPHER
78object containing the description of the actually used cipher of a connection
79established with the
80.Fa ssl
81object.
82See
83.Xr SSL_CIPHER_get_name 3
84for more details.
85.Pp
86.Fn SSL_get_cipher_name
87obtains the name of the currently used cipher.
88.Fn SSL_get_cipher
89is identical to
90.Fn SSL_get_cipher_name .
91.Pp
92.Fn SSL_get_cipher_bits
93obtains the number of secret/algorithm bits used and
94.Fn SSL_get_cipher_version
95returns the protocol name.
96.Pp
97.Fn SSL_get_cipher ,
98.Fn SSL_get_cipher_name ,
99.Fn SSL_get_cipher_bits ,
100and
101.Fn SSL_get_cipher_version
102are implemented as macros.
103.Sh RETURN VALUES
104.Fn SSL_get_current_cipher
105returns the cipher actually used, or
106.Dv NULL
107if no session has been established.
108.Sh SEE ALSO
109.Xr ssl 3 ,
110.Xr SSL_CIPHER_get_name 3
111.Sh HISTORY
112.Fn SSL_get_cipher
113appeared in SSLeay 0.4 or earlier.
114.Fn SSL_get_cipher_bits
115first appeared in SSLeay 0.6.4.
116.Fn SSL_get_cipher_name
117and
118.Fn SSL_get_cipher_version
119first appeared in SSLeay 0.8.0.
120.Fn SSL_get_current_cipher
121first appeared in SSLeay 0.8.1.
122These functions have been available since
123.Ox 2.4 .