doc/man3/SSL_get_current_cipher.pod

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