xref: /netbsd-src/include/arpa/nameser.h (revision 3fe138c1461e710931a50b66f08982c5f52c371f)
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  * Portions Copyright (c) 1995 by International Business Machines, Inc.
54  *
55  * International Business Machines, Inc. (hereinafter called IBM) grants
56  * permission under its copyrights to use, copy, modify, and distribute this
57  * Software with or without fee, provided that the above copyright notice and
58  * all paragraphs of this notice appear in all copies, and that the name of IBM
59  * not be used in connection with the marketing of any product incorporating
60  * the Software or modifications thereof, without specific, written prior
61  * permission.
62  *
63  * To the extent it has a right to do so, IBM grants an immunity from suit
64  * under its patents, if any, for the use, sale or manufacture of products to
65  * the extent that such products are used for performing Domain Name System
66  * dynamic updates in TCP/IP networks by means of the Software.  No immunity is
67  * granted for any product per se or for any other function of any product.
68  *
69  * THE SOFTWARE IS PROVIDED "AS IS", AND IBM DISCLAIMS ALL WARRANTIES,
70  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
71  * PARTICULAR PURPOSE.  IN NO EVENT SHALL IBM BE LIABLE FOR ANY SPECIAL,
72  * DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER ARISING
73  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE, EVEN
74  * IF IBM IS APPRISED OF THE POSSIBILITY OF SUCH DAMAGES.
75  * --Copyright--
76  */
77 
78 /*
79  *      @(#)nameser.h	8.1 (Berkeley) 6/2/93
80  *	$NetBSD: nameser.h,v 1.10 1997/10/13 09:26:09 lukem Exp $
81  */
82 
83 #ifndef _NAMESER_H_
84 #define _NAMESER_H_
85 
86 #include <sys/param.h>
87 #if (!defined(BSD)) || (BSD < 199306)
88 # include <sys/bitypes.h>
89 #else
90 # include <sys/types.h>
91 #endif
92 #include <sys/cdefs.h>
93 
94 #ifdef _AUX_SOURCE
95 # include <sys/types.h>
96 #endif
97 
98 /*
99  * revision information.  this is the release date in YYYYMMDD format.
100  * it can change every day so the right thing to do with it is use it
101  * in preprocessor commands such as "#if (__BIND > 19931104)".  do not
102  * compare for equality; rather, use it to determine whether your resolver
103  * is new enough to contain a certain feature.
104  */
105 
106 #define __BIND		19960801	/* interface version stamp */
107 
108 /*
109  * Define constants based on rfc883
110  */
111 #define PACKETSZ	512		/* maximum packet size */
112 #define MAXDNAME	1025		/* maximum presentation domain name */
113 #define MAXCDNAME	255		/* maximum compressed domain name */
114 #define MAXLABEL	63		/* maximum length of domain label */
115 #define HFIXEDSZ	12		/* #/bytes of fixed data in header */
116 #define QFIXEDSZ	4		/* #/bytes of fixed data in query */
117 #define RRFIXEDSZ	10		/* #/bytes of fixed data in r record */
118 #define INT32SZ		4		/* for systems without 32-bit ints */
119 #define INT16SZ		2		/* for systems without 16-bit ints */
120 #define INADDRSZ	4		/* IPv4 T_A */
121 #define IN6ADDRSZ	16		/* IPv6 T_AAAA */
122 
123 /*
124  * Internet nameserver port number
125  */
126 #define NAMESERVER_PORT	53
127 
128 /*
129  * Currently defined opcodes
130  */
131 #define QUERY		0x0		/* standard query */
132 #define IQUERY		0x1		/* inverse query */
133 #define STATUS		0x2		/* nameserver status query */
134 /*#define xxx		0x3*/		/* 0x3 reserved */
135 #define NS_NOTIFY_OP	0x4		/* notify secondary of SOA change */
136 /*
137  * Currently defined response codes
138  */
139 #define NOERROR		0		/* no error */
140 #define FORMERR		1		/* format error */
141 #define SERVFAIL	2		/* server failure */
142 #define NXDOMAIN	3		/* non existent domain */
143 #define NOTIMP		4		/* not implemented */
144 #define REFUSED		5		/* query refused */
145 
146 /*
147  * Type values for resources and queries
148  */
149 #define T_A		1		/* host address */
150 #define T_NS		2		/* authoritative server */
151 #define T_MD		3		/* mail destination */
152 #define T_MF		4		/* mail forwarder */
153 #define T_CNAME		5		/* canonical name */
154 #define T_SOA		6		/* start of authority zone */
155 #define T_MB		7		/* mailbox domain name */
156 #define T_MG		8		/* mail group member */
157 #define T_MR		9		/* mail rename name */
158 #define T_NULL		10		/* null resource record */
159 #define T_WKS		11		/* well known service */
160 #define T_PTR		12		/* domain name pointer */
161 #define T_HINFO		13		/* host information */
162 #define T_MINFO		14		/* mailbox information */
163 #define T_MX		15		/* mail routing information */
164 #define T_TXT		16		/* text strings */
165 #define T_RP		17		/* responsible person */
166 #define T_AFSDB		18		/* AFS cell database */
167 #define T_X25		19		/* X_25 calling address */
168 #define T_ISDN		20		/* ISDN calling address */
169 #define T_RT		21		/* router */
170 #define T_NSAP		22		/* NSAP address */
171 #define T_NSAP_PTR	23		/* reverse NSAP lookup (deprecated) */
172 #define T_SIG		24		/* security signature */
173 #define T_KEY		25		/* security key */
174 #define T_PX		26		/* X.400 mail mapping */
175 #define T_GPOS		27		/* geographical position (withdrawn) */
176 #define T_AAAA		28		/* IP6 Address */
177 #define T_LOC		29		/* Location Information */
178 #define T_NXT		30		/* Next Valid Name in Zone */
179 #define T_EID		31		/* Endpoint identifier */
180 #define T_NIMLOC	32		/* Nimrod locator */
181 #define T_SRV		33		/* Server selection */
182 #define T_ATMA		34		/* ATM Address */
183 #define T_NAPTR		35		/* Naming Authority PoinTeR */
184 	/* non standard */
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 	/* Query type values which do not appear in resource records */
190 #define	T_IXFR		251		/* incremental zone transfer */
191 #define T_AXFR		252		/* transfer zone of authority */
192 #define T_MAILB		253		/* transfer mailbox records */
193 #define T_MAILA		254		/* transfer mail agent records */
194 #define T_ANY		255		/* wildcard match */
195 
196 /*
197  * Values for class field
198  */
199 
200 #define C_IN		1		/* the arpa internet */
201 #define C_CHAOS		3		/* for chaos net (MIT) */
202 #define C_HS		4		/* for Hesiod name server (MIT) (XXX) */
203 	/* Query class values which do not appear in resource records */
204 #define C_ANY		255		/* wildcard match */
205 
206 /*
207  * Flags field of the KEY RR rdata
208  */
209 #define	KEYFLAG_TYPEMASK	0xC000	/* Mask for "type" bits */
210 #define	KEYFLAG_TYPE_AUTH_CONF	0x0000	/* Key usable for both */
211 #define	KEYFLAG_TYPE_CONF_ONLY	0x8000	/* Key usable for confidentiality */
212 #define	KEYFLAG_TYPE_AUTH_ONLY	0x4000	/* Key usable for authentication */
213 #define	KEYFLAG_TYPE_NO_KEY	0xC000	/* No key usable for either; no key */
214 /* The type bits can also be interpreted independently, as single bits: */
215 #define	KEYFLAG_NO_AUTH		0x8000	/* Key not usable for authentication */
216 #define	KEYFLAG_NO_CONF		0x4000	/* Key not usable for confidentiality */
217 
218 #define	KEYFLAG_EXPERIMENTAL	0x2000	/* Security is *mandatory* if bit=0 */
219 #define	KEYFLAG_RESERVED3	0x1000  /* reserved - must be zero */
220 #define	KEYFLAG_RESERVED4	0x0800  /* reserved - must be zero */
221 #define	KEYFLAG_USERACCOUNT	0x0400	/* key is assoc. with a user acct */
222 #define	KEYFLAG_ENTITY		0x0200	/* key is assoc. with entity eg host */
223 #define	KEYFLAG_ZONEKEY		0x0100	/* key is zone key for the zone named */
224 #define	KEYFLAG_IPSEC		0x0080  /* key is for IPSEC use (host or user)*/
225 #define	KEYFLAG_EMAIL		0x0040  /* key is for email (MIME security) */
226 #define	KEYFLAG_RESERVED10	0x0020  /* reserved - must be zero */
227 #define	KEYFLAG_RESERVED11	0x0010  /* reserved - must be zero */
228 #define	KEYFLAG_SIGNATORYMASK	0x000F	/* key can sign DNS RR's of same name */
229 
230 #define  KEYFLAG_RESERVED_BITMASK ( KEYFLAG_RESERVED3 | \
231 				    KEYFLAG_RESERVED4 | \
232 				    KEYFLAG_RESERVED10| KEYFLAG_RESERVED11)
233 
234 /* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */
235 #define	ALGORITHM_MD5RSA	1	/* MD5 with RSA */
236 #define	ALGORITHM_EXPIRE_ONLY	253	/* No alg, no security */
237 #define	ALGORITHM_PRIVATE_OID	254	/* Key begins with OID indicating alg */
238 
239 /* Signatures */
240 					/* Size of a mod or exp in bits */
241 #define	MIN_MD5RSA_KEY_PART_BITS	 512
242 #define	MAX_MD5RSA_KEY_PART_BITS	2552
243 					/* Total of binary mod and exp, bytes */
244 #define	MAX_MD5RSA_KEY_BYTES		((MAX_MD5RSA_KEY_PART_BITS+7/8)*2+3)
245 					/* Max length of text sig block */
246 #define	MAX_KEY_BASE64			(((MAX_MD5RSA_KEY_BYTES+2)/3)*4)
247 
248 /*
249  * Status return codes for T_UNSPEC conversion routines
250  */
251 #define CONV_SUCCESS	0
252 #define CONV_OVERFLOW	(-1)
253 #define CONV_BADFMT	(-2)
254 #define CONV_BADCKSUM	(-3)
255 #define CONV_BADBUFLEN	(-4)
256 
257 #ifndef BYTE_ORDER
258 #if (BSD >= 199103)
259 # include <machine/endian.h>
260 #else
261 #ifdef linux
262 # include <endian.h>
263 #else
264 #define LITTLE_ENDIAN	1234	/* least-significant byte first (vax, pc) */
265 #define BIG_ENDIAN	4321	/* most-significant byte first (IBM, net) */
266 #define PDP_ENDIAN	3412	/* LSB first in word, MSW first in long (pdp)*/
267 
268 #if defined(vax) || defined(ns32000) || defined(sun386) || defined(i386) || \
269     defined(MIPSEL) || defined(_MIPSEL) || defined(BIT_ZERO_ON_RIGHT) || \
270     defined(__alpha__) || defined(__alpha)
271 #define BYTE_ORDER	LITTLE_ENDIAN
272 #endif
273 
274 #if defined(sel) || defined(pyr) || defined(mc68000) || defined(sparc) || \
275     defined(is68k) || defined(tahoe) || defined(ibm032) || defined(ibm370) || \
276     defined(MIPSEB) || defined(_MIPSEB) || defined(_IBMR2) || defined(DGUX) ||\
277     defined(apollo) || defined(__convex__) || defined(_CRAY) || \
278     defined(__hppa) || defined(__hp9000) || \
279     defined(__hp9000s300) || defined(__hp9000s700) || \
280     defined (BIT_ZERO_ON_LEFT) || defined(m68k)
281 #define BYTE_ORDER	BIG_ENDIAN
282 #endif
283 #endif /* linux */
284 #endif /* BSD */
285 #endif /* BYTE_ORDER */
286 
287 #if !defined(BYTE_ORDER) || \
288     (BYTE_ORDER != BIG_ENDIAN && BYTE_ORDER != LITTLE_ENDIAN && \
289     BYTE_ORDER != PDP_ENDIAN)
290 	/* you must determine what the correct bit order is for
291 	 * your compiler - the next line is an intentional error
292 	 * which will force your compiles to bomb until you fix
293 	 * the above macros.
294 	 */
295   error "Undefined or invalid BYTE_ORDER";
296 #endif
297 
298 /*
299  * Structure for query header.  The order of the fields is machine- and
300  * compiler-dependent, depending on the byte/bit order and the layout
301  * of bit fields.  We use bit fields only in int variables, as this
302  * is all ANSI requires.  This requires a somewhat confusing rearrangement.
303  */
304 
305 typedef struct {
306 	unsigned	id :16;		/* query identification number */
307 #if BYTE_ORDER == BIG_ENDIAN
308 			/* fields in third byte */
309 	unsigned	qr: 1;		/* response flag */
310 	unsigned	opcode: 4;	/* purpose of message */
311 	unsigned	aa: 1;		/* authoritive answer */
312 	unsigned	tc: 1;		/* truncated message */
313 	unsigned	rd: 1;		/* recursion desired */
314 			/* fields in fourth byte */
315 	unsigned	ra: 1;		/* recursion available */
316 	unsigned	unused :1;	/* unused bits (MBZ as of 4.9.3a3) */
317 	unsigned	ad: 1;		/* authentic data from named */
318 	unsigned	cd: 1;		/* checking disabled by resolver */
319 	unsigned	rcode :4;	/* response code */
320 #endif
321 #if BYTE_ORDER == LITTLE_ENDIAN || BYTE_ORDER == PDP_ENDIAN
322 			/* fields in third byte */
323 	unsigned	rd :1;		/* recursion desired */
324 	unsigned	tc :1;		/* truncated message */
325 	unsigned	aa :1;		/* authoritive answer */
326 	unsigned	opcode :4;	/* purpose of message */
327 	unsigned	qr :1;		/* response flag */
328 			/* fields in fourth byte */
329 	unsigned	rcode :4;	/* response code */
330 	unsigned	cd: 1;		/* checking disabled by resolver */
331 	unsigned	ad: 1;		/* authentic data from named */
332 	unsigned	unused :1;	/* unused bits (MBZ as of 4.9.3a3) */
333 	unsigned	ra :1;		/* recursion available */
334 #endif
335 			/* remaining bytes */
336 	unsigned	qdcount :16;	/* number of question entries */
337 	unsigned	ancount :16;	/* number of answer entries */
338 	unsigned	nscount :16;	/* number of authority entries */
339 	unsigned	arcount :16;	/* number of resource entries */
340 } HEADER;
341 
342 /*
343  * Defines for handling compressed domain names
344  */
345 #define INDIR_MASK	0xc0
346 
347 extern	u_int16_t	_getshort __P((const u_char *));
348 extern	u_int32_t	_getlong __P((const u_char *));
349 
350 /*
351  * Inline versions of get/put short/long.  Pointer is advanced.
352  *
353  * These macros demonstrate the property of C whereby it can be
354  * portable or it can be elegant but rarely both.
355  */
356 #define GETSHORT(s, cp) { \
357 	register u_char *t_cp = (u_char *)(cp); \
358 	(s) = ((u_int16_t)t_cp[0] << 8) \
359 	    | ((u_int16_t)t_cp[1]) \
360 	    ; \
361 	(cp) += INT16SZ; \
362 }
363 
364 #define GETLONG(l, cp) { \
365 	register u_char *t_cp = (u_char *)(cp); \
366 	(l) = ((u_int32_t)t_cp[0] << 24) \
367 	    | ((u_int32_t)t_cp[1] << 16) \
368 	    | ((u_int32_t)t_cp[2] << 8) \
369 	    | ((u_int32_t)t_cp[3]) \
370 	    ; \
371 	(cp) += INT32SZ; \
372 }
373 
374 #define PUTSHORT(s, cp) { \
375 	register u_int16_t t_s = (u_int16_t)(s); \
376 	register u_char *t_cp = (u_char *)(cp); \
377 	*t_cp++ = t_s >> 8; \
378 	*t_cp   = t_s; \
379 	(cp) += INT16SZ; \
380 }
381 
382 #define PUTLONG(l, cp) { \
383 	register u_int32_t t_l = (u_int32_t)(l); \
384 	register u_char *t_cp = (u_char *)(cp); \
385 	*t_cp++ = t_l >> 24; \
386 	*t_cp++ = t_l >> 16; \
387 	*t_cp++ = t_l >> 8; \
388 	*t_cp   = t_l; \
389 	(cp) += INT32SZ; \
390 }
391 
392 #endif /* !_NAMESER_H_ */
393