Merge branch 'vendor/TCPDUMP' (early part)
[dragonfly.git] / contrib / tcpdump-3.9 / nameser.h
1 /* @(#) $Header: /tcpdump/master/tcpdump/nameser.h,v 1.14.4.2 2006/11/10 03:15:35 guy Exp $ (LBL) */
2 /*
3  * Copyright (c) 1983, 1989, 1993
4  *      The Regents of the University of California.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *      This product includes software developed by the University of
17  *      California, Berkeley and its contributors.
18  * 4. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *      @(#)nameser.h   8.2 (Berkeley) 2/16/94
35  * -
36  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
37  *
38  * Permission to use, copy, modify, and distribute this software for any
39  * purpose with or without fee is hereby granted, provided that the above
40  * copyright notice and this permission notice appear in all copies, and that
41  * the name of Digital Equipment Corporation not be used in advertising or
42  * publicity pertaining to distribution of the document or software without
43  * specific, written prior permission.
44  *
45  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
46  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
47  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
48  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
49  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
50  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
51  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
52  * SOFTWARE.
53  * -
54  * --Copyright--
55  */
56
57 #ifndef _NAMESER_H_
58 #define _NAMESER_H_
59
60 #include <sys/types.h>
61
62 /*
63  * Define constants based on rfc883
64  */
65 #define PACKETSZ        512             /* maximum packet size */
66 #define MAXDNAME        256             /* maximum domain name */
67 #define MAXCDNAME       255             /* maximum compressed domain name */
68 #define MAXLABEL        63              /* maximum length of domain label */
69         /* Number of bytes of fixed size data in query structure */
70 #define QFIXEDSZ        4
71         /* number of bytes of fixed size data in resource record */
72 #define RRFIXEDSZ       10
73
74 /*
75  * Internet nameserver port number
76  */
77 #define NAMESERVER_PORT 53
78
79 /*
80  * Port for multicast DNS; see
81  *
82  *      http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt
83  *
84  * for the current mDNS spec.
85  */
86 #define MULTICASTDNS_PORT       5353
87
88 /*
89  * Currently defined opcodes
90  */
91 #define QUERY           0x0             /* standard query */
92 #define IQUERY          0x1             /* inverse query */
93 #define STATUS          0x2             /* nameserver status query */
94 #if 0
95 #define xxx             0x3             /* 0x3 reserved */
96 #endif
97         /* non standard - supports ALLOW_UPDATES stuff from Mike Schwartz */
98 #define UPDATEA         0x9             /* add resource record */
99 #define UPDATED         0xa             /* delete a specific resource record */
100 #define UPDATEDA        0xb             /* delete all named resource record */
101 #define UPDATEM         0xc             /* modify a specific resource record */
102 #define UPDATEMA        0xd             /* modify all named resource record */
103
104 #define ZONEINIT        0xe             /* initial zone transfer */
105 #define ZONEREF         0xf             /* incremental zone referesh */
106
107 /*
108  * Undefine various #defines from various System V-flavored OSes (Solaris,
109  * SINIX, HP-UX) so the compiler doesn't whine that we redefine them.
110  */
111 #ifdef T_NULL
112 #undef T_NULL
113 #endif
114 #ifdef T_OPT
115 #undef T_OPT
116 #endif
117 #ifdef T_UNSPEC
118 #undef T_UNSPEC
119 #endif
120 #ifdef NOERROR
121 #undef NOERROR
122 #endif
123
124 /*
125  * Currently defined response codes
126  */
127 #define NOERROR         0               /* no error */
128 #define FORMERR         1               /* format error */
129 #define SERVFAIL        2               /* server failure */
130 #define NXDOMAIN        3               /* non existent domain */
131 #define NOTIMP          4               /* not implemented */
132 #define REFUSED         5               /* query refused */
133         /* non standard */
134 #define NOCHANGE        0xf             /* update failed to change db */
135
136 /*
137  * Type values for resources and queries
138  */
139 #define T_A             1               /* host address */
140 #define T_NS            2               /* authoritative server */
141 #define T_MD            3               /* mail destination */
142 #define T_MF            4               /* mail forwarder */
143 #define T_CNAME         5               /* connonical name */
144 #define T_SOA           6               /* start of authority zone */
145 #define T_MB            7               /* mailbox domain name */
146 #define T_MG            8               /* mail group member */
147 #define T_MR            9               /* mail rename name */
148 #define T_NULL          10              /* null resource record */
149 #define T_WKS           11              /* well known service */
150 #define T_PTR           12              /* domain name pointer */
151 #define T_HINFO         13              /* host information */
152 #define T_MINFO         14              /* mailbox information */
153 #define T_MX            15              /* mail routing information */
154 #define T_TXT           16              /* text strings */
155 #define T_RP            17              /* responsible person */
156 #define T_AFSDB         18              /* AFS cell database */
157 #define T_X25           19              /* X_25 calling address */
158 #define T_ISDN          20              /* ISDN calling address */
159 #define T_RT            21              /* router */
160 #define T_NSAP          22              /* NSAP address */
161 #define T_NSAP_PTR      23              /* reverse lookup for NSAP */
162 #define T_SIG           24              /* security signature */
163 #define T_KEY           25              /* security key */
164 #define T_PX            26              /* X.400 mail mapping */
165 #define T_GPOS          27              /* geographical position (withdrawn) */
166 #define T_AAAA          28              /* IP6 Address */
167 #define T_LOC           29              /* Location Information */
168 #define T_NXT           30              /* Next Valid Name in Zone */
169 #define T_EID           31              /* Endpoint identifier */
170 #define T_NIMLOC        32              /* Nimrod locator */
171 #define T_SRV           33              /* Server selection */
172 #define T_ATMA          34              /* ATM Address */
173 #define T_NAPTR         35              /* Naming Authority PoinTeR */
174 #define T_KX            36              /* Key Exchanger */
175 #define T_CERT          37              /* Certificates in the DNS */
176 #define T_A6            38              /* IP6 address */
177 #define T_DNAME         39              /* non-terminal redirection */
178 #define T_SINK          40              /* unknown */
179 #define T_OPT           41              /* EDNS0 option (meta-RR) */
180 #define T_APL           42              /* lists of address prefixes */
181 #define T_DS            43              /* Delegation Signer */
182 #define T_SSHFP         44              /* SSH Fingerprint */
183 #define T_IPSECKEY      45              /* IPsec keying material */
184 #define T_RRSIG         46              /* new security signature */
185 #define T_NSEC          47              /* provable insecure information */
186 #define T_DNSKEY        48              /* new security key */
187         /* non standard */
188 #define T_SPF           99              /* sender policy framework */
189 #define T_UINFO         100             /* user (finger) information */
190 #define T_UID           101             /* user ID */
191 #define T_GID           102             /* group ID */
192 #define T_UNSPEC        103             /* Unspecified format (binary data) */
193 #define T_UNSPECA       104             /* "unspecified ascii". Ugly MIT hack */
194         /* Query type values which do not appear in resource records */
195 #define T_TKEY          249             /* Transaction Key [RFC2930] */
196 #define T_TSIG          250             /* Transaction Signature [RFC2845] */
197 #define T_IXFR          251             /* incremental transfer [RFC1995] */
198 #define T_AXFR          252             /* transfer zone of authority */
199 #define T_MAILB         253             /* transfer mailbox records */
200 #define T_MAILA         254             /* transfer mail agent records */
201 #define T_ANY           255             /* wildcard match */
202
203 /*
204  * Values for class field
205  */
206
207 #define C_IN            1               /* the arpa internet */
208 #define C_CHAOS         3               /* for chaos net (MIT) */
209 #define C_HS            4               /* for Hesiod name server (MIT) (XXX) */
210         /* Query class values which do not appear in resource records */
211 #define C_ANY           255             /* wildcard match */
212 #define C_QU            0x8000          /* mDNS QU flag in queries */
213 #define C_CACHE_FLUSH   0x8000          /* mDNS cache flush flag in replies */
214
215 /*
216  * Status return codes for T_UNSPEC conversion routines
217  */
218 #define CONV_SUCCESS 0
219 #define CONV_OVERFLOW -1
220 #define CONV_BADFMT -2
221 #define CONV_BADCKSUM -3
222 #define CONV_BADBUFLEN -4
223
224 /*
225  * Structure for query header.
226  */
227 typedef struct {
228         u_int16_t id;           /* query identification number */
229         u_int8_t  flags1;       /* first byte of flags */
230         u_int8_t  flags2;       /* second byte of flags */
231         u_int16_t qdcount;      /* number of question entries */
232         u_int16_t ancount;      /* number of answer entries */
233         u_int16_t nscount;      /* number of authority entries */
234         u_int16_t arcount;      /* number of resource entries */
235 } HEADER;
236
237 /*
238  * Macros for subfields of flag fields.
239  */
240 #define DNS_QR(np)      ((np)->flags1 & 0x80)           /* response flag */
241 #define DNS_OPCODE(np)  ((((np)->flags1) >> 3) & 0xF)   /* purpose of message */
242 #define DNS_AA(np)      ((np)->flags1 & 0x04)           /* authoritative answer */
243 #define DNS_TC(np)      ((np)->flags1 & 0x02)           /* truncated message */
244 #define DNS_RD(np)      ((np)->flags1 & 0x01)           /* recursion desired */
245
246 #define DNS_RA(np)      ((np)->flags2 & 0x80)   /* recursion available */
247 #define DNS_AD(np)      ((np)->flags2 & 0x20)   /* authentic data from named */
248 #define DNS_CD(np)      ((np)->flags2 & 0x10)   /* checking disabled by resolver */
249 #define DNS_RCODE(np)   ((np)->flags2 & 0xF)    /* response code */
250
251 /*
252  * Defines for handling compressed domain names, EDNS0 labels, etc.
253  */
254 #define INDIR_MASK      0xc0    /* 11.... */
255 #define EDNS0_MASK      0x40    /* 01.... */
256 #  define EDNS0_ELT_BITLABEL 0x01
257
258 /*
259  * Structure for passing resource records around.
260  */
261 struct rrec {
262         int16_t r_zone;                 /* zone number */
263         int16_t r_class;                /* class number */
264         int16_t r_type;                 /* type number */
265         u_int32_t       r_ttl;                  /* time to live */
266         int     r_size;                 /* size of data area */
267         char    *r_data;                /* pointer to data */
268 };
269
270 /*
271  * Inline versions of get/put short/long.  Pointer is advanced.
272  * We also assume that a "u_int16_t" holds 2 "chars"
273  * and that a "u_int32_t" holds 4 "chars".
274  *
275  * These macros demonstrate the property of C whereby it can be
276  * portable or it can be elegant but never both.
277  */
278 #define GETSHORT(s, cp) { \
279         register u_char *t_cp = (u_char *)(cp); \
280         (s) = ((u_int16_t)t_cp[0] << 8) | (u_int16_t)t_cp[1]; \
281         (cp) += 2; \
282 }
283
284 #define GETLONG(l, cp) { \
285         register u_char *t_cp = (u_char *)(cp); \
286         (l) = (((u_int32_t)t_cp[0]) << 24) \
287             | (((u_int32_t)t_cp[1]) << 16) \
288             | (((u_int32_t)t_cp[2]) << 8) \
289             | (((u_int32_t)t_cp[3])); \
290         (cp) += 4; \
291 }
292
293 #define PUTSHORT(s, cp) { \
294         register u_int16_t t_s = (u_int16_t)(s); \
295         register u_char *t_cp = (u_char *)(cp); \
296         *t_cp++ = t_s >> 8; \
297         *t_cp   = t_s; \
298         (cp) += 2; \
299 }
300
301 /*
302  * Warning: PUTLONG --no-longer-- destroys its first argument.  if you
303  * were depending on this "feature", you will lose.
304  */
305 #define PUTLONG(l, cp) { \
306         register u_int32_t t_l = (u_int32_t)(l); \
307         register u_char *t_cp = (u_char *)(cp); \
308         *t_cp++ = t_l >> 24; \
309         *t_cp++ = t_l >> 16; \
310         *t_cp++ = t_l >> 8; \
311         *t_cp   = t_l; \
312         (cp) += 4; \
313 }
314
315 #endif /* !_NAMESER_H_ */