doc/ssl/SSL_get_ciphers.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_get1_supported_ciphers, SSL_get_client_ciphers,
   6 SSL_get_ciphers, SSL_CTX_get_ciphers, SSL_get_cipher_list
   7 - get list of available SSL_CIPHERs
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/ssl.h>
  12
  13  STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl);
  14  STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx);
  15  STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s);
  16  STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *ssl);
  17  const char *SSL_get_cipher_list(const SSL *ssl, int priority);
  18
  19 =head1 DESCRIPTION
  20
  21 SSL_get_ciphers() returns the stack of available SSL_CIPHERs for B<ssl>,
  22 sorted by preference. If B<ssl> is NULL or no ciphers are available, NULL
  23 is returned.
  24
  25 SSL_CTX_get_ciphers() returns the stack of available SSL_CIPHERs for B<ctx>.
  26
  27 SSL_get1_supported_ciphers() returns the stack of enabled SSL_CIPHERs for
  28 B<ssl>, sorted by preference.
  29 The list depends on settings like the cipher list, the supported protocol
  30 versions, the security level, and the enabled signature algorithms.
  31 SRP and PSK ciphers are only enabled if the appropriate callbacks or settings
  32 have been applied.
  33 This is the list that will be sent by the client to the server.
  34 The list supported by the server might include more ciphers in case there is a
  35 hole in the list of supported protocols.
  36 The server will also not use ciphers from this list depending on the
  37 configured certificates and DH parameters.
  38 If B<ssl> is NULL or no ciphers are available, NULL is returned.
  39
  40 SSL_get_client_ciphers() returns the stack of available SSL_CIPHERs matching the
  41 list received from the client on B<ssl>. If B<ssl> is NULL, no ciphers are
  42 available, or B<ssl> is not operating in server mode, NULL is returned.
  43
  44 SSL_get_cipher_list() returns a pointer to the name of the SSL_CIPHER
  45 listed for B<ssl> with B<priority>. If B<ssl> is NULL, no ciphers are
  46 available, or there are less ciphers than B<priority> available, NULL
  47 is returned.
  48
  49 =head1 NOTES
  50
  51 The details of the ciphers obtained by SSL_get_ciphers(), SSL_CTX_get_ciphers()
  52 SSL_get1_supported_ciphers() and SSL_get_client_ciphers() can be obtained using
  53 the L<SSL_CIPHER_get_name(3)> family of functions.
  54
  55 Call SSL_get_cipher_list() with B<priority> starting from 0 to obtain the
  56 sorted list of available ciphers, until NULL is returned.
  57
  58 Note: SSL_get_ciphers(), SSL_CTX_get_ciphers() and SSL_get_client_ciphers()
  59 return a pointer to an internal cipher stack, which will be freed later on when
  60 the SSL or SSL_SESSION object is freed.  Therefore, the calling code B<MUST NOT>
  61 free the return value itself.
  62
  63 The stack returned by SSL_get1_supported_ciphers() should be freed using
  64 sk_SSL_CIPHER_free().
  65
  66 =head1 RETURN VALUES
  67
  68 See DESCRIPTION
  69
  70 =head1 SEE ALSO
  71
  72 L<ssl(3)>, L<SSL_CTX_set_cipher_list(3)>,
  73 L<SSL_CIPHER_get_name(3)>
  74
  75 =head1 COPYRIGHT
  76
  77 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  78
  79 Licensed under the OpenSSL license (the "License").  You may not use
  80 this file except in compliance with the License.  You can obtain a copy
  81 in the file LICENSE in the source distribution or at
  82 L<https://www.openssl.org/source/license.html>.
  83
  84 =cut