SSL_rstate_string - get textual description of state of an SSL object during read operation
#include <openssl/ssl.h> const char *SSL_rstate_string(SSL *ssl); const char *SSL_rstate_string_long(SSL *ssl);
OpenSSL SSL_rstate_string(3openssl) NAME SSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation SYNOPSIS #include <openssl/ssl.h> const char *SSL_rstate_string(SSL *ssl); const char *SSL_rstate_string_long(SSL *ssl); DESCRIPTION SSL_rstate_string() returns a 2 letter string indicating the current read state of the SSL object ssl. SSL_rstate_string_long() returns a string indicating the current read 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 When performing a read operation, the SSL/TLS engine must parse the record, consisting of header and body. When working in a blocking environment, SSL_rstate_string[_long]() should always return "RD"/"read done". This function should only seldom be needed in applications. 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 SSL_rstate_string() and SSL_rstate_string_long() can return the following values: "RH"/"read header" The header of the record is being evaluated. "RB"/"read body" The body of the record is being evaluated. "RD"/"read done" The record has been completely processed. "unknown"/"unknown" The read state is unknown. This should never happen. SEE ALSO ssl(3) 1.0.2ze 2022-05-03 SSL_rstate_string(3openssl)