jcs.org
jcs's openbsd hax
openbsd
1.\" $OpenBSD: SSL_rstate_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 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_RSTATE_STRING 3
53.Os
54.Sh NAME
55.Nm SSL_rstate_string ,
56.Nm SSL_rstate_string_long
57.Nd get textual description of state of an SSL object during read operation
58.Sh SYNOPSIS
59.Lb libssl libcrypto
60.In openssl/ssl.h
61.Ft const char *
62.Fn SSL_rstate_string "SSL *ssl"
63.Ft const char *
64.Fn SSL_rstate_string_long "SSL *ssl"
65.Sh DESCRIPTION
66.Fn SSL_rstate_string
67returns a 2-letter string indicating the current read state of the
68.Vt SSL
69object
70.Fa ssl .
71.Pp
72.Fn SSL_rstate_string_long
73returns a string indicating the current read state of the
74.Vt SSL
75object
76.Fa ssl .
77.Pp
78When performing a read operation, the SSL/TLS engine must parse the record,
79consisting of header and body.
80When working in a blocking environment,
81.Fn SSL_rstate_string[_long]
82should always return
83.Qo RD Qc Ns / Ns Qo read done Qc .
84.Pp
85This function should only seldom be needed in applications.
86.Sh RETURN VALUES
87.Fn SSL_rstate_string
88and
89.Fn SSL_rstate_string_long
90can return the following values:
91.Bl -tag -width Ds
92.It Qo RH Qc Ns / Ns Qo read header Qc
93The header of the record is being evaluated.
94.It Qo RB Qc Ns / Ns Qo read body Qc
95The body of the record is being evaluated.
96.It Qo RD Qc Ns / Ns Qo read done Qc
97The record has been completely processed.
98.It Qo unknown Qc Ns / Ns Qo unknown Qc
99The read state is unknown.
100This should never happen.
101.El
102.Sh SEE ALSO
103.Xr ssl 3
104.Sh HISTORY
105.Fn SSL_rstate_string
106and
107.Fn SSL_rstate_string_long
108first appeared in SSLeay 0.6.0 and have been available since
109.Ox 2.4 .