summaryrefslogtreecommitdiffstats
path: root/lib/libssl/man
diff options
context:
space:
mode:
authorschwarze <schwarze@openbsd.org>2016-11-30 18:29:14 +0000
committerschwarze <schwarze@openbsd.org>2016-11-30 18:29:14 +0000
commit27ef29481a1ecebcb1fc8bba74de5f86ebfff865 (patch)
tree2c6c66b44a68f2017a71cc3600122dc1d49ab6f1 /lib/libssl/man
parentAdd Copyright and license. (diff)
downloadwireguard-openbsd-27ef29481a1ecebcb1fc8bba74de5f86ebfff865.tar.xz
wireguard-openbsd-27ef29481a1ecebcb1fc8bba74de5f86ebfff865.zip
Add Copyright and license.
Correct prototypes. Drop the useless statement that a void function does not return a value.
Diffstat (limited to 'lib/libssl/man')
-rw-r--r--lib/libssl/man/SSL_CTX_set_info_callback.384
1 files changed, 73 insertions, 11 deletions
diff --git a/lib/libssl/man/SSL_CTX_set_info_callback.3 b/lib/libssl/man/SSL_CTX_set_info_callback.3
index 760c239951b..2c38586078e 100644
--- a/lib/libssl/man/SSL_CTX_set_info_callback.3
+++ b/lib/libssl/man/SSL_CTX_set_info_callback.3
@@ -1,7 +1,54 @@
+.\" $OpenBSD: SSL_CTX_set_info_callback.3,v 1.2 2016/11/30 18:29:14 schwarze Exp $
+.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
.\"
-.\" $OpenBSD: SSL_CTX_set_info_callback.3,v 1.1 2016/11/05 15:32:19 schwarze Exp $
+.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
+.\" Copyright (c) 2001, 2005, 2014 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 30 2016 $
.Dt SSL_CTX_SET_INFO_CALLBACK 3
.Os
.Sh NAME
@@ -13,13 +60,27 @@
.Sh SYNOPSIS
.In openssl/ssl.h
.Ft void
-.Fn SSL_CTX_set_info_callback "SSL_CTX *ctx" "void (*callback)()"
+.Fo SSL_CTX_set_info_callback
+.Fa "SSL_CTX *ctx"
+.Fa "void (*callback)(const SSL *ssl, int where, int ret)"
+.Fc
.Ft void
-.Fn "(*SSL_CTX_get_info_callback(const SSL_CTX *ctx))"
+.Fo "(*SSL_CTX_get_info_callback(const SSL_CTX *ctx))"
+.Fa "const SSL *ssl"
+.Fa "int where"
+.Fa "int ret"
+.Fc
.Ft void
-.Fn SSL_set_info_callback "SSL *ssl" "void (*callback)()"
+.Fo SSL_set_info_callback
+.Fa "SSL *ssl"
+.Fa "void (*callback)(const SSL *ssl, int where, int ret)"
+.Fc
.Ft void
-.Fn "(*SSL_get_info_callback(const SSL *ssl))"
+.Fo "(*SSL_get_info_callback(const SSL *ssl))"
+.Fa "const SSL *ssl"
+.Fa "int where"
+.Fa "int ret"
+.Fc
.Sh DESCRIPTION
.Fn SSL_CTX_set_info_callback
sets the
@@ -59,7 +120,7 @@ returns a pointer to the currently set information callback function for
.Fn SSL_get_info_callback
returns a pointer to the currently set information callback function for
.Fa ssl .
-.Sh NOTES
+.Pp
When setting up a connection and during use,
it is possible to obtain state information from the SSL/TLS engine.
When set, an information callback function is called whenever the state changes,
@@ -116,11 +177,12 @@ information can be evaluated using the
.Xr SSL_alert_type_string 3
family of functions.
.Sh RETURN VALUES
-.Fn SSL_set_info_callback
-does not provide diagnostic information.
-.Pp
+.Fn SSL_CTX_get_info_callback
+and
.Fn SSL_get_info_callback
-returns the current setting.
+return a pointer to the current callback or
+.Dv NULL
+if none is set.
.Sh EXAMPLES
The following example callback function prints state strings,
information about alerts being handled and error messages to the