1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Tue Jul 30 09:22:12 2002
5 .\" ======================================================================
6 .de Sh \" Subsection heading
14 .de Sp \" Vertical space (when we can't use .PP)
20 .ie \\n(.$>=3 .ne \\$3
24 .de Vb \" Begin verbatim text
29 .de Ve \" End verbatim text
34 .\" Set up some character translations and predefined strings. \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote. | will give a
37 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available. \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
45 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD. Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
65 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear. Run. Save yourself. No user-serviceable parts.
79 . \" fudge factors for nroff and troff
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
94 . \" simple accents for nroff and troff
104 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
111 . \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 . \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 . \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
138 .\" ======================================================================
140 .IX Title "SSL_CIPHER_get_name 3"
141 .TH SSL_CIPHER_get_name 3 "0.9.6e" "2001-05-19" "OpenSSL"
144 SSL_CIPHER_get_name, SSL_CIPHER_get_bits, SSL_CIPHER_get_version, SSL_CIPHER_description \- get \s-1SSL_CIPHER\s0 properties
146 .IX Header "SYNOPSIS"
148 \& #include <openssl/ssl.h>
151 \& const char *SSL_CIPHER_get_name(SSL_CIPHER *cipher);
152 \& int SSL_CIPHER_get_bits(SSL_CIPHER *cipher, int *alg_bits);
153 \& char *SSL_CIPHER_get_version(SSL_CIPHER *cipher);
154 \& char *SSL_CIPHER_description(SSL_CIPHER *cipher, char *buf, int size);
157 .IX Header "DESCRIPTION"
158 \&\fISSL_CIPHER_get_name()\fR returns a pointer to the name of \fBcipher\fR. If the
159 argument is the \s-1NULL\s0 pointer, a pointer to the constant value \*(L"\s-1NONE\s0\*(R" is
162 \&\fISSL_CIPHER_get_bits()\fR returns the number of secret bits used for \fBcipher\fR. If
163 \&\fBalg_bits\fR is not \s-1NULL\s0, it contains the number of bits processed by the
164 chosen algorithm. If \fBcipher\fR is \s-1NULL\s0, 0 is returned.
166 \&\fISSL_CIPHER_get_version()\fR returns the protocol version for \fBcipher\fR, currently
167 \&\*(L"SSLv2\*(R", \*(L"SSLv3\*(R", or \*(L"TLSv1\*(R". If \fBcipher\fR is \s-1NULL\s0, \*(L"(\s-1NONE\s0)\*(R" is returned.
169 \&\fISSL_CIPHER_description()\fR returns a textual description of the cipher used
170 into the buffer \fBbuf\fR of length \fBlen\fR provided. \fBlen\fR must be at least
171 128 bytes, otherwise a pointer to the the string \*(L"Buffer too small\*(R" is
172 returned. If \fBbuf\fR is \s-1NULL\s0, a buffer of 128 bytes is allocated using
173 \&\fIOPENSSL_malloc()\fR. If the allocation fails, a pointer to the string
174 \&\*(L"OPENSSL_malloc Error\*(R" is returned.
177 The number of bits processed can be different from the secret bits. An
178 export cipher like e.g. \s-1EXP-RC4\-MD5\s0 has only 40 secret bits. The algorithm
179 does use the full 128 bits (which would be returned for \fBalg_bits\fR), of
180 which however 88bits are fixed. The search space is hence only 40 bits.
182 The string returned by \fISSL_CIPHER_description()\fR in case of success consists
183 of cleartext information separated by one or more blanks in the following
186 .IX Item "<ciphername>"
187 Textual representation of the cipher name.
188 .Ip "<protocol version>" 4
189 .IX Item "<protocol version>"
190 Protocol version: \fBSSLv2\fR, \fBSSLv3\fR. The TLSv1 ciphers are flagged with SSLv3.
191 .Ip "Kx=<key exchange>" 4
192 .IX Item "Kx=<key exchange>"
193 Key exchange method: \fB\s-1RSA\s0\fR (for export ciphers as \fBRSA(512)\fR or
194 \&\fBRSA(1024)\fR), \fB\s-1DH\s0\fR (for export ciphers as \fBDH(512)\fR or \fBDH(1024)\fR),
195 \&\fB\s-1DH/RSA\s0\fR, \fB\s-1DH/DSS\s0\fR, \fBFortezza\fR.
196 .Ip "Au=<authentication>" 4
197 .IX Item "Au=<authentication>"
198 Authentication method: \fB\s-1RSA\s0\fR, \fB\s-1DSS\s0\fR, \fB\s-1DH\s0\fR, \fBNone\fR. None is the
199 representation of anonymous ciphers.
200 .Ip "Enc=<symmetric encryption method>" 4
201 .IX Item "Enc=<symmetric encryption method>"
202 Encryption method with number of secret bits: \fBDES(40)\fR, \fBDES(56)\fR,
203 \&\fB3DES(168)\fR, \fBRC4(40)\fR, \fBRC4(56)\fR, \fBRC4(64)\fR, \fBRC4(128)\fR,
204 \&\fBRC2(40)\fR, \fBRC2(56)\fR, \fBRC2(128)\fR, \fBIDEA(128)\fR, \fBFortezza\fR, \fBNone\fR.
205 .Ip "Mac=<message authentication code>" 4
206 .IX Item "Mac=<message authentication code>"
207 Message digest: \fB\s-1MD5\s0\fR, \fB\s-1SHA1\s0\fR.
208 .Ip "<export flag>" 4
209 .IX Item "<export flag>"
210 If the cipher is flagged exportable with respect to old \s-1US\s0 crypto
211 regulations, the word "\fBexport\fR" is printed.
213 .IX Header "EXAMPLES"
214 Some examples for the output of \fISSL_CIPHER_description()\fR:
217 \& EDH-RSA-DES-CBC3-SHA SSLv3 Kx=DH Au=RSA Enc=3DES(168) Mac=SHA1
218 \& EDH-DSS-DES-CBC3-SHA SSLv3 Kx=DH Au=DSS Enc=3DES(168) Mac=SHA1
219 \& RC4-MD5 SSLv3 Kx=RSA Au=RSA Enc=RC4(128) Mac=MD5
220 \& EXP-RC4-MD5 SSLv3 Kx=RSA(512) Au=RSA Enc=RC4(40) Mac=MD5 export
224 If \fISSL_CIPHER_description()\fR is called with \fBcipher\fR being \s-1NULL\s0, the
227 If \fISSL_CIPHER_description()\fR cannot handle a built-in cipher, the according
228 description of the cipher property is \fBunknown\fR. This case should not
231 .IX Header "RETURN VALUES"
232 See \s-1DESCRIPTION\s0
234 .IX Header "SEE ALSO"
235 ssl(3), SSL_get_current_cipher(3),
236 SSL_get_ciphers(3), ciphers(1)