OpenSSL SSL_do_handshake(3openssl)
NNNNAAAAMMMMEEEESSL_do_handshake - perform a TLS/SSL handshake
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS#include
int SSL_do_handshake(SSL *ssl);
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSL_do_handshake() will wait for a 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 eitherSSL_set_connect_state(3) or SSL_set_accept_state(3).
NNNNOOOOTTTTEEEESSSSThe behaviour of SSL_do_handshake() depends on the
underlying BIO.If the underlying BIO is bbbblllloooocccckkkkiiiinnnngggg, SSL_do_handshake() will
only return once the handshake has been finished or an error occurred, except for SGC (Server Gated Cryptography). ForSGC, SSL_do_handshake() may return with -1, but
SSL_get_error() will yield SSSSSSSSLLLL_EEEERRRRRRRROOOORRRR_WWWWAAAANNNNTTTT_RRRREEEEAAAADDDD////WWWWRRRRIIIITTTTEEEE and
SSL_do_handshake() should be called again.
If the underlying BIO is nnnnoooonnnn---bbblllloooocccckkkkiiiinnnngggg, SSL_do_handshake()
will also return when the underlying BIO could not satisfythe 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 SSSSSSSSLLLL_EEEERRRRRRRROOOORRRR_WWWWAAAANNNNTTTT_RRRREEEEAAAADDDD or
SSSSSSSSLLLL_EEEERRRRRRRROOOORRRR_WWWWAAAANNNNTTTT_WWWWRRRRIIIITTTTEEEE. The calling process then must repeat
the call after taking appropriate action to satisfy theneeds of SSL_do_handshake(). The action depends on the
underlying BIO. When using a non-blocking 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. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS The following return values can occur:1 The TLS/SSL handshake was successfully completed, a
TLS/SSL connection has been established.
0 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 rrrreeeetttt
to find out the reason.19/Jul/2002 Last change: 0.9.8o 1
OpenSSL SSL_do_handshake(3openssl)
<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 of action is need to continue the
operation for non-blocking BIOs. Call SSL_get_error()
with the return value rrrreeeetttt to find out the reason. SSSSEEEEEEEE AAAALLLLSSSSOOOOSSL_get_error(3), SSL_connect(3), SSL_accept(3), ssl(3),
bio(3), SSL_set_connect_state(3)
19/Jul/2002 Last change: 0.9.8o 2