Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libssl / man / SSL_alert_type_string.3
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
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.  \*(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-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
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' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
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.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
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
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
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'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
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
115 .    \" corrections for vroff
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'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
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
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "SSL_alert_type_string 3"
135 .TH SSL_alert_type_string 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
140 .SH "NAME"
141 SSL_alert_type_string, SSL_alert_type_string_long, SSL_alert_desc_string, SSL_alert_desc_string_long \- get textual description of alert information
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 .Vb 1
145 \& #include <openssl/ssl.h>
146 \&
147 \& const char *SSL_alert_type_string(int value);
148 \& const char *SSL_alert_type_string_long(int value);
149 \&
150 \& const char *SSL_alert_desc_string(int value);
151 \& const char *SSL_alert_desc_string_long(int value);
152 .Ve
153 .SH "DESCRIPTION"
154 .IX Header "DESCRIPTION"
155 \&\fISSL_alert_type_string()\fR returns a one letter string indicating the
156 type of the alert specified by \fBvalue\fR.
157 .PP
158 \&\fISSL_alert_type_string_long()\fR returns a string indicating the type of the alert
159 specified by \fBvalue\fR.
160 .PP
161 \&\fISSL_alert_desc_string()\fR returns a two letter string as a short form
162 describing the reason of the alert specified by \fBvalue\fR.
163 .PP
164 \&\fISSL_alert_desc_string_long()\fR returns a string describing the reason
165 of the alert specified by \fBvalue\fR.
166 .SH "NOTES"
167 .IX Header "NOTES"
168 When one side of an \s-1SSL/TLS\s0 communication wants to inform the peer about
169 a special situation, it sends an alert. The alert is sent as a special message
170 and does not influence the normal data stream (unless its contents results
171 in the communication being canceled).
172 .PP
173 A warning alert is sent, when a non-fatal error condition occurs. The
174 \&\*(L"close notify\*(R" alert is sent as a warning alert. Other examples for
175 non-fatal errors are certificate errors (\*(L"certificate expired\*(R",
176 \&\*(L"unsupported certificate\*(R"), for which a warning alert may be sent.
177 (The sending party may however decide to send a fatal error.) The
178 receiving side may cancel the connection on reception of a warning
179 alert on it discretion.
180 .PP
181 Several alert messages must be sent as fatal alert messages as specified
182 by the \s-1TLS\s0 \s-1RFC\s0. A fatal alert always leads to a connection abort.
183 .SH "RETURN VALUES"
184 .IX Header "RETURN VALUES"
185 The following strings can occur for \fISSL_alert_type_string()\fR or
186 \&\fISSL_alert_type_string_long()\fR:
187 .ie n .IP """W""/""warning""" 4
188 .el .IP "``W''/``warning''" 4
189 .IX Item "W/warning"
190 .PD 0
191 .ie n .IP """F""/""fatal""" 4
192 .el .IP "``F''/``fatal''" 4
193 .IX Item "F/fatal"
194 .ie n .IP """U""/""unknown""" 4
195 .el .IP "``U''/``unknown''" 4
196 .IX Item "U/unknown"
197 .PD
198 This indicates that no support is available for this alert type.
199 Probably \fBvalue\fR does not contain a correct alert message.
200 .PP
201 The following strings can occur for \fISSL_alert_desc_string()\fR or
202 \&\fISSL_alert_desc_string_long()\fR:
203 .ie n .IP """\s-1CN\s0""/""close notify""" 4
204 .el .IP "``\s-1CN\s0''/``close notify''" 4
205 .IX Item "CN/close notify"
206 The connection shall be closed. This is a warning alert.
207 .ie n .IP """\s-1UM\s0""/""unexpected message""" 4
208 .el .IP "``\s-1UM\s0''/``unexpected message''" 4
209 .IX Item "UM/unexpected message"
210 An inappropriate message was received. This alert is always fatal
211 and should never be observed in communication between proper
212 implementations.
213 .ie n .IP """\s-1BM\s0""/""bad record mac""" 4
214 .el .IP "``\s-1BM\s0''/``bad record mac''" 4
215 .IX Item "BM/bad record mac"
216 This alert is returned if a record is received with an incorrect
217 \&\s-1MAC\s0. This message is always fatal.
218 .ie n .IP """\s-1DF\s0""/""decompression failure""" 4
219 .el .IP "``\s-1DF\s0''/``decompression failure''" 4
220 .IX Item "DF/decompression failure"
221 The decompression function received improper input (e.g. data
222 that would expand to excessive length). This message is always
223 fatal.
224 .ie n .IP """\s-1HF\s0""/""handshake failure""" 4
225 .el .IP "``\s-1HF\s0''/``handshake failure''" 4
226 .IX Item "HF/handshake failure"
227 Reception of a handshake_failure alert message indicates that the
228 sender was unable to negotiate an acceptable set of security
229 parameters given the options available. This is a fatal error.
230 .ie n .IP """\s-1NC\s0""/""no certificate""" 4
231 .el .IP "``\s-1NC\s0''/``no certificate''" 4
232 .IX Item "NC/no certificate"
233 A client, that was asked to send a certificate, does not send a certificate
234 (SSLv3 only).
235 .ie n .IP """\s-1BC\s0""/""bad certificate""" 4
236 .el .IP "``\s-1BC\s0''/``bad certificate''" 4
237 .IX Item "BC/bad certificate"
238 A certificate was corrupt, contained signatures that did not
239 verify correctly, etc
240 .ie n .IP """\s-1UC\s0""/""unsupported certificate""" 4
241 .el .IP "``\s-1UC\s0''/``unsupported certificate''" 4
242 .IX Item "UC/unsupported certificate"
243 A certificate was of an unsupported type.
244 .ie n .IP """\s-1CR\s0""/""certificate revoked""" 4
245 .el .IP "``\s-1CR\s0''/``certificate revoked''" 4
246 .IX Item "CR/certificate revoked"
247 A certificate was revoked by its signer.
248 .ie n .IP """\s-1CE\s0""/""certificate expired""" 4
249 .el .IP "``\s-1CE\s0''/``certificate expired''" 4
250 .IX Item "CE/certificate expired"
251 A certificate has expired or is not currently valid.
252 .ie n .IP """\s-1CU\s0""/""certificate unknown""" 4
253 .el .IP "``\s-1CU\s0''/``certificate unknown''" 4
254 .IX Item "CU/certificate unknown"
255 Some other (unspecified) issue arose in processing the
256 certificate, rendering it unacceptable.
257 .ie n .IP """\s-1IP\s0""/""illegal parameter""" 4
258 .el .IP "``\s-1IP\s0''/``illegal parameter''" 4
259 .IX Item "IP/illegal parameter"
260 A field in the handshake was out of range or inconsistent with
261 other fields. This is always fatal.
262 .ie n .IP """\s-1DC\s0""/""decryption failed""" 4
263 .el .IP "``\s-1DC\s0''/``decryption failed''" 4
264 .IX Item "DC/decryption failed"
265 A TLSCiphertext decrypted in an invalid way: either it wasn't an
266 even multiple of the block length or its padding values, when
267 checked, weren't correct. This message is always fatal.
268 .ie n .IP """\s-1RO\s0""/""record overflow""" 4
269 .el .IP "``\s-1RO\s0''/``record overflow''" 4
270 .IX Item "RO/record overflow"
271 A TLSCiphertext record was received which had a length more than
272 2^14+2048 bytes, or a record decrypted to a TLSCompressed record
273 with more than 2^14+1024 bytes. This message is always fatal.
274 .ie n .IP """\s-1CA\s0""/""unknown \s-1CA\s0""" 4
275 .el .IP "``\s-1CA\s0''/``unknown \s-1CA\s0''" 4
276 .IX Item "CA/unknown CA"
277 A valid certificate chain or partial chain was received, but the
278 certificate was not accepted because the \s-1CA\s0 certificate could not
279 be located or couldn't be matched with a known, trusted \s-1CA\s0.  This
280 message is always fatal.
281 .ie n .IP """\s-1AD\s0""/""access denied""" 4
282 .el .IP "``\s-1AD\s0''/``access denied''" 4
283 .IX Item "AD/access denied"
284 A valid certificate was received, but when access control was
285 applied, the sender decided not to proceed with negotiation.
286 This message is always fatal.
287 .ie n .IP """\s-1DE\s0""/""decode error""" 4
288 .el .IP "``\s-1DE\s0''/``decode error''" 4
289 .IX Item "DE/decode error"
290 A message could not be decoded because some field was out of the
291 specified range or the length of the message was incorrect. This
292 message is always fatal.
293 .ie n .IP """\s-1CY\s0""/""decrypt error""" 4
294 .el .IP "``\s-1CY\s0''/``decrypt error''" 4
295 .IX Item "CY/decrypt error"
296 A handshake cryptographic operation failed, including being
297 unable to correctly verify a signature, decrypt a key exchange,
298 or validate a finished message.
299 .ie n .IP """\s-1ER\s0""/""export restriction""" 4
300 .el .IP "``\s-1ER\s0''/``export restriction''" 4
301 .IX Item "ER/export restriction"
302 A negotiation not in compliance with export restrictions was
303 detected; for example, attempting to transfer a 1024 bit
304 ephemeral \s-1RSA\s0 key for the \s-1RSA_EXPORT\s0 handshake method. This
305 message is always fatal.
306 .ie n .IP """\s-1PV\s0""/""protocol version""" 4
307 .el .IP "``\s-1PV\s0''/``protocol version''" 4
308 .IX Item "PV/protocol version"
309 The protocol version the client has attempted to negotiate is
310 recognized, but not supported. (For example, old protocol
311 versions might be avoided for security reasons). This message is
312 always fatal.
313 .ie n .IP """\s-1IS\s0""/""insufficient security""" 4
314 .el .IP "``\s-1IS\s0''/``insufficient security''" 4
315 .IX Item "IS/insufficient security"
316 Returned instead of handshake_failure when a negotiation has
317 failed specifically because the server requires ciphers more
318 secure than those supported by the client. This message is always
319 fatal.
320 .ie n .IP """\s-1IE\s0""/""internal error""" 4
321 .el .IP "``\s-1IE\s0''/``internal error''" 4
322 .IX Item "IE/internal error"
323 An internal error unrelated to the peer or the correctness of the
324 protocol makes it impossible to continue (such as a memory
325 allocation failure). This message is always fatal.
326 .ie n .IP """\s-1US\s0""/""user canceled""" 4
327 .el .IP "``\s-1US\s0''/``user canceled''" 4
328 .IX Item "US/user canceled"
329 This handshake is being canceled for some reason unrelated to a
330 protocol failure. If the user cancels an operation after the
331 handshake is complete, just closing the connection by sending a
332 close_notify is more appropriate. This alert should be followed
333 by a close_notify. This message is generally a warning.
334 .ie n .IP """\s-1NR\s0""/""no renegotiation""" 4
335 .el .IP "``\s-1NR\s0''/``no renegotiation''" 4
336 .IX Item "NR/no renegotiation"
337 Sent by the client in response to a hello request or by the
338 server in response to a client hello after initial handshaking.
339 Either of these would normally lead to renegotiation; when that
340 is not appropriate, the recipient should respond with this alert;
341 at that point, the original requester can decide whether to
342 proceed with the connection. One case where this would be
343 appropriate would be where a server has spawned a process to
344 satisfy a request; the process might receive security parameters
345 (key length, authentication, etc.) at startup and it might be
346 difficult to communicate changes to these parameters after that
347 point. This message is always a warning.
348 .ie n .IP """\s-1UK\s0""/""unknown""" 4
349 .el .IP "``\s-1UK\s0''/``unknown''" 4
350 .IX Item "UK/unknown"
351 This indicates that no description is available for this alert type.
352 Probably \fBvalue\fR does not contain a correct alert message.
353 .SH "SEE ALSO"
354 .IX Header "SEE ALSO"
355 \&\fIssl\fR\|(3), \fISSL_CTX_set_info_callback\fR\|(3)