SSL_state_string - get textual description of state of an SSL object
#include <openssl/ssl.h> const char *SSL_state_string(const SSL *ssl); const char *SSL_state_string_long(const SSL *ssl);
OpenSSL SSL_state_string(3openssl)
NAME
SSL_state_string, SSL_state_string_long - get textual description of
state of an SSL object
SYNOPSIS
#include <openssl/ssl.h>
const char *SSL_state_string(const SSL *ssl);
const char *SSL_state_string_long(const SSL *ssl);
DESCRIPTION
SSL_state_string() returns a 6 letter string indicating the current
state of the SSL object ssl.
SSL_state_string_long() returns a string indicating the current state
of the SSL object ssl.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+--------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+--------------------------+
|Availability | library/security/openssl |
+---------------+--------------------------+
|Stability | Pass-through uncommitted |
+---------------+--------------------------+
NOTES
During its use, an SSL objects passes several states. The state is
internally maintained. Querying the state information is not very
informative before or when a connection has been established. It
however can be of significant interest during the handshake.
When using non-blocking sockets, the function call performing the
handshake may return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE
condition, so that SSL_state_string[_long]() may be called.
For both blocking or non-blocking sockets, the details state
information can be used within the info_callback function set with the
SSL_set_info_callback() call.
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.
Further information about this software can be found on the open source
community website at https://www.openssl.org/.
RETURN VALUES
Detailed description of possible states to be included later.
SEE ALSO
ssl(3), SSL_CTX_set_info_callback(3)
1.0.2ze 2022-05-03
SSL_state_string(3openssl)