SSL_get_current_cipher.pod 1.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
=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>

12
 SSL_CIPHER *SSL_get_current_cipher(const SSL *ssl);
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 #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.
R
Rich Salz 已提交
32
See L<SSL_CIPHER_get_name(3)> for more details.
33 34 35 36 37 38 39 40

=head1 RETURN VALUES

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

=head1 SEE ALSO

R
Rich Salz 已提交
41
L<ssl(3)>, L<SSL_CIPHER_get_name(3)>
42 43

=cut
R
Rich Salz 已提交
44 45 46 47 48 49 50 51 52 53 54

=head1 COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (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
L<https://www.openssl.org/source/license.html>.

=cut