libcrypto/man/SSL_do_handshake.3

 $NetBSD: SSL_do_handshake.3,v 1.5 2026/04/08 17:06:48 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)

 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

 Required to disable full justification in groff 1.23.0.
 ========================================================================

 Title "SSL_do_handshake 3"  SSL_do_handshake 3 2026-04-07 3.5.6 OpenSSL
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
.nh
 NAME
SSL_do_handshake - perform a TLS/SSL handshake
 SYNOPSIS
 Header "SYNOPSIS" .Vb 1
 #include <openssl/ssl.h>
\&
 int SSL_do_handshake(SSL *ssl);
.Ve
 DESCRIPTION
 Header "DESCRIPTION" \fBSSL_do_handshake() will wait for an SSL/TLS handshake to take place. If the
connection is in client mode, the handshake will be started. The handshake
routines may have to be explicitly set in advance using either
\fBSSL_set_connect_state\|(3) or
\fBSSL_set_accept_state\|(3).
 NOTES
 Header "NOTES" The behaviour of SSL_do_handshake() depends on the underlying BIO.

If the underlying BIO is blocking, SSL_do_handshake() will only return
once the handshake has been finished or an error occurred.

If the underlying BIO is nonblocking, SSL_do_handshake() will also return
when the underlying BIO could not satisfy the needs of SSL_do_handshake()
to continue the handshake. In this case a call to SSL_get_error() with the
return value of SSL_do_handshake() will yield SSL_ERROR_WANT_READ or
\fBSSL_ERROR_WANT_WRITE. The calling process then must repeat the call after
taking appropriate action to satisfy the needs of SSL_do_handshake().
The action depends on the underlying BIO. When using a nonblocking socket,
nothing is to be done, but select() can be used to check for the required
condition. When using a buffering BIO, like a BIO pair, data must be written
into or retrieved out of the BIO before being able to continue.
 "RETURN VALUES"
 Header "RETURN VALUES" The following return values can occur:
 0 4
The TLS/SSL handshake was not successful but was shut down controlled and
by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the
return value ret to find out the reason.
 1 4
 Item "1" The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been
established.
 <0 4
 Item "<0" The TLS/SSL handshake was not successful because a fatal error occurred either
at the protocol level or a connection failure occurred. The shutdown was
not clean. It can also occur if action is needed to continue the operation
for nonblocking BIOs. Call SSL_get_error() with the return value ret
to find out the reason.
 "SEE ALSO"
 Header "SEE ALSO" \fBSSL_get_error\|(3), SSL_connect\|(3),
\fBSSL_accept\|(3), ssl\|(7), bio\|(7),
\fBSSL_set_connect_state\|(3)
 COPYRIGHT
 Header "COPYRIGHT" Copyright 2002-2020 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>.