1 .\" Automatically generated by Pod::Man 2.12 (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 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
124 .\" ========================================================================
126 .IX Title "SSL_connect 3"
127 .TH SSL_connect 3 "2007-10-24" "0.9.8g" "OpenSSL"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 SSL_connect \- initiate the TLS/SSL handshake with an TLS/SSL server
135 .IX Header "SYNOPSIS"
137 \& #include <openssl/ssl.h>
139 \& int SSL_connect(SSL *ssl);
142 .IX Header "DESCRIPTION"
143 \&\fISSL_connect()\fR initiates the \s-1TLS/SSL\s0 handshake with a server. The communication
144 channel must already have been set and assigned to the \fBssl\fR by setting an
145 underlying \fB\s-1BIO\s0\fR.
148 The behaviour of \fISSL_connect()\fR depends on the underlying \s-1BIO\s0.
150 If the underlying \s-1BIO\s0 is \fBblocking\fR, \fISSL_connect()\fR will only return once the
151 handshake has been finished or an error occurred.
153 If the underlying \s-1BIO\s0 is \fBnon-blocking\fR, \fISSL_connect()\fR will also return
154 when the underlying \s-1BIO\s0 could not satisfy the needs of \fISSL_connect()\fR
155 to continue the handshake, indicating the problem by the return value \-1.
156 In this case a call to \fISSL_get_error()\fR with the
157 return value of \fISSL_connect()\fR will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR or
158 \&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. The calling process then must repeat the call after
159 taking appropriate action to satisfy the needs of \fISSL_connect()\fR.
160 The action depends on the underlying \s-1BIO\s0. When using a non-blocking socket,
161 nothing is to be done, but \fIselect()\fR can be used to check for the required
162 condition. When using a buffering \s-1BIO\s0, like a \s-1BIO\s0 pair, data must be written
163 into or retrieved out of the \s-1BIO\s0 before being able to continue.
165 .IX Header "RETURN VALUES"
166 The following return values can occur:
168 The \s-1TLS/SSL\s0 handshake was successfully completed, a \s-1TLS/SSL\s0 connection has been
171 The \s-1TLS/SSL\s0 handshake was not successful but was shut down controlled and
172 by the specifications of the \s-1TLS/SSL\s0 protocol. Call \fISSL_get_error()\fR with the
173 return value \fBret\fR to find out the reason.
177 The \s-1TLS/SSL\s0 handshake was not successful, because a fatal error occurred either
178 at the protocol level or a connection failure occurred. The shutdown was
179 not clean. It can also occur of action is need to continue the operation
180 for non-blocking BIOs. Call \fISSL_get_error()\fR with the return value \fBret\fR
181 to find out the reason.
183 .IX Header "SEE ALSO"
184 \&\fISSL_get_error\fR\|(3), \fISSL_accept\fR\|(3),
185 \&\fISSL_shutdown\fR\|(3), \fIssl\fR\|(3), \fIbio\fR\|(3),
186 \&\fISSL_set_connect_state\fR\|(3),
187 \&\fISSL_do_handshake\fR\|(3),
188 \&\fISSL_CTX_new\fR\|(3)
190 .IX Header "POD ERRORS"
191 Hey! \fBThe above document had some coding errors, which are explained below:\fR
192 .IP "Around line 49:" 4
193 .IX Item "Around line 49:"
194 You have '=item 0' instead of the expected '=item 2'
195 .IP "Around line 55:" 4
196 .IX Item "Around line 55:"