- update OpenSSL to 0.9.8
[dragonfly.git] / secure / lib / libssl / man / SSL_CIPHER_get_name.3
CommitLineData
e056f0e0
JR
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
e056f0e0 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
e056f0e0 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
e056f0e0 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
e056f0e0
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
984263bc 32.tr \(*W-|\(bv\*(Tr
e056f0e0 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
e056f0e0
JR
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
984263bc
MD
43'br\}
44.el\{\
e056f0e0
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
e056f0e0
JR
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 58..
e056f0e0
JR
59. nr % 0
60. rr F
984263bc 61.\}
e056f0e0
JR
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
984263bc 66.if n .na
e056f0e0
JR
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
984263bc 71.if n \{\
e056f0e0
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
e056f0e0
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
e056f0e0 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
e056f0e0
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
e056f0e0
JR
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 101.\}
e056f0e0 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
e056f0e0 112. \" corrections for vroff
984263bc
MD
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
e056f0e0 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
e056f0e0
JR
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
e056f0e0
JR
129.\" ========================================================================
130.\"
131.IX Title "SSL_CIPHER_get_name 3"
a561f9ff 132.TH SSL_CIPHER_get_name 3 "2005-07-06" "0.9.8" "OpenSSL"
984263bc 133.SH "NAME"
a7d27d5a 134SSL_CIPHER_get_name, SSL_CIPHER_get_bits, SSL_CIPHER_get_version, SSL_CIPHER_description \- get SSL_CIPHER properties
984263bc 135.SH "SYNOPSIS"
e056f0e0 136.IX Header "SYNOPSIS"
984263bc
MD
137.Vb 1
138\& #include <openssl/ssl.h>
139.Ve
e056f0e0 140.PP
984263bc 141.Vb 4
a561f9ff
SS
142\& const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
143\& int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher, int *alg_bits);
144\& char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
984263bc
MD
145\& char *SSL_CIPHER_description(SSL_CIPHER *cipher, char *buf, int size);
146.Ve
147.SH "DESCRIPTION"
e056f0e0
JR
148.IX Header "DESCRIPTION"
149\&\fISSL_CIPHER_get_name()\fR returns a pointer to the name of \fBcipher\fR. If the
150argument is the \s-1NULL\s0 pointer, a pointer to the constant value \*(L"\s-1NONE\s0\*(R" is
984263bc
MD
151returned.
152.PP
e056f0e0
JR
153\&\fISSL_CIPHER_get_bits()\fR returns the number of secret bits used for \fBcipher\fR. If
154\&\fBalg_bits\fR is not \s-1NULL\s0, it contains the number of bits processed by the
155chosen algorithm. If \fBcipher\fR is \s-1NULL\s0, 0 is returned.
984263bc 156.PP
e056f0e0
JR
157\&\fISSL_CIPHER_get_version()\fR returns the protocol version for \fBcipher\fR, currently
158\&\*(L"SSLv2\*(R", \*(L"SSLv3\*(R", or \*(L"TLSv1\*(R". If \fBcipher\fR is \s-1NULL\s0, \*(L"(\s-1NONE\s0)\*(R" is returned.
984263bc 159.PP
e056f0e0 160\&\fISSL_CIPHER_description()\fR returns a textual description of the cipher used
984263bc
MD
161into the buffer \fBbuf\fR of length \fBlen\fR provided. \fBlen\fR must be at least
162128 bytes, otherwise a pointer to the the string \*(L"Buffer too small\*(R" is
e056f0e0
JR
163returned. If \fBbuf\fR is \s-1NULL\s0, a buffer of 128 bytes is allocated using
164\&\fIOPENSSL_malloc()\fR. If the allocation fails, a pointer to the string
165\&\*(L"OPENSSL_malloc Error\*(R" is returned.
984263bc 166.SH "NOTES"
e056f0e0 167.IX Header "NOTES"
984263bc 168The number of bits processed can be different from the secret bits. An
e056f0e0 169export cipher like e.g. \s-1EXP\-RC4\-MD5\s0 has only 40 secret bits. The algorithm
984263bc
MD
170does use the full 128 bits (which would be returned for \fBalg_bits\fR), of
171which however 88bits are fixed. The search space is hence only 40 bits.
172.PP
173The string returned by \fISSL_CIPHER_description()\fR in case of success consists
174of cleartext information separated by one or more blanks in the following
175sequence:
e056f0e0
JR
176.IP "<ciphername>" 4
177.IX Item "<ciphername>"
984263bc 178Textual representation of the cipher name.
e056f0e0
JR
179.IP "<protocol version>" 4
180.IX Item "<protocol version>"
984263bc 181Protocol version: \fBSSLv2\fR, \fBSSLv3\fR. The TLSv1 ciphers are flagged with SSLv3.
e056f0e0
JR
182.IP "Kx=<key exchange>" 4
183.IX Item "Kx=<key exchange>"
a7d27d5a 184Key exchange method: \fB\s-1RSA\s0\fR (for export ciphers as \fB\s-1RSA\s0(512)\fR or
e056f0e0
JR
185\&\fB\s-1RSA\s0(1024)\fR), \fB\s-1DH\s0\fR (for export ciphers as \fB\s-1DH\s0(512)\fR or \fB\s-1DH\s0(1024)\fR),
186\&\fB\s-1DH/RSA\s0\fR, \fB\s-1DH/DSS\s0\fR, \fBFortezza\fR.
187.IP "Au=<authentication>" 4
188.IX Item "Au=<authentication>"
984263bc
MD
189Authentication method: \fB\s-1RSA\s0\fR, \fB\s-1DSS\s0\fR, \fB\s-1DH\s0\fR, \fBNone\fR. None is the
190representation of anonymous ciphers.
e056f0e0
JR
191.IP "Enc=<symmetric encryption method>" 4
192.IX Item "Enc=<symmetric encryption method>"
a7d27d5a 193Encryption method with number of secret bits: \fB\s-1DES\s0(40)\fR, \fB\s-1DES\s0(56)\fR,
e056f0e0
JR
194\&\fB3DES(168)\fR, \fB\s-1RC4\s0(40)\fR, \fB\s-1RC4\s0(56)\fR, \fB\s-1RC4\s0(64)\fR, \fB\s-1RC4\s0(128)\fR,
195\&\fB\s-1RC2\s0(40)\fR, \fB\s-1RC2\s0(56)\fR, \fB\s-1RC2\s0(128)\fR, \fB\s-1IDEA\s0(128)\fR, \fBFortezza\fR, \fBNone\fR.
196.IP "Mac=<message authentication code>" 4
197.IX Item "Mac=<message authentication code>"
984263bc 198Message digest: \fB\s-1MD5\s0\fR, \fB\s-1SHA1\s0\fR.
e056f0e0
JR
199.IP "<export flag>" 4
200.IX Item "<export flag>"
984263bc 201If the cipher is flagged exportable with respect to old \s-1US\s0 crypto
e056f0e0 202regulations, the word "\fBexport\fR" is printed.
984263bc 203.SH "EXAMPLES"
e056f0e0 204.IX Header "EXAMPLES"
984263bc
MD
205Some examples for the output of \fISSL_CIPHER_description()\fR:
206.PP
207.Vb 4
208\& EDH-RSA-DES-CBC3-SHA SSLv3 Kx=DH Au=RSA Enc=3DES(168) Mac=SHA1
209\& EDH-DSS-DES-CBC3-SHA SSLv3 Kx=DH Au=DSS Enc=3DES(168) Mac=SHA1
210\& RC4-MD5 SSLv3 Kx=RSA Au=RSA Enc=RC4(128) Mac=MD5
211\& EXP-RC4-MD5 SSLv3 Kx=RSA(512) Au=RSA Enc=RC4(40) Mac=MD5 export
212.Ve
213.SH "BUGS"
e056f0e0
JR
214.IX Header "BUGS"
215If \fISSL_CIPHER_description()\fR is called with \fBcipher\fR being \s-1NULL\s0, the
984263bc
MD
216library crashes.
217.PP
218If \fISSL_CIPHER_description()\fR cannot handle a built-in cipher, the according
219description of the cipher property is \fBunknown\fR. This case should not
220occur.
221.SH "RETURN VALUES"
a7d27d5a 222.IX Header "RETURN VALUES"
e056f0e0
JR
223See \s-1DESCRIPTION\s0
224.SH "SEE ALSO"
a7d27d5a 225.IX Header "SEE ALSO"
e056f0e0
JR
226\&\fIssl\fR\|(3), \fISSL_get_current_cipher\fR\|(3),
227\&\fISSL_get_ciphers\fR\|(3), \fIciphers\fR\|(1)