secure/lib/libcrypto/man/SSL_connect.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_CONNECT 3"
 132 .TH SSL_CONNECT 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 SSL_connect \- initiate the TLS/SSL handshake with an TLS/SSL server
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& int SSL_connect(SSL *ssl);
 145 .Ve
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 \&\fISSL_connect()\fR initiates the \s-1TLS/SSL\s0 handshake with a server. The communication
 149 channel must already have been set and assigned to the \fBssl\fR by setting an
 150 underlying \fB\s-1BIO\s0\fR.
 151 .SH "NOTES"
 152 .IX Header "NOTES"
 153 The behaviour of \fISSL_connect()\fR depends on the underlying \s-1BIO.\s0
 154 .PP
 155 If the underlying \s-1BIO\s0 is \fBblocking\fR, \fISSL_connect()\fR will only return once the
 156 handshake has been finished or an error occurred.
 157 .PP
 158 If the underlying \s-1BIO\s0 is \fBnon-blocking\fR, \fISSL_connect()\fR will also return
 159 when the underlying \s-1BIO\s0 could not satisfy the needs of \fISSL_connect()\fR
 160 to continue the handshake, indicating the problem by the return value \-1.
 161 In this case a call to \fISSL_get_error()\fR with the
 162 return value of \fISSL_connect()\fR will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR or
 163 \&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. The calling process then must repeat the call after
 164 taking appropriate action to satisfy the needs of \fISSL_connect()\fR.
 165 The action depends on the underlying \s-1BIO.\s0 When using a non-blocking socket,
 166 nothing is to be done, but \fIselect()\fR can be used to check for the required
 167 condition. When using a buffering \s-1BIO,\s0 like a \s-1BIO\s0 pair, data must be written
 168 into or retrieved out of the \s-1BIO\s0 before being able to continue.
 169 .PP
 170 Many systems implement Nagle's algorithm by default which means that it will
 171 buffer outgoing \s-1TCP\s0 data if a \s-1TCP\s0 packet has already been sent for which no
 172 corresponding \s-1ACK\s0 has been received yet from the peer. This can have performance
 173 impacts after a successful TLSv1.3 handshake or a successful TLSv1.2 (or below)
 174 resumption handshake, because the last peer to communicate in the handshake is
 175 the client. If the client is also the first to send application data (as is
 176 typical for many protocols) then this data could be buffered until an \s-1ACK\s0 has
 177 been received for the final handshake message.
 178 .PP
 179 The \fB\s-1TCP_NODELAY\s0\fR socket option is often available to disable Nagle's
 180 algorithm. If an application opts to disable Nagle's algorithm consideration
 181 should be given to turning it back on again later if appropriate. The helper
 182 function \fIBIO_set_tcp_ndelay()\fR can be used to turn on or off the \fB\s-1TCP_NODELAY\s0\fR
 183 option.
 184 .SH "RETURN VALUES"
 185 .IX Header "RETURN VALUES"
 186 The following return values can occur:
 187 .IP "0" 4
 188 The \s-1TLS/SSL\s0 handshake was not successful but was shut down controlled and
 189 by the specifications of the \s-1TLS/SSL\s0 protocol. Call \fISSL_get_error()\fR with the
 190 return value \fBret\fR to find out the reason.
 191 .IP "1" 4
 192 .IX Item "1"
 193 The \s-1TLS/SSL\s0 handshake was successfully completed, a \s-1TLS/SSL\s0 connection has been
 194 established.
 195 .IP "<0" 4
 196 .IX Item "<0"
 197 The \s-1TLS/SSL\s0 handshake was not successful, because a fatal error occurred either
 198 at the protocol level or a connection failure occurred. The shutdown was
 199 not clean. It can also occur of action is need to continue the operation
 200 for non-blocking BIOs. Call \fISSL_get_error()\fR with the return value \fBret\fR
 201 to find out the reason.
 202 .SH "SEE ALSO"
 203 .IX Header "SEE ALSO"
 204 \&\fISSL_get_error\fR\|(3), \fISSL_accept\fR\|(3),
 205 \&\fISSL_shutdown\fR\|(3), \fIssl\fR\|(7), \fIbio\fR\|(7),
 206 \&\fISSL_set_connect_state\fR\|(3),
 207 \&\fISSL_do_handshake\fR\|(3),
 208 \&\fISSL_CTX_new\fR\|(3)
 209 .SH "COPYRIGHT"
 210 .IX Header "COPYRIGHT"
 211 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 212 .PP
 213 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 214 this file except in compliance with the License.  You can obtain a copy
 215 in the file \s-1LICENSE\s0 in the source distribution or at
 216 <https://www.openssl.org/source/license.html>.