Name

SSL_connect — initiate the TLS/SSL handshake with an TLS/SSL server.

Library

libssl.lib

Synopsis

#include <openssl/ssl.h>

int SSL_connect(SSL *ssl);

Detailed Description

SSL_connect()initiates the TLS/SSL handshake with a server. The communication channel must already have been set and assigned to the ssl by setting an underlying BIO.

Notes

The behaviour of SSL_connect() depends on the underlying BIO.

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

If the underlying BIO is non-blocking, SSL_connect() will also return when the underlying BIO could not satisfy the needs of SSL_connect() to continue the handshake, indicating the problem by the return value -1. In this case a call to SSL_get_error() with the return value of SSL_connect() 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_connect(). 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 Values

The following return values can occur:

<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 ret to find out the reason.

See Also

SSL_get_error(), SSL_accept(), SSL_shutdown(), ssl(), bio(), SSL_set_connect_state(), SSL_do_handshake(), SSL_CTX_new()

Feedback

For additional information or queries on this page send feedback