summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorschwarze <>2016-11-14 19:27:16 +0000
committerschwarze <>2016-11-14 19:27:16 +0000
commitac63952ce859549a590166ddf160b2f62f581491 (patch)
tree24892258dbbdf75fe79979cd641edaf570088030
parent3f640391ac717875cf9d1e850bf20226fbc6ae01 (diff)
downloadopenbsd-ac63952ce859549a590166ddf160b2f62f581491.tar.gz
openbsd-ac63952ce859549a590166ddf160b2f62f581491.tar.bz2
openbsd-ac63952ce859549a590166ddf160b2f62f581491.zip
Add Copyright and license.
In the SYNOPSIS, show function prototypes rather than macro definitions. Delete the useless NOTES section header.
-rw-r--r--src/lib/libssl/man/BIO_f_ssl.3106
1 files changed, 93 insertions, 13 deletions
diff --git a/src/lib/libssl/man/BIO_f_ssl.3 b/src/lib/libssl/man/BIO_f_ssl.3
index e322fd7887..39a40d7715 100644
--- a/src/lib/libssl/man/BIO_f_ssl.3
+++ b/src/lib/libssl/man/BIO_f_ssl.3
@@ -1,7 +1,55 @@
1.\" $OpenBSD: BIO_f_ssl.3,v 1.2 2016/11/14 19:27:16 schwarze Exp $
2.\" OpenSSL f672aee4 Feb 9 11:52:40 2016 -0500
1.\" 3.\"
2.\" $OpenBSD: BIO_f_ssl.3,v 1.1 2016/11/05 15:32:19 schwarze Exp $ 4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
5.\" Copyright (c) 2000, 2003, 2009, 2014-2016 The OpenSSL Project.
6.\" All rights reserved.
3.\" 7.\"
4.Dd $Mdocdate: November 5 2016 $ 8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\"
12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer.
14.\"
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\" notice, this list of conditions and the following disclaimer in
17.\" the documentation and/or other materials provided with the
18.\" distribution.
19.\"
20.\" 3. All advertising materials mentioning features or use of this
21.\" software must display the following acknowledgment:
22.\" "This product includes software developed by the OpenSSL Project
23.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24.\"
25.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26.\" endorse or promote products derived from this software without
27.\" prior written permission. For written permission, please contact
28.\" openssl-core@openssl.org.
29.\"
30.\" 5. Products derived from this software may not be called "OpenSSL"
31.\" nor may "OpenSSL" appear in their names without prior written
32.\" permission of the OpenSSL Project.
33.\"
34.\" 6. Redistributions of any form whatsoever must retain the following
35.\" acknowledgment:
36.\" "This product includes software developed by the OpenSSL Project
37.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38.\"
39.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE.
51.\"
52.Dd $Mdocdate: November 14 2016 $
5.Dt BIO_F_SSL 3 53.Dt BIO_F_SSL 3
6.Os 54.Os
7.Sh NAME 55.Sh NAME
@@ -24,15 +72,36 @@
24.In openssl/ssl.h 72.In openssl/ssl.h
25.Ft BIO_METHOD * 73.Ft BIO_METHOD *
26.Fn BIO_f_ssl void 74.Fn BIO_f_ssl void
27.Fd #define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl) 75.Ft long
28.Fd #define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp) 76.Fo BIO_set_ssl
29.Fd #define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL) 77.Fa "BIO *b"
30.Fd #define BIO_set_ssl_renegotiate_bytes(b,num) \ 78.Fa "SSL *ssl"
31BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL) 79.Fa "long c"
32.Fd #define BIO_set_ssl_renegotiate_timeout(b,seconds) \ 80.Fc
33BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL) 81.Ft long
34.Fd #define BIO_get_num_renegotiates(b) \ 82.Fo BIO_get_ssl
35BIO_ctrl(b,BIO_C_SET_SSL_NUM_RENEGOTIATES,0,NULL) 83.Fa "BIO *b"
84.Fa "SSL *sslp"
85.Fc
86.Ft long
87.Fo BIO_set_ssl_mode
88.Fa "BIO *b"
89.Fa "long client"
90.Fc
91.Ft long
92.Fo BIO_set_ssl_renegotiate_bytes
93.Fa "BIO *b"
94.Fa "long num"
95.Fc
96.Ft long
97.Fo BIO_set_ssl_renegotiate_timeout
98.Fa "BIO *b"
99.Fa "long seconds"
100.Fc
101.Ft long
102.Fo BIO_get_num_renegotiates
103.Fa "BIO *b"
104.Fc
36.Ft BIO * 105.Ft BIO *
37.Fn BIO_new_ssl "SSL_CTX *ctx" "int client" 106.Fn BIO_new_ssl "SSL_CTX *ctx" "int client"
38.Ft BIO * 107.Ft BIO *
@@ -43,7 +112,8 @@ BIO_ctrl(b,BIO_C_SET_SSL_NUM_RENEGOTIATES,0,NULL)
43.Fn BIO_ssl_copy_session_id "BIO *to" "BIO *from" 112.Fn BIO_ssl_copy_session_id "BIO *to" "BIO *from"
44.Ft void 113.Ft void
45.Fn BIO_ssl_shutdown "BIO *bio" 114.Fn BIO_ssl_shutdown "BIO *bio"
46.Fd #define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL) 115.Ft long
116.Fn BIO_do_handshake "BIO *b"
47.Sh DESCRIPTION 117.Sh DESCRIPTION
48.Fn BIO_f_ssl 118.Fn BIO_f_ssl
49returns the 119returns the
@@ -233,7 +303,7 @@ should be used for non blocking connect
233.Vt BIO Ns s 303.Vt BIO Ns s
234to determine if the call should be retried. 304to determine if the call should be retried.
235If an SSL connection has already been established this call has no effect. 305If an SSL connection has already been established this call has no effect.
236.Sh NOTES 306.Pp
237.Vt SSL 307.Vt SSL
238.Vt BIO Ns s 308.Vt BIO Ns s
239are exceptional in that if the underlying transport is non-blocking they can 309are exceptional in that if the underlying transport is non-blocking they can
@@ -269,6 +339,16 @@ Applications do not have to call
269.Fn BIO_do_handshake 339.Fn BIO_do_handshake
270but may wish to do so to separate the handshake process from other I/O 340but may wish to do so to separate the handshake process from other I/O
271processing. 341processing.
342.Pp
343.Fn BIO_set_ssl ,
344.Fn BIO_get_ssl ,
345.Fn BIO_set_ssl_mode ,
346.Fn BIO_set_ssl_renegotiate_bytes ,
347.Fn BIO_set_ssl_renegotiate_timeout ,
348.Fn BIO_get_num_renegotiates ,
349and
350.Fn BIO_do_handshake
351are implemented as macros.
272.Sh RETURN VALUES 352.Sh RETURN VALUES
273.\" XXX 353.\" XXX
274This section is incomplete. 354This section is incomplete.