mirror of
https://github.com/openssl/openssl.git
synced 2024-12-03 05:41:46 +08:00
9b86974e0c
L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
44 lines
1.3 KiB
Plaintext
44 lines
1.3 KiB
Plaintext
=pod
|
|
|
|
=head1 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
|
|
|
|
=head1 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))
|
|
|
|
=head1 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 B<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 L<SSL_CIPHER_get_name(3)> for more details.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
SSL_get_current_cipher() returns the cipher actually used or NULL, when
|
|
no session has been established.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<ssl(3)>, L<SSL_CIPHER_get_name(3)>
|
|
|
|
=cut
|