secure/lib/libcrypto/man/man3/SSL_connect.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
   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 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SSL_CONNECT 3"
 136 .TH SSL_CONNECT 3 "2021-02-16" "1.1.1j" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 SSL_connect \- initiate the TLS/SSL handshake with an TLS/SSL server
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int SSL_connect(SSL *ssl);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 \&\fBSSL_connect()\fR initiates the \s-1TLS/SSL\s0 handshake with a server. The communication
 153 channel must already have been set and assigned to the \fBssl\fR by setting an
 154 underlying \fB\s-1BIO\s0\fR.
 155 .SH "NOTES"
 156 .IX Header "NOTES"
 157 The behaviour of \fBSSL_connect()\fR depends on the underlying \s-1BIO.\s0
 158 .PP
 159 If the underlying \s-1BIO\s0 is \fBblocking\fR, \fBSSL_connect()\fR will only return once the
 160 handshake has been finished or an error occurred.
 161 .PP
 162 If the underlying \s-1BIO\s0 is \fBnonblocking\fR, \fBSSL_connect()\fR will also return
 163 when the underlying \s-1BIO\s0 could not satisfy the needs of \fBSSL_connect()\fR
 164 to continue the handshake, indicating the problem by the return value \-1.
 165 In this case a call to \fBSSL_get_error()\fR with the
 166 return value of \fBSSL_connect()\fR will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR or
 167 \&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. The calling process then must repeat the call after
 168 taking appropriate action to satisfy the needs of \fBSSL_connect()\fR.
 169 The action depends on the underlying \s-1BIO.\s0 When using a nonblocking socket,
 170 nothing is to be done, but \fBselect()\fR can be used to check for the required
 171 condition. When using a buffering \s-1BIO,\s0 like a \s-1BIO\s0 pair, data must be written
 172 into or retrieved out of the \s-1BIO\s0 before being able to continue.
 173 .PP
 174 Many systems implement Nagle's algorithm by default which means that it will
 175 buffer outgoing \s-1TCP\s0 data if a \s-1TCP\s0 packet has already been sent for which no
 176 corresponding \s-1ACK\s0 has been received yet from the peer. This can have performance
 177 impacts after a successful TLSv1.3 handshake or a successful TLSv1.2 (or below)
 178 resumption handshake, because the last peer to communicate in the handshake is
 179 the client. If the client is also the first to send application data (as is
 180 typical for many protocols) then this data could be buffered until an \s-1ACK\s0 has
 181 been received for the final handshake message.
 182 .PP
 183 The \fB\s-1TCP_NODELAY\s0\fR socket option is often available to disable Nagle's
 184 algorithm. If an application opts to disable Nagle's algorithm consideration
 185 should be given to turning it back on again later if appropriate. The helper
 186 function \fBBIO_set_tcp_ndelay()\fR can be used to turn on or off the \fB\s-1TCP_NODELAY\s0\fR
 187 option.
 188 .SH "RETURN VALUES"
 189 .IX Header "RETURN VALUES"
 190 The following return values can occur:
 191 .IP "0" 4
 192 The \s-1TLS/SSL\s0 handshake was not successful but was shut down controlled and
 193 by the specifications of the \s-1TLS/SSL\s0 protocol. Call \fBSSL_get_error()\fR with the
 194 return value \fBret\fR to find out the reason.
 195 .IP "1" 4
 196 .IX Item "1"
 197 The \s-1TLS/SSL\s0 handshake was successfully completed, a \s-1TLS/SSL\s0 connection has been
 198 established.
 199 .IP "<0" 4
 200 .IX Item "<0"
 201 The \s-1TLS/SSL\s0 handshake was not successful, because a fatal error occurred either
 202 at the protocol level or a connection failure occurred. The shutdown was
 203 not clean. It can also occur if action is needed to continue the operation
 204 for nonblocking BIOs. Call \fBSSL_get_error()\fR with the return value \fBret\fR
 205 to find out the reason.
 206 .SH "SEE ALSO"
 207 .IX Header "SEE ALSO"
 208 \&\fBSSL_get_error\fR\|(3), \fBSSL_accept\fR\|(3),
 209 \&\fBSSL_shutdown\fR\|(3), \fBssl\fR\|(7), \fBbio\fR\|(7),
 210 \&\fBSSL_set_connect_state\fR\|(3),
 211 \&\fBSSL_do_handshake\fR\|(3),
 212 \&\fBSSL_CTX_new\fR\|(3)
 213 .SH "COPYRIGHT"
 214 .IX Header "COPYRIGHT"
 215 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
 216 .PP
 217 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 218 this file except in compliance with the License.  You can obtain a copy
 219 in the file \s-1LICENSE\s0 in the source distribution or at
 220 <https://www.openssl.org/source/license.html>.