nameser.h revision 1.6
1/* $OpenBSD: nameser.h,v 1.6 2001/07/31 22:02:18 jakob 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. All advertising materials mentioning features or use of this software 18 * must display the following acknowledgement: 19 * This product includes software developed by the University of 20 * California, Berkeley and its contributors. 21 * 4. Neither the name of the University nor the names of its contributors 22 * may be used to endorse or promote products derived from this software 23 * without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35 * SUCH DAMAGE. 36 * - 37 * Portions Copyright (c) 1993 by Digital Equipment Corporation. 38 * 39 * Permission to use, copy, modify, and distribute this software for any 40 * purpose with or without fee is hereby granted, provided that the above 41 * copyright notice and this permission notice appear in all copies, and that 42 * the name of Digital Equipment Corporation not be used in advertising or 43 * publicity pertaining to distribution of the document or software without 44 * specific, written prior permission. 45 * 46 * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL 47 * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES 48 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL DIGITAL EQUIPMENT 49 * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 50 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 51 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS 52 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 53 * SOFTWARE. 54 * - 55 * Portions Copyright (c) 1995 by International Business Machines, Inc. 56 * 57 * International Business Machines, Inc. (hereinafter called IBM) grants 58 * permission under its copyrights to use, copy, modify, and distribute this 59 * Software with or without fee, provided that the above copyright notice and 60 * all paragraphs of this notice appear in all copies, and that the name of IBM 61 * not be used in connection with the marketing of any product incorporating 62 * the Software or modifications thereof, without specific, written prior 63 * permission. 64 * 65 * To the extent it has a right to do so, IBM grants an immunity from suit 66 * under its patents, if any, for the use, sale or manufacture of products to 67 * the extent that such products are used for performing Domain Name System 68 * dynamic updates in TCP/IP networks by means of the Software. No immunity is 69 * granted for any product per se or for any other function of any product. 70 * 71 * THE SOFTWARE IS PROVIDED "AS IS", AND IBM DISCLAIMS ALL WARRANTIES, 72 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 73 * PARTICULAR PURPOSE. IN NO EVENT SHALL IBM BE LIABLE FOR ANY SPECIAL, 74 * DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER ARISING 75 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE, EVEN 76 * IF IBM IS APPRISED OF THE POSSIBILITY OF SUCH DAMAGES. 77 * --Copyright-- 78 */ 79 80/* 81 * @(#)nameser.h 8.1 (Berkeley) 6/2/93 82 * $From: nameser.h,v 8.11 1996/10/08 04:51:02 vixie Exp $ 83 */ 84 85#ifndef _NAMESER_H_ 86#define _NAMESER_H_ 87 88#include <sys/param.h> 89#if (!defined(BSD)) || (BSD < 199306) 90# include <sys/bitypes.h> 91#else 92# include <sys/types.h> 93#endif 94#include <sys/cdefs.h> 95 96#ifdef _AUX_SOURCE 97# include <sys/types.h> 98#endif 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 presentation 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#define T_NAPTR 35 /* Naming Authority PoinTeR */ 186#define T_OPT 41 /* OPT pseudo-RR, RFC2671 */ 187 /* non standard */ 188#define T_UINFO 100 /* user (finger) information */ 189#define T_UID 101 /* user ID */ 190#define T_GID 102 /* group ID */ 191#define T_UNSPEC 103 /* Unspecified format (binary data) */ 192 /* Query type values which do not appear in resource records */ 193#define T_IXFR 251 /* incremental zone transfer */ 194#define T_AXFR 252 /* transfer zone of authority */ 195#define T_MAILB 253 /* transfer mailbox records */ 196#define T_MAILA 254 /* transfer mail agent records */ 197#define T_ANY 255 /* wildcard match */ 198 199/* 200 * Values for class field 201 */ 202 203#define C_IN 1 /* the arpa internet */ 204#define C_CHAOS 3 /* for chaos net (MIT) */ 205#define C_HS 4 /* for Hesiod name server (MIT) (XXX) */ 206 /* Query class values which do not appear in resource records */ 207#define C_ANY 255 /* wildcard match */ 208 209/* 210 * Flags field of the KEY RR rdata 211 */ 212#define KEYFLAG_TYPEMASK 0xC000 /* Mask for "type" bits */ 213#define KEYFLAG_TYPE_AUTH_CONF 0x0000 /* Key usable for both */ 214#define KEYFLAG_TYPE_CONF_ONLY 0x8000 /* Key usable for confidentiality */ 215#define KEYFLAG_TYPE_AUTH_ONLY 0x4000 /* Key usable for authentication */ 216#define KEYFLAG_TYPE_NO_KEY 0xC000 /* No key usable for either; no key */ 217/* The type bits can also be interpreted independently, as single bits: */ 218#define KEYFLAG_NO_AUTH 0x8000 /* Key not usable for authentication */ 219#define KEYFLAG_NO_CONF 0x4000 /* Key not usable for confidentiality */ 220 221#define KEYFLAG_EXPERIMENTAL 0x2000 /* Security is *mandatory* if bit=0 */ 222#define KEYFLAG_RESERVED3 0x1000 /* reserved - must be zero */ 223#define KEYFLAG_RESERVED4 0x0800 /* reserved - must be zero */ 224#define KEYFLAG_USERACCOUNT 0x0400 /* key is assoc. with a user acct */ 225#define KEYFLAG_ENTITY 0x0200 /* key is assoc. with entity eg host */ 226#define KEYFLAG_ZONEKEY 0x0100 /* key is zone key for the zone named */ 227#define KEYFLAG_IPSEC 0x0080 /* key is for IPSEC use (host or user)*/ 228#define KEYFLAG_EMAIL 0x0040 /* key is for email (MIME security) */ 229#define KEYFLAG_RESERVED10 0x0020 /* reserved - must be zero */ 230#define KEYFLAG_RESERVED11 0x0010 /* reserved - must be zero */ 231#define KEYFLAG_SIGNATORYMASK 0x000F /* key can sign DNS RR's of same name */ 232 233#define KEYFLAG_RESERVED_BITMASK ( KEYFLAG_RESERVED3 | \ 234 KEYFLAG_RESERVED4 | \ 235 KEYFLAG_RESERVED10| KEYFLAG_RESERVED11) 236 237/* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */ 238#define ALGORITHM_MD5RSA 1 /* MD5 with RSA */ 239#define ALGORITHM_EXPIRE_ONLY 253 /* No alg, no security */ 240#define ALGORITHM_PRIVATE_OID 254 /* Key begins with OID indicating alg */ 241 242/* Signatures */ 243 /* Size of a mod or exp in bits */ 244#define MIN_MD5RSA_KEY_PART_BITS 512 245#define MAX_MD5RSA_KEY_PART_BITS 2552 246 /* Total of binary mod and exp, bytes */ 247#define MAX_MD5RSA_KEY_BYTES ((MAX_MD5RSA_KEY_PART_BITS+7/8)*2+3) 248 /* Max length of text sig block */ 249#define MAX_KEY_BASE64 (((MAX_MD5RSA_KEY_BYTES+2)/3)*4) 250 251/* 252 * EDNS0 Z-field extended flags 253 */ 254#define DNS_MESSAGEEXTFLAG_DO 0x8000U 255 256/* 257 * Status return codes for T_UNSPEC conversion routines 258 */ 259#define CONV_SUCCESS 0 260#define CONV_OVERFLOW (-1) 261#define CONV_BADFMT (-2) 262#define CONV_BADCKSUM (-3) 263#define CONV_BADBUFLEN (-4) 264 265#ifndef BYTE_ORDER 266#if (BSD >= 199103) 267# include <machine/endian.h> 268#else 269#ifdef linux 270# include <endian.h> 271#else 272#define LITTLE_ENDIAN 1234 /* least-significant byte first (vax, pc) */ 273#define BIG_ENDIAN 4321 /* most-significant byte first (IBM, net) */ 274#define PDP_ENDIAN 3412 /* LSB first in word, MSW first in long (pdp)*/ 275 276#if defined(vax) || defined(ns32000) || defined(sun386) || defined(i386) || \ 277 defined(MIPSEL) || defined(_MIPSEL) || defined(BIT_ZERO_ON_RIGHT) || \ 278 defined(__alpha__) || defined(__alpha) 279#define BYTE_ORDER LITTLE_ENDIAN 280#endif 281 282#if defined(sel) || defined(pyr) || defined(mc68000) || defined(sparc) || \ 283 defined(is68k) || defined(tahoe) || defined(ibm032) || defined(ibm370) || \ 284 defined(MIPSEB) || defined(_MIPSEB) || defined(_IBMR2) || defined(DGUX) ||\ 285 defined(apollo) || defined(__convex__) || defined(_CRAY) || \ 286 defined(__hppa) || defined(__hp9000) || \ 287 defined(__hp9000s300) || defined(__hp9000s700) || \ 288 defined (BIT_ZERO_ON_LEFT) || defined(m68k) 289#define BYTE_ORDER BIG_ENDIAN 290#endif 291#endif /* linux */ 292#endif /* BSD */ 293#endif /* BYTE_ORDER */ 294 295#if !defined(BYTE_ORDER) || \ 296 (BYTE_ORDER != BIG_ENDIAN && BYTE_ORDER != LITTLE_ENDIAN && \ 297 BYTE_ORDER != PDP_ENDIAN) 298 /* you must determine what the correct bit order is for 299 * your compiler - the next line is an intentional error 300 * which will force your compiles to bomb until you fix 301 * the above macros. 302 */ 303 error "Undefined or invalid BYTE_ORDER"; 304#endif 305 306/* 307 * Structure for query header. The order of the fields is machine- and 308 * compiler-dependent, depending on the byte/bit order and the layout 309 * of bit fields. We use bit fields only in int variables, as this 310 * is all ANSI requires. This requires a somewhat confusing rearrangement. 311 */ 312 313typedef struct { 314 unsigned id :16; /* query identification number */ 315#if BYTE_ORDER == BIG_ENDIAN 316 /* fields in third byte */ 317 unsigned qr: 1; /* response flag */ 318 unsigned opcode: 4; /* purpose of message */ 319 unsigned aa: 1; /* authoritive answer */ 320 unsigned tc: 1; /* truncated message */ 321 unsigned rd: 1; /* recursion desired */ 322 /* fields in fourth byte */ 323 unsigned ra: 1; /* recursion available */ 324 unsigned unused :1; /* unused bits (MBZ as of 4.9.3a3) */ 325 unsigned ad: 1; /* authentic data from named */ 326 unsigned cd: 1; /* checking disabled by resolver */ 327 unsigned rcode :4; /* response code */ 328#endif 329#if BYTE_ORDER == LITTLE_ENDIAN || BYTE_ORDER == PDP_ENDIAN 330 /* fields in third byte */ 331 unsigned rd :1; /* recursion desired */ 332 unsigned tc :1; /* truncated message */ 333 unsigned aa :1; /* authoritive answer */ 334 unsigned opcode :4; /* purpose of message */ 335 unsigned qr :1; /* response flag */ 336 /* fields in fourth byte */ 337 unsigned rcode :4; /* response code */ 338 unsigned cd: 1; /* checking disabled by resolver */ 339 unsigned ad: 1; /* authentic data from named */ 340 unsigned unused :1; /* unused bits (MBZ as of 4.9.3a3) */ 341 unsigned ra :1; /* recursion available */ 342#endif 343 /* remaining bytes */ 344 unsigned qdcount :16; /* number of question entries */ 345 unsigned ancount :16; /* number of answer entries */ 346 unsigned nscount :16; /* number of authority entries */ 347 unsigned arcount :16; /* number of resource entries */ 348} HEADER; 349 350/* 351 * Defines for handling compressed domain names 352 */ 353#define INDIR_MASK 0xc0 354 355extern u_int16_t _getshort __P((const u_char *)); 356extern u_int32_t _getlong __P((const u_char *)); 357 358/* 359 * Inline versions of get/put short/long. Pointer is advanced. 360 * 361 * These macros demonstrate the property of C whereby it can be 362 * portable or it can be elegant but rarely both. 363 */ 364#define GETSHORT(s, cp) { \ 365 register u_char *t_cp = (u_char *)(cp); \ 366 (s) = ((u_int16_t)t_cp[0] << 8) \ 367 | ((u_int16_t)t_cp[1]) \ 368 ; \ 369 (cp) += INT16SZ; \ 370} 371 372#define GETLONG(l, cp) { \ 373 register u_char *t_cp = (u_char *)(cp); \ 374 (l) = ((u_int32_t)t_cp[0] << 24) \ 375 | ((u_int32_t)t_cp[1] << 16) \ 376 | ((u_int32_t)t_cp[2] << 8) \ 377 | ((u_int32_t)t_cp[3]) \ 378 ; \ 379 (cp) += INT32SZ; \ 380} 381 382#define PUTSHORT(s, cp) { \ 383 register u_int16_t t_s = (u_int16_t)(s); \ 384 register u_char *t_cp = (u_char *)(cp); \ 385 *t_cp++ = t_s >> 8; \ 386 *t_cp = t_s; \ 387 (cp) += INT16SZ; \ 388} 389 390#define PUTLONG(l, cp) { \ 391 register u_int32_t t_l = (u_int32_t)(l); \ 392 register u_char *t_cp = (u_char *)(cp); \ 393 *t_cp++ = t_l >> 24; \ 394 *t_cp++ = t_l >> 16; \ 395 *t_cp++ = t_l >> 8; \ 396 *t_cp = t_l; \ 397 (cp) += INT32SZ; \ 398} 399 400#endif /* !_NAMESER_H_ */ 401