$NetBSD: SSL_SESSION_get0_cipher.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:
========================================================================
..
. 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_get0_cipher 3"
way too many mistakes in technical documents.
-*- 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_get0_cipher 3"
SSL_SESSION_get0_cipher 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makesway too many mistakes in technical documents.
NAME
SSL_SESSION_get0_cipher,
SSL_SESSION_set_cipher
\- set and retrieve the SSL cipher associated with a session
SYNOPSIS
Header "SYNOPSIS" .Vb 1
#include <openssl/ssl.h>
\&
const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s);
int SSL_SESSION_set_cipher(SSL_SESSION *s, const SSL_CIPHER *cipher);
.Ve
DESCRIPTION
Header "DESCRIPTION" \fBSSL_SESSION_get0_cipher() retrieves the cipher that was used by the
connection when the session was created, or NULL if it cannot be determined.
The value returned is a pointer to an object maintained within s and should not be released.
\fBSSL_SESSION_set_cipher() can be used to set the ciphersuite associated with the SSL_SESSION s to cipher. 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_get0_cipher() returns the SSL_CIPHER associated with the SSL_SESSION
or NULL if it cannot be determined.
\fBSSL_SESSION_set_cipher() returns 1 on success or 0 on failure.
"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7),
\fBd2i_SSL_SESSION\|(3),
\fBSSL_SESSION_get_time\|(3),
\fBSSL_SESSION_get0_hostname\|(3),
\fBSSL_SESSION_free\|(3),
\fBSSL_CTX_set_psk_use_session_callback\|(3)
HISTORY
Header "HISTORY" The SSL_SESSION_get0_cipher() function was added in OpenSSL 1.1.0.
The SSL_SESSION_set_cipher() function was added in OpenSSL 1.1.1.
COPYRIGHT
Header "COPYRIGHT" Copyright 2016-2017 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>.