xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/SSL_SESSION_get_protocol_version.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: SSL_SESSION_get_protocol_version.3,v 1.9 2024/09/08 13:08:33 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "SSL_SESSION_get_protocol_version 3"
SSL_SESSION_get_protocol_version 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
SSL_SESSION_get_protocol_version, SSL_SESSION_set_protocol_version \- get and set the session protocol version
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #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); .Ve
DESCRIPTION
Header "DESCRIPTION" \fBSSL_SESSION_get_protocol_version() returns the protocol version number used by session s.

\fBSSL_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"
Header "RETURN VALUES" \fBSSL_SESSION_get_protocol_version() returns a number indicating the protocol version used for the session; this number matches the constants e.g. \fBTLS1_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.

\fBSSL_SESSION_set_protocol_version() returns 1 on success or 0 on failure.

"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7), \fBSSL_CTX_set_psk_use_session_callback\|(3)
HISTORY
Header "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
Header "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>.