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