2
0

SSL_get_current_cipher.pod 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. =pod
  2. =head1 NAME
  3. SSL_get_current_cipher, SSL_get_cipher, SSL_get_cipher_name,
  4. SSL_get_cipher_bits, SSL_get_cipher_version - get SSL_CIPHER of a connection
  5. =head1 SYNOPSIS
  6. #include <openssl/ssl.h>
  7. SSL_CIPHER *SSL_get_current_cipher(const SSL *ssl);
  8. #define SSL_get_cipher(s) \
  9. SSL_CIPHER_get_name(SSL_get_current_cipher(s))
  10. #define SSL_get_cipher_name(s) \
  11. SSL_CIPHER_get_name(SSL_get_current_cipher(s))
  12. #define SSL_get_cipher_bits(s,np) \
  13. SSL_CIPHER_get_bits(SSL_get_current_cipher(s),np)
  14. #define SSL_get_cipher_version(s) \
  15. SSL_CIPHER_get_version(SSL_get_current_cipher(s))
  16. =head1 DESCRIPTION
  17. SSL_get_current_cipher() returns a pointer to an SSL_CIPHER object containing
  18. the description of the actually used cipher of a connection established with
  19. the B<ssl> object.
  20. SSL_get_cipher() and SSL_get_cipher_name() are identical macros to obtain the
  21. name of the currently used cipher. SSL_get_cipher_bits() is a
  22. macro to obtain the number of secret/algorithm bits used and
  23. SSL_get_cipher_version() returns the protocol name.
  24. See L<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)> for more details.
  25. =head1 RETURN VALUES
  26. SSL_get_current_cipher() returns the cipher actually used or NULL, when
  27. no session has been established.
  28. =head1 SEE ALSO
  29. L<ssl(3)|ssl(3)>, L<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)>
  30. =cut