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 *      @(#)nameser.h	8.2 (Berkeley) 2/16/94
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#ifndef _NAMESER_H_
57#define	_NAMESER_H_
58
59#include <sys/types.h>
60
61/*
62 * Define constants based on rfc883
63 */
64#define PACKETSZ	512		/* maximum packet size */
65#define MAXDNAME	256		/* maximum domain name */
66#define MAXCDNAME	255		/* maximum compressed domain name */
67#define MAXLABEL	63		/* maximum length of domain label */
68	/* Number of bytes of fixed size data in query structure */
69#define QFIXEDSZ	4
70	/* number of bytes of fixed size data in resource record */
71#define RRFIXEDSZ	10
72
73/*
74 * Currently defined opcodes
75 */
76#define QUERY		0x0		/* standard query */
77#define IQUERY		0x1		/* inverse query */
78#define STATUS		0x2		/* nameserver status query */
79#if 0
80#define xxx		0x3		/* 0x3 reserved */
81#endif
82	/* non standard - supports ALLOW_UPDATES stuff from Mike Schwartz */
83#define UPDATEA		0x9		/* add resource record */
84#define UPDATED		0xa		/* delete a specific resource record */
85#define UPDATEDA	0xb		/* delete all named resource record */
86#define UPDATEM		0xc		/* modify a specific resource record */
87#define UPDATEMA	0xd		/* modify all named resource record */
88
89#define ZONEINIT	0xe		/* initial zone transfer */
90#define ZONEREF		0xf		/* incremental zone referesh */
91
92/*
93 * Undefine various #defines from various System V-flavored OSes (Solaris,
94 * SINIX, HP-UX) so the compiler doesn't whine that we redefine them.
95 */
96#ifdef T_NULL
97#undef T_NULL
98#endif
99#ifdef T_OPT
100#undef T_OPT
101#endif
102#ifdef T_UNSPEC
103#undef T_UNSPEC
104#endif
105#ifdef NOERROR
106#undef NOERROR
107#endif
108
109/*
110 * Currently defined response codes
111 */
112#define NOERROR		0		/* no error */
113#define FORMERR		1		/* format error */
114#define SERVFAIL	2		/* server failure */
115#define NXDOMAIN	3		/* non existent domain */
116#define NOTIMP		4		/* not implemented */
117#define REFUSED		5		/* query refused */
118	/* non standard */
119#define NOCHANGE	0xf		/* update failed to change db */
120
121/*
122 * Type values for resources and queries
123 */
124#define T_A		1		/* host address */
125#define T_NS		2		/* authoritative server */
126#define T_MD		3		/* mail destination */
127#define T_MF		4		/* mail forwarder */
128#define T_CNAME		5		/* connonical name */
129#define T_SOA		6		/* start of authority zone */
130#define T_MB		7		/* mailbox domain name */
131#define T_MG		8		/* mail group member */
132#define T_MR		9		/* mail rename name */
133#define T_NULL		10		/* null resource record */
134#define T_WKS		11		/* well known service */
135#define T_PTR		12		/* domain name pointer */
136#define T_HINFO		13		/* host information */
137#define T_MINFO		14		/* mailbox information */
138#define T_MX		15		/* mail routing information */
139#define T_TXT		16		/* text strings */
140#define	T_RP		17		/* responsible person */
141#define	T_AFSDB		18		/* AFS cell database */
142#define T_X25		19		/* X_25 calling address */
143#define T_ISDN		20		/* ISDN calling address */
144#define T_RT		21		/* router */
145#define	T_NSAP		22		/* NSAP address */
146#define	T_NSAP_PTR	23		/* reverse lookup for NSAP */
147#define T_SIG		24		/* security signature */
148#define T_KEY		25		/* security key */
149#define T_PX		26		/* X.400 mail mapping */
150#define T_GPOS		27		/* geographical position (withdrawn) */
151#define T_AAAA		28		/* IP6 Address */
152#define T_LOC		29		/* Location Information */
153#define T_NXT		30		/* Next Valid Name in Zone */
154#define T_EID		31		/* Endpoint identifier */
155#define T_NIMLOC	32		/* Nimrod locator */
156#define T_SRV		33		/* Server selection */
157#define T_ATMA		34		/* ATM Address */
158#define T_NAPTR		35		/* Naming Authority PoinTeR */
159#define T_KX		36		/* Key Exchanger */
160#define T_CERT		37		/* Certificates in the DNS */
161#define T_A6		38		/* IP6 address */
162#define T_DNAME		39		/* non-terminal redirection */
163#define T_SINK		40		/* unknown */
164#define T_OPT		41		/* EDNS0 option (meta-RR) */
165#define T_APL		42		/* lists of address prefixes */
166#define T_DS		43		/* Delegation Signer */
167#define T_SSHFP		44		/* SSH Fingerprint */
168#define T_IPSECKEY	45		/* IPsec keying material */
169#define T_RRSIG		46		/* new security signature */
170#define T_NSEC		47		/* provable insecure information */
171#define T_DNSKEY	48		/* new security key */
172	/* non standard */
173#define T_SPF		99		/* sender policy framework */
174#define T_UINFO		100		/* user (finger) information */
175#define T_UID		101		/* user ID */
176#define T_GID		102		/* group ID */
177#define T_UNSPEC	103		/* Unspecified format (binary data) */
178#define T_UNSPECA	104		/* "unspecified ascii". Ugly MIT hack */
179	/* Query type values which do not appear in resource records */
180#define T_TKEY		249		/* Transaction Key [RFC2930] */
181#define T_TSIG		250		/* Transaction Signature [RFC2845] */
182#define T_IXFR		251		/* incremental transfer [RFC1995] */
183#define T_AXFR		252		/* transfer zone of authority */
184#define T_MAILB		253		/* transfer mailbox records */
185#define T_MAILA		254		/* transfer mail agent records */
186#define T_ANY		255		/* wildcard match */
187
188/*
189 * Values for class field
190 */
191
192#define C_IN		1		/* the arpa internet */
193#define C_CHAOS		3		/* for chaos net (MIT) */
194#define C_HS		4		/* for Hesiod name server (MIT) (XXX) */
195	/* Query class values which do not appear in resource records */
196#define C_ANY		255		/* wildcard match */
197#define C_QU		0x8000		/* mDNS QU flag in queries */
198#define C_CACHE_FLUSH	0x8000		/* mDNS cache flush flag in replies */
199
200/*
201 * Status return codes for T_UNSPEC conversion routines
202 */
203#define CONV_SUCCESS 0
204#define CONV_OVERFLOW -1
205#define CONV_BADFMT -2
206#define CONV_BADCKSUM -3
207#define CONV_BADBUFLEN -4
208
209/*
210 * Structure for query header.
211 */
212typedef struct {
213	uint16_t id;		/* query identification number */
214	uint8_t  flags1;	/* first byte of flags */
215	uint8_t  flags2;	/* second byte of flags */
216	uint16_t qdcount;	/* number of question entries */
217	uint16_t ancount;	/* number of answer entries */
218	uint16_t nscount;	/* number of authority entries */
219	uint16_t arcount;	/* number of resource entries */
220} HEADER;
221
222/*
223 * Macros for subfields of flag fields.
224 */
225#define DNS_QR(np)	((np)->flags1 & 0x80)		/* response flag */
226#define DNS_OPCODE(np)	((((np)->flags1) >> 3) & 0xF)	/* purpose of message */
227#define DNS_AA(np)	((np)->flags1 & 0x04)		/* authoritative answer */
228#define DNS_TC(np)	((np)->flags1 & 0x02)		/* truncated message */
229#define DNS_RD(np)	((np)->flags1 & 0x01)		/* recursion desired */
230
231#define DNS_RA(np)	((np)->flags2 & 0x80)	/* recursion available */
232#define DNS_AD(np)	((np)->flags2 & 0x20)	/* authentic data from named */
233#define DNS_CD(np)	((np)->flags2 & 0x10)	/* checking disabled by resolver */
234#define DNS_RCODE(np)	((np)->flags2 & 0xF)	/* response code */
235
236/*
237 * Defines for handling compressed domain names, EDNS0 labels, etc.
238 */
239#define INDIR_MASK	0xc0	/* 11.... */
240#define EDNS0_MASK	0x40	/* 01.... */
241#  define EDNS0_ELT_BITLABEL 0x01
242
243/*
244 * Structure for passing resource records around.
245 */
246struct rrec {
247	int16_t	r_zone;			/* zone number */
248	int16_t	r_class;		/* class number */
249	int16_t	r_type;			/* type number */
250	uint32_t	r_ttl;			/* time to live */
251	int	r_size;			/* size of data area */
252	char	*r_data;		/* pointer to data */
253};
254
255/*
256 * Inline versions of get/put short/long.  Pointer is advanced.
257 * We also assume that a "uint16_t" holds 2 "chars"
258 * and that a "uint32_t" holds 4 "chars".
259 *
260 * These macros demonstrate the property of C whereby it can be
261 * portable or it can be elegant but never both.
262 */
263#define GETSHORT(s, cp) { \
264	register u_char *t_cp = (u_char *)(cp); \
265	(s) = ((uint16_t)t_cp[0] << 8) | (uint16_t)t_cp[1]; \
266	(cp) += 2; \
267}
268
269#define GETLONG(l, cp) { \
270	register u_char *t_cp = (u_char *)(cp); \
271	(l) = (((uint32_t)t_cp[0]) << 24) \
272	    | (((uint32_t)t_cp[1]) << 16) \
273	    | (((uint32_t)t_cp[2]) << 8) \
274	    | (((uint32_t)t_cp[3])); \
275	(cp) += 4; \
276}
277
278#define PUTSHORT(s, cp) { \
279	register uint16_t t_s = (uint16_t)(s); \
280	register u_char *t_cp = (u_char *)(cp); \
281	*t_cp++ = t_s >> 8; \
282	*t_cp   = t_s; \
283	(cp) += 2; \
284}
285
286/*
287 * Warning: PUTLONG --no-longer-- destroys its first argument.  if you
288 * were depending on this "feature", you will lose.
289 */
290#define PUTLONG(l, cp) { \
291	register uint32_t t_l = (uint32_t)(l); \
292	register u_char *t_cp = (u_char *)(cp); \
293	*t_cp++ = t_l >> 24; \
294	*t_cp++ = t_l >> 16; \
295	*t_cp++ = t_l >> 8; \
296	*t_cp   = t_l; \
297	(cp) += 4; \
298}
299
300#endif /* !_NAMESER_H_ */
301