Updated: 2022/Sep/29

Please read Privacy Policy. It's for your privacy.


SSL_SESSION_get_protocol_version(3)                                    OpenSSL



NAME
       SSL_SESSION_get_protocol_version, SSL_SESSION_set_protocol_version -
       get and set the session protocol version

LIBRARY
       libcrypto, -lcrypto

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);

DESCRIPTION
       SSL_SESSION_get_protocol_version() returns the protocol version number
       used by session s.

       SSL_SESSION_set_protocol_version() sets the protocol version associated
       with the SSL_SESSION object s to the value version. This value should
       be a version constant such as TLS1_3_VERSION etc. For example, this
       could be used to set up a session based PSK (see
       SSL_CTX_set_psk_use_session_callback(3)).

RETURN VALUES
       SSL_SESSION_get_protocol_version() returns a number indicating the
       protocol version used for the session; this number matches the
       constants e.g. TLS1_VERSION, TLS1_2_VERSION or TLS1_3_VERSION.

       Note that the SSL_SESSION_get_protocol_version() function does not
       perform a null check on the provided session s pointer.

       SSL_SESSION_set_protocol_version() returns 1 on success or 0 on
       failure.

SEE ALSO
       ssl(7), SSL_CTX_set_psk_use_session_callback(3)

HISTORY
       The SSL_SESSION_get_protocol_version() function was added in OpenSSL
       1.1.0.  The SSL_SESSION_set_protocol_version() function was added in
       OpenSSL 1.1.1.

COPYRIGHT
       Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.

       Licensed under the Apache License 2.0 (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
       <https://www.openssl.org/source/license.html>.



3.0.12                            2023-05-07
                                           SSL_SESSION_get_protocol_version(3)