nameser.h revision 17902
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. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * -
34 * Portions Copyright (c) 1993 by Digital Equipment Corporation.
35 *
36 * Permission to use, copy, modify, and distribute this software for any
37 * purpose with or without fee is hereby granted, provided that the above
38 * copyright notice and this permission notice appear in all copies, and that
39 * the name of Digital Equipment Corporation not be used in advertising or
40 * publicity pertaining to distribution of the document or software without
41 * specific, written prior permission.
42 *
43 * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
44 * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
45 * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
46 * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
47 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
48 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
49 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
50 * SOFTWARE.
51 * -
52 * --Copyright--
53 *
54 *      @(#)nameser.h	8.2 (Berkeley) 2/16/94
55 *	From Id: nameser.h,v 4.9.1.15 1994/07/19 22:51:24 vixie Exp
56 *	$Id: nameser.h,v 1.7 1996/01/30 23:31:16 mpp Exp $
57 */
58
59#ifndef _ARPA_NAMESER_H_
60#define	_ARPA_NAMESER_H_
61
62#include <sys/param.h>
63#include <sys/types.h>
64#include <sys/cdefs.h>
65#include <machine/endian.h>
66
67
68/*
69 * revision information.  this is the release date in YYYYMMDD format.
70 * it can change every day so the right thing to do with it is use it
71 * in preprocessor commands such as "#if (__BIND > 19931104)".  do not
72 * compare for equality; rather, use it to determine whether your resolver
73 * is new enough to contain a certain feature.
74 */
75
76#define	__BIND		19950621	/* interface version stamp */
77
78/*
79 * Define constants based on rfc883
80 */
81#define	PACKETSZ	512		/* maximum packet size */
82#define	MAXDNAME	256		/* maximum domain name */
83#define	MAXCDNAME	255		/* maximum compressed domain name */
84#define	MAXLABEL	63		/* maximum length of domain label */
85#define	HFIXEDSZ	12		/* #/bytes of fixed data in header */
86#define	QFIXEDSZ	4		/* #/bytes of fixed data in query */
87#define	RRFIXEDSZ	10		/* #/bytes of fixed data in r record */
88#define	INT32SZ		4		/* for systems without 32-bit ints */
89#define	INT16SZ		2		/* for systems without 16-bit ints */
90#define INADDRSZ	4		/* IPv4 T_A */
91#define IN6ADDRSZ	16		/* IPv6 T_AAAA */
92
93
94/*
95 * Internet nameserver port number
96 */
97#define	NAMESERVER_PORT	53
98
99/*
100 * Currently defined opcodes
101 */
102#define	QUERY		0x0		/* standard query */
103#define	IQUERY		0x1		/* inverse query */
104#define	STATUS		0x2		/* nameserver status query */
105/*#define xxx		0x3 */		/* 0x3 reserved */
106#define	NS_NOTIFY_OP	0x4		/* notify secondary of SOA change */
107#ifdef ALLOW_UPDATES
108	/* non standard - supports ALLOW_UPDATES stuff from Mike Schwartz */
109# define UPDATEA	0x9		/* add resource record */
110# define UPDATED	0xa		/* delete a specific resource record */
111# define UPDATEDA	0xb		/* delete all named resource record */
112# define UPDATEM	0xc		/* modify a specific resource record */
113# define UPDATEMA	0xd		/* modify all named resource record */
114# define ZONEINIT	0xe		/* initial zone transfer */
115# define ZONEREF	0xf		/* incremental zone referesh */
116#endif
117
118/*
119 * Currently defined response codes
120 */
121#define	NOERROR		0		/* no error */
122#define	FORMERR		1		/* format error */
123#define	SERVFAIL	2		/* server failure */
124#define	NXDOMAIN	3		/* non existent domain */
125#define	NOTIMP		4		/* not implemented */
126#define	REFUSED		5		/* query refused */
127#ifdef ALLOW_UPDATES
128	/* non standard */
129# define NOCHANGE	0xf		/* update failed to change db */
130#endif
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		/* canonical 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 NSAP lookup (deprecated) */
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	/* non standard */
165#define	T_UINFO		100		/* user (finger) information */
166#define	T_UID		101		/* user ID */
167#define	T_GID		102		/* group ID */
168#define	T_UNSPEC	103		/* Unspecified format (binary data) */
169	/* Query type values which do not appear in resource records */
170#define	T_AXFR		252		/* transfer zone of authority */
171#define	T_MAILB		253		/* transfer mailbox records */
172#define	T_MAILA		254		/* transfer mail agent records */
173#define	T_ANY		255		/* wildcard match */
174
175/*
176 * Values for class field
177 */
178
179#define	C_IN		1		/* the arpa internet */
180#define	C_CHAOS		3		/* for chaos net (MIT) */
181#define	C_HS		4		/* for Hesiod name server (MIT) (XXX) */
182	/* Query class values which do not appear in resource records */
183#define	C_ANY		255		/* wildcard match */
184
185/*
186 * Status return codes for T_UNSPEC conversion routines
187 */
188#define	CONV_SUCCESS	0
189#define	CONV_OVERFLOW	(-1)
190#define	CONV_BADFMT	(-2)
191#define	CONV_BADCKSUM	(-3)
192#define	CONV_BADBUFLEN	(-4)
193
194/*
195 * Structure for query header.  The order of the fields is machine- and
196 * compiler-dependent, depending on the byte/bit order and the layout
197 * of bit fields.  We use bit fields only in int variables, as this
198 * is all ANSI requires.  This requires a somewhat confusing rearrangement.
199 */
200
201typedef struct {
202	unsigned	id :16;		/* query identification number */
203#if BYTE_ORDER == BIG_ENDIAN
204			/* fields in third byte */
205	unsigned	qr: 1;		/* response flag */
206	unsigned	opcode: 4;	/* purpose of message */
207	unsigned	aa: 1;		/* authoritative answer */
208	unsigned	tc: 1;		/* truncated message */
209	unsigned	rd: 1;		/* recursion desired */
210			/* fields in fourth byte */
211	unsigned	ra: 1;		/* recursion available */
212	unsigned	unused :3;	/* unused bits (MBZ as of 4.9.3a3) */
213	unsigned	rcode :4;	/* response code */
214#endif
215#if BYTE_ORDER == LITTLE_ENDIAN || BYTE_ORDER == PDP_ENDIAN
216			/* fields in third byte */
217	unsigned	rd :1;		/* recursion desired */
218	unsigned	tc :1;		/* truncated message */
219	unsigned	aa :1;		/* authoritative answer */
220	unsigned	opcode :4;	/* purpose of message */
221	unsigned	qr :1;		/* response flag */
222			/* fields in fourth byte */
223	unsigned	rcode :4;	/* response code */
224	unsigned	unused :3;	/* unused bits (MBZ as of 4.9.3a3) */
225	unsigned	ra :1;		/* recursion available */
226#endif
227			/* remaining bytes */
228	unsigned	qdcount :16;	/* number of question entries */
229	unsigned	ancount :16;	/* number of answer entries */
230	unsigned	nscount :16;	/* number of authority entries */
231	unsigned	arcount :16;	/* number of resource entries */
232} HEADER;
233
234/*
235 * Defines for handling compressed domain names
236 */
237#define	INDIR_MASK	0xc0
238
239/*
240 * Structure for passing resource records around.
241 */
242struct rrec {
243	int16_t		r_zone;			/* zone number */
244	int16_t		r_class;		/* class number */
245	int16_t		r_type;			/* type number */
246	u_int32_t	r_ttl;			/* time to live */
247	int		r_size;			/* size of data area */
248	char		*r_data;		/* pointer to data */
249};
250
251extern	u_int16_t	_getshort __P((const u_char *));
252extern	u_int32_t	_getlong __P((const u_char *));
253
254/*
255 * Inline versions of get/put short/long.  Pointer is advanced.
256 *
257 * These macros demonstrate the property of C whereby it can be
258 * portable or it can be elegant but rarely both.
259 */
260#define	GETSHORT(s, cp) { \
261	register u_char *t_cp = (u_char *)(cp); \
262	(s) = ((u_int16_t)t_cp[0] << 8) \
263	    | ((u_int16_t)t_cp[1]) \
264	    ; \
265	(cp) += INT16SZ; \
266}
267
268#define	GETLONG(l, cp) { \
269	register u_char *t_cp = (u_char *)(cp); \
270	(l) = ((u_int32_t)t_cp[0] << 24) \
271	    | ((u_int32_t)t_cp[1] << 16) \
272	    | ((u_int32_t)t_cp[2] << 8) \
273	    | ((u_int32_t)t_cp[3]) \
274	    ; \
275	(cp) += INT32SZ; \
276}
277
278#define	PUTSHORT(s, cp) { \
279	register u_int16_t t_s = (u_int16_t)(s); \
280	register u_char *t_cp = (u_char *)(cp); \
281	*t_cp++ = t_s >> 8; \
282	*t_cp   = t_s; \
283	(cp) += INT16SZ; \
284}
285
286#define	PUTLONG(l, cp) { \
287	register u_int32_t t_l = (u_int32_t)(l); \
288	register u_char *t_cp = (u_char *)(cp); \
289	*t_cp++ = t_l >> 24; \
290	*t_cp++ = t_l >> 16; \
291	*t_cp++ = t_l >> 8; \
292	*t_cp   = t_l; \
293	(cp) += INT32SZ; \
294}
295
296#endif /* !_ARPA_NAMESER_H_ */
297