SSL_rstate_string(3ssl)

SSL_rstate_string3ssl

Get textual description of state of an ssl object during read operation

Usage

 #include <openssl/ssl.h>
 const char *SSL_rstate_string(SSL *ssl);
 const char *SSL_rstate_string_long(SSL *ssl);

Overview

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.

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.

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.

"unknown"/"unknown"

The read state is unknown. This should never happen.

When used with QUIC SSL objects, these functions always return "RH"/"read header" in normal conditions.

Releases

13 releases since Debian 3.0 (Woody); the text changed 12 times.

  1. 3.0
  2. 3.1
  3. 4.0
  4. 5.0
  5. 6.0
  6. 7
  7. 8
  8. 9
  9. 10
  10. 11
  11. 12
  12. 13
  13. Arch

From openssl 3.6.5-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.