1.\" $OpenBSD: SSL_state_string.3,v 1.4 2018/03/27 17:35:50 schwarze Exp $ 2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 3.\" 4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. 5.\" Copyright (c) 2001, 2005 The OpenSSL Project. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in 16.\" the documentation and/or other materials provided with the 17.\" distribution. 18.\" 19.\" 3. All advertising materials mentioning features or use of this 20.\" software must display the following acknowledgment: 21.\" "This product includes software developed by the OpenSSL Project 22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 23.\" 24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 25.\" endorse or promote products derived from this software without 26.\" prior written permission. For written permission, please contact 27.\" openssl-core@openssl.org. 28.\" 29.\" 5. Products derived from this software may not be called "OpenSSL" 30.\" nor may "OpenSSL" appear in their names without prior written 31.\" permission of the OpenSSL Project. 32.\" 33.\" 6. Redistributions of any form whatsoever must retain the following 34.\" acknowledgment: 35.\" "This product includes software developed by the OpenSSL Project 36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 37.\" 38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" 51.Dd $Mdocdate: March 27 2018 $ 52.Dt SSL_STATE_STRING 3 53.Os 54.Sh NAME 55.Nm SSL_state_string , 56.Nm SSL_state_string_long 57.Nd get textual description of state of an SSL object 58.Sh SYNOPSIS 59.In openssl/ssl.h 60.Ft const char * 61.Fn SSL_state_string "const SSL *ssl" 62.Ft const char * 63.Fn SSL_state_string_long "const SSL *ssl" 64.Sh DESCRIPTION 65.Fn SSL_state_string 66returns a 6 letter string indicating the current state of the 67.Vt SSL 68object 69.Fa ssl . 70.Pp 71.Fn SSL_state_string_long 72returns a string indicating the current state of the 73.Vt SSL 74object 75.Fa ssl . 76.Pp 77During its use, an 78.Vt SSL 79object passes several states. 80The state is internally maintained. 81Querying the state information is not very informative before or when a 82connection has been established. 83It however can be of significant interest during the handshake. 84.Pp 85When using non-blocking sockets, 86the function call performing the handshake may return with 87.Dv SSL_ERROR_WANT_READ 88or 89.Dv SSL_ERROR_WANT_WRITE 90condition, so that 91.Fn SSL_state_string[_long] 92may be called. 93.Pp 94For both blocking or non-blocking sockets, 95the details state information can be used within the 96.Fn info_callback 97function set with the 98.Xr SSL_set_info_callback 3 99call. 100.Sh RETURN VALUES 101Detailed description of possible states to be included later. 102.Sh SEE ALSO 103.Xr ssl 3 , 104.Xr SSL_CTX_set_info_callback 3 105.Sh HISTORY 106.Fn SSL_state_string 107and 108.Fn SSL_state_string_long 109first appeared in SSLeay 0.6.0 and have been available since 110.Ox 2.4 . 111