Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_get_current_cipher (3openssl)

Name

SSL_get_current_cipher - SSL_get_current_cipher, SSL_get_cipher, SSL_get_cipher_name, get SSL_CIPHER of a connection

Synopsis

#include <openssl/ssl.h>

SSL_CIPHER *SSL_get_current_cipher(const SSL *ssl);
#define SSL_get_cipher(s) \
SSL_CIPHER_get_name(SSL_get_current_cipher(s))
#define SSL_get_cipher_name(s) \
SSL_CIPHER_get_name(SSL_get_current_cipher(s))
#define SSL_get_cipher_bits(s,np) \
SSL_CIPHER_get_bits(SSL_get_current_cipher(s),np)
#define SSL_get_cipher_version(s) \
SSL_CIPHER_get_version(SSL_get_current_cipher(s))

Description

OpenSSL                                       SSL_get_current_cipher(3openssl)



NAME
       SSL_get_current_cipher, SSL_get_cipher, SSL_get_cipher_name,
       SSL_get_cipher_bits, SSL_get_cipher_version - get SSL_CIPHER of a
       connection

SYNOPSIS
        #include <openssl/ssl.h>

        SSL_CIPHER *SSL_get_current_cipher(const SSL *ssl);
        #define SSL_get_cipher(s) \
                       SSL_CIPHER_get_name(SSL_get_current_cipher(s))
        #define SSL_get_cipher_name(s) \
                       SSL_CIPHER_get_name(SSL_get_current_cipher(s))
        #define SSL_get_cipher_bits(s,np) \
                       SSL_CIPHER_get_bits(SSL_get_current_cipher(s),np)
        #define SSL_get_cipher_version(s) \
                       SSL_CIPHER_get_version(SSL_get_current_cipher(s))

DESCRIPTION
       SSL_get_current_cipher() returns a pointer to an SSL_CIPHER object
       containing the description of the actually used cipher of a connection
       established with the ssl object.

       SSL_get_cipher() and SSL_get_cipher_name() are identical macros to
       obtain the name of the currently used cipher. SSL_get_cipher_bits() is
       a macro to obtain the number of secret/algorithm bits used and
       SSL_get_cipher_version() returns the protocol name.  See
       SSL_CIPHER_get_name(3) for more details.

RETURN VALUES
       SSL_get_current_cipher() returns the cipher actually used or NULL, when
       no session has been established.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

SEE ALSO
       ssl(3), SSL_CIPHER_get_name(3)



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.



1.0.2ze                           2022-05-03
                                              SSL_get_current_cipher(3openssl)