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