summaryrefslogtreecommitdiffstats
path: root/lib/dns/include/dns/result.h
blob: 0ec874bdd8d3f55d13267b07e3da5064acbb572d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */

#ifndef DNS_RESULT_H
#define DNS_RESULT_H 1

/*! \file dns/result.h */

#include <isc/lang.h>
#include <isc/resultclass.h>

#include <dns/types.h>

/*
 * Nothing in this file truly depends on <isc/result.h>, but the
 * DNS result codes are considered to be publicly derived from
 * the ISC result codes, so including this file buys you the ISC_R_
 * namespace too.
 */
#include <isc/result.h> /* Contractual promise. */

/*
 * DNS library result codes
 */
#define DNS_R_LABELTOOLONG (ISC_RESULTCLASS_DNS + 0)
#define DNS_R_BADESCAPE	   (ISC_RESULTCLASS_DNS + 1)
/*
 * Since we dropped the support of bitstring labels, deprecate the related
 * result codes too.
 *
 #define DNS_R_BADBITSTRING		(ISC_RESULTCLASS_DNS + 2)
 #define DNS_R_BITSTRINGTOOLONG		(ISC_RESULTCLASS_DNS + 3)
 */
#define DNS_R_EMPTYLABEL	(ISC_RESULTCLASS_DNS + 4)
#define DNS_R_BADDOTTEDQUAD	(ISC_RESULTCLASS_DNS + 5)
#define DNS_R_INVALIDNS		(ISC_RESULTCLASS_DNS + 6)
#define DNS_R_UNKNOWN		(ISC_RESULTCLASS_DNS + 7)
#define DNS_R_BADLABELTYPE	(ISC_RESULTCLASS_DNS + 8)
#define DNS_R_BADPOINTER	(ISC_RESULTCLASS_DNS + 9)
#define DNS_R_TOOMANYHOPS	(ISC_RESULTCLASS_DNS + 10)
#define DNS_R_DISALLOWED	(ISC_RESULTCLASS_DNS + 11)
#define DNS_R_EXTRATOKEN	(ISC_RESULTCLASS_DNS + 12)
#define DNS_R_EXTRADATA		(ISC_RESULTCLASS_DNS + 13)
#define DNS_R_TEXTTOOLONG	(ISC_RESULTCLASS_DNS + 14)
#define DNS_R_NOTZONETOP	(ISC_RESULTCLASS_DNS + 15)
#define DNS_R_SYNTAX		(ISC_RESULTCLASS_DNS + 16)
#define DNS_R_BADCKSUM		(ISC_RESULTCLASS_DNS + 17)
#define DNS_R_BADAAAA		(ISC_RESULTCLASS_DNS + 18)
#define DNS_R_NOOWNER		(ISC_RESULTCLASS_DNS + 19)
#define DNS_R_NOTTL		(ISC_RESULTCLASS_DNS + 20)
#define DNS_R_BADCLASS		(ISC_RESULTCLASS_DNS + 21)
#define DNS_R_NAMETOOLONG	(ISC_RESULTCLASS_DNS + 22)
#define DNS_R_PARTIALMATCH	(ISC_RESULTCLASS_DNS + 23)
#define DNS_R_NEWORIGIN		(ISC_RESULTCLASS_DNS + 24)
#define DNS_R_UNCHANGED		(ISC_RESULTCLASS_DNS + 25)
#define DNS_R_BADTTL		(ISC_RESULTCLASS_DNS + 26)
#define DNS_R_NOREDATA		(ISC_RESULTCLASS_DNS + 27)
#define DNS_R_CONTINUE		(ISC_RESULTCLASS_DNS + 28)
#define DNS_R_DELEGATION	(ISC_RESULTCLASS_DNS + 29)
#define DNS_R_GLUE		(ISC_RESULTCLASS_DNS + 30)
#define DNS_R_DNAME		(ISC_RESULTCLASS_DNS + 31)
#define DNS_R_CNAME		(ISC_RESULTCLASS_DNS + 32)
#define DNS_R_BADDB		(ISC_RESULTCLASS_DNS + 33)
#define DNS_R_ZONECUT		(ISC_RESULTCLASS_DNS + 34)
#define DNS_R_BADZONE		(ISC_RESULTCLASS_DNS + 35)
#define DNS_R_MOREDATA		(ISC_RESULTCLASS_DNS + 36)
#define DNS_R_UPTODATE		(ISC_RESULTCLASS_DNS + 37)
#define DNS_R_TSIGVERIFYFAILURE (ISC_RESULTCLASS_DNS + 38)
#define DNS_R_TSIGERRORSET	(ISC_RESULTCLASS_DNS + 39)
#define DNS_R_SIGINVALID	(ISC_RESULTCLASS_DNS + 40)
#define DNS_R_SIGEXPIRED	(ISC_RESULTCLASS_DNS + 41)
#define DNS_R_SIGFUTURE		(ISC_RESULTCLASS_DNS + 42)
#define DNS_R_KEYUNAUTHORIZED	(ISC_RESULTCLASS_DNS + 43)
#define DNS_R_INVALIDTIME	(ISC_RESULTCLASS_DNS + 44)
#define DNS_R_EXPECTEDTSIG	(ISC_RESULTCLASS_DNS + 45)
#define DNS_R_UNEXPECTEDTSIG	(ISC_RESULTCLASS_DNS + 46)
#define DNS_R_INVALIDTKEY	(ISC_RESULTCLASS_DNS + 47)
#define DNS_R_HINT		(ISC_RESULTCLASS_DNS + 48)
#define DNS_R_DROP		(ISC_RESULTCLASS_DNS + 49)
#define DNS_R_NOTLOADED		(ISC_RESULTCLASS_DNS + 50)
#define DNS_R_NCACHENXDOMAIN	(ISC_RESULTCLASS_DNS + 51)
#define DNS_R_NCACHENXRRSET	(ISC_RESULTCLASS_DNS + 52)
#define DNS_R_WAIT		(ISC_RESULTCLASS_DNS + 53)
#define DNS_R_NOTVERIFIEDYET	(ISC_RESULTCLASS_DNS + 54)
#define DNS_R_NOIDENTITY	(ISC_RESULTCLASS_DNS + 55)
#define DNS_R_NOJOURNAL		(ISC_RESULTCLASS_DNS + 56)
#define DNS_R_ALIAS		(ISC_RESULTCLASS_DNS + 57)
#define DNS_R_USETCP		(ISC_RESULTCLASS_DNS + 58)
#define DNS_R_NOVALIDSIG	(ISC_RESULTCLASS_DNS + 59)
#define DNS_R_NOVALIDNSEC	(ISC_RESULTCLASS_DNS + 60)
#define DNS_R_NOTINSECURE	(ISC_RESULTCLASS_DNS + 61)
#define DNS_R_UNKNOWNSERVICE	(ISC_RESULTCLASS_DNS + 62)
#define DNS_R_RECOVERABLE	(ISC_RESULTCLASS_DNS + 63)
#define DNS_R_UNKNOWNOPT	(ISC_RESULTCLASS_DNS + 64)
#define DNS_R_UNEXPECTEDID	(ISC_RESULTCLASS_DNS + 65)
#define DNS_R_SEENINCLUDE	(ISC_RESULTCLASS_DNS + 66)
#define DNS_R_NOTEXACT		(ISC_RESULTCLASS_DNS + 67)
#define DNS_R_BLACKHOLED	(ISC_RESULTCLASS_DNS + 68)
#define DNS_R_BADALG		(ISC_RESULTCLASS_DNS + 69)
#define DNS_R_METATYPE		(ISC_RESULTCLASS_DNS + 70)
#define DNS_R_CNAMEANDOTHER	(ISC_RESULTCLASS_DNS + 71)
#define DNS_R_SINGLETON		(ISC_RESULTCLASS_DNS + 72)
#define DNS_R_HINTNXRRSET	(ISC_RESULTCLASS_DNS + 73)
#define DNS_R_NOMASTERFILE	(ISC_RESULTCLASS_DNS + 74)
#define DNS_R_UNKNOWNPROTO	(ISC_RESULTCLASS_DNS + 75)
#define DNS_R_CLOCKSKEW		(ISC_RESULTCLASS_DNS + 76)
#define DNS_R_BADIXFR		(ISC_RESULTCLASS_DNS + 77)
#define DNS_R_NOTAUTHORITATIVE	(ISC_RESULTCLASS_DNS + 78)
#define DNS_R_NOVALIDKEY	(ISC_RESULTCLASS_DNS + 79)
#define DNS_R_OBSOLETE		(ISC_RESULTCLASS_DNS + 80)
#define DNS_R_FROZEN		(ISC_RESULTCLASS_DNS + 81)
#define DNS_R_UNKNOWNFLAG	(ISC_RESULTCLASS_DNS + 82)
#define DNS_R_EXPECTEDRESPONSE	(ISC_RESULTCLASS_DNS + 83)
#define DNS_R_NOVALIDDS		(ISC_RESULTCLASS_DNS + 84)
#define DNS_R_NSISADDRESS	(ISC_RESULTCLASS_DNS + 85)
#define DNS_R_REMOTEFORMERR	(ISC_RESULTCLASS_DNS + 86)
#define DNS_R_TRUNCATEDTCP	(ISC_RESULTCLASS_DNS + 87)
#define DNS_R_LAME		(ISC_RESULTCLASS_DNS + 88)
#define DNS_R_UNEXPECTEDRCODE	(ISC_RESULTCLASS_DNS + 89)
#define DNS_R_UNEXPECTEDOPCODE	(ISC_RESULTCLASS_DNS + 90)
#define DNS_R_CHASEDSSERVERS	(ISC_RESULTCLASS_DNS + 91)
#define DNS_R_EMPTYNAME		(ISC_RESULTCLASS_DNS + 92)
#define DNS_R_EMPTYWILD		(ISC_RESULTCLASS_DNS + 93)
#define DNS_R_BADBITMAP		(ISC_RESULTCLASS_DNS + 94)
#define DNS_R_FROMWILDCARD	(ISC_RESULTCLASS_DNS + 95)
#define DNS_R_BADOWNERNAME	(ISC_RESULTCLASS_DNS + 96)
#define DNS_R_BADNAME		(ISC_RESULTCLASS_DNS + 97)
#define DNS_R_DYNAMIC		(ISC_RESULTCLASS_DNS + 98)
#define DNS_R_UNKNOWNCOMMAND	(ISC_RESULTCLASS_DNS + 99)
#define DNS_R_MUSTBESECURE	(ISC_RESULTCLASS_DNS + 100)
#define DNS_R_COVERINGNSEC	(ISC_RESULTCLASS_DNS + 101)
#define DNS_R_MXISADDRESS	(ISC_RESULTCLASS_DNS + 102)
#define DNS_R_DUPLICATE		(ISC_RESULTCLASS_DNS + 103)
#define DNS_R_INVALIDNSEC3	(ISC_RESULTCLASS_DNS + 104)
#define DNS_R_NOTMASTER		(ISC_RESULTCLASS_DNS + 105)
#define DNS_R_BROKENCHAIN	(ISC_RESULTCLASS_DNS + 106)
#define DNS_R_EXPIRED		(ISC_RESULTCLASS_DNS + 107)
#define DNS_R_NOTDYNAMIC	(ISC_RESULTCLASS_DNS + 108)
#define DNS_R_BADEUI		(ISC_RESULTCLASS_DNS + 109)
#define DNS_R_NTACOVERED	(ISC_RESULTCLASS_DNS + 110)
#define DNS_R_BADCDS		(ISC_RESULTCLASS_DNS + 111)
#define DNS_R_BADCDNSKEY	(ISC_RESULTCLASS_DNS + 112)
#define DNS_R_OPTERR		(ISC_RESULTCLASS_DNS + 113)
#define DNS_R_BADDNSTAP		(ISC_RESULTCLASS_DNS + 114)
#define DNS_R_BADTSIG		(ISC_RESULTCLASS_DNS + 115)
#define DNS_R_BADSIG0		(ISC_RESULTCLASS_DNS + 116)
#define DNS_R_TOOMANYRECORDS	(ISC_RESULTCLASS_DNS + 117)
#define DNS_R_VERIFYFAILURE	(ISC_RESULTCLASS_DNS + 118)
#define DNS_R_ATZONETOP		(ISC_RESULTCLASS_DNS + 119)
#define DNS_R_NOKEYMATCH	(ISC_RESULTCLASS_DNS + 120)
#define DNS_R_TOOMANYKEYS	(ISC_RESULTCLASS_DNS + 121)
#define DNS_R_KEYNOTACTIVE	(ISC_RESULTCLASS_DNS + 122)
#define DNS_R_NSEC3ITERRANGE	(ISC_RESULTCLASS_DNS + 123)
#define DNS_R_NSEC3SALTRANGE	(ISC_RESULTCLASS_DNS + 124)
#define DNS_R_NSEC3BADALG	(ISC_RESULTCLASS_DNS + 125)
#define DNS_R_NSEC3RESALT	(ISC_RESULTCLASS_DNS + 126)
#define DNS_R_INCONSISTENTRR	(ISC_RESULTCLASS_DNS + 127)

#define DNS_R_NRESULTS 128 /*%< Number of results */

/*
 * DNS wire format rcodes.
 *
 * By making these their own class we can easily convert them into the
 * wire-format rcode value simply by masking off the resultclass.
 */
#define DNS_R_NOERROR  (ISC_RESULTCLASS_DNSRCODE + 0)
#define DNS_R_FORMERR  (ISC_RESULTCLASS_DNSRCODE + 1)
#define DNS_R_SERVFAIL (ISC_RESULTCLASS_DNSRCODE + 2)
#define DNS_R_NXDOMAIN (ISC_RESULTCLASS_DNSRCODE + 3)
#define DNS_R_NOTIMP   (ISC_RESULTCLASS_DNSRCODE + 4)
#define DNS_R_REFUSED  (ISC_RESULTCLASS_DNSRCODE + 5)
#define DNS_R_YXDOMAIN (ISC_RESULTCLASS_DNSRCODE + 6)
#define DNS_R_YXRRSET  (ISC_RESULTCLASS_DNSRCODE + 7)
#define DNS_R_NXRRSET  (ISC_RESULTCLASS_DNSRCODE + 8)
#define DNS_R_NOTAUTH  (ISC_RESULTCLASS_DNSRCODE + 9)
#define DNS_R_NOTZONE  (ISC_RESULTCLASS_DNSRCODE + 10)
#define DNS_R_RCODE11  (ISC_RESULTCLASS_DNSRCODE + 11)
#define DNS_R_RCODE12  (ISC_RESULTCLASS_DNSRCODE + 12)
#define DNS_R_RCODE13  (ISC_RESULTCLASS_DNSRCODE + 13)
#define DNS_R_RCODE14  (ISC_RESULTCLASS_DNSRCODE + 14)
#define DNS_R_RCODE15  (ISC_RESULTCLASS_DNSRCODE + 15)
#define DNS_R_BADVERS  (ISC_RESULTCLASS_DNSRCODE + 16)

#define DNS_R_NRCODERESULTS 17 /*%< Number of rcode results */

#define DNS_RESULT_ISRCODE(result) \
	(ISC_RESULTCLASS_INCLASS(ISC_RESULTCLASS_DNSRCODE, (result)))

ISC_LANG_BEGINDECLS

const char *dns_result_totext(isc_result_t);

void
dns_result_register(void);

dns_rcode_t
dns_result_torcode(isc_result_t result);

ISC_LANG_ENDDECLS

#endif /* DNS_RESULT_H */