The Tcpdump Group git mirrors - tcpdump/blob - nameser.h

   1 /*
   2  * Copyright (c) 1983, 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. 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  *      @(#)nameser.h   8.2 (Berkeley) 2/16/94
  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  * --Copyright--
  54  */
  55
  56 #ifndef _NAMESER_H_
  57 #define _NAMESER_H_
  58
  59 #include <sys/types.h>
  60
  61 /*
  62  * Define constants based on rfc883
  63  */
  64 #define PACKETSZ        512             /* maximum packet size */
  65 #define MAXDNAME        256             /* maximum domain name */
  66 #define MAXCDNAME       255             /* maximum compressed domain name */
  67 #define MAXLABEL        63              /* maximum length of domain label */
  68         /* Number of bytes of fixed size data in query structure */
  69 #define QFIXEDSZ        4
  70         /* number of bytes of fixed size data in resource record */
  71 #define RRFIXEDSZ       10
  72
  73 /*
  74  * Internet nameserver port number
  75  */
  76 #define NAMESERVER_PORT 53
  77
  78 /*
  79  * Currently defined opcodes
  80  */
  81 #define QUERY           0x0             /* standard query */
  82 #define IQUERY          0x1             /* inverse query */
  83 #define STATUS          0x2             /* nameserver status query */
  84 /*#define xxx           0x3             /* 0x3 reserved */
  85         /* non standard - supports ALLOW_UPDATES stuff from Mike Schwartz */
  86 #define UPDATEA         0x9             /* add resource record */
  87 #define UPDATED         0xa             /* delete a specific resource record */
  88 #define UPDATEDA        0xb             /* delete all named resource record */
  89 #define UPDATEM         0xc             /* modify a specific resource record */
  90 #define UPDATEMA        0xd             /* modify all named resource record */
  91
  92 #define ZONEINIT        0xe             /* initial zone transfer */
  93 #define ZONEREF         0xf             /* incremental zone referesh */
  94
  95 /*
  96  * Currently defined response codes
  97  */
  98 #define NOERROR         0               /* no error */
  99 #define FORMERR         1               /* format error */
 100 #define SERVFAIL        2               /* server failure */
 101 #define NXDOMAIN        3               /* non existent domain */
 102 #define NOTIMP          4               /* not implemented */
 103 #define REFUSED         5               /* query refused */
 104         /* non standard */
 105 #define NOCHANGE        0xf             /* update failed to change db */
 106
 107 /*
 108  * Type values for resources and queries
 109  */
 110 #define T_A             1               /* host address */
 111 #define T_NS            2               /* authoritative server */
 112 #define T_MD            3               /* mail destination */
 113 #define T_MF            4               /* mail forwarder */
 114 #define T_CNAME         5               /* connonical name */
 115 #define T_SOA           6               /* start of authority zone */
 116 #define T_MB            7               /* mailbox domain name */
 117 #define T_MG            8               /* mail group member */
 118 #define T_MR            9               /* mail rename name */
 119 #define T_NULL          10              /* null resource record */
 120 #define T_WKS           11              /* well known service */
 121 #define T_PTR           12              /* domain name pointer */
 122 #define T_HINFO         13              /* host information */
 123 #define T_MINFO         14              /* mailbox information */
 124 #define T_MX            15              /* mail routing information */
 125 #define T_TXT           16              /* text strings */
 126 #define T_RP            17              /* responsible person */
 127 #define T_AFSDB         18              /* AFS cell database */
 128 #define T_NSAP          22              /* NSAP address */
 129 #define T_NSAP_PTR      23              /* reverse lookup for NSAP */
 130         /* non standard */
 131 #define T_UINFO         100             /* user (finger) information */
 132 #define T_UID           101             /* user ID */
 133 #define T_GID           102             /* group ID */
 134 #define T_UNSPEC        103             /* Unspecified format (binary data) */
 135         /* Query type values which do not appear in resource records */
 136 #define T_AXFR          252             /* transfer zone of authority */
 137 #define T_MAILB         253             /* transfer mailbox records */
 138 #define T_MAILA         254             /* transfer mail agent records */
 139 #define T_ANY           255             /* wildcard match */
 140
 141 /*
 142  * Values for class field
 143  */
 144
 145 #define C_IN            1               /* the arpa internet */
 146 #define C_CHAOS         3               /* for chaos net (MIT) */
 147 #define C_HS            4               /* for Hesiod name server (MIT) (XXX) */
 148         /* Query class values which do not appear in resource records */
 149 #define C_ANY           255             /* wildcard match */
 150
 151 /*
 152  * Status return codes for T_UNSPEC conversion routines
 153  */
 154 #define CONV_SUCCESS 0
 155 #define CONV_OVERFLOW -1
 156 #define CONV_BADFMT -2
 157 #define CONV_BADCKSUM -3
 158 #define CONV_BADBUFLEN -4
 159
 160 #ifndef BYTE_ORDER
 161 #define LITTLE_ENDIAN   1234    /* least-significant byte first (vax, pc) */
 162 #define BIG_ENDIAN      4321    /* most-significant byte first (IBM, net) */
 163 #define PDP_ENDIAN      3412    /* LSB first in word, MSW first in long (pdp)*/
 164
 165 #ifdef WORDS_BIGENDIAN
 166 #define BYTE_ORDER      BIG_ENDIAN
 167 #else
 168 #define BYTE_ORDER      LITTLE_ENDIAN
 169 #endif /* WORDS_BIGENDIAN */
 170 #endif /* BYTE_ORDER */
 171
 172 #if !defined(BYTE_ORDER) || \
 173     (BYTE_ORDER != BIG_ENDIAN && BYTE_ORDER != LITTLE_ENDIAN && \
 174     BYTE_ORDER != PDP_ENDIAN)
 175         /* you must determine what the correct bit order is for
 176          * your compiler - the next line is an intentional error
 177          * which will force your compiles to bomb until you fix
 178          * the above macros.
 179          */
 180   #error "Undefined or invalid BYTE_ORDER";
 181 #endif
 182
 183 /*
 184  * Structure for query header.  The order of the fields is machine- and
 185  * compiler-dependent, depending on the byte/bit order and the layout
 186  * of bit fields.  We use bit fields only in int variables, as this
 187  * is all ANSI requires.  This requires a somewhat confusing rearrangement.
 188  */
 189
 190 typedef struct {
 191         u_int16_t id;           /* query identification number */
 192 #if BYTE_ORDER == BIG_ENDIAN
 193                         /* fields in third byte */
 194         u_int   qr:1;           /* response flag */
 195         u_int   opcode:4;       /* purpose of message */
 196         u_int   aa:1;           /* authoritive answer */
 197         u_int   tc:1;           /* truncated message */
 198         u_int   rd:1;           /* recursion desired */
 199                         /* fields in fourth byte */
 200         u_int   ra:1;           /* recursion available */
 201         u_int   pr:1;           /* primary server required (non standard) */
 202         u_int   ad: 1;          /* authentic data from named */
 203         u_int   cd: 1;          /* checking disabled by resolver */
 204         u_int   rcode:4;        /* response code */
 205 #endif
 206 #if BYTE_ORDER == LITTLE_ENDIAN || BYTE_ORDER == PDP_ENDIAN
 207                         /* fields in third byte */
 208         u_int   rd:1;           /* recursion desired */
 209         u_int   tc:1;           /* truncated message */
 210         u_int   aa:1;           /* authoritive answer */
 211         u_int   opcode:4;       /* purpose of message */
 212         u_int   qr:1;           /* response flag */
 213                         /* fields in fourth byte */
 214         u_int   rcode:4;        /* response code */
 215         u_int   cd: 1;          /* checking disabled by resolver */
 216         u_int   ad: 1;          /* authentic data from named */
 217         u_int   pr:1;           /* primary server required (non standard) */
 218         u_int   ra:1;           /* recursion available */
 219 #endif
 220                         /* remaining bytes */
 221         u_int16_t qdcount;      /* number of question entries */
 222         u_int16_t ancount;      /* number of answer entries */
 223         u_int16_t nscount;      /* number of authority entries */
 224         u_int16_t arcount;      /* number of resource entries */
 225 } HEADER;
 226
 227 /*
 228  * Defines for handling compressed domain names
 229  */
 230 #define INDIR_MASK      0xc0
 231
 232 /*
 233  * Structure for passing resource records around.
 234  */
 235 struct rrec {
 236         int16_t r_zone;                 /* zone number */
 237         int16_t r_class;                /* class number */
 238         int16_t r_type;                 /* type number */
 239         u_int32_t       r_ttl;                  /* time to live */
 240         int     r_size;                 /* size of data area */
 241         char    *r_data;                /* pointer to data */
 242 };
 243
 244 extern  u_int16_t       _getshort();
 245 extern  u_int32_t       _getlong();
 246
 247 /*
 248  * Inline versions of get/put short/long.  Pointer is advanced.
 249  * We also assume that a "u_int16_t" holds 2 "chars"
 250  * and that a "u_int32_t" holds 4 "chars".
 251  *
 252  * These macros demonstrate the property of C whereby it can be
 253  * portable or it can be elegant but never both.
 254  */
 255 #define GETSHORT(s, cp) { \
 256         register u_char *t_cp = (u_char *)(cp); \
 257         (s) = ((u_int16_t)t_cp[0] << 8) | (u_int16_t)t_cp[1]; \
 258         (cp) += 2; \
 259 }
 260
 261 #define GETLONG(l, cp) { \
 262         register u_char *t_cp = (u_char *)(cp); \
 263         (l) = (((u_int32_t)t_cp[0]) << 24) \
 264             | (((u_int32_t)t_cp[1]) << 16) \
 265             | (((u_int32_t)t_cp[2]) << 8) \
 266             | (((u_int32_t)t_cp[3])); \
 267         (cp) += 4; \
 268 }
 269
 270 #define PUTSHORT(s, cp) { \
 271         register u_int16_t t_s = (u_int16_t)(s); \
 272         register u_char *t_cp = (u_char *)(cp); \
 273         *t_cp++ = t_s >> 8; \
 274         *t_cp   = t_s; \
 275         (cp) += 2; \
 276 }
 277
 278 /*
 279  * Warning: PUTLONG --no-longer-- destroys its first argument.  if you
 280  * were depending on this "feature", you will lose.
 281  */
 282 #define PUTLONG(l, cp) { \
 283         register u_int32_t t_l = (u_int32_t)(l); \
 284         register u_char *t_cp = (u_char *)(cp); \
 285         *t_cp++ = t_l >> 24; \
 286         *t_cp++ = t_l >> 16; \
 287         *t_cp++ = t_l >> 8; \
 288         *t_cp   = t_l; \
 289         (cp) += 4; \
 290 }
 291
 292 #endif /* !_NAMESER_H_ */