xref: /netbsd-src/external/bsd/tcpdump/dist/nameser.h (revision b2c35e17b976cf7ccd7250c86c6f5e95090ed636)
1 /*
2  * Copyright (c) 1983, 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *      @(#)nameser.h	8.2 (Berkeley) 2/16/94
30  * -
31  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
32  *
33  * Permission to use, copy, modify, and distribute this software for any
34  * purpose with or without fee is hereby granted, provided that the above
35  * copyright notice and this permission notice appear in all copies, and that
36  * the name of Digital Equipment Corporation not be used in advertising or
37  * publicity pertaining to distribution of the document or software without
38  * specific, written prior permission.
39  *
40  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
41  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
43  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
44  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
45  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
46  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
47  * SOFTWARE.
48  * -
49  * --Copyright--
50  */
51 
52 #ifndef _NAMESER_H_
53 #define	_NAMESER_H_
54 
55 #include <sys/types.h>
56 
57 /*
58  * Define constants based on rfc883
59  */
60 #define PACKETSZ	512		/* maximum packet size */
61 #define MAXDNAME	256		/* maximum domain name */
62 #define MAXCDNAME	255		/* maximum compressed domain name */
63 #define MAXLABEL	63		/* maximum length of domain label */
64 	/* Number of bytes of fixed size data in query structure */
65 #define QFIXEDSZ	4
66 	/* number of bytes of fixed size data in resource record */
67 #define RRFIXEDSZ	10
68 
69 /*
70  * Currently defined opcodes
71  */
72 #define QUERY		0x0		/* standard query */
73 #define IQUERY		0x1		/* inverse query */
74 #define STATUS		0x2		/* nameserver status query */
75 #if 0
76 #define xxx		0x3		/* 0x3 reserved */
77 #endif
78 	/* non standard - supports ALLOW_UPDATES stuff from Mike Schwartz */
79 #define UPDATEA		0x9		/* add resource record */
80 #define UPDATED		0xa		/* delete a specific resource record */
81 #define UPDATEDA	0xb		/* delete all named resource record */
82 #define UPDATEM		0xc		/* modify a specific resource record */
83 #define UPDATEMA	0xd		/* modify all named resource record */
84 
85 #define ZONEINIT	0xe		/* initial zone transfer */
86 #define ZONEREF		0xf		/* incremental zone referesh */
87 
88 /*
89  * Undefine various #defines from various System V-flavored OSes (Solaris,
90  * SINIX, HP-UX) so the compiler doesn't whine that we redefine them.
91  */
92 #ifdef T_NULL
93 #undef T_NULL
94 #endif
95 #ifdef T_OPT
96 #undef T_OPT
97 #endif
98 #ifdef T_UNSPEC
99 #undef T_UNSPEC
100 #endif
101 #ifdef NOERROR
102 #undef NOERROR
103 #endif
104 
105 /*
106  * Currently defined response codes
107  */
108 #define NOERROR		0		/* no error */
109 #define FORMERR		1		/* format error */
110 #define SERVFAIL	2		/* server failure */
111 #define NXDOMAIN	3		/* non existent domain */
112 #define NOTIMP		4		/* not implemented */
113 #define REFUSED		5		/* query refused */
114 	/* non standard */
115 #define NOCHANGE	0xf		/* update failed to change db */
116 
117 /*
118  * Type values for resources and queries
119  */
120 #define T_A		1		/* host address */
121 #define T_NS		2		/* authoritative server */
122 #define T_MD		3		/* mail destination */
123 #define T_MF		4		/* mail forwarder */
124 #define T_CNAME		5		/* connonical name */
125 #define T_SOA		6		/* start of authority zone */
126 #define T_MB		7		/* mailbox domain name */
127 #define T_MG		8		/* mail group member */
128 #define T_MR		9		/* mail rename name */
129 #define T_NULL		10		/* null resource record */
130 #define T_WKS		11		/* well known service */
131 #define T_PTR		12		/* domain name pointer */
132 #define T_HINFO		13		/* host information */
133 #define T_MINFO		14		/* mailbox information */
134 #define T_MX		15		/* mail routing information */
135 #define T_TXT		16		/* text strings */
136 #define	T_RP		17		/* responsible person */
137 #define	T_AFSDB		18		/* AFS cell database */
138 #define T_X25		19		/* X_25 calling address */
139 #define T_ISDN		20		/* ISDN calling address */
140 #define T_RT		21		/* router */
141 #define	T_NSAP		22		/* NSAP address */
142 #define	T_NSAP_PTR	23		/* reverse lookup for NSAP */
143 #define T_SIG		24		/* security signature */
144 #define T_KEY		25		/* security key */
145 #define T_PX		26		/* X.400 mail mapping */
146 #define T_GPOS		27		/* geographical position (withdrawn) */
147 #define T_AAAA		28		/* IP6 Address */
148 #define T_LOC		29		/* Location Information */
149 #define T_NXT		30		/* Next Valid Name in Zone */
150 #define T_EID		31		/* Endpoint identifier */
151 #define T_NIMLOC	32		/* Nimrod locator */
152 #define T_SRV		33		/* Server selection */
153 #define T_ATMA		34		/* ATM Address */
154 #define T_NAPTR		35		/* Naming Authority PoinTeR */
155 #define T_KX		36		/* Key Exchanger */
156 #define T_CERT		37		/* Certificates in the DNS */
157 #define T_A6		38		/* IP6 address */
158 #define T_DNAME		39		/* non-terminal redirection */
159 #define T_SINK		40		/* unknown */
160 #define T_OPT		41		/* EDNS0 option (meta-RR) */
161 #define T_APL		42		/* lists of address prefixes */
162 #define T_DS		43		/* Delegation Signer */
163 #define T_SSHFP		44		/* SSH Fingerprint */
164 #define T_IPSECKEY	45		/* IPsec keying material */
165 #define T_RRSIG		46		/* new security signature */
166 #define T_NSEC		47		/* provable insecure information */
167 #define T_DNSKEY	48		/* new security key */
168 #define T_DHCID		49		/* DHCP IDentifier */
169 #define T_NSEC3		50		/* Next SECure record v3 */
170 #define T_NSEC3PARAM	51		/* NSEC3 PARAMeter */
171 #define T_TLSA		52		/* TLS Authentication */
172 #define T_SMIMEA	53		/* S/MIME Authentication */
173 /* Unassigned */
174 #define T_HIP		55		/* Host Identity Protocol */
175 #define T_NINFO		56		/* zone status information */
176 #define T_RKEY		57		/* Record encryption KEY */
177 #define T_TALINK	58		/* Trust Anchor LINK */
178 #define T_CDS		59		/* Child Delegation Signer */
179 #define T_CDNSKEY	60		/* Child DNSKEY */
180 #define T_OPENPGPKEY	61		/* OpenPGP KEY */
181 #define T_CSYNC		62		/* Child to parent SYNCronization */
182 #define T_ZONEMD	63		/* ZONE data Message Digest */
183 #define T_SVCB		64		/* SerViCe Binding */
184 #define T_HTTPS		65		/* HTTPS binding */
185 	/* non standard */
186 #define T_SPF		99		/* sender policy framework */
187 #define T_UINFO		100		/* user (finger) information */
188 #define T_UID		101		/* user ID */
189 #define T_GID		102		/* group ID */
190 #define T_UNSPEC	103		/* Unspecified format (binary data) */
191 #define T_NID		104		/* Node IDentifier */
192 #define T_L32		105		/* Locator 32-bit */
193 #define T_L64		106		/* Locator 64-bit */
194 #define T_LP		107		/* Locator Pointer */
195 #define T_EUI48		108		/* an EUI-48 address */
196 #define T_EUI64		109		/* an EUI-64 address */
197 	/* Query type values which do not appear in resource records */
198 #define T_TKEY		249		/* Transaction Key [RFC2930] */
199 #define T_TSIG		250		/* Transaction Signature [RFC2845] */
200 #define T_IXFR		251		/* incremental transfer [RFC1995] */
201 #define T_AXFR		252		/* transfer zone of authority */
202 #define T_MAILB		253		/* transfer mailbox records */
203 #define T_MAILA		254		/* transfer mail agent records */
204 #define T_ANY		255		/* wildcard match */
205 #define T_URI		256		/* uri records [RFC7553] */
206 #define T_CAA		257		/* Certification Authority Authorization */
207 #define T_AVC		258		/* Application Visibility and Control */
208 #define T_DOA		259		/* Digital Object Architecture */
209 #define T_AMTRELAY	260		/* Automatic Multicast Tunneling RELAY */
210 #define T_TA		32768		/* DNSSEC Trust Authorities */
211 #define T_DLV		32769		/* DNSSEC Lookaside Validation */
212 
213 /*
214  * Values for class field
215  */
216 
217 #define C_IN		1		/* the arpa internet */
218 #define C_CHAOS		3		/* for chaos net (MIT) */
219 #define C_HS		4		/* for Hesiod name server (MIT) (XXX) */
220 	/* Query class values which do not appear in resource records */
221 #define C_ANY		255		/* wildcard match */
222 #define C_QU		0x8000		/* mDNS QU flag in queries */
223 #define C_CACHE_FLUSH	0x8000		/* mDNS cache flush flag in replies */
224 
225 /*
226  * Values for EDNS option types
227  */
228 #define E_LLQ           1       /* long lived queries protocol */
229 #define E_UL            2       /* dynamic dns update leases */
230 #define E_NSID          3       /* name server identifier */
231 #define E_DAU           5       /* signal DNSSEC algorithm understood */
232 #define E_DHU           6       /* signal DS hash understood */
233 #define E_N3U           7       /* signal NSEC3 hash understood */
234 #define E_ECS           8       /* EDNS client subnet */
235 #define E_EXPIRE        9       /* zone expiration */
236 #define E_COOKIE        10      /* DNS cookies */
237 #define E_KEEPALIVE     11      /* TCP keepalive */
238 #define E_PADDING       12      /* pad DNS messages */
239 #define E_CHAIN         13      /* chain DNS queries */
240 #define E_KEYTAG        14      /* EDNS key tag */
241 #define E_CLIENTTAG     16      /* EDNS client tag */
242 #define E_SERVERTAG     17      /* EDNS server tag */
243 
244 /*
245  * Values for DNSSEC Algorithms
246  * https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml
247  */
248 
249 #define A_DELETE                0
250 #define A_RSAMD5                1
251 #define A_DH                    2
252 #define A_DSA                   3
253 #define A_RSASHA1               5
254 #define A_DSA_NSEC3_SHA1        6
255 #define A_RSASHA1_NSEC3_SHA1    7
256 #define A_RSASHA256             8
257 #define A_RSASHA512             10
258 #define A_ECC_GOST              12
259 #define A_ECDSAP256SHA256       13
260 #define A_ECDSAP384SHA384       14
261 #define A_ED25519               15
262 #define A_ED448                 16
263 #define A_INDIRECT              252
264 #define A_PRIVATEDNS            253
265 #define A_PRIVATEOID            254
266 
267 /*
268  * Values for NSEC3 algorithms
269  * https://www.iana.org/assignments/dnssec-nsec3-parameters/dnssec-nsec3-parameters.xhtml
270  */
271 #define NSEC_SHA1   1
272 
273 /*
274  * Values for delegation signer algorithms
275  * https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml
276  */
277 #define DS_SHA1     1
278 #define DS_SHA256   2
279 #define DS_GOST     3
280 #define DS_SHA384   4
281 
282 
283 /*
284  * Status return codes for T_UNSPEC conversion routines
285  */
286 #define CONV_SUCCESS 0
287 #define CONV_OVERFLOW -1
288 #define CONV_BADFMT -2
289 #define CONV_BADCKSUM -3
290 #define CONV_BADBUFLEN -4
291 
292 /*
293  * Structure for query header.
294  */
295 typedef struct {
296 	nd_uint16_t id;		/* query identification number */
297 	nd_uint16_t flags;	/* QR, Opcode, AA, TC, RD, RA, RCODE */
298 	nd_uint16_t qdcount;	/* number of question entries */
299 	nd_uint16_t ancount;	/* number of answer entries */
300 	nd_uint16_t nscount;	/* number of authority entries */
301 	nd_uint16_t arcount;	/* number of resource entries */
302 } dns_header_t;
303 
304 /*
305  * Macros for subfields of flag fields.
306  */
307 #define DNS_QR(flags)		((flags) & 0x8000)	/* response flag */
308 #define DNS_OPCODE(flags)	(((flags) >> 11) & 0xF)	/* purpose of message */
309 #define DNS_AA(flags)		(flags & 0x0400)	/* authoritative answer */
310 #define DNS_TC(flags)		(flags & 0x0200)	/* truncated message */
311 #define DNS_RD(flags)		(flags & 0x0100)	/* recursion desired */
312 #define DNS_RA(flags)		(flags & 0x0080)	/* recursion available */
313 #define DNS_AD(flags)		(flags & 0x0020)	/* authentic data from named */
314 #define DNS_CD(flags)		(flags & 0x0010)	/* checking disabled by resolver */
315 #define DNS_RCODE(flags)	(flags & 0x000F)	/* response code */
316 
317 /*
318  * Defines for handling compressed domain names, EDNS0 labels, etc.
319  */
320 #define TYPE_MASK	0xc0	/* mask for the type bits of the item */
321 #define TYPE_INDIR	0xc0	/* 11.... - pointer */
322 #define TYPE_RESERVED	0x80	/* 10.... - reserved */
323 #define TYPE_EDNS0	0x40	/* 01.... - EDNS(0) label */
324 #define TYPE_LABEL	0x00	/* 00.... - regular label */
325 #  define EDNS0_ELT_BITLABEL 0x01
326 
327 #endif /* !_NAMESER_H_ */
328