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