diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/lib/libssl/man/SSL_CTX_set_info_callback.3 | 84 |
1 files changed, 73 insertions, 11 deletions
diff --git a/src/lib/libssl/man/SSL_CTX_set_info_callback.3 b/src/lib/libssl/man/SSL_CTX_set_info_callback.3 index 760c239951..2c38586078 100644 --- a/src/lib/libssl/man/SSL_CTX_set_info_callback.3 +++ b/src/lib/libssl/man/SSL_CTX_set_info_callback.3 | |||
| @@ -1,7 +1,54 @@ | |||
| 1 | .\" $OpenBSD: SSL_CTX_set_info_callback.3,v 1.2 2016/11/30 18:29:14 schwarze Exp $ | ||
| 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | ||
| 1 | .\" | 3 | .\" |
| 2 | .\" $OpenBSD: SSL_CTX_set_info_callback.3,v 1.1 2016/11/05 15:32:19 schwarze Exp $ | 4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. |
| 5 | .\" Copyright (c) 2001, 2005, 2014 The OpenSSL Project. All rights reserved. | ||
| 3 | .\" | 6 | .\" |
| 4 | .Dd $Mdocdate: November 5 2016 $ | 7 | .\" Redistribution and use in source and binary forms, with or without |
| 8 | .\" modification, are permitted provided that the following conditions | ||
| 9 | .\" are met: | ||
| 10 | .\" | ||
| 11 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 12 | .\" notice, this list of conditions and the following disclaimer. | ||
| 13 | .\" | ||
| 14 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 15 | .\" notice, this list of conditions and the following disclaimer in | ||
| 16 | .\" the documentation and/or other materials provided with the | ||
| 17 | .\" distribution. | ||
| 18 | .\" | ||
| 19 | .\" 3. All advertising materials mentioning features or use of this | ||
| 20 | .\" software must display the following acknowledgment: | ||
| 21 | .\" "This product includes software developed by the OpenSSL Project | ||
| 22 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
| 23 | .\" | ||
| 24 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
| 25 | .\" endorse or promote products derived from this software without | ||
| 26 | .\" prior written permission. For written permission, please contact | ||
| 27 | .\" openssl-core@openssl.org. | ||
| 28 | .\" | ||
| 29 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
| 30 | .\" nor may "OpenSSL" appear in their names without prior written | ||
| 31 | .\" permission of the OpenSSL Project. | ||
| 32 | .\" | ||
| 33 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
| 34 | .\" acknowledgment: | ||
| 35 | .\" "This product includes software developed by the OpenSSL Project | ||
| 36 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
| 37 | .\" | ||
| 38 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
| 39 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 40 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| 41 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
| 42 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| 43 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
| 44 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| 45 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 46 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
| 47 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
| 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| 50 | .\" | ||
| 51 | .Dd $Mdocdate: November 30 2016 $ | ||
| 5 | .Dt SSL_CTX_SET_INFO_CALLBACK 3 | 52 | .Dt SSL_CTX_SET_INFO_CALLBACK 3 |
| 6 | .Os | 53 | .Os |
| 7 | .Sh NAME | 54 | .Sh NAME |
| @@ -13,13 +60,27 @@ | |||
| 13 | .Sh SYNOPSIS | 60 | .Sh SYNOPSIS |
| 14 | .In openssl/ssl.h | 61 | .In openssl/ssl.h |
| 15 | .Ft void | 62 | .Ft void |
| 16 | .Fn SSL_CTX_set_info_callback "SSL_CTX *ctx" "void (*callback)()" | 63 | .Fo SSL_CTX_set_info_callback |
| 64 | .Fa "SSL_CTX *ctx" | ||
| 65 | .Fa "void (*callback)(const SSL *ssl, int where, int ret)" | ||
| 66 | .Fc | ||
| 17 | .Ft void | 67 | .Ft void |
| 18 | .Fn "(*SSL_CTX_get_info_callback(const SSL_CTX *ctx))" | 68 | .Fo "(*SSL_CTX_get_info_callback(const SSL_CTX *ctx))" |
| 69 | .Fa "const SSL *ssl" | ||
| 70 | .Fa "int where" | ||
| 71 | .Fa "int ret" | ||
| 72 | .Fc | ||
| 19 | .Ft void | 73 | .Ft void |
| 20 | .Fn SSL_set_info_callback "SSL *ssl" "void (*callback)()" | 74 | .Fo SSL_set_info_callback |
| 75 | .Fa "SSL *ssl" | ||
| 76 | .Fa "void (*callback)(const SSL *ssl, int where, int ret)" | ||
| 77 | .Fc | ||
| 21 | .Ft void | 78 | .Ft void |
| 22 | .Fn "(*SSL_get_info_callback(const SSL *ssl))" | 79 | .Fo "(*SSL_get_info_callback(const SSL *ssl))" |
| 80 | .Fa "const SSL *ssl" | ||
| 81 | .Fa "int where" | ||
| 82 | .Fa "int ret" | ||
| 83 | .Fc | ||
| 23 | .Sh DESCRIPTION | 84 | .Sh DESCRIPTION |
| 24 | .Fn SSL_CTX_set_info_callback | 85 | .Fn SSL_CTX_set_info_callback |
| 25 | sets the | 86 | sets the |
| @@ -59,7 +120,7 @@ returns a pointer to the currently set information callback function for | |||
| 59 | .Fn SSL_get_info_callback | 120 | .Fn SSL_get_info_callback |
| 60 | returns a pointer to the currently set information callback function for | 121 | returns a pointer to the currently set information callback function for |
| 61 | .Fa ssl . | 122 | .Fa ssl . |
| 62 | .Sh NOTES | 123 | .Pp |
| 63 | When setting up a connection and during use, | 124 | When setting up a connection and during use, |
| 64 | it is possible to obtain state information from the SSL/TLS engine. | 125 | it is possible to obtain state information from the SSL/TLS engine. |
| 65 | When set, an information callback function is called whenever the state changes, | 126 | When set, an information callback function is called whenever the state changes, |
| @@ -116,11 +177,12 @@ information can be evaluated using the | |||
| 116 | .Xr SSL_alert_type_string 3 | 177 | .Xr SSL_alert_type_string 3 |
| 117 | family of functions. | 178 | family of functions. |
| 118 | .Sh RETURN VALUES | 179 | .Sh RETURN VALUES |
| 119 | .Fn SSL_set_info_callback | 180 | .Fn SSL_CTX_get_info_callback |
| 120 | does not provide diagnostic information. | 181 | and |
| 121 | .Pp | ||
| 122 | .Fn SSL_get_info_callback | 182 | .Fn SSL_get_info_callback |
| 123 | returns the current setting. | 183 | return a pointer to the current callback or |
| 184 | .Dv NULL | ||
| 185 | if none is set. | ||
| 124 | .Sh EXAMPLES | 186 | .Sh EXAMPLES |
| 125 | The following example callback function prints state strings, | 187 | The following example callback function prints state strings, |
| 126 | information about alerts being handled and error messages to the | 188 | information about alerts being handled and error messages to the |
