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