doc/ssl/SSL_CIPHER_get_name.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CIPHER_get_name, SSL_CIPHER_get_bits, SSL_CIPHER_get_version, SSL_CIPHER_description - get SSL_CIPHER properties
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
  12  int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher, int *alg_bits);
  13  char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
  14  char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int size);
  15  int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c);
  16  int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c);
  17
  18 =head1 DESCRIPTION
  19
  20 SSL_CIPHER_get_name() returns a pointer to the name of B<cipher>. If the
  21 argument is the NULL pointer, a pointer to the constant value "NONE" is
  22 returned.
  23
  24 SSL_CIPHER_get_bits() returns the number of secret bits used for B<cipher>. If
  25 B<alg_bits> is not NULL, it contains the number of bits processed by the
  26 chosen algorithm. If B<cipher> is NULL, 0 is returned.
  27
  28 SSL_CIPHER_get_version() returns string which indicates the SSL/TLS protocol
  29 version that first defined the cipher.
  30 This is currently B<TLSv1/SSLv3>.
  31 In some cases it should possibly return "TLSv1.2" but does not;
  32 use SSL_CIPHER_description() instead.
  33 If B<cipher> is NULL, "(NONE)" is returned.
  34
  35 SSL_CIPHER_description() returns a textual description of the cipher used
  36 into the buffer B<buf> of length B<len> provided. B<len> must be at least
  37 128 bytes, otherwise a pointer to the string "Buffer too small" is
  38 returned. If B<buf> is NULL, a buffer of 128 bytes is allocated using
  39 OPENSSL_malloc(). If the allocation fails, a pointer to the string
  40 "OPENSSL_malloc Error" is returned.
  41
  42 SSL_CIPHER_get_cipher_nid() returns the cipher NID corresponding to B<c>.
  43 If there is no cipher (e.g. for ciphersuites with no encryption) then
  44 B<NID_undef> is returned.
  45
  46 SSL_CIPHER_get_digest_nid() returns the digest NID corresponding to the MAC
  47 used by B<c>. If there is no digest (e.g. for AEAD ciphersuites) then
  48 B<NID_undef> is returned.
  49
  50 =head1 NOTES
  51
  52 The number of bits processed can be different from the secret bits. An
  53 export cipher like e.g. EXP-RC4-MD5 has only 40 secret bits. The algorithm
  54 does use the full 128 bits (which would be returned for B<alg_bits>), of
  55 which however 88bits are fixed. The search space is hence only 40 bits.
  56
  57 The string returned by SSL_CIPHER_description() in case of success consists
  58 of cleartext information separated by one or more blanks in the following
  59 sequence:
  60
  61 =over 4
  62
  63 =item <ciphername>
  64
  65 Textual representation of the cipher name.
  66
  67 =item <protocol version>
  68
  69 Protocol version: B<SSLv3>, B<TLSv1.2>. The TLSv1.0 ciphers are
  70 flagged with SSLv3. No new ciphers were added by TLSv1.1.
  71
  72 =item Kx=<key exchange>
  73
  74 Key exchange method: B<RSA> (for export ciphers as B<RSA(512)> or
  75 B<RSA(1024)>), B<DH> (for export ciphers as B<DH(512)> or B<DH(1024)>),
  76 B<DH/RSA>, B<DH/DSS>, B<Fortezza>.
  77
  78 =item Au=<authentication>
  79
  80 Authentication method: B<RSA>, B<DSS>, B<DH>, B<None>. None is the
  81 representation of anonymous ciphers.
  82
  83 =item Enc=<symmetric encryption method>
  84
  85 Encryption method with number of secret bits: B<DES(40)>, B<DES(56)>,
  86 B<3DES(168)>, B<RC4(40)>, B<RC4(56)>, B<RC4(64)>, B<RC4(128)>,
  87 B<RC2(40)>, B<RC2(56)>, B<RC2(128)>, B<IDEA(128)>, B<Fortezza>, B<None>.
  88
  89 =item Mac=<message authentication code>
  90
  91 Message digest: B<MD5>, B<SHA1>.
  92
  93 =item <export flag>
  94
  95 If the cipher is flagged exportable with respect to old US crypto
  96 regulations, the word "B<export>" is printed.
  97
  98 =back
  99
 100 =head1 EXAMPLES
 101
 102 Some examples for the output of SSL_CIPHER_description():
 103
 104  DHE-RSA-DES-CBC3-SHA    SSLv3 Kx=DH       Au=RSA  Enc=3DES(168) Mac=SHA1
 105  DHE-DSS-DES-CBC3-SHA    SSLv3 Kx=DH       Au=DSS  Enc=3DES(168) Mac=SHA1
 106  RC4-MD5                 SSLv3 Kx=RSA      Au=RSA  Enc=RC4(128)  Mac=MD5
 107  EXP-RC4-MD5             SSLv3 Kx=RSA(512) Au=RSA  Enc=RC4(40)   Mac=MD5  export
 108
 109 A comp[lete list can be retrieved by invoking the following command:
 110
 111  openssl ciphers -v ALL
 112
 113 =head1 BUGS
 114
 115 If SSL_CIPHER_description() is called with B<cipher> being NULL, the
 116 library crashes.
 117
 118 If SSL_CIPHER_description() cannot handle a built-in cipher, the according
 119 description of the cipher property is B<unknown>. This case should not
 120 occur.
 121
 122 =head1 RETURN VALUES
 123
 124 See DESCRIPTION
 125
 126 =head1 SEE ALSO
 127
 128 L<ssl(3)|ssl(3)>, L<SSL_get_current_cipher(3)|SSL_get_current_cipher(3)>,
 129 L<SSL_get_ciphers(3)|SSL_get_ciphers(3)>, L<ciphers(1)|ciphers(1)>
 130
 131 =cut