Debian Codegraph @

upstream/debian-unstable/man3/SSL_SESSION_get_protocol_version.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_SESSION_GET_PROTOCOL_VERSION 3SSL"
58 .TH SSL_SESSION_GET_PROTOCOL_VERSION 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_SESSION_get_protocol_version,
65 SSL_SESSION_set_protocol_version
66 \&\- get and set the session protocol version
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/ssl.h>
71 \&
72 \& int SSL_SESSION_get_protocol_version(const SSL_SESSION *s);
73 \& int SSL_SESSION_set_protocol_version(SSL_SESSION *s, int version);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 \&\fBSSL_SESSION_get_protocol_version()\fR returns the protocol version number used
78 by session \fBs\fR.
79 .PP
80 \&\fBSSL_SESSION_set_protocol_version()\fR sets the protocol version associated with the
81 SSL_SESSION object \fBs\fR to the value \fBversion\fR. This value should be a version
82 constant such as \fBTLS1_3_VERSION\fR etc. For example, this could be used to set
83 up a session based PSK (see \fBSSL_CTX_set_psk_use_session_callback\fR\|(3)).
84 .SH "RETURN VALUES"
85 .IX Header "RETURN VALUES"
86 \&\fBSSL_SESSION_get_protocol_version()\fR returns a number indicating the protocol
87 version used for the session; this number matches the constants \fIe.g.\fR
88 \&\fBTLS1_VERSION\fR, \fBTLS1_2_VERSION\fR or \fBTLS1_3_VERSION\fR.
89 .PP
90 Note that the \fBSSL_SESSION_get_protocol_version()\fR function
91 does \fBnot\fR perform a null check on the provided session \fBs\fR pointer.
92 .PP
93 \&\fBSSL_SESSION_set_protocol_version()\fR returns 1 on success or 0 on failure.
94 .SH "SEE ALSO"
95 .IX Header "SEE ALSO"
96 \&\fBssl\fR\|(7),
97 \&\fBSSL_CTX_set_psk_use_session_callback\fR\|(3)
98 .SH HISTORY
99 .IX Header "HISTORY"
100 The \fBSSL_SESSION_get_protocol_version()\fR function was added in OpenSSL 1.1.0.
101 The \fBSSL_SESSION_set_protocol_version()\fR function was added in OpenSSL 1.1.1.
102 .SH COPYRIGHT
103 .IX Header "COPYRIGHT"
104 Copyright 2001\-2018 The OpenSSL Project Authors. All Rights Reserved.
105 .PP
106 Licensed under the Apache License 2.0 (the "License"). You may not use
107 this file except in compliance with the License. You can obtain a copy
108 in the file LICENSE in the source distribution or at
109 <https://www.openssl.org/source/license.html>.