xref: /minix3/external/bsd/tcpdump/dist/nameser.h (revision b636d99d91c3d54204248f643c14627405d4afd1)
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  * Internet nameserver port number
71  */
72 #define NAMESERVER_PORT	53
73 
74 /*
75  * Port for multicast DNS; see
76  *
77  *	http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt
78  *
79  * for the current mDNS spec.
80  */
81 #define MULTICASTDNS_PORT	5353
82 
83 /*
84  * Currently defined opcodes
85  */
86 #define QUERY		0x0		/* standard query */
87 #define IQUERY		0x1		/* inverse query */
88 #define STATUS		0x2		/* nameserver status query */
89 #if 0
90 #define xxx		0x3		/* 0x3 reserved */
91 #endif
92 	/* non standard - supports ALLOW_UPDATES stuff from Mike Schwartz */
93 #define UPDATEA		0x9		/* add resource record */
94 #define UPDATED		0xa		/* delete a specific resource record */
95 #define UPDATEDA	0xb		/* delete all named resource record */
96 #define UPDATEM		0xc		/* modify a specific resource record */
97 #define UPDATEMA	0xd		/* modify all named resource record */
98 
99 #define ZONEINIT	0xe		/* initial zone transfer */
100 #define ZONEREF		0xf		/* incremental zone referesh */
101 
102 /*
103  * Undefine various #defines from various System V-flavored OSes (Solaris,
104  * SINIX, HP-UX) so the compiler doesn't whine that we redefine them.
105  */
106 #ifdef T_NULL
107 #undef T_NULL
108 #endif
109 #ifdef T_OPT
110 #undef T_OPT
111 #endif
112 #ifdef T_UNSPEC
113 #undef T_UNSPEC
114 #endif
115 #ifdef NOERROR
116 #undef NOERROR
117 #endif
118 
119 /*
120  * Currently defined response codes
121  */
122 #define NOERROR		0		/* no error */
123 #define FORMERR		1		/* format error */
124 #define SERVFAIL	2		/* server failure */
125 #define NXDOMAIN	3		/* non existent domain */
126 #define NOTIMP		4		/* not implemented */
127 #define REFUSED		5		/* query refused */
128 	/* non standard */
129 #define NOCHANGE	0xf		/* update failed to change db */
130 
131 /*
132  * Type values for resources and queries
133  */
134 #define T_A		1		/* host address */
135 #define T_NS		2		/* authoritative server */
136 #define T_MD		3		/* mail destination */
137 #define T_MF		4		/* mail forwarder */
138 #define T_CNAME		5		/* connonical name */
139 #define T_SOA		6		/* start of authority zone */
140 #define T_MB		7		/* mailbox domain name */
141 #define T_MG		8		/* mail group member */
142 #define T_MR		9		/* mail rename name */
143 #define T_NULL		10		/* null resource record */
144 #define T_WKS		11		/* well known service */
145 #define T_PTR		12		/* domain name pointer */
146 #define T_HINFO		13		/* host information */
147 #define T_MINFO		14		/* mailbox information */
148 #define T_MX		15		/* mail routing information */
149 #define T_TXT		16		/* text strings */
150 #define	T_RP		17		/* responsible person */
151 #define	T_AFSDB		18		/* AFS cell database */
152 #define T_X25		19		/* X_25 calling address */
153 #define T_ISDN		20		/* ISDN calling address */
154 #define T_RT		21		/* router */
155 #define	T_NSAP		22		/* NSAP address */
156 #define	T_NSAP_PTR	23		/* reverse lookup for NSAP */
157 #define T_SIG		24		/* security signature */
158 #define T_KEY		25		/* security key */
159 #define T_PX		26		/* X.400 mail mapping */
160 #define T_GPOS		27		/* geographical position (withdrawn) */
161 #define T_AAAA		28		/* IP6 Address */
162 #define T_LOC		29		/* Location Information */
163 #define T_NXT		30		/* Next Valid Name in Zone */
164 #define T_EID		31		/* Endpoint identifier */
165 #define T_NIMLOC	32		/* Nimrod locator */
166 #define T_SRV		33		/* Server selection */
167 #define T_ATMA		34		/* ATM Address */
168 #define T_NAPTR		35		/* Naming Authority PoinTeR */
169 #define T_KX		36		/* Key Exchanger */
170 #define T_CERT		37		/* Certificates in the DNS */
171 #define T_A6		38		/* IP6 address */
172 #define T_DNAME		39		/* non-terminal redirection */
173 #define T_SINK		40		/* unknown */
174 #define T_OPT		41		/* EDNS0 option (meta-RR) */
175 #define T_APL		42		/* lists of address prefixes */
176 #define T_DS		43		/* Delegation Signer */
177 #define T_SSHFP		44		/* SSH Fingerprint */
178 #define T_IPSECKEY	45		/* IPsec keying material */
179 #define T_RRSIG		46		/* new security signature */
180 #define T_NSEC		47		/* provable insecure information */
181 #define T_DNSKEY	48		/* new security key */
182 	/* non standard */
183 #define T_SPF		99		/* sender policy framework */
184 #define T_UINFO		100		/* user (finger) information */
185 #define T_UID		101		/* user ID */
186 #define T_GID		102		/* group ID */
187 #define T_UNSPEC	103		/* Unspecified format (binary data) */
188 #define T_UNSPECA	104		/* "unspecified ascii". Ugly MIT hack */
189 	/* Query type values which do not appear in resource records */
190 #define T_TKEY		249		/* Transaction Key [RFC2930] */
191 #define T_TSIG		250		/* Transaction Signature [RFC2845] */
192 #define T_IXFR		251		/* incremental transfer [RFC1995] */
193 #define T_AXFR		252		/* transfer zone of authority */
194 #define T_MAILB		253		/* transfer mailbox records */
195 #define T_MAILA		254		/* transfer mail agent records */
196 #define T_ANY		255		/* wildcard match */
197 
198 /*
199  * Values for class field
200  */
201 
202 #define C_IN		1		/* the arpa internet */
203 #define C_CHAOS		3		/* for chaos net (MIT) */
204 #define C_HS		4		/* for Hesiod name server (MIT) (XXX) */
205 	/* Query class values which do not appear in resource records */
206 #define C_ANY		255		/* wildcard match */
207 #define C_QU		0x8000		/* mDNS QU flag in queries */
208 #define C_CACHE_FLUSH	0x8000		/* mDNS cache flush flag in replies */
209 
210 /*
211  * Status return codes for T_UNSPEC conversion routines
212  */
213 #define CONV_SUCCESS 0
214 #define CONV_OVERFLOW -1
215 #define CONV_BADFMT -2
216 #define CONV_BADCKSUM -3
217 #define CONV_BADBUFLEN -4
218 
219 /*
220  * Structure for query header.
221  */
222 typedef struct {
223 	uint16_t id;		/* query identification number */
224 	uint8_t  flags1;	/* first byte of flags */
225 	uint8_t  flags2;	/* second byte of flags */
226 	uint16_t qdcount;	/* number of question entries */
227 	uint16_t ancount;	/* number of answer entries */
228 	uint16_t nscount;	/* number of authority entries */
229 	uint16_t arcount;	/* number of resource entries */
230 } HEADER;
231 
232 /*
233  * Macros for subfields of flag fields.
234  */
235 #define DNS_QR(np)	((np)->flags1 & 0x80)		/* response flag */
236 #define DNS_OPCODE(np)	((((np)->flags1) >> 3) & 0xF)	/* purpose of message */
237 #define DNS_AA(np)	((np)->flags1 & 0x04)		/* authoritative answer */
238 #define DNS_TC(np)	((np)->flags1 & 0x02)		/* truncated message */
239 #define DNS_RD(np)	((np)->flags1 & 0x01)		/* recursion desired */
240 
241 #define DNS_RA(np)	((np)->flags2 & 0x80)	/* recursion available */
242 #define DNS_AD(np)	((np)->flags2 & 0x20)	/* authentic data from named */
243 #define DNS_CD(np)	((np)->flags2 & 0x10)	/* checking disabled by resolver */
244 #define DNS_RCODE(np)	((np)->flags2 & 0xF)	/* response code */
245 
246 /*
247  * Defines for handling compressed domain names, EDNS0 labels, etc.
248  */
249 #define INDIR_MASK	0xc0	/* 11.... */
250 #define EDNS0_MASK	0x40	/* 01.... */
251 #  define EDNS0_ELT_BITLABEL 0x01
252 
253 /*
254  * Structure for passing resource records around.
255  */
256 struct rrec {
257 	int16_t	r_zone;			/* zone number */
258 	int16_t	r_class;		/* class number */
259 	int16_t	r_type;			/* type number */
260 	uint32_t	r_ttl;			/* time to live */
261 	int	r_size;			/* size of data area */
262 	char	*r_data;		/* pointer to data */
263 };
264 
265 /*
266  * Inline versions of get/put short/long.  Pointer is advanced.
267  * We also assume that a "uint16_t" holds 2 "chars"
268  * and that a "uint32_t" holds 4 "chars".
269  *
270  * These macros demonstrate the property of C whereby it can be
271  * portable or it can be elegant but never both.
272  */
273 #define GETSHORT(s, cp) { \
274 	register u_char *t_cp = (u_char *)(cp); \
275 	(s) = ((uint16_t)t_cp[0] << 8) | (uint16_t)t_cp[1]; \
276 	(cp) += 2; \
277 }
278 
279 #define GETLONG(l, cp) { \
280 	register u_char *t_cp = (u_char *)(cp); \
281 	(l) = (((uint32_t)t_cp[0]) << 24) \
282 	    | (((uint32_t)t_cp[1]) << 16) \
283 	    | (((uint32_t)t_cp[2]) << 8) \
284 	    | (((uint32_t)t_cp[3])); \
285 	(cp) += 4; \
286 }
287 
288 #define PUTSHORT(s, cp) { \
289 	register uint16_t t_s = (uint16_t)(s); \
290 	register u_char *t_cp = (u_char *)(cp); \
291 	*t_cp++ = t_s >> 8; \
292 	*t_cp   = t_s; \
293 	(cp) += 2; \
294 }
295 
296 /*
297  * Warning: PUTLONG --no-longer-- destroys its first argument.  if you
298  * were depending on this "feature", you will lose.
299  */
300 #define PUTLONG(l, cp) { \
301 	register uint32_t t_l = (uint32_t)(l); \
302 	register u_char *t_cp = (u_char *)(cp); \
303 	*t_cp++ = t_l >> 24; \
304 	*t_cp++ = t_l >> 16; \
305 	*t_cp++ = t_l >> 8; \
306 	*t_cp   = t_l; \
307 	(cp) += 4; \
308 }
309 
310 #endif /* !_NAMESER_H_ */
311