xref: /freebsd/include/arpa/nameser.h (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
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  */
57 
58 #ifndef _NAMESER_H_
59 #define	_NAMESER_H_
60 
61 #include <sys/param.h>
62 #include <sys/types.h>
63 #include <sys/cdefs.h>
64 #include <machine/endian.h>
65 
66 
67 /*
68  * revision information.  this is the release date in YYYYMMDD format.
69  * it can change every day so the right thing to do with it is use it
70  * in preprocessor commands such as "#if (__BIND > 19931104)".  do not
71  * compare for equality; rather, use it to determine whether your resolver
72  * is new enough to contain a certain feature.
73  */
74 
75 #define	__BIND		19940417	/* interface version stamp */
76 
77 /*
78  * Define constants based on rfc883
79  */
80 #define	PACKETSZ	512		/* maximum packet size */
81 #define	MAXDNAME	256		/* maximum domain name */
82 #define	MAXCDNAME	255		/* maximum compressed domain name */
83 #define	MAXLABEL	63		/* maximum length of domain label */
84 #define	HFIXEDSZ	12		/* #/bytes of fixed data in header */
85 #define	QFIXEDSZ	4		/* #/bytes of fixed data in query */
86 #define	RRFIXEDSZ	10		/* #/bytes of fixed data in r record */
87 #define	INT32SZ		4		/* for systems without 32-bit ints */
88 #define	INT16SZ		2		/* for systems without 16-bit ints */
89 #define	INADDRSZ	4		/* for sizeof(struct inaddr) != 4 */
90 
91 /*
92  * Internet nameserver port number
93  */
94 #define	NAMESERVER_PORT	53
95 
96 /*
97  * Currently define	d opcodes
98  */
99 #define	QUERY		0x0		/* standard query */
100 #define	IQUERY		0x1		/* inverse query */
101 #define	STATUS		0x2		/* nameserver status query */
102 			/* 0x3		   reserved */
103 	/* non standard - supports ALLOW_UPDATES stuff from Mike Schwartz */
104 #define	UPDATEA		0x9		/* add resource record */
105 #define	UPDATED		0xa		/* delete a specific resource record */
106 #define	UPDATEDA	0xb		/* delete all named resource record */
107 #define	UPDATEM		0xc		/* modify a specific resource record */
108 #define	UPDATEMA	0xd		/* modify all named resource record */
109 
110 #define	ZONEINIT	0xe		/* initial zone transfer */
111 #define	ZONEREF		0xf		/* incremental zone referesh */
112 
113 /*
114  * Currently define	d response codes
115  */
116 #define	NOERROR		0		/* no error */
117 #define	FORMERR		1		/* format error */
118 #define	SERVFAIL	2		/* server failure */
119 #define	NXDOMAIN	3		/* non existent domain */
120 #define	NOTIMP		4		/* not implemented */
121 #define	REFUSED		5		/* query refused */
122 	/* non standard */
123 #define	NOCHANGE	0xf		/* update failed to change db */
124 
125 /*
126  * Type values for resources and queries
127  */
128 #define	T_A		1		/* host address */
129 #define	T_NS		2		/* authoritative server */
130 #define	T_MD		3		/* mail destination */
131 #define	T_MF		4		/* mail forwarder */
132 #define	T_CNAME		5		/* connonical name */
133 #define	T_SOA		6		/* start of authority zone */
134 #define	T_MB		7		/* mailbox domain name */
135 #define	T_MG		8		/* mail group member */
136 #define	T_MR		9		/* mail rename name */
137 #define	T_NULL		10		/* null resource record */
138 #define	T_WKS		11		/* well known service */
139 #define	T_PTR		12		/* domain name pointer */
140 #define	T_HINFO		13		/* host information */
141 #define	T_MINFO		14		/* mailbox information */
142 #define	T_MX		15		/* mail routing information */
143 #define	T_TXT		16		/* text strings */
144 #define	T_RP		17		/* responsible person */
145 #define	T_AFSDB		18		/* AFS cell database */
146 #define	T_X25		19		/* X_25 calling address */
147 #define	T_ISDN		20		/* ISDN calling address */
148 #define	T_RT		21		/* router */
149 #define	T_NSAP		22		/* NSAP address */
150 #define	T_NSAP_PTR	23		/* reverse NSAP lookup (deprecated) */
151 	/* non standard */
152 #define	T_UINFO		100		/* user (finger) information */
153 #define	T_UID		101		/* user ID */
154 #define	T_GID		102		/* group ID */
155 #define	T_UNSPEC	103		/* Unspecified format (binary data) */
156 #define	T_SA		200		/* shuffle address */
157 	/* Query type values which do not appear in resource records */
158 #define	T_AXFR		252		/* transfer zone of authority */
159 #define	T_MAILB		253		/* transfer mailbox records */
160 #define	T_MAILA		254		/* transfer mail agent records */
161 #define	T_ANY		255		/* wildcard match */
162 
163 /*
164  * Values for class field
165  */
166 
167 #define	C_IN		1		/* the arpa internet */
168 #define	C_CHAOS		3		/* for chaos net (MIT) */
169 #define	C_HS		4		/* for Hesiod name server (MIT) (XXX) */
170 	/* Query class values which do not appear in resource records */
171 #define	C_ANY		255		/* wildcard match */
172 
173 /*
174  * Status return codes for T_UNSPEC conversion routines
175  */
176 #define	CONV_SUCCESS	0
177 #define	CONV_OVERFLOW	(-1)
178 #define	CONV_BADFMT	(-2)
179 #define	CONV_BADCKSUM	(-3)
180 #define	CONV_BADBUFLEN	(-4)
181 
182 /*
183  * Structure for query header.  The order of the fields is machine- and
184  * compiler-dependent, depending on the byte/bit order and the layout
185  * of bit fields.  We use bit fields only in int variables, as this
186  * is all ANSI requires.  This requires a somewhat confusing rearrangement.
187  */
188 
189 typedef struct {
190 	unsigned	id :16;		/* query identification number */
191 #if BYTE_ORDER == BIG_ENDIAN
192 			/* fields in third byte */
193 	unsigned	qr: 1;		/* response flag */
194 	unsigned	opcode: 4;	/* purpose of message */
195 	unsigned	aa: 1;		/* authoritive answer */
196 	unsigned	tc: 1;		/* truncated message */
197 	unsigned	rd: 1;		/* recursion desired */
198 			/* fields in fourth byte */
199 	unsigned	ra: 1;		/* recursion available */
200 	unsigned	pr: 1;		/* primary server req'd (!standard) */
201 	unsigned	unused :2;	/* unused bits (MBZ as of 4.9.3a3) */
202 	unsigned	rcode :4;	/* response code */
203 #endif
204 #if BYTE_ORDER == LITTLE_ENDIAN || BYTE_ORDER == PDP_ENDIAN
205 			/* fields in third byte */
206 	unsigned	rd :1;		/* recursion desired */
207 	unsigned	tc :1;		/* truncated message */
208 	unsigned	aa :1;		/* authoritive answer */
209 	unsigned	opcode :4;	/* purpose of message */
210 	unsigned	qr :1;		/* response flag */
211 			/* fields in fourth byte */
212 	unsigned	rcode :4;	/* response code */
213 	unsigned	unused :2;	/* unused bits (MBZ as of 4.9.3a3) */
214 	unsigned	pr :1;		/* primary server req'd (!standard) */
215 	unsigned	ra :1;		/* recursion available */
216 #endif
217 			/* remaining bytes */
218 	unsigned	qdcount :16;	/* number of question entries */
219 	unsigned	ancount :16;	/* number of answer entries */
220 	unsigned	nscount :16;	/* number of authority entries */
221 	unsigned	arcount :16;	/* number of resource entries */
222 } HEADER;
223 
224 /*
225  * Defines for handling compressed domain names
226  */
227 #define	INDIR_MASK	0xc0
228 
229 /*
230  * Structure for passing resource records around.
231  */
232 struct rrec {
233 	int16_t		r_zone;			/* zone number */
234 	int16_t		r_class;		/* class number */
235 	int16_t		r_type;			/* type number */
236 	u_int32_t	r_ttl;			/* time to live */
237 	int		r_size;			/* size of data area */
238 	char		*r_data;		/* pointer to data */
239 };
240 
241 extern	u_int16_t	_getshort __P((const u_char *));
242 extern	u_int32_t	_getlong __P((const u_char *));
243 
244 /*
245  * Inline versions of get/put short/long.  Pointer is advanced.
246  *
247  * These macros demonstrate the property of C whereby it can be
248  * portable or it can be elegant but rarely both.
249  */
250 #define	GETSHORT(s, cp) { \
251 	register u_char *t_cp = (u_char *)(cp); \
252 	(s) = ((u_int16_t)t_cp[0] << 8) \
253 	    | ((u_int16_t)t_cp[1]) \
254 	    ; \
255 	(cp) += INT16SZ; \
256 }
257 
258 #define	GETLONG(l, cp) { \
259 	register u_char *t_cp = (u_char *)(cp); \
260 	(l) = ((u_int32_t)t_cp[0] << 24) \
261 	    | ((u_int32_t)t_cp[1] << 16) \
262 	    | ((u_int32_t)t_cp[2] << 8) \
263 	    | ((u_int32_t)t_cp[3]) \
264 	    ; \
265 	(cp) += INT32SZ; \
266 }
267 
268 #define	PUTSHORT(s, cp) { \
269 	register u_int16_t t_s = (u_int16_t)(s); \
270 	register u_char *t_cp = (u_char *)(cp); \
271 	*t_cp++ = t_s >> 8; \
272 	*t_cp   = t_s; \
273 	(cp) += INT16SZ; \
274 }
275 
276 #define	PUTLONG(l, cp) { \
277 	register u_int32_t t_l = (u_int32_t)(l); \
278 	register u_char *t_cp = (u_char *)(cp); \
279 	*t_cp++ = t_l >> 24; \
280 	*t_cp++ = t_l >> 16; \
281 	*t_cp++ = t_l >> 8; \
282 	*t_cp   = t_l; \
283 	(cp) += INT32SZ; \
284 }
285 
286 #endif /* !_NAMESER_H_ */
287