diff options
author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2016-11-14 19:27:17 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2016-11-14 19:27:17 +0000 |
commit | 34b36c8f1248a0a2779b84e19db5200cc8c725ef (patch) | |
tree | 2305c1dd12ba0598539b1e5f06abec8895a5f13b /lib/libssl | |
parent | bf16ec936d99b5d09981563b4bfef122b6d85b6e (diff) |
Add Copyright and license.
In the SYNOPSIS, show function prototypes rather than macro definitions.
Delete the useless NOTES section header.
Diffstat (limited to 'lib/libssl')
-rw-r--r-- | lib/libssl/man/BIO_f_ssl.3 | 106 |
1 files changed, 93 insertions, 13 deletions
diff --git a/lib/libssl/man/BIO_f_ssl.3 b/lib/libssl/man/BIO_f_ssl.3 index e322fd78874..39a40d77150 100644 --- a/lib/libssl/man/BIO_f_ssl.3 +++ b/lib/libssl/man/BIO_f_ssl.3 @@ -1,7 +1,55 @@ +.\" $OpenBSD: BIO_f_ssl.3,v 1.2 2016/11/14 19:27:16 schwarze Exp $ +.\" OpenSSL f672aee4 Feb 9 11:52:40 2016 -0500 .\" -.\" $OpenBSD: BIO_f_ssl.3,v 1.1 2016/11/05 15:32:19 schwarze Exp $ +.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. +.\" Copyright (c) 2000, 2003, 2009, 2014-2016 The OpenSSL Project. +.\" All rights reserved. .\" -.Dd $Mdocdate: November 5 2016 $ +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in +.\" the documentation and/or other materials provided with the +.\" distribution. +.\" +.\" 3. All advertising materials mentioning features or use of this +.\" software must display the following acknowledgment: +.\" "This product includes software developed by the OpenSSL Project +.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" +.\" +.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to +.\" endorse or promote products derived from this software without +.\" prior written permission. For written permission, please contact +.\" openssl-core@openssl.org. +.\" +.\" 5. Products derived from this software may not be called "OpenSSL" +.\" nor may "OpenSSL" appear in their names without prior written +.\" permission of the OpenSSL Project. +.\" +.\" 6. Redistributions of any form whatsoever must retain the following +.\" acknowledgment: +.\" "This product includes software developed by the OpenSSL Project +.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY +.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR +.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +.\" OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd $Mdocdate: November 14 2016 $ .Dt BIO_F_SSL 3 .Os .Sh NAME @@ -24,15 +72,36 @@ .In openssl/ssl.h .Ft BIO_METHOD * .Fn BIO_f_ssl void -.Fd #define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl) -.Fd #define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp) -.Fd #define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL) -.Fd #define BIO_set_ssl_renegotiate_bytes(b,num) \ -BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL) -.Fd #define BIO_set_ssl_renegotiate_timeout(b,seconds) \ -BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL) -.Fd #define BIO_get_num_renegotiates(b) \ -BIO_ctrl(b,BIO_C_SET_SSL_NUM_RENEGOTIATES,0,NULL) +.Ft long +.Fo BIO_set_ssl +.Fa "BIO *b" +.Fa "SSL *ssl" +.Fa "long c" +.Fc +.Ft long +.Fo BIO_get_ssl +.Fa "BIO *b" +.Fa "SSL *sslp" +.Fc +.Ft long +.Fo BIO_set_ssl_mode +.Fa "BIO *b" +.Fa "long client" +.Fc +.Ft long +.Fo BIO_set_ssl_renegotiate_bytes +.Fa "BIO *b" +.Fa "long num" +.Fc +.Ft long +.Fo BIO_set_ssl_renegotiate_timeout +.Fa "BIO *b" +.Fa "long seconds" +.Fc +.Ft long +.Fo BIO_get_num_renegotiates +.Fa "BIO *b" +.Fc .Ft BIO * .Fn BIO_new_ssl "SSL_CTX *ctx" "int client" .Ft BIO * @@ -43,7 +112,8 @@ BIO_ctrl(b,BIO_C_SET_SSL_NUM_RENEGOTIATES,0,NULL) .Fn BIO_ssl_copy_session_id "BIO *to" "BIO *from" .Ft void .Fn BIO_ssl_shutdown "BIO *bio" -.Fd #define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL) +.Ft long +.Fn BIO_do_handshake "BIO *b" .Sh DESCRIPTION .Fn BIO_f_ssl returns the @@ -233,7 +303,7 @@ should be used for non blocking connect .Vt BIO Ns s to determine if the call should be retried. If an SSL connection has already been established this call has no effect. -.Sh NOTES +.Pp .Vt SSL .Vt BIO Ns s are exceptional in that if the underlying transport is non-blocking they can @@ -269,6 +339,16 @@ Applications do not have to call .Fn BIO_do_handshake but may wish to do so to separate the handshake process from other I/O processing. +.Pp +.Fn BIO_set_ssl , +.Fn BIO_get_ssl , +.Fn BIO_set_ssl_mode , +.Fn BIO_set_ssl_renegotiate_bytes , +.Fn BIO_set_ssl_renegotiate_timeout , +.Fn BIO_get_num_renegotiates , +and +.Fn BIO_do_handshake +are implemented as macros. .Sh RETURN VALUES .\" XXX This section is incomplete. |