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