Home | History | Annotate | Line # | Download | only in arpa
nameser.h revision 1.4 
      1 /*
      2  * Copyright (c) 1983, 1989 Regents of the University of California.
      3  * 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  *	from: @(#)nameser.h	5.25 (Berkeley) 4/3/91
     34  *	$Id: nameser.h,v 1.4 1993/10/27 00:10:40 mycroft Exp $
     35  */
     36 
     37 #ifndef _NAMESER_H_
     38 #define	_NAMESER_H_
     39 
     40 #include <machine/endian.h>
     41 
     42 /*
     43  * Define constants based on rfc883
     44  */
     45 #define PACKETSZ	512		/* maximum packet size */
     46 #define MAXDNAME	256		/* maximum domain name */
     47 #define MAXCDNAME	255		/* maximum compressed domain name */
     48 #define MAXLABEL	63		/* maximum length of domain label */
     49 	/* Number of bytes of fixed size data in query structure */
     50 #define QFIXEDSZ	4
     51 	/* number of bytes of fixed size data in resource record */
     52 #define RRFIXEDSZ	10
     53 
     54 /*
     55  * Internet nameserver port number
     56  */
     57 #define NAMESERVER_PORT	53
     58 
     59 /*
     60  * Currently defined opcodes
     61  */
     62 #define QUERY		0x0		/* standard query */
     63 #define IQUERY		0x1		/* inverse query */
     64 #define STATUS		0x2		/* nameserver status query */
     65 /*#define xxx		0x3		/* 0x3 reserved */
     66 	/* non standard */
     67 #define UPDATEA		0x9		/* add resource record */
     68 #define UPDATED		0xa		/* delete a specific resource record */
     69 #define UPDATEDA	0xb		/* delete all nemed resource record */
     70 #define UPDATEM		0xc		/* modify a specific resource record */
     71 #define UPDATEMA	0xd		/* modify all named resource record */
     72 
     73 #define ZONEINIT	0xe		/* initial zone transfer */
     74 #define ZONEREF		0xf		/* incremental zone referesh */
     75 
     76 /*
     77  * Currently defined response codes
     78  */
     79 #define NOERROR		0		/* no error */
     80 #define FORMERR		1		/* format error */
     81 #define SERVFAIL	2		/* server failure */
     82 #define NXDOMAIN	3		/* non existent domain */
     83 #define NOTIMP		4		/* not implemented */
     84 #define REFUSED		5		/* query refused */
     85 	/* non standard */
     86 #define NOCHANGE	0xf		/* update failed to change db */
     87 
     88 /*
     89  * Type values for resources and queries
     90  */
     91 #define T_A		1		/* host address */
     92 #define T_NS		2		/* authoritative server */
     93 #define T_MD		3		/* mail destination */
     94 #define T_MF		4		/* mail forwarder */
     95 #define T_CNAME		5		/* connonical name */
     96 #define T_SOA		6		/* start of authority zone */
     97 #define T_MB		7		/* mailbox domain name */
     98 #define T_MG		8		/* mail group member */
     99 #define T_MR		9		/* mail rename name */
    100 #define T_NULL		10		/* null resource record */
    101 #define T_WKS		11		/* well known service */
    102 #define T_PTR		12		/* domain name pointer */
    103 #define T_HINFO		13		/* host information */
    104 #define T_MINFO		14		/* mailbox information */
    105 #define T_MX		15		/* mail routing information */
    106 #define T_TXT		16		/* text strings */
    107 	/* non standard */
    108 #define T_UINFO		100		/* user (finger) information */
    109 #define T_UID		101		/* user ID */
    110 #define T_GID		102		/* group ID */
    111 #define T_UNSPEC	103		/* Unspecified format (binary data) */
    112 	/* Query type values which do not appear in resource records */
    113 #define T_AXFR		252		/* transfer zone of authority */
    114 #define T_MAILB		253		/* transfer mailbox records */
    115 #define T_MAILA		254		/* transfer mail agent records */
    116 #define T_ANY		255		/* wildcard match */
    117 
    118 /*
    119  * Values for class field
    120  */
    121 #define C_IN		1		/* the arpa internet */
    122 #define C_CHAOS		3		/* for chaos net at MIT */
    123 #define C_HS		4		/* for Hesiod name server at MIT */
    124 	/* Query class values which do not appear in resource records */
    125 #define C_ANY		255		/* wildcard match */
    126 
    127 /*
    128  * Status return codes for T_UNSPEC conversion routines
    129  */
    130 #define CONV_SUCCESS 0
    131 #define CONV_OVERFLOW -1
    132 #define CONV_BADFMT -2
    133 #define CONV_BADCKSUM -3
    134 #define CONV_BADBUFLEN -4
    135 
    136 /*
    137  * Structure for query header, the order of the fields is machine and
    138  * compiler dependent, in our case, the bits within a byte are assignd
    139  * least significant first, while the order of transmition is most
    140  * significant first.  This requires a somewhat confusing rearrangement.
    141  */
    142 typedef struct {
    143 	u_short	id;		/* query identification number */
    144 #if BYTE_ORDER == BIG_ENDIAN
    145 			/* fields in third byte */
    146 	u_char	qr:1;		/* response flag */
    147 	u_char	opcode:4;	/* purpose of message */
    148 	u_char	aa:1;		/* authoritive answer */
    149 	u_char	tc:1;		/* truncated message */
    150 	u_char	rd:1;		/* recursion desired */
    151 			/* fields in fourth byte */
    152 	u_char	ra:1;		/* recursion available */
    153 	u_char	pr:1;		/* primary server required (non standard) */
    154 	u_char	unused:2;	/* unused bits */
    155 	u_char	rcode:4;	/* response code */
    156 #endif
    157 #if BYTE_ORDER == LITTLE_ENDIAN || BYTE_ORDER == PDP_ENDIAN
    158 			/* fields in third byte */
    159 	u_char	rd:1;		/* recursion desired */
    160 	u_char	tc:1;		/* truncated message */
    161 	u_char	aa:1;		/* authoritive answer */
    162 	u_char	opcode:4;	/* purpose of message */
    163 	u_char	qr:1;		/* response flag */
    164 			/* fields in fourth byte */
    165 	u_char	rcode:4;	/* response code */
    166 	u_char	unused:2;	/* unused bits */
    167 	u_char	pr:1;		/* primary server required (non standard) */
    168 	u_char	ra:1;		/* recursion available */
    169 #endif
    170 			/* remaining bytes */
    171 	u_short	qdcount;	/* number of question entries */
    172 	u_short	ancount;	/* number of answer entries */
    173 	u_short	nscount;	/* number of authority entries */
    174 	u_short	arcount;	/* number of resource entries */
    175 } HEADER;
    176 
    177 /*
    178  * Defines for handling compressed domain names
    179  */
    180 #define INDIR_MASK	0xc0
    181 
    182 /*
    183  * Structure for passing resource records around.
    184  */
    185 struct rrec {
    186 	short	r_zone;			/* zone number */
    187 	short	r_class;		/* class number */
    188 	short	r_type;			/* type number */
    189 	u_long	r_ttl;			/* time to live */
    190 	int	r_size;			/* size of data area */
    191 	char	*r_data;		/* pointer to data */
    192 };
    193 
    194 extern	u_short	_getshort();
    195 extern	u_long	_getlong();
    196 
    197 /*
    198  * Inline versions of get/put short/long.
    199  * Pointer is advanced; we assume that both arguments
    200  * are lvalues and will already be in registers.
    201  * cp MUST be u_char *.
    202  */
    203 #define GETSHORT(s, cp) { \
    204 	(s) = *(cp)++ << 8; \
    205 	(s) |= *(cp)++; \
    206 }
    207 
    208 #define GETLONG(l, cp) { \
    209 	(l) = *(cp)++ << 8; \
    210 	(l) |= *(cp)++; (l) <<= 8; \
    211 	(l) |= *(cp)++; (l) <<= 8; \
    212 	(l) |= *(cp)++; \
    213 }
    214 
    215 
    216 #define PUTSHORT(s, cp) { \
    217 	*(cp)++ = (s) >> 8; \
    218 	*(cp)++ = (s); \
    219 }
    220 
    221 /*
    222  * Warning: PUTLONG destroys its first argument.
    223  */
    224 #define PUTLONG(l, cp) { \
    225 	(cp)[3] = l; \
    226 	(cp)[2] = (l >>= 8); \
    227 	(cp)[1] = (l >>= 8); \
    228 	(cp)[0] = l >> 8; \
    229 	(cp) += sizeof(u_long); \
    230 }
    231 
    232 #endif /* !_NAMESER_H_ */
    233