Deleted Added
sdiff udiff text old ( 206048 ) new ( 215698 )
full compact
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
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. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
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
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
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.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1

--- 48 unchanged lines hidden (view full) ---

124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "BIO_f_ssl 3"
132.TH BIO_f_ssl 3 "2010-03-24" "0.9.8n" "OpenSSL"
133.SH "NAME"
134BIO_f_ssl, BIO_set_ssl, BIO_get_ssl, BIO_set_ssl_mode, BIO_set_ssl_renegotiate_bytes,
135BIO_get_num_renegotiates, BIO_set_ssl_renegotiate_timeout, BIO_new_ssl,
136BIO_new_ssl_connect, BIO_new_buffer_ssl_connect, BIO_ssl_copy_session_id,
137BIO_ssl_shutdown \- SSL BIO
138.SH "SYNOPSIS"
139.IX Header "SYNOPSIS"
140.Vb 2
141\& #include <openssl/bio.h>
142\& #include <openssl/ssl.h>
143.Ve
144.PP
145.Vb 1
146\& BIO_METHOD *BIO_f_ssl(void);
147.Ve
148.PP
149.Vb 9
150\& #define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl)
151\& #define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp)
152\& #define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
153\& #define BIO_set_ssl_renegotiate_bytes(b,num) \e
154\& BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL);
155\& #define BIO_set_ssl_renegotiate_timeout(b,seconds) \e
156\& BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL);
157\& #define BIO_get_num_renegotiates(b) \e
158\& BIO_ctrl(b,BIO_C_SET_SSL_NUM_RENEGOTIATES,0,NULL);
159.Ve
160.PP
161.Vb 5
162\& BIO *BIO_new_ssl(SSL_CTX *ctx,int client);
163\& BIO *BIO_new_ssl_connect(SSL_CTX *ctx);
164\& BIO *BIO_new_buffer_ssl_connect(SSL_CTX *ctx);
165\& int BIO_ssl_copy_session_id(BIO *to,BIO *from);
166\& void BIO_ssl_shutdown(BIO *bio);
167.Ve
168.PP
169.Vb 1
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\s0 \s-1BIO\s0 method. This is a filter \s-1BIO\s0 which
175is a wrapper round the OpenSSL \s-1SSL\s0 routines adding a \s-1BIO\s0 \*(L"flavour\*(R" to
176\&\s-1SSL\s0 I/O.
177.PP
178I/O performed on an \s-1SSL\s0 \s-1BIO\s0 communicates using the \s-1SSL\s0 protocol with
179the SSLs read and write BIOs. If an \s-1SSL\s0 connection is not established
180then an attempt is made to establish one on the first I/O call.
181.PP
182If a \s-1BIO\s0 is appended to an \s-1SSL\s0 \s-1BIO\s0 using \fIBIO_push()\fR it is automatically
183used as the \s-1SSL\s0 BIOs read and write BIOs.
184.PP

--- 84 unchanged lines hidden (view full) ---

269unencrypted 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.Ve
278.PP
279.Vb 3
280\& ERR_load_crypto_strings();
281\& ERR_load_SSL_strings();
282\& OpenSSL_add_all_algorithms();
283.Ve
284.PP
285.Vb 3
286\& /* We would seed the PRNG here if the platform didn't
287\& * do it automatically
288\& */
289.Ve
290.PP
291.Vb 1
292\& ctx = SSL_CTX_new(SSLv23_client_method());
293.Ve
294.PP
295.Vb 4
296\& /* We'd normally set some stuff like the verify paths and
297\& * mode here because as things stand this will connect to
298\& * any server whose certificate is signed by any CA.
299\& */
300.Ve
301.PP
302.Vb 1
303\& sbio = BIO_new_ssl_connect(ctx);
304.Ve
305.PP
306.Vb 1
307\& BIO_get_ssl(sbio, &ssl);
308.Ve
309.PP
310.Vb 4
311\& if(!ssl) {
312\& fprintf(stderr, "Can't locate SSL pointer\en");
313\& /* whatever ... */
314\& }
315.Ve
316.PP
317.Vb 2
318\& /* Don't want any retries */
319\& SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY);
320.Ve
321.PP
322.Vb 1
323\& /* We might want to do other things with ssl here */
324.Ve
325.PP
326.Vb 1
327\& BIO_set_conn_hostname(sbio, "localhost:https");
328.Ve
329.PP
330.Vb 6
331\& out = BIO_new_fp(stdout, BIO_NOCLOSE);
332\& if(BIO_do_connect(sbio) <= 0) {
333\& fprintf(stderr, "Error connecting to server\en");
334\& ERR_print_errors_fp(stderr);
335\& /* whatever ... */
336\& }
337.Ve
338.PP
339.Vb 5
340\& if(BIO_do_handshake(sbio) <= 0) {
341\& fprintf(stderr, "Error establishing SSL connection\en");
342\& ERR_print_errors_fp(stderr);
343\& /* whatever ... */
344\& }
345.Ve
346.PP
347.Vb 1
348\& /* Could examine ssl here to get connection info */
349.Ve
350.PP
351.Vb 8
352\& BIO_puts(sbio, "GET / HTTP/1.0\en\en");
353\& for(;;) {
354\& len = BIO_read(sbio, tmpbuf, 1024);
355\& if(len <= 0) break;
356\& BIO_write(out, tmpbuf, len);
357\& }
358\& BIO_free_all(sbio);
359\& BIO_free(out);

--- 5 unchanged lines hidden (view full) ---

365a client and also echoes the request to standard output.
366.PP
367.Vb 5
368\& BIO *sbio, *bbio, *acpt, *out;
369\& int len;
370\& char tmpbuf[1024];
371\& SSL_CTX *ctx;
372\& SSL *ssl;
373.Ve
374.PP
375.Vb 3
376\& ERR_load_crypto_strings();
377\& ERR_load_SSL_strings();
378\& OpenSSL_add_all_algorithms();
379.Ve
380.PP
381.Vb 1
382\& /* Might seed PRNG here */
383.Ve
384.PP
385.Vb 1
386\& ctx = SSL_CTX_new(SSLv23_server_method());
387.Ve
388.PP
389.Vb 3
390\& if (!SSL_CTX_use_certificate_file(ctx,"server.pem",SSL_FILETYPE_PEM)
391\& || !SSL_CTX_use_PrivateKey_file(ctx,"server.pem",SSL_FILETYPE_PEM)
392\& || !SSL_CTX_check_private_key(ctx)) {
393.Ve
394.PP
395.Vb 4
396\& fprintf(stderr, "Error setting up SSL_CTX\en");
397\& ERR_print_errors_fp(stderr);
398\& return 0;
399\& }
400.Ve
401.PP
402.Vb 3
403\& /* Might do other things here like setting verify locations and
404\& * DH and/or RSA temporary key callbacks
405\& */
406.Ve
407.PP
408.Vb 2
409\& /* New SSL BIO setup as server */
410\& sbio=BIO_new_ssl(ctx,0);
411.Ve
412.PP
413.Vb 1
414\& BIO_get_ssl(sbio, &ssl);
415.Ve
416.PP
417.Vb 4
418\& if(!ssl) {
419\& fprintf(stderr, "Can't locate SSL pointer\en");
420\& /* whatever ... */
421\& }
422.Ve
423.PP
424.Vb 2
425\& /* Don't want any retries */
426\& SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY);
427.Ve
428.PP
429.Vb 1
430\& /* Create the buffering BIO */
431.Ve
432.PP
433.Vb 1
434\& bbio = BIO_new(BIO_f_buffer());
435.Ve
436.PP
437.Vb 2
438\& /* Add to chain */
439\& sbio = BIO_push(bbio, sbio);
440.Ve
441.PP
442.Vb 1
443\& acpt=BIO_new_accept("4433");
444.Ve
445.PP
446.Vb 5
447\& /* By doing this when a new connection is established
448\& * we automatically have sbio inserted into it. The
449\& * BIO chain is now 'swallowed' by the accept BIO and
450\& * will be freed when the accept BIO is freed.
451\& */
452.Ve
453.PP
454.Vb 1
455\& BIO_set_accept_bios(acpt,sbio);
456.Ve
457.PP
458.Vb 1
459\& out = BIO_new_fp(stdout, BIO_NOCLOSE);
460.Ve
461.PP
462.Vb 6
463\& /* Setup accept BIO */
464\& if(BIO_do_accept(acpt) <= 0) {
465\& fprintf(stderr, "Error setting up accept BIO\en");
466\& ERR_print_errors_fp(stderr);
467\& return 0;
468\& }
469.Ve
470.PP
471.Vb 6
472\& /* Now wait for incoming connection */
473\& if(BIO_do_accept(acpt) <= 0) {
474\& fprintf(stderr, "Error in connection\en");
475\& ERR_print_errors_fp(stderr);
476\& return 0;
477\& }
478.Ve
479.PP
480.Vb 3
481\& /* We only want one connection so remove and free
482\& * accept BIO
483\& */
484.Ve
485.PP
486.Vb 1
487\& sbio = BIO_pop(acpt);
488.Ve
489.PP
490.Vb 1
491\& BIO_free_all(acpt);
492.Ve
493.PP
494.Vb 5
495\& if(BIO_do_handshake(sbio) <= 0) {
496\& fprintf(stderr, "Error in SSL handshake\en");
497\& ERR_print_errors_fp(stderr);
498\& return 0;
499\& }
500.Ve
501.PP
502.Vb 3
503\& BIO_puts(sbio, "HTTP/1.0 200 OK\er\enContent-type: text/plain\er\en\er\en");
504\& BIO_puts(sbio, "\er\enConnection Established\er\enRequest headers:\er\en");
505\& BIO_puts(sbio, "--------------------------------------------------\er\en");
506.Ve
507.PP
508.Vb 8
509\& for(;;) {
510\& len = BIO_gets(sbio, tmpbuf, 1024);
511\& if(len <= 0) break;
512\& BIO_write(sbio, tmpbuf, len);
513\& BIO_write(out, tmpbuf, len);
514\& /* Look for blank line signifying end of headers*/
515\& if((tmpbuf[0] == '\er') || (tmpbuf[0] == '\en')) break;
516\& }
517.Ve
518.PP
519.Vb 2
520\& BIO_puts(sbio, "--------------------------------------------------\er\en");
521\& BIO_puts(sbio, "\er\en");
522.Ve
523.PP
524.Vb 2
525\& /* Since there is a buffering BIO present we had better flush it */
526\& BIO_flush(sbio);
527.Ve
528.PP
529.Vb 1
530\& BIO_free_all(sbio);
531.Ve
532.SH "SEE ALSO"
533.IX Header "SEE ALSO"
534\&\s-1TBA\s0