1SSL_DO_HANDSHAKE(3)                 OpenSSL                SSL_DO_HANDSHAKE(3)
2
3
4

NAME

6       SSL_do_handshake - perform a TLS/SSL handshake
7

SYNOPSIS

9        #include <openssl/ssl.h>
10
11        int SSL_do_handshake(SSL *ssl);
12

DESCRIPTION

14       SSL_do_handshake() will wait for a SSL/TLS handshake to take place. If
15       the connection is in client mode, the handshake will be started. The
16       handshake routines may have to be explicitly set in advance using
17       either SSL_set_connect_state(3) or SSL_set_accept_state(3).
18

NOTES

20       The behaviour of SSL_do_handshake() depends on the underlying BIO.
21
22       If the underlying BIO is blocking, SSL_do_handshake() will only return
23       once the handshake has been finished or an error occurred.
24
25       If the underlying BIO is nonblocking, SSL_do_handshake() will also
26       return when the underlying BIO could not satisfy the needs of
27       SSL_do_handshake() to continue the handshake. In this case a call to
28       SSL_get_error() with the return value of SSL_do_handshake() will yield
29       SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE. The calling process then
30       must repeat the call after taking appropriate action to satisfy the
31       needs of SSL_do_handshake().  The action depends on the underlying BIO.
32       When using a nonblocking socket, nothing is to be done, but select()
33       can be used to check for the required condition. When using a buffering
34       BIO, like a BIO pair, data must be written into or retrieved out of the
35       BIO before being able to continue.
36

RETURN VALUES

38       The following return values can occur:
39
40       0   The TLS/SSL handshake was not successful but was shut down
41           controlled and by the specifications of the TLS/SSL protocol. Call
42           SSL_get_error() with the return value ret to find out the reason.
43
44       1   The TLS/SSL handshake was successfully completed, a TLS/SSL
45           connection has been established.
46
47       <0  The TLS/SSL handshake was not successful because a fatal error
48           occurred either at the protocol level or a connection failure
49           occurred. The shutdown was not clean. It can also occur if action
50           is needed to continue the operation for nonblocking BIOs. Call
51           SSL_get_error() with the return value ret to find out the reason.
52

SEE ALSO

54       SSL_get_error(3), SSL_connect(3), SSL_accept(3), ssl(7), bio(7),
55       SSL_set_connect_state(3)
56

58       Copyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.
59
60       Licensed under the OpenSSL license (the "License").  You may not use
61       this file except in compliance with the License.  You can obtain a copy
62       in the file LICENSE in the source distribution or at
63       <https://www.openssl.org/source/license.html>.
64
65
66
671.1.1k                            2021-03-26               SSL_DO_HANDSHAKE(3)
Impressum