nameser.h revision 1.2
1/* @(#) Header: /tcpdump/master/tcpdump/nameser.h,v 1.16 2006-11-10 03:18:21 guy Exp (LBL) */
2/*
3 * Copyright (c) 1983, 1989, 1993
4 *	The Regents of the University of California.  All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of the University nor the names of its contributors
15 *    may be used to endorse or promote products derived from this software
16 *    without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 *      @(#)nameser.h	8.2 (Berkeley) 2/16/94
31 * -
32 * Portions Copyright (c) 1993 by Digital Equipment Corporation.
33 *
34 * Permission to use, copy, modify, and distribute this software for any
35 * purpose with or without fee is hereby granted, provided that the above
36 * copyright notice and this permission notice appear in all copies, and that
37 * the name of Digital Equipment Corporation not be used in advertising or
38 * publicity pertaining to distribution of the document or software without
39 * specific, written prior permission.
40 *
41 * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
42 * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
44 * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
45 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
46 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
47 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
48 * SOFTWARE.
49 * -
50 * --Copyright--
51 */
52
53#ifndef _NAMESER_H_
54#define	_NAMESER_H_
55
56#include <sys/types.h>
57
58/*
59 * Define constants based on rfc883
60 */
61#define PACKETSZ	512		/* maximum packet size */
62#define MAXDNAME	256		/* maximum domain name */
63#define MAXCDNAME	255		/* maximum compressed domain name */
64#define MAXLABEL	63		/* maximum length of domain label */
65	/* Number of bytes of fixed size data in query structure */
66#define QFIXEDSZ	4
67	/* number of bytes of fixed size data in resource record */
68#define RRFIXEDSZ	10
69
70/*
71 * Internet nameserver port number
72 */
73#define NAMESERVER_PORT	53
74
75/*
76 * Port for multicast DNS; see
77 *
78 *	http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt
79 *
80 * for the current mDNS spec.
81 */
82#define MULTICASTDNS_PORT	5353
83
84/*
85 * Currently defined opcodes
86 */
87#define QUERY		0x0		/* standard query */
88#define IQUERY		0x1		/* inverse query */
89#define STATUS		0x2		/* nameserver status query */
90#if 0
91#define xxx		0x3		/* 0x3 reserved */
92#endif
93	/* non standard - supports ALLOW_UPDATES stuff from Mike Schwartz */
94#define UPDATEA		0x9		/* add resource record */
95#define UPDATED		0xa		/* delete a specific resource record */
96#define UPDATEDA	0xb		/* delete all named resource record */
97#define UPDATEM		0xc		/* modify a specific resource record */
98#define UPDATEMA	0xd		/* modify all named resource record */
99
100#define ZONEINIT	0xe		/* initial zone transfer */
101#define ZONEREF		0xf		/* incremental zone referesh */
102
103/*
104 * Undefine various #defines from various System V-flavored OSes (Solaris,
105 * SINIX, HP-UX) so the compiler doesn't whine that we redefine them.
106 */
107#ifdef T_NULL
108#undef T_NULL
109#endif
110#ifdef T_OPT
111#undef T_OPT
112#endif
113#ifdef T_UNSPEC
114#undef T_UNSPEC
115#endif
116#ifdef NOERROR
117#undef NOERROR
118#endif
119
120/*
121 * Currently defined response codes
122 */
123#define NOERROR		0		/* no error */
124#define FORMERR		1		/* format error */
125#define SERVFAIL	2		/* server failure */
126#define NXDOMAIN	3		/* non existent domain */
127#define NOTIMP		4		/* not implemented */
128#define REFUSED		5		/* query refused */
129	/* non standard */
130#define NOCHANGE	0xf		/* update failed to change db */
131
132/*
133 * Type values for resources and queries
134 */
135#define T_A		1		/* host address */
136#define T_NS		2		/* authoritative server */
137#define T_MD		3		/* mail destination */
138#define T_MF		4		/* mail forwarder */
139#define T_CNAME		5		/* connonical name */
140#define T_SOA		6		/* start of authority zone */
141#define T_MB		7		/* mailbox domain name */
142#define T_MG		8		/* mail group member */
143#define T_MR		9		/* mail rename name */
144#define T_NULL		10		/* null resource record */
145#define T_WKS		11		/* well known service */
146#define T_PTR		12		/* domain name pointer */
147#define T_HINFO		13		/* host information */
148#define T_MINFO		14		/* mailbox information */
149#define T_MX		15		/* mail routing information */
150#define T_TXT		16		/* text strings */
151#define	T_RP		17		/* responsible person */
152#define	T_AFSDB		18		/* AFS cell database */
153#define T_X25		19		/* X_25 calling address */
154#define T_ISDN		20		/* ISDN calling address */
155#define T_RT		21		/* router */
156#define	T_NSAP		22		/* NSAP address */
157#define	T_NSAP_PTR	23		/* reverse lookup for NSAP */
158#define T_SIG		24		/* security signature */
159#define T_KEY		25		/* security key */
160#define T_PX		26		/* X.400 mail mapping */
161#define T_GPOS		27		/* geographical position (withdrawn) */
162#define T_AAAA		28		/* IP6 Address */
163#define T_LOC		29		/* Location Information */
164#define T_NXT		30		/* Next Valid Name in Zone */
165#define T_EID		31		/* Endpoint identifier */
166#define T_NIMLOC	32		/* Nimrod locator */
167#define T_SRV		33		/* Server selection */
168#define T_ATMA		34		/* ATM Address */
169#define T_NAPTR		35		/* Naming Authority PoinTeR */
170#define T_KX		36		/* Key Exchanger */
171#define T_CERT		37		/* Certificates in the DNS */
172#define T_A6		38		/* IP6 address */
173#define T_DNAME		39		/* non-terminal redirection */
174#define T_SINK		40		/* unknown */
175#define T_OPT		41		/* EDNS0 option (meta-RR) */
176#define T_APL		42		/* lists of address prefixes */
177#define T_DS		43		/* Delegation Signer */
178#define T_SSHFP		44		/* SSH Fingerprint */
179#define T_IPSECKEY	45		/* IPsec keying material */
180#define T_RRSIG		46		/* new security signature */
181#define T_NSEC		47		/* provable insecure information */
182#define T_DNSKEY	48		/* new security key */
183	/* non standard */
184#define T_SPF		99		/* sender policy framework */
185#define T_UINFO		100		/* user (finger) information */
186#define T_UID		101		/* user ID */
187#define T_GID		102		/* group ID */
188#define T_UNSPEC	103		/* Unspecified format (binary data) */
189#define T_UNSPECA	104		/* "unspecified ascii". Ugly MIT hack */
190	/* Query type values which do not appear in resource records */
191#define T_TKEY		249		/* Transaction Key [RFC2930] */
192#define T_TSIG		250		/* Transaction Signature [RFC2845] */
193#define T_IXFR		251		/* incremental transfer [RFC1995] */
194#define T_AXFR		252		/* transfer zone of authority */
195#define T_MAILB		253		/* transfer mailbox records */
196#define T_MAILA		254		/* transfer mail agent records */
197#define T_ANY		255		/* wildcard match */
198
199/*
200 * Values for class field
201 */
202
203#define C_IN		1		/* the arpa internet */
204#define C_CHAOS		3		/* for chaos net (MIT) */
205#define C_HS		4		/* for Hesiod name server (MIT) (XXX) */
206	/* Query class values which do not appear in resource records */
207#define C_ANY		255		/* wildcard match */
208#define C_QU		0x8000		/* mDNS QU flag in queries */
209#define C_CACHE_FLUSH	0x8000		/* mDNS cache flush flag in replies */
210
211/*
212 * Status return codes for T_UNSPEC conversion routines
213 */
214#define CONV_SUCCESS 0
215#define CONV_OVERFLOW -1
216#define CONV_BADFMT -2
217#define CONV_BADCKSUM -3
218#define CONV_BADBUFLEN -4
219
220/*
221 * Structure for query header.
222 */
223typedef struct {
224	u_int16_t id;		/* query identification number */
225	u_int8_t  flags1;	/* first byte of flags */
226	u_int8_t  flags2;	/* second byte of flags */
227	u_int16_t qdcount;	/* number of question entries */
228	u_int16_t ancount;	/* number of answer entries */
229	u_int16_t nscount;	/* number of authority entries */
230	u_int16_t arcount;	/* number of resource entries */
231} HEADER;
232
233/*
234 * Macros for subfields of flag fields.
235 */
236#define DNS_QR(np)	((np)->flags1 & 0x80)		/* response flag */
237#define DNS_OPCODE(np)	((((np)->flags1) >> 3) & 0xF)	/* purpose of message */
238#define DNS_AA(np)	((np)->flags1 & 0x04)		/* authoritative answer */
239#define DNS_TC(np)	((np)->flags1 & 0x02)		/* truncated message */
240#define DNS_RD(np)	((np)->flags1 & 0x01)		/* recursion desired */
241
242#define DNS_RA(np)	((np)->flags2 & 0x80)	/* recursion available */
243#define DNS_AD(np)	((np)->flags2 & 0x20)	/* authentic data from named */
244#define DNS_CD(np)	((np)->flags2 & 0x10)	/* checking disabled by resolver */
245#define DNS_RCODE(np)	((np)->flags2 & 0xF)	/* response code */
246
247/*
248 * Defines for handling compressed domain names, EDNS0 labels, etc.
249 */
250#define INDIR_MASK	0xc0	/* 11.... */
251#define EDNS0_MASK	0x40	/* 01.... */
252#  define EDNS0_ELT_BITLABEL 0x01
253
254/*
255 * Structure for passing resource records around.
256 */
257struct rrec {
258	int16_t	r_zone;			/* zone number */
259	int16_t	r_class;		/* class number */
260	int16_t	r_type;			/* type number */
261	u_int32_t	r_ttl;			/* time to live */
262	int	r_size;			/* size of data area */
263	char	*r_data;		/* pointer to data */
264};
265
266/*
267 * Inline versions of get/put short/long.  Pointer is advanced.
268 * We also assume that a "u_int16_t" holds 2 "chars"
269 * and that a "u_int32_t" holds 4 "chars".
270 *
271 * These macros demonstrate the property of C whereby it can be
272 * portable or it can be elegant but never both.
273 */
274#define GETSHORT(s, cp) { \
275	register u_char *t_cp = (u_char *)(cp); \
276	(s) = ((u_int16_t)t_cp[0] << 8) | (u_int16_t)t_cp[1]; \
277	(cp) += 2; \
278}
279
280#define GETLONG(l, cp) { \
281	register u_char *t_cp = (u_char *)(cp); \
282	(l) = (((u_int32_t)t_cp[0]) << 24) \
283	    | (((u_int32_t)t_cp[1]) << 16) \
284	    | (((u_int32_t)t_cp[2]) << 8) \
285	    | (((u_int32_t)t_cp[3])); \
286	(cp) += 4; \
287}
288
289#define PUTSHORT(s, cp) { \
290	register u_int16_t t_s = (u_int16_t)(s); \
291	register u_char *t_cp = (u_char *)(cp); \
292	*t_cp++ = t_s >> 8; \
293	*t_cp   = t_s; \
294	(cp) += 2; \
295}
296
297/*
298 * Warning: PUTLONG --no-longer-- destroys its first argument.  if you
299 * were depending on this "feature", you will lose.
300 */
301#define PUTLONG(l, cp) { \
302	register u_int32_t t_l = (u_int32_t)(l); \
303	register u_char *t_cp = (u_char *)(cp); \
304	*t_cp++ = t_l >> 24; \
305	*t_cp++ = t_l >> 16; \
306	*t_cp++ = t_l >> 8; \
307	*t_cp   = t_l; \
308	(cp) += 4; \
309}
310
311#endif /* !_NAMESER_H_ */
312