1 /*	$NetBSD: result.h,v 1.7 2022/09/23 12:15:30 christos Exp $	*/
2 
3 /*
4  * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
5  *
6  * SPDX-License-Identifier: MPL-2.0
7  *
8  * This Source Code Form is subject to the terms of the Mozilla Public
9  * License, v. 2.0. If a copy of the MPL was not distributed with this
10  * file, you can obtain one at https://mozilla.org/MPL/2.0/.
11  *
12  * See the COPYRIGHT file distributed with this work for additional
13  * information regarding copyright ownership.
14  */
15 
16 #ifndef DNS_RESULT_H
17 #define DNS_RESULT_H 1
18 
19 /*! \file dns/result.h */
20 
21 #include <isc/lang.h>
22 #include <isc/resultclass.h>
23 
24 #include <dns/types.h>
25 
26 /*
27  * Nothing in this file truly depends on <isc/result.h>, but the
28  * DNS result codes are considered to be publicly derived from
29  * the ISC result codes, so including this file buys you the ISC_R_
30  * namespace too.
31  */
32 #include <isc/result.h> /* Contractual promise. */
33 
34 /*
35  * DNS library result codes
36  */
37 #define DNS_R_LABELTOOLONG (ISC_RESULTCLASS_DNS + 0)
38 #define DNS_R_BADESCAPE	   (ISC_RESULTCLASS_DNS + 1)
39 /*
40  * Since we dropped the support of bitstring labels, deprecate the related
41  * result codes too.
42  *
43  #define DNS_R_BADBITSTRING		(ISC_RESULTCLASS_DNS + 2)
44  #define DNS_R_BITSTRINGTOOLONG		(ISC_RESULTCLASS_DNS + 3)
45  */
46 #define DNS_R_EMPTYLABEL	(ISC_RESULTCLASS_DNS + 4)
47 #define DNS_R_BADDOTTEDQUAD	(ISC_RESULTCLASS_DNS + 5)
48 #define DNS_R_INVALIDNS		(ISC_RESULTCLASS_DNS + 6)
49 #define DNS_R_UNKNOWN		(ISC_RESULTCLASS_DNS + 7)
50 #define DNS_R_BADLABELTYPE	(ISC_RESULTCLASS_DNS + 8)
51 #define DNS_R_BADPOINTER	(ISC_RESULTCLASS_DNS + 9)
52 #define DNS_R_TOOMANYHOPS	(ISC_RESULTCLASS_DNS + 10)
53 #define DNS_R_DISALLOWED	(ISC_RESULTCLASS_DNS + 11)
54 #define DNS_R_EXTRATOKEN	(ISC_RESULTCLASS_DNS + 12)
55 #define DNS_R_EXTRADATA		(ISC_RESULTCLASS_DNS + 13)
56 #define DNS_R_TEXTTOOLONG	(ISC_RESULTCLASS_DNS + 14)
57 #define DNS_R_NOTZONETOP	(ISC_RESULTCLASS_DNS + 15)
58 #define DNS_R_SYNTAX		(ISC_RESULTCLASS_DNS + 16)
59 #define DNS_R_BADCKSUM		(ISC_RESULTCLASS_DNS + 17)
60 #define DNS_R_BADAAAA		(ISC_RESULTCLASS_DNS + 18)
61 #define DNS_R_NOOWNER		(ISC_RESULTCLASS_DNS + 19)
62 #define DNS_R_NOTTL		(ISC_RESULTCLASS_DNS + 20)
63 #define DNS_R_BADCLASS		(ISC_RESULTCLASS_DNS + 21)
64 #define DNS_R_NAMETOOLONG	(ISC_RESULTCLASS_DNS + 22)
65 #define DNS_R_PARTIALMATCH	(ISC_RESULTCLASS_DNS + 23)
66 #define DNS_R_NEWORIGIN		(ISC_RESULTCLASS_DNS + 24)
67 #define DNS_R_UNCHANGED		(ISC_RESULTCLASS_DNS + 25)
68 #define DNS_R_BADTTL		(ISC_RESULTCLASS_DNS + 26)
69 #define DNS_R_NOREDATA		(ISC_RESULTCLASS_DNS + 27)
70 #define DNS_R_CONTINUE		(ISC_RESULTCLASS_DNS + 28)
71 #define DNS_R_DELEGATION	(ISC_RESULTCLASS_DNS + 29)
72 #define DNS_R_GLUE		(ISC_RESULTCLASS_DNS + 30)
73 #define DNS_R_DNAME		(ISC_RESULTCLASS_DNS + 31)
74 #define DNS_R_CNAME		(ISC_RESULTCLASS_DNS + 32)
75 #define DNS_R_BADDB		(ISC_RESULTCLASS_DNS + 33)
76 #define DNS_R_ZONECUT		(ISC_RESULTCLASS_DNS + 34)
77 #define DNS_R_BADZONE		(ISC_RESULTCLASS_DNS + 35)
78 #define DNS_R_MOREDATA		(ISC_RESULTCLASS_DNS + 36)
79 #define DNS_R_UPTODATE		(ISC_RESULTCLASS_DNS + 37)
80 #define DNS_R_TSIGVERIFYFAILURE (ISC_RESULTCLASS_DNS + 38)
81 #define DNS_R_TSIGERRORSET	(ISC_RESULTCLASS_DNS + 39)
82 #define DNS_R_SIGINVALID	(ISC_RESULTCLASS_DNS + 40)
83 #define DNS_R_SIGEXPIRED	(ISC_RESULTCLASS_DNS + 41)
84 #define DNS_R_SIGFUTURE		(ISC_RESULTCLASS_DNS + 42)
85 #define DNS_R_KEYUNAUTHORIZED	(ISC_RESULTCLASS_DNS + 43)
86 #define DNS_R_INVALIDTIME	(ISC_RESULTCLASS_DNS + 44)
87 #define DNS_R_EXPECTEDTSIG	(ISC_RESULTCLASS_DNS + 45)
88 #define DNS_R_UNEXPECTEDTSIG	(ISC_RESULTCLASS_DNS + 46)
89 #define DNS_R_INVALIDTKEY	(ISC_RESULTCLASS_DNS + 47)
90 #define DNS_R_HINT		(ISC_RESULTCLASS_DNS + 48)
91 #define DNS_R_DROP		(ISC_RESULTCLASS_DNS + 49)
92 #define DNS_R_NOTLOADED		(ISC_RESULTCLASS_DNS + 50)
93 #define DNS_R_NCACHENXDOMAIN	(ISC_RESULTCLASS_DNS + 51)
94 #define DNS_R_NCACHENXRRSET	(ISC_RESULTCLASS_DNS + 52)
95 #define DNS_R_WAIT		(ISC_RESULTCLASS_DNS + 53)
96 #define DNS_R_NOTVERIFIEDYET	(ISC_RESULTCLASS_DNS + 54)
97 #define DNS_R_NOIDENTITY	(ISC_RESULTCLASS_DNS + 55)
98 #define DNS_R_NOJOURNAL		(ISC_RESULTCLASS_DNS + 56)
99 #define DNS_R_ALIAS		(ISC_RESULTCLASS_DNS + 57)
100 #define DNS_R_USETCP		(ISC_RESULTCLASS_DNS + 58)
101 #define DNS_R_NOVALIDSIG	(ISC_RESULTCLASS_DNS + 59)
102 #define DNS_R_NOVALIDNSEC	(ISC_RESULTCLASS_DNS + 60)
103 #define DNS_R_NOTINSECURE	(ISC_RESULTCLASS_DNS + 61)
104 #define DNS_R_UNKNOWNSERVICE	(ISC_RESULTCLASS_DNS + 62)
105 #define DNS_R_RECOVERABLE	(ISC_RESULTCLASS_DNS + 63)
106 #define DNS_R_UNKNOWNOPT	(ISC_RESULTCLASS_DNS + 64)
107 #define DNS_R_UNEXPECTEDID	(ISC_RESULTCLASS_DNS + 65)
108 #define DNS_R_SEENINCLUDE	(ISC_RESULTCLASS_DNS + 66)
109 #define DNS_R_NOTEXACT		(ISC_RESULTCLASS_DNS + 67)
110 #define DNS_R_BLACKHOLED	(ISC_RESULTCLASS_DNS + 68)
111 #define DNS_R_BADALG		(ISC_RESULTCLASS_DNS + 69)
112 #define DNS_R_METATYPE		(ISC_RESULTCLASS_DNS + 70)
113 #define DNS_R_CNAMEANDOTHER	(ISC_RESULTCLASS_DNS + 71)
114 #define DNS_R_SINGLETON		(ISC_RESULTCLASS_DNS + 72)
115 #define DNS_R_HINTNXRRSET	(ISC_RESULTCLASS_DNS + 73)
116 #define DNS_R_NOMASTERFILE	(ISC_RESULTCLASS_DNS + 74)
117 #define DNS_R_UNKNOWNPROTO	(ISC_RESULTCLASS_DNS + 75)
118 #define DNS_R_CLOCKSKEW		(ISC_RESULTCLASS_DNS + 76)
119 #define DNS_R_BADIXFR		(ISC_RESULTCLASS_DNS + 77)
120 #define DNS_R_NOTAUTHORITATIVE	(ISC_RESULTCLASS_DNS + 78)
121 #define DNS_R_NOVALIDKEY	(ISC_RESULTCLASS_DNS + 79)
122 #define DNS_R_OBSOLETE		(ISC_RESULTCLASS_DNS + 80)
123 #define DNS_R_FROZEN		(ISC_RESULTCLASS_DNS + 81)
124 #define DNS_R_UNKNOWNFLAG	(ISC_RESULTCLASS_DNS + 82)
125 #define DNS_R_EXPECTEDRESPONSE	(ISC_RESULTCLASS_DNS + 83)
126 #define DNS_R_NOVALIDDS		(ISC_RESULTCLASS_DNS + 84)
127 #define DNS_R_NSISADDRESS	(ISC_RESULTCLASS_DNS + 85)
128 #define DNS_R_REMOTEFORMERR	(ISC_RESULTCLASS_DNS + 86)
129 #define DNS_R_TRUNCATEDTCP	(ISC_RESULTCLASS_DNS + 87)
130 #define DNS_R_LAME		(ISC_RESULTCLASS_DNS + 88)
131 #define DNS_R_UNEXPECTEDRCODE	(ISC_RESULTCLASS_DNS + 89)
132 #define DNS_R_UNEXPECTEDOPCODE	(ISC_RESULTCLASS_DNS + 90)
133 #define DNS_R_CHASEDSSERVERS	(ISC_RESULTCLASS_DNS + 91)
134 #define DNS_R_EMPTYNAME		(ISC_RESULTCLASS_DNS + 92)
135 #define DNS_R_EMPTYWILD		(ISC_RESULTCLASS_DNS + 93)
136 #define DNS_R_BADBITMAP		(ISC_RESULTCLASS_DNS + 94)
137 #define DNS_R_FROMWILDCARD	(ISC_RESULTCLASS_DNS + 95)
138 #define DNS_R_BADOWNERNAME	(ISC_RESULTCLASS_DNS + 96)
139 #define DNS_R_BADNAME		(ISC_RESULTCLASS_DNS + 97)
140 #define DNS_R_DYNAMIC		(ISC_RESULTCLASS_DNS + 98)
141 #define DNS_R_UNKNOWNCOMMAND	(ISC_RESULTCLASS_DNS + 99)
142 #define DNS_R_MUSTBESECURE	(ISC_RESULTCLASS_DNS + 100)
143 #define DNS_R_COVERINGNSEC	(ISC_RESULTCLASS_DNS + 101)
144 #define DNS_R_MXISADDRESS	(ISC_RESULTCLASS_DNS + 102)
145 #define DNS_R_DUPLICATE		(ISC_RESULTCLASS_DNS + 103)
146 #define DNS_R_INVALIDNSEC3	(ISC_RESULTCLASS_DNS + 104)
147 #define DNS_R_NOTMASTER		(ISC_RESULTCLASS_DNS + 105)
148 #define DNS_R_BROKENCHAIN	(ISC_RESULTCLASS_DNS + 106)
149 #define DNS_R_EXPIRED		(ISC_RESULTCLASS_DNS + 107)
150 #define DNS_R_NOTDYNAMIC	(ISC_RESULTCLASS_DNS + 108)
151 #define DNS_R_BADEUI		(ISC_RESULTCLASS_DNS + 109)
152 #define DNS_R_NTACOVERED	(ISC_RESULTCLASS_DNS + 110)
153 #define DNS_R_BADCDS		(ISC_RESULTCLASS_DNS + 111)
154 #define DNS_R_BADCDNSKEY	(ISC_RESULTCLASS_DNS + 112)
155 #define DNS_R_OPTERR		(ISC_RESULTCLASS_DNS + 113)
156 #define DNS_R_BADDNSTAP		(ISC_RESULTCLASS_DNS + 114)
157 #define DNS_R_BADTSIG		(ISC_RESULTCLASS_DNS + 115)
158 #define DNS_R_BADSIG0		(ISC_RESULTCLASS_DNS + 116)
159 #define DNS_R_TOOMANYRECORDS	(ISC_RESULTCLASS_DNS + 117)
160 #define DNS_R_VERIFYFAILURE	(ISC_RESULTCLASS_DNS + 118)
161 #define DNS_R_ATZONETOP		(ISC_RESULTCLASS_DNS + 119)
162 #define DNS_R_NOKEYMATCH	(ISC_RESULTCLASS_DNS + 120)
163 #define DNS_R_TOOMANYKEYS	(ISC_RESULTCLASS_DNS + 121)
164 #define DNS_R_KEYNOTACTIVE	(ISC_RESULTCLASS_DNS + 122)
165 #define DNS_R_NSEC3ITERRANGE	(ISC_RESULTCLASS_DNS + 123)
166 #define DNS_R_NSEC3SALTRANGE	(ISC_RESULTCLASS_DNS + 124)
167 #define DNS_R_NSEC3BADALG	(ISC_RESULTCLASS_DNS + 125)
168 #define DNS_R_NSEC3RESALT	(ISC_RESULTCLASS_DNS + 126)
169 #define DNS_R_INCONSISTENTRR	(ISC_RESULTCLASS_DNS + 127)
170 
171 #define DNS_R_NRESULTS 128 /*%< Number of results */
172 
173 /*
174  * DNS wire format rcodes.
175  *
176  * By making these their own class we can easily convert them into the
177  * wire-format rcode value simply by masking off the resultclass.
178  */
179 #define DNS_R_NOERROR  (ISC_RESULTCLASS_DNSRCODE + 0)
180 #define DNS_R_FORMERR  (ISC_RESULTCLASS_DNSRCODE + 1)
181 #define DNS_R_SERVFAIL (ISC_RESULTCLASS_DNSRCODE + 2)
182 #define DNS_R_NXDOMAIN (ISC_RESULTCLASS_DNSRCODE + 3)
183 #define DNS_R_NOTIMP   (ISC_RESULTCLASS_DNSRCODE + 4)
184 #define DNS_R_REFUSED  (ISC_RESULTCLASS_DNSRCODE + 5)
185 #define DNS_R_YXDOMAIN (ISC_RESULTCLASS_DNSRCODE + 6)
186 #define DNS_R_YXRRSET  (ISC_RESULTCLASS_DNSRCODE + 7)
187 #define DNS_R_NXRRSET  (ISC_RESULTCLASS_DNSRCODE + 8)
188 #define DNS_R_NOTAUTH  (ISC_RESULTCLASS_DNSRCODE + 9)
189 #define DNS_R_NOTZONE  (ISC_RESULTCLASS_DNSRCODE + 10)
190 #define DNS_R_RCODE11  (ISC_RESULTCLASS_DNSRCODE + 11)
191 #define DNS_R_RCODE12  (ISC_RESULTCLASS_DNSRCODE + 12)
192 #define DNS_R_RCODE13  (ISC_RESULTCLASS_DNSRCODE + 13)
193 #define DNS_R_RCODE14  (ISC_RESULTCLASS_DNSRCODE + 14)
194 #define DNS_R_RCODE15  (ISC_RESULTCLASS_DNSRCODE + 15)
195 #define DNS_R_BADVERS  (ISC_RESULTCLASS_DNSRCODE + 16)
196 
197 #define DNS_R_NRCODERESULTS 17 /*%< Number of rcode results */
198 
199 #define DNS_RESULT_ISRCODE(result) \
200 	(ISC_RESULTCLASS_INCLASS(ISC_RESULTCLASS_DNSRCODE, (result)))
201 
202 ISC_LANG_BEGINDECLS
203 
204 const char *dns_result_totext(isc_result_t);
205 
206 void
207 dns_result_register(void);
208 
209 dns_rcode_t
210 dns_result_torcode(isc_result_t result);
211 
212 ISC_LANG_ENDDECLS
213 
214 #endif /* DNS_RESULT_H */
215