lib/libssl/man/SSL_do_handshake.3

   1 .\"     $OpenBSD: SSL_do_handshake.3,v 1.4 2016/12/16 15:39:08 jmc Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   3 .\"
   4 .\" This file was written by Martin Sjoegren <martin@strakt.com>.
   5 .\" Copyright (c) 2002 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: December 16 2016 $
  52 .Dt SSL_DO_HANDSHAKE 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_do_handshake
  56 .Nd perform a TLS/SSL handshake
  57 .Sh SYNOPSIS
  58 .In openssl/ssl.h
  59 .Ft int
  60 .Fn SSL_do_handshake "SSL *ssl"
  61 .Sh DESCRIPTION
  62 .Fn SSL_do_handshake
  63 will wait for a SSL/TLS handshake to take place.
  64 If the connection is in client mode, the handshake will be started.
  65 The handshake routines may have to be explicitly set in advance using either
  66 .Xr SSL_set_connect_state 3
  67 or
  68 .Xr SSL_set_accept_state 3 .
  69 .Pp
  70 The behaviour of
  71 .Fn SSL_do_handshake
  72 depends on the underlying
  73 .Vt BIO .
  74 .Pp
  75 If the underlying
  76 .Vt BIO
  77 is
  78 .Em blocking ,
  79 .Fn SSL_do_handshake
  80 will only return once the handshake has been finished or an error occurred.
  81 .Pp
  82 If the underlying
  83 .Vt BIO
  84 is
  85 .Em non-blocking ,
  86 .Fn SSL_do_handshake
  87 will also return when the underlying
  88 .Vt BIO
  89 could not satisfy the needs of
  90 .Fn SSL_do_handshake
  91 to continue the handshake.
  92 In this case a call to
  93 .Xr SSL_get_error 3
  94 with the return value of
  95 .Fn SSL_do_handshake
  96 will yield
  97 .Dv SSL_ERROR_WANT_READ
  98 or
  99 .Dv SSL_ERROR_WANT_WRITE .
 100 The calling process then must repeat the call after taking appropriate action
 101 to satisfy the needs of
 102 .Fn SSL_do_handshake .
 103 The action depends on the underlying
 104 .Vt BIO .
 105 When using a non-blocking socket, nothing is to be done, but
 106 .Xr select 2
 107 can be used to check for the required condition.
 108 When using a buffering
 109 .Vt BIO ,
 110 like a
 111 .Vt BIO
 112 pair, data must be written into or retrieved out of the
 113 .Vt BIO
 114 before being able to continue.
 115 .Sh RETURN VALUES
 116 The following return values can occur:
 117 .Bl -tag -width Ds
 118 .It 0
 119 The TLS/SSL handshake was not successful but was shut down controlled and
 120 by the specifications of the TLS/SSL protocol.
 121 Call
 122 .Xr SSL_get_error 3
 123 with the return value
 124 .Fa ret
 125 to find out the reason.
 126 .It 1
 127 The TLS/SSL handshake was successfully completed,
 128 and a TLS/SSL connection has been established.
 129 .It <0
 130 The TLS/SSL handshake was not successful because either a fatal error occurred
 131 at the protocol level or a connection failure occurred.
 132 The shutdown was not clean.
 133 It can also occur if action is needed to continue the operation for
 134 non-blocking
 135 .Vt BIO Ns s .
 136 Call
 137 .Xr SSL_get_error 3
 138 with the return value
 139 .Fa ret
 140 to find out the reason.
 141 .El
 142 .Sh SEE ALSO
 143 .Xr BIO_new 3 ,
 144 .Xr ssl 3 ,
 145 .Xr SSL_accept 3 ,
 146 .Xr SSL_connect 3 ,
 147 .Xr SSL_get_error 3 ,
 148 .Xr SSL_set_connect_state 3