nameser.h revision 1.2
1/*
2 * ++Copyright++ 1983, 1989, 1993
3 * -
4 * Copyright (c) 1983, 1989, 1993
5 *    The Regents of the University of California.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 *    must display the following acknowledgement:
17 * 	This product includes software developed by the University of
18 * 	California, Berkeley and its contributors.
19 * 4. Neither the name of the University nor the names of its contributors
20 *    may be used to endorse or promote products derived from this software
21 *    without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 * -
35 * Portions Copyright (c) 1993 by Digital Equipment Corporation.
36 *
37 * Permission to use, copy, modify, and distribute this software for any
38 * purpose with or without fee is hereby granted, provided that the above
39 * copyright notice and this permission notice appear in all copies, and that
40 * the name of Digital Equipment Corporation not be used in advertising or
41 * publicity pertaining to distribution of the document or software without
42 * specific, written prior permission.
43 *
44 * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
45 * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
46 * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
47 * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
48 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
49 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
50 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
51 * SOFTWARE.
52 * -
53 * --Copyright--
54 */
55
56/*
57 *      @(#)nameser.h	8.1 (Berkeley) 6/2/93
58 *	$Id: nameser.h,v 8.3 1995/08/21 01:27:12 vixie Exp
59 */
60
61#ifndef _NAMESER_H_
62#define	_NAMESER_H_
63
64#include <sys/param.h>
65#if (!defined(BSD)) || (BSD < 199306)
66# include <sys/bitypes.h>
67#else
68# include <sys/types.h>
69#endif
70#include <sys/cdefs.h>
71
72#ifdef _AUX_SOURCE
73#include <sys/types.h>			/* ech for A/UX */
74#define res_send ucb_res_send		/* already def'd in libc */
75#define _res_close _ucb_res_close    /* removing res_send.o from the library */
76#endif				     /* gives an undefined symbol... */
77
78/*
79 * revision information.  this is the release date in YYYYMMDD format.
80 * it can change every day so the right thing to do with it is use it
81 * in preprocessor commands such as "#if (__BIND > 19931104)".  do not
82 * compare for equality; rather, use it to determine whether your resolver
83 * is new enough to contain a certain feature.
84 */
85
86#define	__BIND		19950621	/* interface version stamp */
87
88/*
89 * Define constants based on rfc883
90 */
91#define PACKETSZ	512		/* maximum packet size */
92#define MAXDNAME	256		/* maximum domain name */
93#define MAXCDNAME	255		/* maximum compressed domain name */
94#define MAXLABEL	63		/* maximum length of domain label */
95#define	HFIXEDSZ	12		/* #/bytes of fixed data in header */
96#define QFIXEDSZ	4		/* #/bytes of fixed data in query */
97#define RRFIXEDSZ	10		/* #/bytes of fixed data in r record */
98#define	INT32SZ		4		/* for systems without 32-bit ints */
99#define	INT16SZ		2		/* for systems without 16-bit ints */
100#define	INADDRSZ	4		/* for sizeof(struct inaddr) != 4 */
101
102/*
103 * Internet nameserver port number
104 */
105#define NAMESERVER_PORT	53
106
107/*
108 * Currently defined opcodes
109 */
110#define QUERY		0x0		/* standard query */
111#define IQUERY		0x1		/* inverse query */
112#define STATUS		0x2		/* nameserver status query */
113/*#define xxx		0x3*/		/* 0x3 reserved */
114#define	NS_NOTIFY_OP	0x4		/* notify secondary of SOA change */
115#ifdef ALLOW_UPDATES
116	/* non standard - supports ALLOW_UPDATES stuff from Mike Schwartz */
117# define UPDATEA	0x9		/* add resource record */
118# define UPDATED	0xa		/* delete a specific resource record */
119# define UPDATEDA	0xb		/* delete all named resource record */
120# define UPDATEM	0xc		/* modify a specific resource record */
121# define UPDATEMA	0xd		/* modify all named resource record */
122# define ZONEINIT	0xe		/* initial zone transfer */
123# define ZONEREF	0xf		/* incremental zone referesh */
124#endif
125
126/*
127 * Currently defined response codes
128 */
129#define NOERROR		0		/* no error */
130#define FORMERR		1		/* format error */
131#define SERVFAIL	2		/* server failure */
132#define NXDOMAIN	3		/* non existent domain */
133#define NOTIMP		4		/* not implemented */
134#define REFUSED		5		/* query refused */
135#ifdef ALLOW_UPDATES
136	/* non standard */
137# define NOCHANGE	0xf		/* update failed to change db */
138#endif
139
140/*
141 * Type values for resources and queries
142 */
143#define T_A		1		/* host address */
144#define T_NS		2		/* authoritative server */
145#define T_MD		3		/* mail destination */
146#define T_MF		4		/* mail forwarder */
147#define T_CNAME		5		/* canonical name */
148#define T_SOA		6		/* start of authority zone */
149#define T_MB		7		/* mailbox domain name */
150#define T_MG		8		/* mail group member */
151#define T_MR		9		/* mail rename name */
152#define T_NULL		10		/* null resource record */
153#define T_WKS		11		/* well known service */
154#define T_PTR		12		/* domain name pointer */
155#define T_HINFO		13		/* host information */
156#define T_MINFO		14		/* mailbox information */
157#define T_MX		15		/* mail routing information */
158#define T_TXT		16		/* text strings */
159#define	T_RP		17		/* responsible person */
160#define T_AFSDB		18		/* AFS cell database */
161#define T_X25		19		/* X_25 calling address */
162#define T_ISDN		20		/* ISDN calling address */
163#define T_RT		21		/* router */
164#define T_NSAP		22		/* NSAP address */
165#define T_NSAP_PTR	23		/* reverse NSAP lookup (deprecated) */
166#define	T_SIG		24		/* security signature */
167#define	T_KEY		25		/* security key */
168#define	T_PX		26		/* X.400 mail mapping */
169#define	T_GPOS		27		/* geographical position (withdrawn) */
170#define	T_AAAA		28		/* IP6 Address */
171#define	T_LOC		29		/* Location Information */
172	/* non standard */
173#define T_UINFO		100		/* user (finger) information */
174#define T_UID		101		/* user ID */
175#define T_GID		102		/* group ID */
176#define T_UNSPEC	103		/* Unspecified format (binary data) */
177	/* Query type values which do not appear in resource records */
178#define T_AXFR		252		/* transfer zone of authority */
179#define T_MAILB		253		/* transfer mailbox records */
180#define T_MAILA		254		/* transfer mail agent records */
181#define T_ANY		255		/* wildcard match */
182
183/*
184 * Values for class field
185 */
186
187#define C_IN		1		/* the arpa internet */
188#define C_CHAOS		3		/* for chaos net (MIT) */
189#define C_HS		4		/* for Hesiod name server (MIT) (XXX) */
190	/* Query class values which do not appear in resource records */
191#define C_ANY		255		/* wildcard match */
192
193/*
194 * Status return codes for T_UNSPEC conversion routines
195 */
196#define CONV_SUCCESS	0
197#define CONV_OVERFLOW	(-1)
198#define CONV_BADFMT	(-2)
199#define CONV_BADCKSUM	(-3)
200#define CONV_BADBUFLEN	(-4)
201
202#ifndef BYTE_ORDER
203#if (BSD >= 199103)
204# include <machine/endian.h>
205#else
206#ifdef linux
207# include <endian.h>
208#else
209#define	LITTLE_ENDIAN	1234	/* least-significant byte first (vax, pc) */
210#define	BIG_ENDIAN	4321	/* most-significant byte first (IBM, net) */
211#define	PDP_ENDIAN	3412	/* LSB first in word, MSW first in long (pdp)*/
212
213#if defined(vax) || defined(ns32000) || defined(sun386) || defined(i386) || \
214    defined(MIPSEL) || defined(_MIPSEL) || defined(BIT_ZERO_ON_RIGHT) || \
215    defined(__alpha__) || defined(__alpha)
216#define BYTE_ORDER	LITTLE_ENDIAN
217#endif
218
219#if defined(sel) || defined(pyr) || defined(mc68000) || defined(sparc) || \
220    defined(is68k) || defined(tahoe) || defined(ibm032) || defined(ibm370) || \
221    defined(MIPSEB) || defined(_MIPSEB) || defined(_IBMR2) || defined(DGUX) ||\
222    defined(apollo) || defined(__convex__) || defined(_CRAY) || \
223    defined(__hppa) || defined(__hp9000) || \
224    defined(__hp9000s300) || defined(__hp9000s700) || \
225    defined (BIT_ZERO_ON_LEFT) || defined(m68k)
226#define BYTE_ORDER	BIG_ENDIAN
227#endif
228#endif /* linux */
229#endif /* BSD */
230#endif /* BYTE_ORDER */
231
232#if !defined(BYTE_ORDER) || \
233    (BYTE_ORDER != BIG_ENDIAN && BYTE_ORDER != LITTLE_ENDIAN && \
234    BYTE_ORDER != PDP_ENDIAN)
235	/* you must determine what the correct bit order is for
236	 * your compiler - the next line is an intentional error
237	 * which will force your compiles to bomb until you fix
238	 * the above macros.
239	 */
240  error "Undefined or invalid BYTE_ORDER";
241#endif
242
243/*
244 * Structure for query header.  The order of the fields is machine- and
245 * compiler-dependent, depending on the byte/bit order and the layout
246 * of bit fields.  We use bit fields only in int variables, as this
247 * is all ANSI requires.  This requires a somewhat confusing rearrangement.
248 */
249
250typedef struct {
251	unsigned	id :16;		/* query identification number */
252#if BYTE_ORDER == BIG_ENDIAN
253			/* fields in third byte */
254	unsigned	qr: 1;		/* response flag */
255	unsigned	opcode: 4;	/* purpose of message */
256	unsigned	aa: 1;		/* authoritive answer */
257	unsigned	tc: 1;		/* truncated message */
258	unsigned	rd: 1;		/* recursion desired */
259			/* fields in fourth byte */
260	unsigned	ra: 1;		/* recursion available */
261	unsigned	pr:1;		/* primary server required (non standard) */
262	unsigned	unused :2;	/* unused bits (MBZ as of 4.9.3a3) */
263	unsigned	rcode :4;	/* response code */
264#endif
265#if BYTE_ORDER == LITTLE_ENDIAN || BYTE_ORDER == PDP_ENDIAN
266			/* fields in third byte */
267	unsigned	rd :1;		/* recursion desired */
268	unsigned	tc :1;		/* truncated message */
269	unsigned	aa :1;		/* authoritive answer */
270	unsigned	opcode :4;	/* purpose of message */
271	unsigned	qr :1;		/* response flag */
272			/* fields in fourth byte */
273	unsigned	rcode :4;	/* response code */
274	unsigned	unused :2;	/* unused bits (MBZ as of 4.9.3a3) */
275	unsigned	pr:1;		/* primary server required (non standard) */
276	unsigned	ra :1;		/* recursion available */
277#endif
278			/* remaining bytes */
279	unsigned	qdcount :16;	/* number of question entries */
280	unsigned	ancount :16;	/* number of answer entries */
281	unsigned	nscount :16;	/* number of authority entries */
282	unsigned	arcount :16;	/* number of resource entries */
283} HEADER;
284
285/*
286 * Defines for handling compressed domain names
287 */
288#define INDIR_MASK	0xc0
289
290/*
291 * Structure for passing resource records around.
292 */
293struct rrec {
294	int16_t		r_zone;			/* zone number */
295	int16_t		r_class;		/* class number */
296	int16_t		r_type;			/* type number */
297	u_int32_t	r_ttl;			/* time to live */
298	int		r_size;			/* size of data area */
299	char		*r_data;		/* pointer to data */
300};
301
302extern	u_int16_t	_getshort __P((const u_char *));
303extern	u_int32_t	_getlong __P((const u_char *));
304
305/*
306 * Inline versions of get/put short/long.  Pointer is advanced.
307 *
308 * These macros demonstrate the property of C whereby it can be
309 * portable or it can be elegant but rarely both.
310 */
311#define GETSHORT(s, cp) { \
312	register u_char *t_cp = (u_char *)(cp); \
313	(s) = ((u_int16_t)t_cp[0] << 8) \
314	    | ((u_int16_t)t_cp[1]) \
315	    ; \
316	(cp) += INT16SZ; \
317}
318
319#define GETLONG(l, cp) { \
320	register u_char *t_cp = (u_char *)(cp); \
321	(l) = ((u_int32_t)t_cp[0] << 24) \
322	    | ((u_int32_t)t_cp[1] << 16) \
323	    | ((u_int32_t)t_cp[2] << 8) \
324	    | ((u_int32_t)t_cp[3]) \
325	    ; \
326	(cp) += INT32SZ; \
327}
328
329#define PUTSHORT(s, cp) { \
330	register u_int16_t t_s = (u_int16_t)(s); \
331	register u_char *t_cp = (u_char *)(cp); \
332	*t_cp++ = t_s >> 8; \
333	*t_cp   = t_s; \
334	(cp) += INT16SZ; \
335}
336
337#define PUTLONG(l, cp) { \
338	register u_int32_t t_l = (u_int32_t)(l); \
339	register u_char *t_cp = (u_char *)(cp); \
340	*t_cp++ = t_l >> 24; \
341	*t_cp++ = t_l >> 16; \
342	*t_cp++ = t_l >> 8; \
343	*t_cp   = t_l; \
344	(cp) += INT32SZ; \
345}
346
347#endif /* !_NAMESER_H_ */
348