jcs.org
jcs's openbsd hax
openbsd
1.\" $OpenBSD: SSL_state_string.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) 2001, 2005 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_STATE_STRING 3
53.Os
54.Sh NAME
55.Nm SSL_state_string ,
56.Nm SSL_state_string_long
57.Nd get textual description of state of an SSL object
58.Sh SYNOPSIS
59.Lb libssl libcrypto
60.In openssl/ssl.h
61.Ft const char *
62.Fn SSL_state_string "const SSL *ssl"
63.Ft const char *
64.Fn SSL_state_string_long "const SSL *ssl"
65.Sh DESCRIPTION
66.Fn SSL_state_string
67returns a 6 letter string indicating the current state of the
68.Vt SSL
69object
70.Fa ssl .
71.Pp
72.Fn SSL_state_string_long
73returns a string indicating the current state of the
74.Vt SSL
75object
76.Fa ssl .
77.Pp
78During its use, an
79.Vt SSL
80object passes several states.
81The state is internally maintained.
82Querying the state information is not very informative before or when a
83connection has been established.
84It however can be of significant interest during the handshake.
85.Pp
86When using non-blocking sockets,
87the function call performing the handshake may return with
88.Dv SSL_ERROR_WANT_READ
89or
90.Dv SSL_ERROR_WANT_WRITE
91condition, so that
92.Fn SSL_state_string[_long]
93may be called.
94.Pp
95For both blocking or non-blocking sockets,
96the details state information can be used within the
97.Fn info_callback
98function set with the
99.Xr SSL_set_info_callback 3
100call.
101.Sh RETURN VALUES
102Detailed description of possible states to be included later.
103.Sh SEE ALSO
104.Xr ssl 3 ,
105.Xr SSL_CTX_set_info_callback 3
106.Sh HISTORY
107.Fn SSL_state_string
108and
109.Fn SSL_state_string_long
110first appeared in SSLeay 0.6.0 and have been available since
111.Ox 2.4 .