SSL_get_current_cipher.pod 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. =pod
  2. =head1 NAME
  3. SSL_get_current_cipher, SSL_get_cipher_name, SSL_get_cipher,
  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. const char *SSL_get_cipher_name(const SSL *s);
  9. const char *SSL_get_cipher(const SSL *s);
  10. int SSL_get_cipher_bits(const SSL *s, int *np) \
  11. const char *SSL_get_cipher_version(const SSL *s);
  12. =head1 DESCRIPTION
  13. SSL_get_current_cipher() returns a pointer to an SSL_CIPHER object containing
  14. the description of the actually used cipher of a connection established with
  15. the B<ssl> object.
  16. See L<SSL_CIPHER_get_name(3)> for more details.
  17. SSL_get_cipher_name() obtains the
  18. name of the currently used cipher.
  19. SSL_get_cipher() is identical to SSL_get_cipher_name().
  20. SSL_get_cipher_bits() is a
  21. macro to obtain the number of secret/algorithm bits used and
  22. SSL_get_cipher_version() returns the protocol name.
  23. =head1 RETURN VALUES
  24. SSL_get_current_cipher() returns the cipher actually used, or NULL if
  25. no session has been established.
  26. =head1 NOTES
  27. These are implemented as macros.
  28. =head1 SEE ALSO
  29. L<ssl(3)>, L<SSL_CIPHER_get_name(3)>
  30. =head1 COPYRIGHT
  31. Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  32. Licensed under the OpenSSL license (the "License"). You may not use
  33. this file except in compliance with the License. You can obtain a copy
  34. in the file LICENSE in the source distribution or at
  35. L<https://www.openssl.org/source/license.html>.
  36. =cut