=pod =head1 NAME SSL_CIPHER_get_name, SSL_CIPHER_get_bits, SSL_CIPHER_get_version, SSL_CIPHER_description - get SSL_CIPHER properties =head1 SYNOPSIS #include 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); =head1 DESCRIPTION SSL_CIPHER_get_name() returns a pointer to the name of B. If the argument is the NULL pointer, a pointer to the constant value "NONE" is returned. SSL_CIPHER_get_bits() returns the number of secret bits used for B. If B is not NULL, it contains the number of bits processed by the chosen algorithm. If B is NULL, 0 is returned. SSL_CIPHER_get_version() returns string which indicates the SSL/TLS protocol version that first defined the cipher. This is currently B or B. In some cases it should possibly return "TLSv1.2" but does not; use SSL_CIPHER_description() instead. If B is NULL, "(NONE)" is returned. SSL_CIPHER_description() returns a textual description of the cipher used into the buffer B of length B provided. B must be at least 128 bytes, otherwise a pointer to the string "Buffer too small" is returned. If B is NULL, a buffer of 128 bytes is allocated using OPENSSL_malloc(). If the allocation fails, a pointer to the string "OPENSSL_malloc Error" is returned. =head1 NOTES The number of bits processed can be different from the secret bits. An export cipher like e.g. EXP-RC4-MD5 has only 40 secret bits. The algorithm does use the full 128 bits (which would be returned for B), 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: =over 4 =item Textual representation of the cipher name. =item Protocol version: B, B, B. The TLSv1.0 ciphers are flagged with SSLv3. No new ciphers were added by TLSv1.1. =item Kx= Key exchange method: B (for export ciphers as B or B), B (for export ciphers as B or B), B, B, B. =item Au= Authentication method: B, B, B, B. None is the representation of anonymous ciphers. =item Enc= Encryption method with number of secret bits: B, B, B<3DES(168)>, B, B, B, B, B, B, B, B, B, B. =item Mac= Message digest: B, B. =item If the cipher is flagged exportable with respect to old US crypto regulations, the word "B" is printed. =back =head1 EXAMPLES Some examples for the output of SSL_CIPHER_description(): DHE-RSA-DES-CBC3-SHA SSLv3 Kx=DH Au=RSA Enc=3DES(168) Mac=SHA1 DHE-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 A comp[lete list can be retrieved by invoking the following command: openssl ciphers -v ALL =head1 BUGS If SSL_CIPHER_description() is called with B being NULL, the library crashes. If SSL_CIPHER_description() cannot handle a built-in cipher, the according description of the cipher property is B. This case should not occur. =head1 RETURN VALUES See DESCRIPTION =head1 SEE ALSO L, L, L, L =cut