$NetBSD: SSL_in_init.3,v 1.8 2024/09/08 13:08:35 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "SSL_in_init 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
SSL_in_before, SSL_in_init, SSL_is_init_finished, SSL_in_connect_init, SSL_in_accept_init, SSL_get_state \- retrieve information about the handshake state machine Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& int SSL_in_init(const SSL *s); int SSL_in_before(const SSL *s); int SSL_is_init_finished(const SSL *s); \& int SSL_in_connect_init(SSL *s); int SSL_in_accept_init(SSL *s); \& OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl); .Ve Header "DESCRIPTION" \fBSSL_in_init() returns 1 if the SSL/TLS state machine is currently processing or awaiting handshake messages, or 0 otherwise.

\fBSSL_in_before() returns 1 if no SSL/TLS handshake has yet been initiated, or 0 otherwise.

\fBSSL_is_init_finished() returns 1 if the SSL/TLS connection is in a state where fully protected application data can be transferred or 0 otherwise.

Note that in some circumstances (such as when early data is being transferred) \fBSSL_in_init(), SSL_in_before() and SSL_is_init_finished() can all return 0.

\fBSSL_in_connect_init() returns 1 if s is acting as a client and SSL_in_init() would return 1, or 0 otherwise.

\fBSSL_in_accept_init() returns 1 if s is acting as a server and SSL_in_init() would return 1, or 0 otherwise.

\fBSSL_in_connect_init() and SSL_in_accept_init() are implemented as macros.

\fBSSL_get_state() returns a value indicating the current state of the handshake state machine. OSSL_HANDSHAKE_STATE is an enumerated type where each value indicates a discrete state machine state. Note that future versions of OpenSSL may define more states so applications should expect to receive unrecognised state values. The naming format is made up of a number of elements as follows:

\fBprotocol_ST_role_message

\fBprotocol is one of TLS or DTLS. DTLS is used where a state is specific to the DTLS protocol. Otherwise TLS is used.

\fBrole is one of CR, CW, SR or SW to indicate "client reading", "client writing", "server reading" or "server writing" respectively.

\fBmessage is the name of a handshake message that is being or has been sent, or is being or has been processed.

Additionally there are some special states that do not conform to the above format. These are:

Item "TLS_ST_BEFORE" No handshake messages have yet been been sent or received. Item "TLS_ST_OK" Handshake message sending/processing has completed. Item "TLS_ST_EARLY_DATA" Early data is being processed Item "TLS_ST_PENDING_EARLY_DATA_END" Awaiting the end of early data processing Header "RETURN VALUES" \fBSSL_in_init(), SSL_in_before(), SSL_is_init_finished(), SSL_in_connect_init() and SSL_in_accept_init() return values as indicated above.

\fBSSL_get_state() returns the current handshake state.

Header "SEE ALSO" \fBssl\|(7), \fBSSL_read_early_data\|(3) Header "COPYRIGHT" Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.