diff options
| author | Matt Caswell <matt@openssl.org> | 2017-06-14 13:58:29 +0100 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2017-06-21 14:45:35 +0100 |
| commit | 267869d3f307e1160f79e1b09246bb091ed00bbf (patch) | |
| tree | 2a3b3ec3718e23df4a5cd8cfd333416be8a88a1b | |
| parent | 5eb7273669e5dc05c9b744cbba5a2a2915827746 (diff) | |
Document SSL_SESSION_set_protocol_version()
Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/3670)
| -rw-r--r-- | doc/man3/SSL_SESSION_get_protocol_version.pod | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/doc/man3/SSL_SESSION_get_protocol_version.pod b/doc/man3/SSL_SESSION_get_protocol_version.pod index ea3601245b..22e40bd643 100644 --- a/doc/man3/SSL_SESSION_get_protocol_version.pod +++ b/doc/man3/SSL_SESSION_get_protocol_version.pod @@ -2,19 +2,27 @@ =head1 NAME -SSL_SESSION_get_protocol_version - retrieve session protocol version +SSL_SESSION_get_protocol_version, +SSL_SESSION_set_protocol_version +- get and set the session protocol version =head1 SYNOPSIS #include <openssl/ssl.h> int SSL_SESSION_get_protocol_version(const SSL_SESSION *s); + int SSL_SESSION_set_protocol_version(SSL_SESSION *s, int version); =head1 DESCRIPTION SSL_SESSION_get_protocol_version() returns the protocol version number used by session B<s>. +SSL_SESSION_set_protocol_version() sets the protocol version associated with the +SSL_SESSION object B<s> to the value B<version>. This value should be a version +constant such as B<TLS1_3_VERSION> etc. For example, this could be used to set +up a session based PSK (see L<SSL_CTX_set_psk_use_session_callback(3)>). + =head1 RETURN VALUES SSL_SESSION_get_protocol_version() returns a number indicating the protocol @@ -24,17 +32,21 @@ B<TLS1_VERSION> or B<TLS1_2_VERSION>. Note that the SSL_SESSION_get_protocol_version() function does B<not> perform a null check on the provided session B<s> pointer. +SSL_SESSION_set_protocol_version() returns 1 on success or 0 on failure. + =head1 SEE ALSO -L<ssl(7)> +L<ssl(7)>, +L<SSL_CTX_set_psk_use_session_callback(3)> =head1 HISTORY -SSL_SESSION_get_protocol_version() was first added to OpenSSL 1.1.0 +SSL_SESSION_get_protocol_version() was first added to OpenSSL 1.1.0. +SSL_SESSION_set_protocol_version() was first added to OpenSSL 1.1.1. =head1 COPYRIGHT -Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2001-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 |