Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is turned on, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "SSL_CIPHER_get_name 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
SSL_CIPHER_get_name, SSL_CIPHER_get_bits, SSL_CIPHER_get_version, SSL_CIPHER_description - get SSL_CIPHER properties Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher); int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher, int *alg_bits); char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher); char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int size); .Ve Header "DESCRIPTION" \fISSL_CIPHER_get_name() returns a pointer to the name of cipher. If the argument is the \s-1NULL\s0 pointer, a pointer to the constant value \*(L"\s-1NONE\*(R"\s0 is returned.

\fISSL_CIPHER_get_bits() returns the number of secret bits used for cipher. If \fBalg_bits is not \s-1NULL,\s0 it contains the number of bits processed by the chosen algorithm. If cipher is \s-1NULL, 0\s0 is returned.

\fISSL_CIPHER_get_version() returns string which indicates the \s-1SSL/TLS\s0 protocol version that first defined the cipher. This is currently SSLv2 or TLSv1/SSLv3. In some cases it should possibly return \*(L"TLSv1.2\*(R" but does not; use SSL_CIPHER_description() instead. If cipher is \s-1NULL, \*(L"\s0(\s-1NONE\s0)\*(R" is returned.

\fISSL_CIPHER_description() returns a textual description of the cipher used into the buffer buf of length len provided. len must be at least 128 bytes, otherwise a pointer to the string \*(L"Buffer too small\*(R" is returned. If buf is \s-1NULL,\s0 a buffer of 128 bytes is allocated using \fIOPENSSL_malloc(). If the allocation fails, a pointer to the string \*(L"OPENSSL_malloc Error\*(R" is returned.

Header "NOTES" The number of bits processed can be different from the secret bits. An export cipher like e.g. \s-1EXP-RC4-MD5\s0 has only 40 secret bits. The algorithm does use the full 128 bits (which would be returned for alg_bits), of which however 88bits are fixed. The search space is hence only 40 bits.

The string returned by SSL_CIPHER_description() in case of success consists of cleartext information separated by one or more blanks in the following sequence:

Item "<ciphername>" Textual representation of the cipher name. Item "<protocol version>" Protocol version: SSLv2, SSLv3, TLSv1.2. The TLSv1.0 ciphers are flagged with SSLv3. No new ciphers were added by TLSv1.1. Item "Kx=<key exchange>" Key exchange method: \s-1RSA\s0 (for export ciphers as \s-1RSA\s0(512) or \fB\s-1RSA\s0(1024)), \s-1DH\s0 (for export ciphers as \s-1DH\s0(512) or \s-1DH\s0(1024)), \fB\s-1DH/RSA\s0, \s-1DH/DSS\s0, Fortezza. Item "Au=<authentication>" Authentication method: \s-1RSA\s0, \s-1DSS\s0, \s-1DH\s0, None. None is the representation of anonymous ciphers. Item "Enc=<symmetric encryption method>" Encryption method with number of secret bits: \s-1DES\s0(40), \s-1DES\s0(56), \fB3DES(168), \s-1RC4\s0(40), \s-1RC4\s0(56), \s-1RC4\s0(64), \s-1RC4\s0(128), \fB\s-1RC2\s0(40), \s-1RC2\s0(56), \s-1RC2\s0(128), \s-1IDEA\s0(128), Fortezza, None. Item "Mac=<message authentication code>" Message digest: \s-1MD5\s0, \s-1SHA1\s0. Item "<export flag>" If the cipher is flagged exportable with respect to old \s-1US\s0 crypto regulations, the word "export" is printed. Header "EXAMPLES" Some examples for the output of SSL_CIPHER_description():

.Vb 4 EDH-RSA-DES-CBC3-SHA SSLv3 Kx=DH Au=RSA Enc=3DES(168) Mac=SHA1 EDH-DSS-DES-CBC3-SHA SSLv3 Kx=DH Au=DSS Enc=3DES(168) Mac=SHA1 RC4-MD5 SSLv3 Kx=RSA Au=RSA Enc=RC4(128) Mac=MD5 EXP-RC4-MD5 SSLv3 Kx=RSA(512) Au=RSA Enc=RC4(40) Mac=MD5 export .Ve

A comp[lete list can be retrieved by invoking the following command:

.Vb 1 openssl ciphers -v ALL .Ve

Header "BUGS" If SSL_CIPHER_description() is called with cipher being \s-1NULL,\s0 the library crashes.

If SSL_CIPHER_description() cannot handle a built-in cipher, the according description of the cipher property is unknown. This case should not occur.

Header "RETURN VALUES" See \s-1DESCRIPTION\s0 Header "SEE ALSO" \fIssl\|(3), SSL_get_current_cipher\|(3), \fISSL_get_ciphers\|(3), ciphers\|(1)