openssl/doc/man3/SSL_SESSION_is_resumable.pod
Matt Caswell 6ff7149468 Documentation updates for TLSv1.3 sessions
Add documentation for SSL_SESSION_is_resumable(). Also describe the interaction
of the various session functions and TLSv1.3 post-handshake sessions.

Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/3008)
2017-04-26 16:42:29 +01:00

41 lines
992 B
Plaintext

=pod
=head1 NAME
SSL_SESSION_is_resumable
- determine whether an SSL_SESSION object can be used for resumption
=head1 SYNOPSIS
#include <openssl/ssl.h>
const SSL_CIPHER *SSL_SESSION_is_resumable(const SSL_SESSSION *s);
=head1 DESCRIPTION
SSL_SESSION_is_resumable() determines whether an SSL_SESSION object can be used
to resume a session or not. Returns 1 if it can or 0 if not. Note that
attempting to resume with a non-resumable session will result in OpenSSL
performing a full handshake.
=head1 SEE ALSO
L<ssl(7)>,
L<SSL_get_session(3)>,
L<SSL_CTX_sess_set_new_cb(3)>
=head1 HISTORY
SSL_SESSION_is_resumable() was first added to OpenSSL 1.1.1
=head1 COPYRIGHT
Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut