nameser.h revision 1.6 1 /*
2 * Copyright (c) 1983, 1989 Regents of the University of California.
3 * 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 * from: @(#)nameser.h 5.25 (Berkeley) 4/3/91
34 * $Id: nameser.h,v 1.6 1994/10/15 07:56:55 deraadt Exp $
35 */
36
37 #ifndef _NAMESER_H_
38 #define _NAMESER_H_
39
40 #include <machine/endian.h>
41 #include <sys/cdefs.h>
42
43 /*
44 * Define constants based on rfc883
45 */
46 #define PACKETSZ 512 /* maximum packet size */
47 #define MAXDNAME 256 /* maximum domain name */
48 #define MAXCDNAME 255 /* maximum compressed domain name */
49 #define MAXLABEL 63 /* maximum length of domain label */
50 /* Number of bytes of fixed size data in query structure */
51 #define QFIXEDSZ 4
52 /* number of bytes of fixed size data in resource record */
53 #define RRFIXEDSZ 10
54
55 /*
56 * Internet nameserver port number
57 */
58 #define NAMESERVER_PORT 53
59
60 /*
61 * Currently defined opcodes
62 */
63 #define QUERY 0x0 /* standard query */
64 #define IQUERY 0x1 /* inverse query */
65 #define STATUS 0x2 /* nameserver status query */
66 /*#define xxx 0x3 /* 0x3 reserved */
67 /* non standard */
68 #define UPDATEA 0x9 /* add resource record */
69 #define UPDATED 0xa /* delete a specific resource record */
70 #define UPDATEDA 0xb /* delete all named resource record */
71 #define UPDATEM 0xc /* modify a specific resource record */
72 #define UPDATEMA 0xd /* modify all named resource record */
73
74 #define ZONEINIT 0xe /* initial zone transfer */
75 #define ZONEREF 0xf /* incremental zone referesh */
76
77 /*
78 * Currently defined response codes
79 */
80 #define NOERROR 0 /* no error */
81 #define FORMERR 1 /* format error */
82 #define SERVFAIL 2 /* server failure */
83 #define NXDOMAIN 3 /* non existent domain */
84 #define NOTIMP 4 /* not implemented */
85 #define REFUSED 5 /* query refused */
86 /* non standard */
87 #define NOCHANGE 0xf /* update failed to change db */
88
89 /*
90 * Type values for resources and queries
91 */
92 #define T_A 1 /* host address */
93 #define T_NS 2 /* authoritative server */
94 #define T_MD 3 /* mail destination */
95 #define T_MF 4 /* mail forwarder */
96 #define T_CNAME 5 /* connonical name */
97 #define T_SOA 6 /* start of authority zone */
98 #define T_MB 7 /* mailbox domain name */
99 #define T_MG 8 /* mail group member */
100 #define T_MR 9 /* mail rename name */
101 #define T_NULL 10 /* null resource record */
102 #define T_WKS 11 /* well known service */
103 #define T_PTR 12 /* domain name pointer */
104 #define T_HINFO 13 /* host information */
105 #define T_MINFO 14 /* mailbox information */
106 #define T_MX 15 /* mail routing information */
107 #define T_TXT 16 /* text strings */
108 #define T_RP 17 /* responsible person */
109 #define T_AFSDB 18 /* AFS cell database */
110 #define T_NSAP 22 /* NSAP address */
111 #define T_NSAP_PTR 23 /* reverse lookup for NSAP */
112 /* non standard */
113 #define T_UINFO 100 /* user (finger) information */
114 #define T_UID 101 /* user ID */
115 #define T_GID 102 /* group ID */
116 #define T_UNSPEC 103 /* Unspecified format (binary data) */
117 #define T_SA 200 /* shuffle address */
118 /* Query type values which do not appear in resource records */
119 #define T_AXFR 252 /* transfer zone of authority */
120 #define T_MAILB 253 /* transfer mailbox records */
121 #define T_MAILA 254 /* transfer mail agent records */
122 #define T_ANY 255 /* wildcard match */
123
124 /*
125 * Values for class field
126 */
127 #define C_IN 1 /* the arpa internet */
128 #define C_CHAOS 3 /* for chaos net at MIT */
129 #define C_HS 4 /* for Hesiod name server at MIT */
130 /* Query class values which do not appear in resource records */
131 #define C_ANY 255 /* wildcard match */
132
133 /*
134 * Status return codes for T_UNSPEC conversion routines
135 */
136 #define CONV_SUCCESS 0
137 #define CONV_OVERFLOW -1
138 #define CONV_BADFMT -2
139 #define CONV_BADCKSUM -3
140 #define CONV_BADBUFLEN -4
141
142 /*
143 * Structure for query header, the order of the fields is machine and
144 * compiler dependent, in our case, the bits within a byte are assignd
145 * least significant first, while the order of transmition is most
146 * significant first. This requires a somewhat confusing rearrangement.
147 */
148 typedef struct {
149 u_short id; /* query identification number */
150 #if BYTE_ORDER == BIG_ENDIAN
151 /* fields in third byte */
152 u_char qr:1; /* response flag */
153 u_char opcode:4; /* purpose of message */
154 u_char aa:1; /* authoritive answer */
155 u_char tc:1; /* truncated message */
156 u_char rd:1; /* recursion desired */
157 /* fields in fourth byte */
158 u_char ra:1; /* recursion available */
159 u_char pr:1; /* primary server required (non standard) */
160 u_char unused:2; /* unused bits */
161 u_char rcode:4; /* response code */
162 #endif
163 #if BYTE_ORDER == LITTLE_ENDIAN || BYTE_ORDER == PDP_ENDIAN
164 /* fields in third byte */
165 u_char rd:1; /* recursion desired */
166 u_char tc:1; /* truncated message */
167 u_char aa:1; /* authoritive answer */
168 u_char opcode:4; /* purpose of message */
169 u_char qr:1; /* response flag */
170 /* fields in fourth byte */
171 u_char rcode:4; /* response code */
172 u_char unused:2; /* unused bits */
173 u_char pr:1; /* primary server required (non standard) */
174 u_char ra:1; /* recursion available */
175 #endif
176 /* remaining bytes */
177 u_short qdcount; /* number of question entries */
178 u_short ancount; /* number of answer entries */
179 u_short nscount; /* number of authority entries */
180 u_short arcount; /* number of resource entries */
181 } HEADER;
182
183 /*
184 * Defines for handling compressed domain names
185 */
186 #define INDIR_MASK 0xc0
187
188 /*
189 * Structure for passing resource records around.
190 */
191 struct rrec {
192 int16_t r_zone; /* zone number */
193 int16_t r_class; /* class number */
194 int16_t r_type; /* type number */
195 u_int32_t r_ttl; /* time to live */
196 int r_size; /* size of data area */
197 char *r_data; /* pointer to data */
198 };
199
200 extern u_int16_t _getshort();
201 extern u_int32_t _getlong();
202
203 /*
204 * Inline versions of get/put short/long.
205 * Pointer is advanced; we assume that both arguments
206 * are lvalues and will already be in registers.
207 * cp MUST be u_char *.
208 */
209 #define GETSHORT(s, cp) { \
210 register u_char *t_cp = (u_char *)(cp); \
211 (s) = ((u_int16_t)t_cp[0] << 8) \
212 | ((u_int16_t)t_cp[1]) ;\
213 (cp) += sizeof(u_int16_t); \
214 }
215
216 #define GETLONG(l, cp) { \
217 register u_char *t_cp = (u_char *)(cp); \
218 (l) = ((u_int32_t)t_cp[0] << 24) \
219 | ((u_int32_t)t_cp[1] << 16) \
220 | ((u_int32_t)t_cp[2] << 8) \
221 | ((u_int32_t)t_cp[3]) ;\
222 (cp) += sizeof(u_int32_t); \
223 }
224
225 #define PUTSHORT(s, cp) { \
226 register u_int16_t t_s = (u_int16_t)(s); \
227 register u_char *t_cp = (u_char *)(cp); \
228 *t_cp++ = t_s >> 8; \
229 *t_cp = t_s; \
230 (cp) += sizeof(u_int16_t); \
231 }
232
233 /*
234 * Warning: PUTLONG --no-longer-- destroys its first argument. if you
235 * were depending on this "feature", you will lose.
236 */
237 #define PUTLONG(l, cp) { \
238 register u_int32_t t_l = (u_int32_t)(l); \
239 register u_char *t_cp = (u_char *)(cp); \
240 *t_cp++ = t_l >> 24; \
241 *t_cp++ = t_l >> 16; \
242 *t_cp++ = t_l >> 8; \
243 *t_cp = t_l; \
244 (cp) += sizeof(u_int32_t); \
245 }
246
247 #endif /* !_NAMESER_H_ */
248