1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
61 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
88 . \" simple accents for nroff and troff
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
132 .\" ========================================================================
134 .IX Title "SSL_connect 3"
135 .TH SSL_connect 3 "2009-04-11" "0.9.8k" "OpenSSL"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
141 SSL_connect \- initiate the TLS/SSL handshake with an TLS/SSL server
143 .IX Header "SYNOPSIS"
145 \& #include <openssl/ssl.h>
147 \& int SSL_connect(SSL *ssl);
150 .IX Header "DESCRIPTION"
151 \&\fISSL_connect()\fR initiates the \s-1TLS/SSL\s0 handshake with a server. The communication
152 channel must already have been set and assigned to the \fBssl\fR by setting an
153 underlying \fB\s-1BIO\s0\fR.
156 The behaviour of \fISSL_connect()\fR depends on the underlying \s-1BIO\s0.
158 If the underlying \s-1BIO\s0 is \fBblocking\fR, \fISSL_connect()\fR will only return once the
159 handshake has been finished or an error occurred.
161 If the underlying \s-1BIO\s0 is \fBnon-blocking\fR, \fISSL_connect()\fR will also return
162 when the underlying \s-1BIO\s0 could not satisfy the needs of \fISSL_connect()\fR
163 to continue the handshake, indicating the problem by the return value \-1.
164 In this case a call to \fISSL_get_error()\fR with the
165 return value of \fISSL_connect()\fR will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR or
166 \&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. The calling process then must repeat the call after
167 taking appropriate action to satisfy the needs of \fISSL_connect()\fR.
168 The action depends on the underlying \s-1BIO\s0. When using a non-blocking socket,
169 nothing is to be done, but \fIselect()\fR can be used to check for the required
170 condition. When using a buffering \s-1BIO\s0, like a \s-1BIO\s0 pair, data must be written
171 into or retrieved out of the \s-1BIO\s0 before being able to continue.
173 .IX Header "RETURN VALUES"
174 The following return values can occur:
176 The \s-1TLS/SSL\s0 handshake was successfully completed, a \s-1TLS/SSL\s0 connection has been
179 The \s-1TLS/SSL\s0 handshake was not successful but was shut down controlled and
180 by the specifications of the \s-1TLS/SSL\s0 protocol. Call \fISSL_get_error()\fR with the
181 return value \fBret\fR to find out the reason.
185 The \s-1TLS/SSL\s0 handshake was not successful, because a fatal error occurred either
186 at the protocol level or a connection failure occurred. The shutdown was
187 not clean. It can also occur of action is need to continue the operation
188 for non-blocking BIOs. Call \fISSL_get_error()\fR with the return value \fBret\fR
189 to find out the reason.
191 .IX Header "SEE ALSO"
192 \&\fISSL_get_error\fR\|(3), \fISSL_accept\fR\|(3),
193 \&\fISSL_shutdown\fR\|(3), \fIssl\fR\|(3), \fIbio\fR\|(3),
194 \&\fISSL_set_connect_state\fR\|(3),
195 \&\fISSL_do_handshake\fR\|(3),
196 \&\fISSL_CTX_new\fR\|(3)
198 .IX Header "POD ERRORS"
199 Hey! \fBThe above document had some coding errors, which are explained below:\fR
200 .IP "Around line 49:" 4
201 .IX Item "Around line 49:"
202 You have '=item 0' instead of the expected '=item 2'
203 .IP "Around line 55:" 4
204 .IX Item "Around line 55:"