GH528: "cipher -v" output is confusing.
[openssl.git] / 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 B<cipher> is NULL, it returns "(NONE)".
22
23 SSL_CIPHER_get_bits() returns the number of secret bits used for B<cipher>.
24 If B<cipher> is NULL, 0 is returned.
25
26 SSL_CIPHER_get_version() returns string which indicates the SSL/TLS protocol
27 version that first defined the cipher.  It returns "(NONE)" if B<cipher> is NULL.
28
29 SSL_CIPHER_get_cipher_nid() returns the cipher NID corresponding to B<c>.
30 If there is no cipher (e.g. for ciphersuites with no encryption) then
31 B<NID_undef> is returned.
32
33 SSL_CIPHER_get_digest_nid() returns the digest NID corresponding to the MAC
34 used by B<c>. If there is no digest (e.g. for AEAD ciphersuites) then
35 B<NID_undef> is returned.
36
37 SSL_CIPHER_description() returns a textual description of the cipher used
38 into the buffer B<buf> of length B<len> provided.  If B<buf> is provided, it
39 must be at least 128 bytes, otherwise a buffer will be allocated using
40 OPENSSL_malloc().  If the provided buffer is too small, or the allocation fails,
41 B<NULL> is returned.
42
43 The string returned by SSL_CIPHER_description() consists of several fields
44 separated by whitespace:
45
46 =over 4
47
48 =item <ciphername>
49
50 Textual representation of the cipher name.
51
52 =item <protocol version>
53
54 Protocol version, such as B<TLSv1.2>, when the cipher was first defined.
55
56 =item Kx=<key exchange>
57
58 Key exchange method such as B<RSA>, B<ECDHE>, etc.
59
60 =item Au=<authentication>
61
62 Authentication method such as B<RSA>, B<None>, etc.. None is the
63 representation of anonymous ciphers.
64
65 =item Enc=<symmetric encryption method>
66
67 Encryption method, with number of secret bits, such as B<AESGCM(128)>.
68
69 =item Mac=<message authentication code>
70
71 Message digest, such as B<SHA256>.
72
73 =back
74
75 Some examples for the output of SSL_CIPHER_description():
76
77  ECDHE-RSA-AES256-GCM-SHA256 TLSv1.2 Kx=ECDH     Au=RSA  Enc=AESGCM(256) Mac=AEAD
78  RSA-PSK-AES256-CBC-SHA384 TLSv1.0 Kx=RSAPSK   Au=RSA  Enc=AES(256)  Mac=SHA384
79
80 =head1 HISTORY
81
82 SSL_CIPHER_get_version() was updated to always return the correct protocol
83 string in OpenSSL 1.1.
84
85 SSL_CIPHER_description() was changed to return B<NULL> on error,
86 rather than a fixed string, in OpenSSL 1.1
87
88 =head1 SEE ALSO
89
90 L<ssl(3)>, L<SSL_get_current_cipher(3)>,
91 L<SSL_get_ciphers(3)>, L<ciphers(1)>
92
93 =cut