openssl: Adjust manual pages for 1.0.1n.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_f_ssl.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
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 turned on, 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 "BIO_f_ssl 3"
136 .TH BIO_f_ssl 3 "2015-06-11" "1.0.1n" "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 BIO_f_ssl, BIO_set_ssl, BIO_get_ssl, BIO_set_ssl_mode, BIO_set_ssl_renegotiate_bytes,
143 BIO_get_num_renegotiates, BIO_set_ssl_renegotiate_timeout, BIO_new_ssl,
144 BIO_new_ssl_connect, BIO_new_buffer_ssl_connect, BIO_ssl_copy_session_id,
145 BIO_ssl_shutdown \- SSL BIO
146 .SH "SYNOPSIS"
147 .IX Header "SYNOPSIS"
148 .Vb 2
149 \& #include <openssl/bio.h>
150 \& #include <openssl/ssl.h>
151 \&
152 \& BIO_METHOD *BIO_f_ssl(void);
153 \&
154 \& #define BIO_set_ssl(b,ssl,c)   BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl)
155 \& #define BIO_get_ssl(b,sslp)    BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp)
156 \& #define BIO_set_ssl_mode(b,client)     BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
157 \& #define BIO_set_ssl_renegotiate_bytes(b,num) \e
158 \&        BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL);
159 \& #define BIO_set_ssl_renegotiate_timeout(b,seconds) \e
160 \&        BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL);
161 \& #define BIO_get_num_renegotiates(b) \e
162 \&        BIO_ctrl(b,BIO_C_SET_SSL_NUM_RENEGOTIATES,0,NULL);
163 \&
164 \& BIO *BIO_new_ssl(SSL_CTX *ctx,int client);
165 \& BIO *BIO_new_ssl_connect(SSL_CTX *ctx);
166 \& BIO *BIO_new_buffer_ssl_connect(SSL_CTX *ctx);
167 \& int BIO_ssl_copy_session_id(BIO *to,BIO *from);
168 \& void BIO_ssl_shutdown(BIO *bio);
169 \&
170 \& #define BIO_do_handshake(b)    BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
171 .Ve
172 .SH "DESCRIPTION"
173 .IX Header "DESCRIPTION"
174 \&\fIBIO_f_ssl()\fR returns the \s-1SSL BIO\s0 method. This is a filter \s-1BIO\s0 which
175 is a wrapper round the OpenSSL \s-1SSL\s0 routines adding a \s-1BIO \s0\*(L"flavour\*(R" to
176 \&\s-1SSL I/O. \s0
177 .PP
178 I/O performed on an \s-1SSL BIO\s0 communicates using the \s-1SSL\s0 protocol with
179 the SSLs read and write BIOs. If an \s-1SSL\s0 connection is not established
180 then an attempt is made to establish one on the first I/O call.
181 .PP
182 If a \s-1BIO\s0 is appended to an \s-1SSL BIO\s0 using \fIBIO_push()\fR it is automatically
183 used as the \s-1SSL\s0 BIOs read and write BIOs.
184 .PP
185 Calling \fIBIO_reset()\fR on an \s-1SSL BIO\s0 closes down any current \s-1SSL\s0 connection
186 by calling \fISSL_shutdown()\fR. \fIBIO_reset()\fR is then sent to the next \s-1BIO\s0 in
187 the chain: this will typically disconnect the underlying transport.
188 The \s-1SSL BIO\s0 is then reset to the initial accept or connect state.
189 .PP
190 If the close flag is set when an \s-1SSL BIO\s0 is freed then the internal
191 \&\s-1SSL\s0 structure is also freed using \fISSL_free()\fR.
192 .PP
193 \&\fIBIO_set_ssl()\fR sets the internal \s-1SSL\s0 pointer of \s-1BIO \s0\fBb\fR to \fBssl\fR using
194 the close flag \fBc\fR.
195 .PP
196 \&\fIBIO_get_ssl()\fR retrieves the \s-1SSL\s0 pointer of \s-1BIO \s0\fBb\fR, it can then be
197 manipulated using the standard \s-1SSL\s0 library functions.
198 .PP
199 \&\fIBIO_set_ssl_mode()\fR sets the \s-1SSL BIO\s0 mode to \fBclient\fR. If \fBclient\fR
200 is 1 client mode is set. If \fBclient\fR is 0 server mode is set.
201 .PP
202 \&\fIBIO_set_ssl_renegotiate_bytes()\fR sets the renegotiate byte count
203 to \fBnum\fR. When set after every \fBnum\fR bytes of I/O (read and write) 
204 the \s-1SSL\s0 session is automatically renegotiated. \fBnum\fR must be at
205 least 512 bytes.
206 .PP
207 \&\fIBIO_set_ssl_renegotiate_timeout()\fR sets the renegotiate timeout to
208 \&\fBseconds\fR. When the renegotiate timeout elapses the session is
209 automatically renegotiated.
210 .PP
211 \&\fIBIO_get_num_renegotiates()\fR returns the total number of session
212 renegotiations due to I/O or timeout.
213 .PP
214 \&\fIBIO_new_ssl()\fR allocates an \s-1SSL BIO\s0 using \s-1SSL_CTX \s0\fBctx\fR and using
215 client mode if \fBclient\fR is non zero.
216 .PP
217 \&\fIBIO_new_ssl_connect()\fR creates a new \s-1BIO\s0 chain consisting of an
218 \&\s-1SSL BIO \s0(using \fBctx\fR) followed by a connect \s-1BIO.\s0
219 .PP
220 \&\fIBIO_new_buffer_ssl_connect()\fR creates a new \s-1BIO\s0 chain consisting
221 of a buffering \s-1BIO,\s0 an \s-1SSL BIO \s0(using \fBctx\fR) and a connect
222 \&\s-1BIO.\s0
223 .PP
224 \&\fIBIO_ssl_copy_session_id()\fR copies an \s-1SSL\s0 session id between 
225 \&\s-1BIO\s0 chains \fBfrom\fR and \fBto\fR. It does this by locating the
226 \&\s-1SSL\s0 BIOs in each chain and calling \fISSL_copy_session_id()\fR on
227 the internal \s-1SSL\s0 pointer.
228 .PP
229 \&\fIBIO_ssl_shutdown()\fR closes down an \s-1SSL\s0 connection on \s-1BIO\s0
230 chain \fBbio\fR. It does this by locating the \s-1SSL BIO\s0 in the
231 chain and calling \fISSL_shutdown()\fR on its internal \s-1SSL\s0
232 pointer.
233 .PP
234 \&\fIBIO_do_handshake()\fR attempts to complete an \s-1SSL\s0 handshake on the
235 supplied \s-1BIO\s0 and establish the \s-1SSL\s0 connection. It returns 1
236 if the connection was established successfully. A zero or negative
237 value is returned if the connection could not be established, the
238 call \fIBIO_should_retry()\fR should be used for non blocking connect BIOs
239 to determine if the call should be retried. If an \s-1SSL\s0 connection has
240 already been established this call has no effect.
241 .SH "NOTES"
242 .IX Header "NOTES"
243 \&\s-1SSL\s0 BIOs are exceptional in that if the underlying transport
244 is non blocking they can still request a retry in exceptional
245 circumstances. Specifically this will happen if a session
246 renegotiation takes place during a \fIBIO_read()\fR operation, one
247 case where this happens is when \s-1SGC\s0 or step up occurs.
248 .PP
249 In OpenSSL 0.9.6 and later the \s-1SSL\s0 flag \s-1SSL_AUTO_RETRY\s0 can be
250 set to disable this behaviour. That is when this flag is set
251 an \s-1SSL BIO\s0 using a blocking transport will never request a
252 retry.
253 .PP
254 Since unknown \fIBIO_ctrl()\fR operations are sent through filter
255 BIOs the servers name and port can be set using \fIBIO_set_host()\fR
256 on the \s-1BIO\s0 returned by \fIBIO_new_ssl_connect()\fR without having
257 to locate the connect \s-1BIO\s0 first.
258 .PP
259 Applications do not have to call \fIBIO_do_handshake()\fR but may wish
260 to do so to separate the handshake process from other I/O
261 processing.
262 .SH "RETURN VALUES"
263 .IX Header "RETURN VALUES"
264 \&\s-1TBA\s0
265 .SH "EXAMPLE"
266 .IX Header "EXAMPLE"
267 This \s-1SSL/TLS\s0 client example, attempts to retrieve a page from an
268 \&\s-1SSL/TLS\s0 web server. The I/O routines are identical to those of the
269 unencrypted example in \fIBIO_s_connect\fR\|(3).
270 .PP
271 .Vb 5
272 \& BIO *sbio, *out;
273 \& int len;
274 \& char tmpbuf[1024];
275 \& SSL_CTX *ctx;
276 \& SSL *ssl;
277 \&
278 \& ERR_load_crypto_strings();
279 \& ERR_load_SSL_strings();
280 \& OpenSSL_add_all_algorithms();
281 \&
282 \& /* We would seed the PRNG here if the platform didn\*(Aqt
283 \&  * do it automatically
284 \&  */
285 \&
286 \& ctx = SSL_CTX_new(SSLv23_client_method());
287 \&
288 \& /* We\*(Aqd normally set some stuff like the verify paths and
289 \&  * mode here because as things stand this will connect to
290 \&  * any server whose certificate is signed by any CA.
291 \&  */
292 \&
293 \& sbio = BIO_new_ssl_connect(ctx);
294 \&
295 \& BIO_get_ssl(sbio, &ssl);
296 \&
297 \& if(!ssl) {
298 \&   fprintf(stderr, "Can\*(Aqt locate SSL pointer\en");
299 \&   /* whatever ... */
300 \& }
301 \&
302 \& /* Don\*(Aqt want any retries */
303 \& SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY);
304 \&
305 \& /* We might want to do other things with ssl here */
306 \&
307 \& BIO_set_conn_hostname(sbio, "localhost:https");
308 \&
309 \& out = BIO_new_fp(stdout, BIO_NOCLOSE);
310 \& if(BIO_do_connect(sbio) <= 0) {
311 \&        fprintf(stderr, "Error connecting to server\en");
312 \&        ERR_print_errors_fp(stderr);
313 \&        /* whatever ... */
314 \& }
315 \&
316 \& if(BIO_do_handshake(sbio) <= 0) {
317 \&        fprintf(stderr, "Error establishing SSL connection\en");
318 \&        ERR_print_errors_fp(stderr);
319 \&        /* whatever ... */
320 \& }
321 \&
322 \& /* Could examine ssl here to get connection info */
323 \&
324 \& BIO_puts(sbio, "GET / HTTP/1.0\en\en");
325 \& for(;;) {      
326 \&        len = BIO_read(sbio, tmpbuf, 1024);
327 \&        if(len <= 0) break;
328 \&        BIO_write(out, tmpbuf, len);
329 \& }
330 \& BIO_free_all(sbio);
331 \& BIO_free(out);
332 .Ve
333 .PP
334 Here is a simple server example. It makes use of a buffering
335 \&\s-1BIO\s0 to allow lines to be read from the \s-1SSL BIO\s0 using BIO_gets.
336 It creates a pseudo web page containing the actual request from
337 a client and also echoes the request to standard output.
338 .PP
339 .Vb 5
340 \& BIO *sbio, *bbio, *acpt, *out;
341 \& int len;
342 \& char tmpbuf[1024];
343 \& SSL_CTX *ctx;
344 \& SSL *ssl;
345 \&
346 \& ERR_load_crypto_strings();
347 \& ERR_load_SSL_strings();
348 \& OpenSSL_add_all_algorithms();
349 \&
350 \& /* Might seed PRNG here */
351 \&
352 \& ctx = SSL_CTX_new(SSLv23_server_method());
353 \&
354 \& if (!SSL_CTX_use_certificate_file(ctx,"server.pem",SSL_FILETYPE_PEM)
355 \&        || !SSL_CTX_use_PrivateKey_file(ctx,"server.pem",SSL_FILETYPE_PEM)
356 \&        || !SSL_CTX_check_private_key(ctx)) {
357 \&
358 \&        fprintf(stderr, "Error setting up SSL_CTX\en");
359 \&        ERR_print_errors_fp(stderr);
360 \&        return 0;
361 \& }
362 \&
363 \& /* Might do other things here like setting verify locations and
364 \&  * DH and/or RSA temporary key callbacks
365 \&  */
366 \&
367 \& /* New SSL BIO setup as server */
368 \& sbio=BIO_new_ssl(ctx,0);
369 \&
370 \& BIO_get_ssl(sbio, &ssl);
371 \&
372 \& if(!ssl) {
373 \&   fprintf(stderr, "Can\*(Aqt locate SSL pointer\en");
374 \&   /* whatever ... */
375 \& }
376 \&
377 \& /* Don\*(Aqt want any retries */
378 \& SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY);
379 \&
380 \& /* Create the buffering BIO */
381 \&
382 \& bbio = BIO_new(BIO_f_buffer());
383 \&
384 \& /* Add to chain */
385 \& sbio = BIO_push(bbio, sbio);
386 \&
387 \& acpt=BIO_new_accept("4433");
388 \&
389 \& /* By doing this when a new connection is established
390 \&  * we automatically have sbio inserted into it. The
391 \&  * BIO chain is now \*(Aqswallowed\*(Aq by the accept BIO and
392 \&  * will be freed when the accept BIO is freed. 
393 \&  */
394 \& 
395 \& BIO_set_accept_bios(acpt,sbio);
396 \&
397 \& out = BIO_new_fp(stdout, BIO_NOCLOSE);
398 \&
399 \& /* Setup accept BIO */
400 \& if(BIO_do_accept(acpt) <= 0) {
401 \&        fprintf(stderr, "Error setting up accept BIO\en");
402 \&        ERR_print_errors_fp(stderr);
403 \&        return 0;
404 \& }
405 \&
406 \& /* Now wait for incoming connection */
407 \& if(BIO_do_accept(acpt) <= 0) {
408 \&        fprintf(stderr, "Error in connection\en");
409 \&        ERR_print_errors_fp(stderr);
410 \&        return 0;
411 \& }
412 \&
413 \& /* We only want one connection so remove and free
414 \&  * accept BIO
415 \&  */
416 \&
417 \& sbio = BIO_pop(acpt);
418 \&
419 \& BIO_free_all(acpt);
420 \&
421 \& if(BIO_do_handshake(sbio) <= 0) {
422 \&        fprintf(stderr, "Error in SSL handshake\en");
423 \&        ERR_print_errors_fp(stderr);
424 \&        return 0;
425 \& }
426 \&
427 \& BIO_puts(sbio, "HTTP/1.0 200 OK\er\enContent\-type: text/plain\er\en\er\en");
428 \& BIO_puts(sbio, "\er\enConnection Established\er\enRequest headers:\er\en");
429 \& BIO_puts(sbio, "\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\er\en");
430 \&
431 \& for(;;) {
432 \&        len = BIO_gets(sbio, tmpbuf, 1024);
433 \&        if(len <= 0) break;
434 \&        BIO_write(sbio, tmpbuf, len);
435 \&        BIO_write(out, tmpbuf, len);
436 \&        /* Look for blank line signifying end of headers*/
437 \&        if((tmpbuf[0] == \*(Aq\er\*(Aq) || (tmpbuf[0] == \*(Aq\en\*(Aq)) break;
438 \& }
439 \&
440 \& BIO_puts(sbio, "\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\er\en");
441 \& BIO_puts(sbio, "\er\en");
442 \&
443 \& /* Since there is a buffering BIO present we had better flush it */
444 \& BIO_flush(sbio);
445 \&
446 \& BIO_free_all(sbio);
447 .Ve
448 .SH "BUGS"
449 .IX Header "BUGS"
450 In OpenSSL versions before 1.0.0 the \fIBIO_pop()\fR call was handled incorrectly,
451 the I/O \s-1BIO\s0 reference count was incorrectly incremented (instead of
452 decremented) and dissociated with the \s-1SSL BIO\s0 even if the \s-1SSL BIO\s0 was not
453 explicitly being popped (e.g. a pop higher up the chain). Applications which
454 included workarounds for this bug (e.g. freeing BIOs more than once) should
455 be modified to handle this fix or they may free up an already freed \s-1BIO.\s0
456 .SH "SEE ALSO"
457 .IX Header "SEE ALSO"
458 \&\s-1TBA\s0