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