doc/ssl/SSL_connect.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_connect - initiate the TLS/SSL handshake with an TLS/SSL server
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  int SSL_connect(SSL *ssl);
  12
  13 =head1 DESCRIPTION
  14
  15 SSL_connect() initiates the TLS/SSL handshake with a server. The communication
  16 channel must already have been set and assigned to the B<ssl> by setting an
  17 underlying B<BIO>.
  18
  19 =head1 NOTES
  20
  21 The behaviour of SSL_connect() depends on the underlying BIO.
  22
  23 If the underlying BIO is B<blocking>, SSL_connect() will only return once the
  24 handshake has been finished or an error occurred.
  25
  26 If the underlying BIO is B<non-blocking>, SSL_connect() will also return
  27 when the underlying BIO could not satisfy the needs of SSL_connect()
  28 to continue the handshake. In this case a call to SSL_get_error() with the
  29 return value of SSL_connect() will yield B<SSL_ERROR_WANT_READ> or
  30 B<SSL_ERROR_WANT_WRITE>. The calling process then must repeat the call after
  31 taking appropriate action to satisfy the needs of SSL_connect().
  32 The action depends on the underlying BIO. When using a non-blocking socket,
  33 nothing is to be done, but select() can be used to check for the required
  34 condition. When using a buffering BIO, like a BIO pair, data must be written
  35 into or retrieved out of the BIO before being able to continue.
  36
  37 =head1 RETURN VALUES
  38
  39 The following return values can occur:
  40
  41 =over 4
  42
  43 =item 1
  44
  45 The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been
  46 established.
  47
  48 =item 0
  49
  50 The TLS/SSL handshake was not successful but was shut down controlled and
  51 by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the
  52 return value B<ret> to find out the reason.
  53
  54 =item E<lt>0
  55
  56 The TLS/SSL handshake was not successful, because a fatal error occurred either
  57 at the protocol level or a connection failure occurred. The shutdown was
  58 not clean. It can also occur of action is need to continue the operation
  59 for non-blocking BIOs. Call SSL_get_error() with the return value B<ret>
  60 to find out the reason.
  61
  62 =back
  63
  64 =head1 SEE ALSO
  65
  66 L<SSL_get_error(3)|SSL_get_error(3)>, L<SSL_accept(3)|SSL_accept(3)>,
  67 L<SSL_shutdown(3)|SSL_shutdown(3)>, L<ssl(3)|ssl(3)>, L<bio(3)|bio(3)>
  68
  69 =cut