SSL_SESSION_get0_cipher(3) - NetBSD Manual Pages

Command:
Section:
Arch:
Collection:
>>>
SSL_SESSION_get0_cipher(3)          OpenSSL         SSL_SESSION_get0_cipher(3)




NAME

       SSL_SESSION_get0_cipher, SSL_SESSION_set_cipher - set and retrieve the
       SSL cipher associated with a session


SYNOPSIS

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


DESCRIPTION

       SSL_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.

       SSL_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

       SSL_SESSION_get0_cipher() returns the SSL_CIPHER associated with the
       SSL_SESSION or NULL if it cannot be determined.

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


SEE ALSO

       ssl(7), d2i_SSL_SESSION(3), SSL_SESSION_get_time(3),
       SSL_SESSION_get0_hostname(3), SSL_SESSION_free(3),
       SSL_CTX_set_psk_use_session_callback(3)


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

       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>.



3.0.15                            2024-09-03        SSL_SESSION_get0_cipher(3)