$NetBSD: SSL_get_current_cipher.3,v 1.25 2024/09/08 13:08:34 christos Exp $

-*- 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_get_current_cipher 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
SSL_get_current_cipher, SSL_get_cipher_name, SSL_get_cipher, SSL_get_cipher_bits, SSL_get_cipher_version, SSL_get_pending_cipher - get SSL_CIPHER of a connection Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& const SSL_CIPHER *SSL_get_current_cipher(const SSL *ssl); const SSL_CIPHER *SSL_get_pending_cipher(const SSL *ssl); \& const char *SSL_get_cipher_name(const SSL *s); const char *SSL_get_cipher(const SSL *s); int SSL_get_cipher_bits(const SSL *s, int *np); const char *SSL_get_cipher_version(const SSL *s); .Ve Header "DESCRIPTION" \fBSSL_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. See SSL_CIPHER_get_name\|(3) for more details.

\fBSSL_get_cipher_name() obtains the name of the currently used cipher. \fBSSL_get_cipher() is identical to SSL_get_cipher_name(). \fBSSL_get_cipher_bits() is a macro to obtain the number of secret/algorithm bits used and \fBSSL_get_cipher_version() returns the protocol name.

\fBSSL_get_pending_cipher() returns a pointer to an SSL_CIPHER object containing the description of the cipher (if any) that has been negotiated for future use on the connection established with the ssl object, but is not yet in use. This may be the case during handshake processing, when control flow can be returned to the application via any of several callback methods. The internal sequencing of handshake processing and callback invocation is not guaranteed to be stable from release to release, and at present only the callback set by SSL_CTX_set_alpn_select_cb() is guaranteed to have a non-NULL return value. Other callbacks may be added to this list over time.

Header "RETURN VALUES" \fBSSL_get_current_cipher() returns the cipher actually used, or NULL if no session has been established.

\fBSSL_get_pending_cipher() returns the cipher to be used at the next change of cipher suite, or NULL if no such cipher is known.

Header "NOTES" SSL_get_cipher, SSL_get_cipher_bits, SSL_get_cipher_version, and SSL_get_cipher_name are implemented as macros. Header "SEE ALSO" \fBssl\|(7), SSL_CIPHER_get_name\|(3) Header "COPYRIGHT" Copyright 2000-2022 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>.