1SSL_STATE_STRING(3ossl) OpenSSL SSL_STATE_STRING(3ossl)
2
3
4
6 SSL_state_string, SSL_state_string_long - get textual description of
7 state of an SSL object
8
10 #include <openssl/ssl.h>
11
12 const char *SSL_state_string(const SSL *ssl);
13 const char *SSL_state_string_long(const SSL *ssl);
14
16 SSL_state_string() returns an abbreviated string indicating the current
17 state of the SSL object ssl. The returned NUL-terminated string
18 contains 6 or fewer characters.
19
20 SSL_state_string_long() returns a descriptive string indicating the
21 current state of the SSL object ssl.
22
24 During its use, an SSL objects passes several states. The state is
25 internally maintained. Querying the state information is not very
26 informative before or when a connection has been established. It
27 however can be of significant interest during the handshake.
28
29 When using nonblocking sockets, the function call performing the
30 handshake may return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE
31 condition, so that SSL_state_string[_long]() may be called.
32
33 For both blocking or nonblocking sockets, the details state information
34 can be used within the info_callback function set with the
35 SSL_set_info_callback() call.
36
38 Detailed description of possible states to be included later.
39
41 ssl(7), SSL_CTX_set_info_callback(3)
42
44 Copyright 2001-2021 The OpenSSL Project Authors. All Rights Reserved.
45
46 Licensed under the Apache License 2.0 (the "License"). You may not use
47 this file except in compliance with the License. You can obtain a copy
48 in the file LICENSE in the source distribution or at
49 <https://www.openssl.org/source/license.html>.
50
51
52
533.1.1 2023-08-31 SSL_STATE_STRING(3ossl)