skip book previous and next navigation links
go up to top of book: HP Open Source Security for OpenVMS Volume 2:... HP Open Source Security for OpenVMS Volume 2:...
go to beginning of reference: SSL Application Programming Interface (API) Reference SSL Application Programming Interface (API) Reference
go to previous page: SSL_CTX_use_certificate SSL_CTX_use_certificate
go to next page: SSL_freeSSL_free
end of book navigation links


SSL_do_handshake
Description
Notes
Return Values
See Also
 

NAME

SSL_do_handshake - perform a TLS/SSL handshake

Synopsis  

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


return to top DESCRIPTION  

SSL_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 either SSL_set_connect_state(3) or SSL_set_accept_state(3) .


return to top 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, except for SGC (Server Gated Cryptography). For SGC, SSL_do_handshake() may return with -1, but SSL_get_error() will yield SSL_ERROR_WANT_READ/WRITE and SSL_do_handshake() should be called again.

If the underlying BIO is non-blocking, 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 SSL_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 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.


return to top RETURN VALUES  

The following return values can occur:


return to top SEE ALSO  

SSL_get_error(3) , SSL_connect(3) , SSL_accept(3) , ssl(3) , bio(3) , SSL_set_connect_state(3)
go to previous page: SSL_CTX_use_certificate SSL_CTX_use_certificate
go to next page: SSL_freeSSL_free