]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - secure/lib/libcrypto/man/man3/BIO_f_ssl.3
OpenSSL: Merge OpenSSL 1.1.1o
[FreeBSD/FreeBSD.git] / secure / lib / libcrypto / man / man3 / BIO_f_ssl.3
1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
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 "BIO_F_SSL 3"
136 .TH BIO_F_SSL 3 "2022-05-03" "1.1.1o" "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_do_handshake, BIO_f_ssl, BIO_set_ssl, BIO_get_ssl, BIO_set_ssl_mode, BIO_set_ssl_renegotiate_bytes, BIO_get_num_renegotiates, BIO_set_ssl_renegotiate_timeout, BIO_new_ssl, BIO_new_ssl_connect, BIO_new_buffer_ssl_connect, BIO_ssl_copy_session_id, BIO_ssl_shutdown \- SSL BIO
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 2
146 \& #include <openssl/bio.h>
147 \& #include <openssl/ssl.h>
148 \&
149 \& const BIO_METHOD *BIO_f_ssl(void);
150 \&
151 \& long BIO_set_ssl(BIO *b, SSL *ssl, long c);
152 \& long BIO_get_ssl(BIO *b, SSL **sslp);
153 \& long BIO_set_ssl_mode(BIO *b, long client);
154 \& long BIO_set_ssl_renegotiate_bytes(BIO *b, long num);
155 \& long BIO_set_ssl_renegotiate_timeout(BIO *b, long seconds);
156 \& long BIO_get_num_renegotiates(BIO *b);
157 \&
158 \& BIO *BIO_new_ssl(SSL_CTX *ctx, int client);
159 \& BIO *BIO_new_ssl_connect(SSL_CTX *ctx);
160 \& BIO *BIO_new_buffer_ssl_connect(SSL_CTX *ctx);
161 \& int BIO_ssl_copy_session_id(BIO *to, BIO *from);
162 \& void BIO_ssl_shutdown(BIO *bio);
163 \&
164 \& long BIO_do_handshake(BIO *b);
165 .Ve
166 .SH "DESCRIPTION"
167 .IX Header "DESCRIPTION"
168 \&\fBBIO_f_ssl()\fR returns the \s-1SSL BIO\s0 method. This is a filter \s-1BIO\s0 which
169 is a wrapper round the OpenSSL \s-1SSL\s0 routines adding a \s-1BIO\s0 \*(L"flavour\*(R" to
170 \&\s-1SSL I/O.\s0
171 .PP
172 I/O performed on an \s-1SSL BIO\s0 communicates using the \s-1SSL\s0 protocol with
173 the SSLs read and write BIOs. If an \s-1SSL\s0 connection is not established
174 then an attempt is made to establish one on the first I/O call.
175 .PP
176 If a \s-1BIO\s0 is appended to an \s-1SSL BIO\s0 using \fBBIO_push()\fR it is automatically
177 used as the \s-1SSL\s0 BIOs read and write BIOs.
178 .PP
179 Calling \fBBIO_reset()\fR on an \s-1SSL BIO\s0 closes down any current \s-1SSL\s0 connection
180 by calling \fBSSL_shutdown()\fR. \fBBIO_reset()\fR is then sent to the next \s-1BIO\s0 in
181 the chain: this will typically disconnect the underlying transport.
182 The \s-1SSL BIO\s0 is then reset to the initial accept or connect state.
183 .PP
184 If the close flag is set when an \s-1SSL BIO\s0 is freed then the internal
185 \&\s-1SSL\s0 structure is also freed using \fBSSL_free()\fR.
186 .PP
187 \&\fBBIO_set_ssl()\fR sets the internal \s-1SSL\s0 pointer of \s-1SSL BIO\s0 \fBb\fR to \fBssl\fR using
188 the close flag \fBc\fR.
189 .PP
190 \&\fBBIO_get_ssl()\fR retrieves the \s-1SSL\s0 pointer of \s-1SSL BIO\s0 \fBb\fR, it can then be
191 manipulated using the standard \s-1SSL\s0 library functions.
192 .PP
193 \&\fBBIO_set_ssl_mode()\fR sets the \s-1SSL BIO\s0 mode to \fBclient\fR. If \fBclient\fR
194 is 1 client mode is set. If \fBclient\fR is 0 server mode is set.
195 .PP
196 \&\fBBIO_set_ssl_renegotiate_bytes()\fR sets the renegotiate byte count of \s-1SSL BIO\s0 \fBb\fR
197 to \fBnum\fR. When set after every \fBnum\fR bytes of I/O (read and write)
198 the \s-1SSL\s0 session is automatically renegotiated. \fBnum\fR must be at
199 least 512 bytes.
200 .PP
201 \&\fBBIO_set_ssl_renegotiate_timeout()\fR sets the renegotiate timeout of \s-1SSL BIO\s0 \fBb\fR
202 to \fBseconds\fR.
203 When the renegotiate timeout elapses the session is automatically renegotiated.
204 .PP
205 \&\fBBIO_get_num_renegotiates()\fR returns the total number of session
206 renegotiations due to I/O or timeout of \s-1SSL BIO\s0 \fBb\fR.
207 .PP
208 \&\fBBIO_new_ssl()\fR allocates an \s-1SSL BIO\s0 using \s-1SSL_CTX\s0 \fBctx\fR and using
209 client mode if \fBclient\fR is non zero.
210 .PP
211 \&\fBBIO_new_ssl_connect()\fR creates a new \s-1BIO\s0 chain consisting of an
212 \&\s-1SSL BIO\s0 (using \fBctx\fR) followed by a connect \s-1BIO.\s0
213 .PP
214 \&\fBBIO_new_buffer_ssl_connect()\fR creates a new \s-1BIO\s0 chain consisting
215 of a buffering \s-1BIO,\s0 an \s-1SSL BIO\s0 (using \fBctx\fR), and a connect \s-1BIO.\s0
216 .PP
217 \&\fBBIO_ssl_copy_session_id()\fR copies an \s-1SSL\s0 session id between
218 \&\s-1BIO\s0 chains \fBfrom\fR and \fBto\fR. It does this by locating the
219 \&\s-1SSL\s0 BIOs in each chain and calling \fBSSL_copy_session_id()\fR on
220 the internal \s-1SSL\s0 pointer.
221 .PP
222 \&\fBBIO_ssl_shutdown()\fR closes down an \s-1SSL\s0 connection on \s-1BIO\s0
223 chain \fBbio\fR. It does this by locating the \s-1SSL BIO\s0 in the
224 chain and calling \fBSSL_shutdown()\fR on its internal \s-1SSL\s0
225 pointer.
226 .PP
227 \&\fBBIO_do_handshake()\fR attempts to complete an \s-1SSL\s0 handshake on the
228 supplied \s-1BIO\s0 and establish the \s-1SSL\s0 connection. It returns 1
229 if the connection was established successfully. A zero or negative
230 value is returned if the connection could not be established, the
231 call \fBBIO_should_retry()\fR should be used for non blocking connect BIOs
232 to determine if the call should be retried. If an \s-1SSL\s0 connection has
233 already been established this call has no effect.
234 .SH "NOTES"
235 .IX Header "NOTES"
236 \&\s-1SSL\s0 BIOs are exceptional in that if the underlying transport
237 is non blocking they can still request a retry in exceptional
238 circumstances. Specifically this will happen if a session
239 renegotiation takes place during a \fBBIO_read_ex()\fR operation, one
240 case where this happens is when step up occurs.
241 .PP
242 The \s-1SSL\s0 flag \s-1SSL_AUTO_RETRY\s0 can be
243 set to disable this behaviour. That is when this flag is set
244 an \s-1SSL BIO\s0 using a blocking transport will never request a
245 retry.
246 .PP
247 Since unknown \fBBIO_ctrl()\fR operations are sent through filter
248 BIOs the servers name and port can be set using \fBBIO_set_host()\fR
249 on the \s-1BIO\s0 returned by \fBBIO_new_ssl_connect()\fR without having
250 to locate the connect \s-1BIO\s0 first.
251 .PP
252 Applications do not have to call \fBBIO_do_handshake()\fR but may wish
253 to do so to separate the handshake process from other I/O
254 processing.
255 .PP
256 \&\fBBIO_set_ssl()\fR, \fBBIO_get_ssl()\fR, \fBBIO_set_ssl_mode()\fR,
257 \&\fBBIO_set_ssl_renegotiate_bytes()\fR, \fBBIO_set_ssl_renegotiate_timeout()\fR,
258 \&\fBBIO_get_num_renegotiates()\fR, and \fBBIO_do_handshake()\fR are implemented as macros.
259 .SH "RETURN VALUES"
260 .IX Header "RETURN VALUES"
261 \&\fBBIO_f_ssl()\fR returns the \s-1SSL\s0 \fB\s-1BIO_METHOD\s0\fR structure.
262 .PP
263 \&\fBBIO_set_ssl()\fR, \fBBIO_get_ssl()\fR, \fBBIO_set_ssl_mode()\fR, \fBBIO_set_ssl_renegotiate_bytes()\fR,
264 \&\fBBIO_set_ssl_renegotiate_timeout()\fR and \fBBIO_get_num_renegotiates()\fR return 1 on
265 success or a value which is less than or equal to 0 if an error occurred.
266 .PP
267 \&\fBBIO_new_ssl()\fR, \fBBIO_new_ssl_connect()\fR and \fBBIO_new_buffer_ssl_connect()\fR return
268 a valid \fB\s-1BIO\s0\fR structure on success or \fB\s-1NULL\s0\fR if an error occurred.
269 .PP
270 \&\fBBIO_ssl_copy_session_id()\fR returns 1 on success or 0 on error.
271 .PP
272 \&\fBBIO_do_handshake()\fR returns 1 if the connection was established successfully.
273 A zero or negative value is returned if the connection could not be established.
274 .SH "EXAMPLES"
275 .IX Header "EXAMPLES"
276 This \s-1SSL/TLS\s0 client example attempts to retrieve a page from an
277 \&\s-1SSL/TLS\s0 web server. The I/O routines are identical to those of the
278 unencrypted example in \fBBIO_s_connect\fR\|(3).
279 .PP
280 .Vb 5
281 \& BIO *sbio, *out;
282 \& int len;
283 \& char tmpbuf[1024];
284 \& SSL_CTX *ctx;
285 \& SSL *ssl;
286 \&
287 \& /* XXX Seed the PRNG if needed. */
288 \&
289 \& ctx = SSL_CTX_new(TLS_client_method());
290 \&
291 \& /* XXX Set verify paths and mode here. */
292 \&
293 \& sbio = BIO_new_ssl_connect(ctx);
294 \& BIO_get_ssl(sbio, &ssl);
295 \& if (ssl == NULL) {
296 \&     fprintf(stderr, "Can\*(Aqt locate SSL pointer\en");
297 \&     ERR_print_errors_fp(stderr);
298 \&     exit(1);
299 \& }
300 \&
301 \& /* Don\*(Aqt want any retries */
302 \& SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY);
303 \&
304 \& /* XXX We might want to do other things with ssl here */
305 \&
306 \& /* An empty host part means the loopback address */
307 \& BIO_set_conn_hostname(sbio, ":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 \&     exit(1);
314 \& }
315 \&
316 \& /* XXX Could examine ssl here to get connection info */
317 \&
318 \& BIO_puts(sbio, "GET / HTTP/1.0\en\en");
319 \& for (;;) {
320 \&     len = BIO_read(sbio, tmpbuf, 1024);
321 \&     if (len <= 0)
322 \&         break;
323 \&     BIO_write(out, tmpbuf, len);
324 \& }
325 \& BIO_free_all(sbio);
326 \& BIO_free(out);
327 .Ve
328 .PP
329 Here is a simple server example. It makes use of a buffering
330 \&\s-1BIO\s0 to allow lines to be read from the \s-1SSL BIO\s0 using BIO_gets.
331 It creates a pseudo web page containing the actual request from
332 a client and also echoes the request to standard output.
333 .PP
334 .Vb 5
335 \& BIO *sbio, *bbio, *acpt, *out;
336 \& int len;
337 \& char tmpbuf[1024];
338 \& SSL_CTX *ctx;
339 \& SSL *ssl;
340 \&
341 \& /* XXX Seed the PRNG if needed. */
342 \&
343 \& ctx = SSL_CTX_new(TLS_server_method());
344 \& if (!SSL_CTX_use_certificate_file(ctx, "server.pem", SSL_FILETYPE_PEM)
345 \&         || !SSL_CTX_use_PrivateKey_file(ctx, "server.pem", SSL_FILETYPE_PEM)
346 \&         || !SSL_CTX_check_private_key(ctx)) {
347 \&     fprintf(stderr, "Error setting up SSL_CTX\en");
348 \&     ERR_print_errors_fp(stderr);
349 \&     exit(1);
350 \& }
351 \&
352 \& /* XXX Other things like set verify locations, EDH temp callbacks. */
353 \&
354 \& /* New SSL BIO setup as server */
355 \& sbio = BIO_new_ssl(ctx, 0);
356 \& BIO_get_ssl(sbio, &ssl);
357 \& if (ssl == NULL) {
358 \&     fprintf(stderr, "Can\*(Aqt locate SSL pointer\en");
359 \&     ERR_print_errors_fp(stderr);
360 \&     exit(1);
361 \& }
362 \&
363 \& SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY);
364 \& bbio = BIO_new(BIO_f_buffer());
365 \& sbio = BIO_push(bbio, sbio);
366 \& acpt = BIO_new_accept("4433");
367 \&
368 \& /*
369 \&  * By doing this when a new connection is established
370 \&  * we automatically have sbio inserted into it. The
371 \&  * BIO chain is now \*(Aqswallowed\*(Aq by the accept BIO and
372 \&  * will be freed when the accept BIO is freed.
373 \&  */
374 \& BIO_set_accept_bios(acpt, sbio);
375 \& out = BIO_new_fp(stdout, BIO_NOCLOSE);
376 \&
377 \& /* Setup accept BIO */
378 \& if (BIO_do_accept(acpt) <= 0) {
379 \&     fprintf(stderr, "Error setting up accept BIO\en");
380 \&     ERR_print_errors_fp(stderr);
381 \&     exit(1);
382 \& }
383 \&
384 \& /* We only want one connection so remove and free accept BIO */
385 \& sbio = BIO_pop(acpt);
386 \& BIO_free_all(acpt);
387 \&
388 \& if (BIO_do_handshake(sbio) <= 0) {
389 \&     fprintf(stderr, "Error in SSL handshake\en");
390 \&     ERR_print_errors_fp(stderr);
391 \&     exit(1);
392 \& }
393 \&
394 \& BIO_puts(sbio, "HTTP/1.0 200 OK\er\enContent\-type: text/plain\er\en\er\en");
395 \& BIO_puts(sbio, "\er\enConnection Established\er\enRequest headers:\er\en");
396 \& BIO_puts(sbio, "\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\er\en");
397 \&
398 \& for (;;) {
399 \&     len = BIO_gets(sbio, tmpbuf, 1024);
400 \&     if (len <= 0)
401 \&         break;
402 \&     BIO_write(sbio, tmpbuf, len);
403 \&     BIO_write(out, tmpbuf, len);
404 \&     /* Look for blank line signifying end of headers*/
405 \&     if (tmpbuf[0] == \*(Aq\er\*(Aq || tmpbuf[0] == \*(Aq\en\*(Aq)
406 \&         break;
407 \& }
408 \&
409 \& BIO_puts(sbio, "\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\er\en");
410 \& BIO_puts(sbio, "\er\en");
411 \& BIO_flush(sbio);
412 \& BIO_free_all(sbio);
413 .Ve
414 .SH "HISTORY"
415 .IX Header "HISTORY"
416 In OpenSSL before 1.0.0 the \fBBIO_pop()\fR call was handled incorrectly,
417 the I/O \s-1BIO\s0 reference count was incorrectly incremented (instead of
418 decremented) and dissociated with the \s-1SSL BIO\s0 even if the \s-1SSL BIO\s0 was not
419 explicitly being popped (e.g. a pop higher up the chain). Applications which
420 included workarounds for this bug (e.g. freeing BIOs more than once) should
421 be modified to handle this fix or they may free up an already freed \s-1BIO.\s0
422 .SH "COPYRIGHT"
423 .IX Header "COPYRIGHT"
424 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
425 .PP
426 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
427 this file except in compliance with the License.  You can obtain a copy
428 in the file \s-1LICENSE\s0 in the source distribution or at
429 <https://www.openssl.org/source/license.html>.