diff options
Diffstat (limited to 'lib/libssl/man/SSL_SESSION_get_id.3')
-rw-r--r-- | lib/libssl/man/SSL_SESSION_get_id.3 | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/lib/libssl/man/SSL_SESSION_get_id.3 b/lib/libssl/man/SSL_SESSION_get_id.3 new file mode 100644 index 00000000000..05b1fe53d99 --- /dev/null +++ b/lib/libssl/man/SSL_SESSION_get_id.3 @@ -0,0 +1,76 @@ +.\" $OpenBSD: SSL_SESSION_get_id.3,v 1.1 2017/04/10 15:37:55 schwarze Exp $ +.\" OpenSSL SSL_SESSION_set1_id.pod b31db505 Mar 24 16:01:50 2017 +0000 +.\" +.\" This file was written by Matt Caswell <matt@openssl.org> +.\" Copyright (c) 2017 The OpenSSL Project. All rights reserved. +.\" +.\" 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: April 10 2017 $ +.Dt SSL_SESSION_GET_ID 3 +.Os +.Sh NAME +.Nm SSL_SESSION_get_id +.Nd get the SSL session ID +.Sh SYNOPSIS +.In openssl/ssl.h +.Ft const unsigned char * +.Fo SSL_SESSION_get_id +.Fa "const SSL_SESSION *s" +.Fa "unsigned int *len" +.Fc +.Sh DESCRIPTION +.Fn SSL_SESSION_get_id +returns a pointer to the internal session id value for the session +.Fa s . +The length of the id in bytes is stored in +.Pf * Fa len . +The length may be 0. +The caller should not free the returned pointer directly. +.Sh SEE ALSO +.Xr ssl 3 , +.Xr SSL_copy_session_id 3 , +.Xr SSL_get_session 3 , +.Xr SSL_SESSION_new 3 |