contrib/tcpdump/nameser.h

   1 /* @(#) $Header: /tcpdump/master/tcpdump/nameser.h,v 1.5 2000/12/28 20:30:41 itojun Exp $ (LBL) */
   2 /*
   3  * Copyright (c) 1983, 1989, 1993
   4  *      The Regents of the University of California.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. All advertising materials mentioning features or use of this software
  15  *    must display the following acknowledgement:
  16  *      This product includes software developed by the University of
  17  *      California, Berkeley and its contributors.
  18  * 4. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)nameser.h   8.2 (Berkeley) 2/16/94
  35  * -
  36  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
  37  *
  38  * Permission to use, copy, modify, and distribute this software for any
  39  * purpose with or without fee is hereby granted, provided that the above
  40  * copyright notice and this permission notice appear in all copies, and that
  41  * the name of Digital Equipment Corporation not be used in advertising or
  42  * publicity pertaining to distribution of the document or software without
  43  * specific, written prior permission.
  44  *
  45  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
  46  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
  47  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
  48  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  49  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  50  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  51  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  52  * SOFTWARE.
  53  * -
  54  * --Copyright--
  55  */
  56
  57 #ifndef _NAMESER_H_
  58 #define _NAMESER_H_
  59
  60 #include <sys/types.h>
  61
  62 /*
  63  * Define constants based on rfc883
  64  */
  65 #define PACKETSZ        512             /* maximum packet size */
  66 #define MAXDNAME        256             /* maximum domain name */
  67 #define MAXCDNAME       255             /* maximum compressed domain name */
  68 #define MAXLABEL        63              /* maximum length of domain label */
  69         /* Number of bytes of fixed size data in query structure */
  70 #define QFIXEDSZ        4
  71         /* number of bytes of fixed size data in resource record */
  72 #define RRFIXEDSZ       10
  73
  74 /*
  75  * Internet nameserver port number
  76  */
  77 #define NAMESERVER_PORT 53
  78
  79 /*
  80  * Currently defined opcodes
  81  */
  82 #define QUERY           0x0             /* standard query */
  83 #define IQUERY          0x1             /* inverse query */
  84 #define STATUS          0x2             /* nameserver status query */
  85 #if 0
  86 #define xxx             0x3             /* 0x3 reserved */
  87 #endif
  88         /* non standard - supports ALLOW_UPDATES stuff from Mike Schwartz */
  89 #define UPDATEA         0x9             /* add resource record */
  90 #define UPDATED         0xa             /* delete a specific resource record */
  91 #define UPDATEDA        0xb             /* delete all named resource record */
  92 #define UPDATEM         0xc             /* modify a specific resource record */
  93 #define UPDATEMA        0xd             /* modify all named resource record */
  94
  95 #define ZONEINIT        0xe             /* initial zone transfer */
  96 #define ZONEREF         0xf             /* incremental zone referesh */
  97
  98 /*
  99  * Currently defined response codes
 100  */
 101 #define NOERROR         0               /* no error */
 102 #define FORMERR         1               /* format error */
 103 #define SERVFAIL        2               /* server failure */
 104 #define NXDOMAIN        3               /* non existent domain */
 105 #define NOTIMP          4               /* not implemented */
 106 #define REFUSED         5               /* query refused */
 107         /* non standard */
 108 #define NOCHANGE        0xf             /* update failed to change db */
 109
 110 /*
 111  * Type values for resources and queries
 112  */
 113 #define T_A             1               /* host address */
 114 #define T_NS            2               /* authoritative server */
 115 #define T_MD            3               /* mail destination */
 116 #define T_MF            4               /* mail forwarder */
 117 #define T_CNAME         5               /* connonical name */
 118 #define T_SOA           6               /* start of authority zone */
 119 #define T_MB            7               /* mailbox domain name */
 120 #define T_MG            8               /* mail group member */
 121 #define T_MR            9               /* mail rename name */
 122 #define T_NULL          10              /* null resource record */
 123 #define T_WKS           11              /* well known service */
 124 #define T_PTR           12              /* domain name pointer */
 125 #define T_HINFO         13              /* host information */
 126 #define T_MINFO         14              /* mailbox information */
 127 #define T_MX            15              /* mail routing information */
 128 #define T_TXT           16              /* text strings */
 129 #define T_RP            17              /* responsible person */
 130 #define T_AFSDB         18              /* AFS cell database */
 131 #define T_NSAP          22              /* NSAP address */
 132 #define T_NSAP_PTR      23              /* reverse lookup for NSAP */
 133         /* non standard */
 134 #define T_UINFO         100             /* user (finger) information */
 135 #define T_UID           101             /* user ID */
 136 #define T_GID           102             /* group ID */
 137 #define T_UNSPEC        103             /* Unspecified format (binary data) */
 138         /* Query type values which do not appear in resource records */
 139 #define T_AXFR          252             /* transfer zone of authority */
 140 #define T_MAILB         253             /* transfer mailbox records */
 141 #define T_MAILA         254             /* transfer mail agent records */
 142 #define T_ANY           255             /* wildcard match */
 143
 144 /*
 145  * Values for class field
 146  */
 147
 148 #define C_IN            1               /* the arpa internet */
 149 #define C_CHAOS         3               /* for chaos net (MIT) */
 150 #define C_HS            4               /* for Hesiod name server (MIT) (XXX) */
 151         /* Query class values which do not appear in resource records */
 152 #define C_ANY           255             /* wildcard match */
 153
 154 /*
 155  * Status return codes for T_UNSPEC conversion routines
 156  */
 157 #define CONV_SUCCESS 0
 158 #define CONV_OVERFLOW -1
 159 #define CONV_BADFMT -2
 160 #define CONV_BADCKSUM -3
 161 #define CONV_BADBUFLEN -4
 162
 163 /*
 164  * Structure for query header.
 165  */
 166 typedef struct {
 167         u_int16_t id;           /* query identification number */
 168         u_int8_t  flags1;       /* first byte of flags */
 169         u_int8_t  flags2;       /* second byte of flags */
 170         u_int16_t qdcount;      /* number of question entries */
 171         u_int16_t ancount;      /* number of answer entries */
 172         u_int16_t nscount;      /* number of authority entries */
 173         u_int16_t arcount;      /* number of resource entries */
 174 } HEADER;
 175
 176 /*
 177  * Macros for subfields of flag fields.
 178  */
 179 #define DNS_QR(np)      ((np)->flags1 & 0x80)           /* response flag */
 180 #define DNS_OPCODE(np)  ((((np)->flags1) >> 3) & 0xF)   /* purpose of message */
 181 #define DNS_AA(np)      ((np)->flags1 & 0x04)           /* authoritative answer */
 182 #define DNS_TC(np)      ((np)->flags1 & 0x02)           /* truncated message */
 183 #define DNS_RD(np)      ((np)->flags1 & 0x01)           /* recursion desired */
 184
 185 #define DNS_RA(np)      ((np)->flags2 & 0x80)   /* recursion available */
 186 #define DNS_AD(np)      ((np)->flags2 & 0x20)   /* authentic data from named */
 187 #define DNS_CD(np)      ((np)->flags2 & 0x10)   /* checking disabled by resolver */
 188 #define DNS_RCODE(np)   ((np)->flags2 & 0xF)    /* response code */
 189
 190 /*
 191  * Defines for handling compressed domain names, EDNS0 labels, etc.
 192  */
 193 #define INDIR_MASK      0xc0    /* 11.... */
 194 #define EDNS0_MASK      0x40    /* 01.... */
 195 #  define EDNS0_ELT_BITLABEL 0x01
 196
 197 /*
 198  * Structure for passing resource records around.
 199  */
 200 struct rrec {
 201         int16_t r_zone;                 /* zone number */
 202         int16_t r_class;                /* class number */
 203         int16_t r_type;                 /* type number */
 204         u_int32_t       r_ttl;                  /* time to live */
 205         int     r_size;                 /* size of data area */
 206         char    *r_data;                /* pointer to data */
 207 };
 208
 209 /*
 210  * Inline versions of get/put short/long.  Pointer is advanced.
 211  * We also assume that a "u_int16_t" holds 2 "chars"
 212  * and that a "u_int32_t" holds 4 "chars".
 213  *
 214  * These macros demonstrate the property of C whereby it can be
 215  * portable or it can be elegant but never both.
 216  */
 217 #define GETSHORT(s, cp) { \
 218         register u_char *t_cp = (u_char *)(cp); \
 219         (s) = ((u_int16_t)t_cp[0] << 8) | (u_int16_t)t_cp[1]; \
 220         (cp) += 2; \
 221 }
 222
 223 #define GETLONG(l, cp) { \
 224         register u_char *t_cp = (u_char *)(cp); \
 225         (l) = (((u_int32_t)t_cp[0]) << 24) \
 226             | (((u_int32_t)t_cp[1]) << 16) \
 227             | (((u_int32_t)t_cp[2]) << 8) \
 228             | (((u_int32_t)t_cp[3])); \
 229         (cp) += 4; \
 230 }
 231
 232 #define PUTSHORT(s, cp) { \
 233         register u_int16_t t_s = (u_int16_t)(s); \
 234         register u_char *t_cp = (u_char *)(cp); \
 235         *t_cp++ = t_s >> 8; \
 236         *t_cp   = t_s; \
 237         (cp) += 2; \
 238 }
 239
 240 /*
 241  * Warning: PUTLONG --no-longer-- destroys its first argument.  if you
 242  * were depending on this "feature", you will lose.
 243  */
 244 #define PUTLONG(l, cp) { \
 245         register u_int32_t t_l = (u_int32_t)(l); \
 246         register u_char *t_cp = (u_char *)(cp); \
 247         *t_cp++ = t_l >> 24; \
 248         *t_cp++ = t_l >> 16; \
 249         *t_cp++ = t_l >> 8; \
 250         *t_cp   = t_l; \
 251         (cp) += 4; \
 252 }
 253
 254 #endif /* !_NAMESER_H_ */