xref: /minix3/crypto/external/bsd/openssl/dist/doc/ssl/SSL_state_string.pod (revision ebfedea0ce5bbe81e252ddf32d732e40fb633fae)
1*ebfedea0SLionel Sambuc=pod
2*ebfedea0SLionel Sambuc
3*ebfedea0SLionel Sambuc=head1 NAME
4*ebfedea0SLionel Sambuc
5*ebfedea0SLionel SambucSSL_state_string, SSL_state_string_long - get textual description of state of an SSL object
6*ebfedea0SLionel Sambuc
7*ebfedea0SLionel Sambuc=head1 SYNOPSIS
8*ebfedea0SLionel Sambuc
9*ebfedea0SLionel Sambuc #include <openssl/ssl.h>
10*ebfedea0SLionel Sambuc
11*ebfedea0SLionel Sambuc const char *SSL_state_string(const SSL *ssl);
12*ebfedea0SLionel Sambuc const char *SSL_state_string_long(const SSL *ssl);
13*ebfedea0SLionel Sambuc
14*ebfedea0SLionel Sambuc=head1 DESCRIPTION
15*ebfedea0SLionel Sambuc
16*ebfedea0SLionel SambucSSL_state_string() returns a 6 letter string indicating the current state
17*ebfedea0SLionel Sambucof the SSL object B<ssl>.
18*ebfedea0SLionel Sambuc
19*ebfedea0SLionel SambucSSL_state_string_long() returns a string indicating the current state of
20*ebfedea0SLionel Sambucthe SSL object B<ssl>.
21*ebfedea0SLionel Sambuc
22*ebfedea0SLionel Sambuc=head1 NOTES
23*ebfedea0SLionel Sambuc
24*ebfedea0SLionel SambucDuring its use, an SSL objects passes several states. The state is internally
25*ebfedea0SLionel Sambucmaintained. Querying the state information is not very informative before
26*ebfedea0SLionel Sambucor when a connection has been established. It however can be of significant
27*ebfedea0SLionel Sambucinterest during the handshake.
28*ebfedea0SLionel Sambuc
29*ebfedea0SLionel SambucWhen using non-blocking sockets, the function call performing the handshake
30*ebfedea0SLionel Sambucmay return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE condition,
31*ebfedea0SLionel Sambucso that SSL_state_string[_long]() may be called.
32*ebfedea0SLionel Sambuc
33*ebfedea0SLionel SambucFor both blocking or non-blocking sockets, the details state information
34*ebfedea0SLionel Sambuccan be used within the info_callback function set with the
35*ebfedea0SLionel SambucSSL_set_info_callback() call.
36*ebfedea0SLionel Sambuc
37*ebfedea0SLionel Sambuc=head1 RETURN VALUES
38*ebfedea0SLionel Sambuc
39*ebfedea0SLionel SambucDetailed description of possible states to be included later.
40*ebfedea0SLionel Sambuc
41*ebfedea0SLionel Sambuc=head1 SEE ALSO
42*ebfedea0SLionel Sambuc
43*ebfedea0SLionel SambucL<ssl(3)|ssl(3)>, L<SSL_CTX_set_info_callback(3)|SSL_CTX_set_info_callback(3)>
44*ebfedea0SLionel Sambuc
45*ebfedea0SLionel Sambuc=cut
46