release/src/router/openssl/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(SSL_CIPHER *cipher);
  12  int SSL_CIPHER_get_bits(SSL_CIPHER *cipher, int *alg_bits);
  13  char *SSL_CIPHER_get_version(SSL_CIPHER *cipher);
  14  char *SSL_CIPHER_description(SSL_CIPHER *cipher, char *buf, int size);
  15
  16 =head1 DESCRIPTION
  17
  18 SSL_CIPHER_get_name() returns a pointer to the name of B<cipher>. If the
  19 argument is the NULL pointer, a pointer to the constant value "NONE" is
  20 returned.
  21
  22 SSL_CIPHER_get_bits() returns the number of secret bits used for B<cipher>. If
  23 B<alg_bits> is not NULL, it contains the number of bits processed by the
  24 chosen algorithm. If B<cipher> is NULL, 0 is returned.
  25
  26 SSL_CIPHER_get_version() returns the protocol version for B<cipher>, currently
  27 "SSLv2", "SSLv3", or "TLSv1". If B<cipher> is NULL, "(NONE)" is returned.
  28
  29 SSL_CIPHER_description() returns a textual description of the cipher used
  30 into the buffer B<buf> of length B<len> provided. B<len> must be at least
  31 128 bytes, otherwise a pointer to the the string "Buffer too small" is
  32 returned. If B<buf> is NULL, a buffer of 128 bytes is allocated using
  33 OPENSSL_malloc(). If the allocation fails, a pointer to the string
  34 "OPENSSL_malloc Error" is returned.
  35
  36 =head1 NOTES
  37
  38 The number of bits processed can be different from the secret bits. An
  39 export cipher like e.g. EXP-RC4-MD5 has only 40 secret bits. The algorithm
  40 does use the full 128 bits (which would be returned for B<alg_bits>), of
  41 which however 88bits are fixed. The search space is hence only 40 bits.
  42
  43 The string returned by SSL_CIPHER_description() in case of success consists
  44 of cleartext information separated by one or more blanks in the following
  45 sequence:
  46
  47 =over 4
  48
  49 =item <ciphername>
  50
  51 Textual representation of the cipher name.
  52
  53 =item <protocol version>
  54
  55 Protocol version: B<SSLv2>, B<SSLv3>. The TLSv1 ciphers are flagged with SSLv3.
  56
  57 =item Kx=<key exchange>
  58
  59 Key exchange method: B<RSA> (for export ciphers as B<RSA(512)> or
  60 B<RSA(1024)>), B<DH> (for export ciphers as B<DH(512)> or B<DH(1024)>),
  61 B<DH/RSA>, B<DH/DSS>, B<Fortezza>.
  62
  63 =item Au=<authentication>
  64
  65 Authentication method: B<RSA>, B<DSS>, B<DH>, B<None>. None is the
  66 representation of anonymous ciphers.
  67
  68 =item Enc=<symmetric encryption method>
  69
  70 Encryption method with number of secret bits: B<DES(40)>, B<DES(56)>,
  71 B<3DES(168)>, B<RC4(40)>, B<RC4(56)>, B<RC4(64)>, B<RC4(128)>,
  72 B<RC2(40)>, B<RC2(56)>, B<RC2(128)>, B<IDEA(128)>, B<Fortezza>, B<None>.
  73
  74 =item Mac=<message authentication code>
  75
  76 Message digest: B<MD5>, B<SHA1>.
  77
  78 =item <export flag>
  79
  80 If the cipher is flagged exportable with respect to old US crypto
  81 regulations, the word "B<export>" is printed.
  82
  83 =back
  84
  85 =head1 EXAMPLES
  86
  87 Some examples for the output of SSL_CIPHER_description():
  88
  89  EDH-RSA-DES-CBC3-SHA    SSLv3 Kx=DH       Au=RSA  Enc=3DES(168) Mac=SHA1
  90  EDH-DSS-DES-CBC3-SHA    SSLv3 Kx=DH       Au=DSS  Enc=3DES(168) Mac=SHA1
  91  RC4-MD5                 SSLv3 Kx=RSA      Au=RSA  Enc=RC4(128)  Mac=MD5
  92  EXP-RC4-MD5             SSLv3 Kx=RSA(512) Au=RSA  Enc=RC4(40)   Mac=MD5  export
  93
  94 =head1 BUGS
  95
  96 If SSL_CIPHER_description() is called with B<cipher> being NULL, the
  97 library crashes.
  98
  99 If SSL_CIPHER_description() cannot handle a built-in cipher, the according
 100 description of the cipher property is B<unknown>. This case should not
 101 occur.
 102
 103 =head1 RETURN VALUES
 104
 105 See DESCRIPTION
 106
 107 =head1 SEE ALSO
 108
 109 L<ssl(3)|ssl(3)>, L<SSL_get_current_cipher(3)|SSL_get_current_cipher(3)>,
 110 L<SSL_get_ciphers(3)|SSL_get_ciphers(3)>, L<ciphers(1)|ciphers(1)>
 111
 112 =cut