[unix-history] / include / arpa / nameser.h

/*
 * Copyright (c) 1983, 1989 Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)nameser.h	5.25 (Berkeley) 4/3/91
 */

#ifndef _NAMESER_H_
#define	_NAMESER_H_

#include <machine/endian.h>

/*
 * Define constants based on rfc883
 */
#define PACKETSZ	512		/* maximum packet size */
#define MAXDNAME	256		/* maximum domain name */
#define MAXCDNAME	255		/* maximum compressed domain name */
#define MAXLABEL	63		/* maximum length of domain label */
	/* Number of bytes of fixed size data in query structure */
#define QFIXEDSZ	4
	/* number of bytes of fixed size data in resource record */
#define RRFIXEDSZ	10

/*
 * Internet nameserver port number
 */
#define NAMESERVER_PORT	53

/*
 * Currently defined opcodes
 */
#define QUERY		0x0		/* standard query */
#define IQUERY		0x1		/* inverse query */
#define STATUS		0x2		/* nameserver status query */
/*#define xxx		0x3		/* 0x3 reserved */
	/* non standard */
#define UPDATEA		0x9		/* add resource record */
#define UPDATED		0xa		/* delete a specific resource record */
#define UPDATEDA	0xb		/* delete all nemed resource record */
#define UPDATEM		0xc		/* modify a specific resource record */
#define UPDATEMA	0xd		/* modify all named resource record */

#define ZONEINIT	0xe		/* initial zone transfer */
#define ZONEREF		0xf		/* incremental zone referesh */

/*
 * Currently defined response codes
 */
#define NOERROR		0		/* no error */
#define FORMERR		1		/* format error */
#define SERVFAIL	2		/* server failure */
#define NXDOMAIN	3		/* non existent domain */
#define NOTIMP		4		/* not implemented */
#define REFUSED		5		/* query refused */
	/* non standard */
#define NOCHANGE	0xf		/* update failed to change db */

/*
 * Type values for resources and queries
 */
#define T_A		1		/* host address */
#define T_NS		2		/* authoritative server */
#define T_MD		3		/* mail destination */
#define T_MF		4		/* mail forwarder */
#define T_CNAME		5		/* connonical name */
#define T_SOA		6		/* start of authority zone */
#define T_MB		7		/* mailbox domain name */
#define T_MG		8		/* mail group member */
#define T_MR		9		/* mail rename name */
#define T_NULL		10		/* null resource record */
#define T_WKS		11		/* well known service */
#define T_PTR		12		/* domain name pointer */
#define T_HINFO		13		/* host information */
#define T_MINFO		14		/* mailbox information */
#define T_MX		15		/* mail routing information */
#define T_TXT		16		/* text strings */
	/* non standard */
#define T_UINFO		100		/* user (finger) information */
#define T_UID		101		/* user ID */
#define T_GID		102		/* group ID */
#define T_UNSPEC	103		/* Unspecified format (binary data) */
#define T_UNSPECA	104		/* Unspecified format (ASCII) */
	/* Query type values which do not appear in resource records */
#define T_AXFR		252		/* transfer zone of authority */
#define T_MAILB		253		/* transfer mailbox records */
#define T_MAILA		254		/* transfer mail agent records */
#define T_ANY		255		/* wildcard match */

/*
 * Values for class field
 */

#define C_IN		1		/* the arpa internet */
#define C_CHAOS		3		/* for chaos net at MIT */
#define C_HS		4		/* for Hesiod name server at MIT */
	/* Query class values which do not appear in resource records */
#define C_ANY		255		/* wildcard match */

/*
 * Status return codes for T_UNSPEC conversion routines
 */
#define CONV_SUCCESS 0
#define CONV_OVERFLOW -1
#define CONV_BADFMT -2
#define CONV_BADCKSUM -3
#define CONV_BADBUFLEN -4

/*
 * Structure for query header, the order of the fields is machine and
 * compiler dependent, in our case, the bits within a byte are assignd 
 * least significant first, while the order of transmition is most 
 * significant first.  This requires a somewhat confusing rearrangement.
 */

typedef struct {
	u_short	id;		/* query identification number */
#if BYTE_ORDER == BIG_ENDIAN
			/* fields in third byte */
	u_char	qr:1;		/* response flag */
	u_char	opcode:4;	/* purpose of message */
	u_char	aa:1;		/* authoritive answer */
	u_char	tc:1;		/* truncated message */
	u_char	rd:1;		/* recursion desired */
			/* fields in fourth byte */
	u_char	ra:1;		/* recursion available */
	u_char	pr:1;		/* primary server required (non standard) */
	u_char	unused:2;	/* unused bits */
	u_char	rcode:4;	/* response code */
#endif
#if BYTE_ORDER == LITTLE_ENDIAN || BYTE_ORDER == PDP_ENDIAN
			/* fields in third byte */
	u_char	rd:1;		/* recursion desired */
	u_char	tc:1;		/* truncated message */
	u_char	aa:1;		/* authoritive answer */
	u_char	opcode:4;	/* purpose of message */
	u_char	qr:1;		/* response flag */
			/* fields in fourth byte */
	u_char	rcode:4;	/* response code */
	u_char	unused:2;	/* unused bits */
	u_char	pr:1;		/* primary server required (non standard) */
	u_char	ra:1;		/* recursion available */
#endif
			/* remaining bytes */
	u_short	qdcount;	/* number of question entries */
	u_short	ancount;	/* number of answer entries */
	u_short	nscount;	/* number of authority entries */
	u_short	arcount;	/* number of resource entries */
} HEADER;

/*
 * Defines for handling compressed domain names
 */
#define INDIR_MASK	0xc0

/*
 * Structure for passing resource records around.
 */
struct rrec {
	short	r_zone;			/* zone number */
	short	r_class;		/* class number */
	short	r_type;			/* type number */
	u_long	r_ttl;			/* time to live */
	int	r_size;			/* size of data area */
	char	*r_data;		/* pointer to data */
};

extern	u_short	_getshort();
extern	u_long	_getlong();

/*
 * Inline versions of get/put short/long.
 * Pointer is advanced; we assume that both arguments
 * are lvalues and will already be in registers.
 * cp MUST be u_char *.
 */
#define GETSHORT(s, cp) { \
	(s) = *(cp)++ << 8; \
	(s) |= *(cp)++; \
}

#define GETLONG(l, cp) { \
	(l) = *(cp)++ << 8; \
	(l) |= *(cp)++; (l) <<= 8; \
	(l) |= *(cp)++; (l) <<= 8; \
	(l) |= *(cp)++; \
}


#define PUTSHORT(s, cp) { \
	*(cp)++ = (s) >> 8; \
	*(cp)++ = (s); \
}

/*
 * Warning: PUTLONG destroys its first argument.
 */
#define PUTLONG(l, cp) { \
	(cp)[3] = l; \
	(cp)[2] = (l >>= 8); \
	(cp)[1] = (l >>= 8); \
	(cp)[0] = l >> 8; \
	(cp) += sizeof(u_long); \
}

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