Debian Codegraph @

upstream/debian-unstable/man3/SSL_SESSION_get0_cipher.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_GET0_CIPHER 3SSL"
58 .TH SSL_SESSION_GET0_CIPHER 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_get0_cipher,
65 SSL_SESSION_set_cipher
66 \&\- set and retrieve the SSL cipher associated with a session
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/ssl.h>
71 \&
72 \& const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s);
73 \& int SSL_SESSION_set_cipher(SSL_SESSION *s, const SSL_CIPHER *cipher);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 \&\fBSSL_SESSION_get0_cipher()\fR retrieves the cipher that was used by the
78 connection when the session was created, or NULL if it cannot be determined.
79 .PP
80 The value returned is a pointer to an object maintained within \fBs\fR and
81 should not be released.
82 .PP
83 \&\fBSSL_SESSION_set_cipher()\fR can be used to set the ciphersuite associated with the
84 SSL_SESSION \fBs\fR to \fBcipher\fR. For example, this could be used to set up a
85 session based PSK (see \fBSSL_CTX_set_psk_use_session_callback\fR\|(3)).
86 .SH "RETURN VALUES"
87 .IX Header "RETURN VALUES"
88 \&\fBSSL_SESSION_get0_cipher()\fR returns the SSL_CIPHER associated with the SSL_SESSION
89 or NULL if it cannot be determined.
90 .PP
91 \&\fBSSL_SESSION_set_cipher()\fR returns 1 on success or 0 on failure.
92 .SH "SEE ALSO"
93 .IX Header "SEE ALSO"
94 \&\fBssl\fR\|(7),
95 \&\fBd2i_SSL_SESSION\fR\|(3),
96 \&\fBSSL_SESSION_get_time\fR\|(3),
97 \&\fBSSL_SESSION_get0_hostname\fR\|(3),
98 \&\fBSSL_SESSION_free\fR\|(3),
99 \&\fBSSL_CTX_set_psk_use_session_callback\fR\|(3)
100 .SH HISTORY
101 .IX Header "HISTORY"
102 The \fBSSL_SESSION_get0_cipher()\fR function was added in OpenSSL 1.1.0.
103 The \fBSSL_SESSION_set_cipher()\fR function was added in OpenSSL 1.1.1.
104 .SH COPYRIGHT
105 .IX Header "COPYRIGHT"
106 Copyright 2016\-2017 The OpenSSL Project Authors. All Rights Reserved.
107 .PP
108 Licensed under the Apache License 2.0 (the "License"). You may not use
109 this file except in compliance with the License. You can obtain a copy
110 in the file LICENSE in the source distribution or at
111 <https://www.openssl.org/source/license.html>.