Merge the stub SSL_SESSION_is_resumable(3) manual page from the
authorschwarze <schwarze@openbsd.org>
Tue, 14 Sep 2021 14:08:15 +0000 (14:08 +0000)
committerschwarze <schwarze@openbsd.org>
Tue, 14 Sep 2021 14:08:15 +0000 (14:08 +0000)
OpenSSL 1.1.1 branch, which is still under a free license.
A few tweaks to wording and structure by me.
OK tb@ on SSL_SESSION_is_resumable.3

lib/libssl/man/Makefile
lib/libssl/man/SSL_SESSION_is_resumable.3 [new file with mode: 0644]
lib/libssl/man/SSL_SESSION_new.3

index de1390e..0c8805d 100644 (file)
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.71 2021/05/12 14:17:27 tb Exp $
+# $OpenBSD: Makefile,v 1.72 2021/09/14 14:08:15 schwarze Exp $
 
 .include <bsd.own.mk>
 
@@ -61,6 +61,7 @@ MAN = BIO_f_ssl.3 \
        SSL_SESSION_get0_cipher.3 \
        SSL_SESSION_get0_peer.3 \
        SSL_SESSION_has_ticket.3 \
+       SSL_SESSION_is_resumable.3 \
        SSL_SESSION_new.3 \
        SSL_SESSION_print.3 \
        SSL_SESSION_set1_id_context.3 \
diff --git a/lib/libssl/man/SSL_SESSION_is_resumable.3 b/lib/libssl/man/SSL_SESSION_is_resumable.3
new file mode 100644 (file)
index 0000000..48d7d17
--- /dev/null
@@ -0,0 +1,81 @@
+.\" $OpenBSD: SSL_SESSION_is_resumable.3,v 1.1 2021/09/14 14:08:15 schwarze Exp $
+.\" full merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100
+.\"
+.\" 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: September 14 2021 $
+.Dt SSL_SESSION_IS_RESUMABLE 3
+.Os
+.Sh NAME
+.Nm SSL_SESSION_is_resumable
+.Nd determine whether an SSL_SESSION object can be used for resumption
+.Sh SYNOPSIS
+.In openssl/ssl.h
+.Ft int
+.Fo SSL_SESSION_is_resumable
+.Fa "const SSL_SESSION *session"
+.Fc
+.Sh DESCRIPTION
+.Fn SSL_SESSION_is_resumable
+determines whether the
+.Fa session
+object can be used to resume a session.
+Note that attempting to resume with a non-resumable session
+will result in a full handshake.
+.Sh RETURN VALUES
+.Fn SSL_SESSION_is_resumable
+returns 1 if the session is resumable or 0 otherwise.
+It always returns 0 with LibreSSL.
+.Sh SEE ALSO
+.Xr ssl 3 ,
+.Xr SSL_CTX_sess_set_new_cb 3 ,
+.Xr SSL_get_session 3
+.Sh HISTORY
+.Fn SSL_SESSION_is_resumable
+first appeared in OpenSSL 1.1.1 and has been available since
+.Ox 7.0 .
index bfc68eb..2dcdb26 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: SSL_SESSION_new.3,v 1.8 2020/12/03 22:47:22 jmc Exp $
+.\" $OpenBSD: SSL_SESSION_new.3,v 1.9 2021/09/14 14:08:15 schwarze Exp $
 .\"
 .\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: December 3 2020 $
+.Dd $Mdocdate: September 14 2021 $
 .Dt SSL_SESSION_NEW 3
 .Os
 .Sh NAME
@@ -68,6 +68,7 @@ returns
 .Xr SSL_SESSION_get_protocol_version 3 ,
 .Xr SSL_SESSION_get_time 3 ,
 .Xr SSL_SESSION_has_ticket 3 ,
+.Xr SSL_SESSION_is_resumable 3 ,
 .Xr SSL_SESSION_print 3 ,
 .Xr SSL_SESSION_set1_id_context 3 ,
 .Xr SSL_set_session 3