williamr@2: /* NAMESER.H
williamr@2:  * 
williamr@4:  * Portions Copyright (c) 1993-1999 Nokia Corporation and/or its subsidiary(-ies).
williamr@4:  * All rights reserved.
williamr@2:  */
williamr@2: 
williamr@2: /** @file
williamr@2: @publishedAll
williamr@2: @released
williamr@2: */
williamr@2: 
williamr@2: /*
williamr@2:  * Copyright (c) 1983, 1989, 1993
williamr@2:  *	The Regents of the University of California.  All rights reserved.
williamr@2:  *
williamr@2:  * Redistribution and use in source and binary forms, with or without
williamr@2:  * modification, are permitted provided that the following conditions
williamr@2:  * are met:
williamr@2:  * 1. Redistributions of source code must retain the above copyright
williamr@2:  *    notice, this list of conditions and the following disclaimer.
williamr@2:  * 2. Redistributions in binary form must reproduce the above copyright
williamr@2:  *    notice, this list of conditions and the following disclaimer in the
williamr@2:  *    documentation and/or other materials provided with the distribution.
williamr@2:  * 3. All advertising materials mentioning features or use of this software
williamr@2:  *    must display the following acknowledgement:
williamr@2:  *	This product includes software developed by the University of
williamr@2:  *	California, Berkeley and its contributors.
williamr@2:  * 4. Neither the name of the University nor the names of its contributors
williamr@2:  *    may be used to endorse or promote products derived from this software
williamr@2:  *    without specific prior written permission.
williamr@2:  *
williamr@2:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
williamr@2:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
williamr@2:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
williamr@2:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
williamr@2:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
williamr@2:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
williamr@2:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
williamr@2:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
williamr@2:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
williamr@2:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
williamr@2:  * SUCH DAMAGE.
williamr@2:  *
williamr@2:  * -
williamr@2:  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
williamr@2:  *
williamr@2:  * Permission to use, copy, modify, and distribute this software for any
williamr@2:  * purpose with or without fee is hereby granted, provided that the above
williamr@2:  * copyright notice and this permission notice appear in all copies, and that
williamr@2:  * the name of Digital Equipment Corporation not be used in advertising or
williamr@2:  * publicity pertaining to distribution of the document or software without
williamr@2:  * specific, written prior permission.
williamr@2:  *
williamr@2:  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
williamr@2:  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
williamr@2:  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
williamr@2:  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
williamr@2:  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
williamr@2:  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
williamr@2:  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
williamr@2:  * SOFTWARE.
williamr@2:  * -
williamr@2:  * Portions Copyright (c) 1995 by International Business Machines, Inc.
williamr@2:  *
williamr@2:  * International Business Machines, Inc. (hereinafter called IBM) grants
williamr@2:  * permission under its copyrights to use, copy, modify, and distribute this
williamr@2:  * Software with or without fee, provided that the above copyright notice and
williamr@2:  * all paragraphs of this notice appear in all copies, and that the name of IBM
williamr@2:  * not be used in connection with the marketing of any product incorporating
williamr@2:  * the Software or modifications thereof, without specific, written prior
williamr@2:  * permission.
williamr@2:  *
williamr@2:  * To the extent it has a right to do so, IBM grants an immunity from suit
williamr@2:  * under its patents, if any, for the use, sale or manufacture of products to
williamr@2:  * the extent that such products are used for performing Domain Name System
williamr@2:  * dynamic updates in TCP/IP networks by means of the Software.  No immunity is
williamr@2:  * granted for any product per se or for any other function of any product.
williamr@2:  * THE SOFTWARE IS PROVIDED "AS IS", AND IBM DISCLAIMS ALL WARRANTIES,
williamr@2:  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
williamr@2:  * PARTICULAR PURPOSE.  IN NO EVENT SHALL IBM BE LIABLE FOR ANY SPECIAL,
williamr@2:  * DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER ARISING
williamr@2:  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE, EVEN
williamr@2:  * IF IBM IS APPRISED OF THE POSSIBILITY OF SUCH DAMAGES.
williamr@2:  *
williamr@2:  *      @(#)nameser.h	8.2 (Berkeley) 2/16/94
williamr@2:  *	From Id: nameser.h,v 8.11 1996/10/08 04:51:02 vixie Exp
williamr@2:  *	$Id: nameser.h,v 1.11 1997/02/23 09:17:20 peter Exp $
williamr@2:  */
williamr@2: 
williamr@2: #ifndef _ARPA_NAMESER_H_
williamr@2: #define	_ARPA_NAMESER_H_
williamr@2: 
williamr@2: #ifdef __cplusplus
williamr@2: extern "C" {
williamr@2: #endif
williamr@2: 
williamr@2: #include <sys/param.h>
williamr@2: #include <sys/types.h>
williamr@2: 
williamr@2: /**
williamr@2: revision information.  this is the release date in YYYYMMDD format.
williamr@2: it can change every day so the right thing to do with it is use it
williamr@2: in preprocessor commands such as "#if (__BIND > 19931104)".  do not
williamr@2: compare for equality; rather, use it to determine whether your resolver
williamr@2: is new enough to contain a certain feature.
williamr@2: */
williamr@2: 
williamr@2: #define	__BIND		19960801	/* interface version stamp */
williamr@2: 
williamr@2: /**
williamr@2: Define constants based on rfc883
williamr@2: */
williamr@2: 
williamr@2: /** maximum packet size */
williamr@2: #define	PACKETSZ	512		
williamr@2: 
williamr@2: /** maximum presentation domain name */
williamr@2: #define MAXDNAME	1025		
williamr@2: 
williamr@2: /** maximum compressed domain name */
williamr@2: #define	MAXCDNAME	255		
williamr@2: 
williamr@2: /** maximum length of domain label */
williamr@2: #define	MAXLABEL	63		
williamr@2: 
williamr@2: /** #/bytes of fixed data in header */
williamr@2: #define	HFIXEDSZ	12		
williamr@2: 
williamr@2: /** #/bytes of fixed data in query */
williamr@2: #define	QFIXEDSZ	4		
williamr@2: 
williamr@2: /** #/bytes of fixed data in r record */
williamr@2: #define	RRFIXEDSZ	10		
williamr@2: 
williamr@2: /** for systems without 32-bit ints */
williamr@2: #define	INT32SZ		4		
williamr@2: 
williamr@2: /** for systems without 16-bit ints */
williamr@2: #define	INT16SZ		2		
williamr@2: 
williamr@2: /** IPv4 T_A */
williamr@2: #define INADDRSZ	4		
williamr@2: 
williamr@2: /** IPv6 T_AAAA */
williamr@2: #define IN6ADDRSZ	16		
williamr@2: 
williamr@2: /**
williamr@2: Internet nameserver port number
williamr@2: */
williamr@2: #define	NAMESERVER_PORT	53
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2: Currently defined opcodes
williamr@2: */
williamr@2: 
williamr@2: /** standard query */
williamr@2: #define	QUERY		0x0		
williamr@2: 
williamr@2: 	/** inverse query */
williamr@2: #define	IQUERY		0x1	
williamr@2: 
williamr@2: /** nameserver status query */
williamr@2: #define	STATUS		0x2		
williamr@2: 
williamr@2: /* 0x3 reserved */
williamr@2: /*#define xxx		0x3 */
williamr@2: #define	NS_NOTIFY_OP	0x4		/* notify secondary of SOA change */
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2: Currently defined response codes
williamr@2: */
williamr@2: 
williamr@2: /** no error */
williamr@2: #define	NOERROR		0	
williamr@2: 
williamr@2: /** format error */
williamr@2: #define	FORMERR		1		
williamr@2: 
williamr@2: /** server failure */
williamr@2: #define	SERVFAIL	2		
williamr@2: 
williamr@2: /** non existent domain */
williamr@2: #define	NXDOMAIN	3		
williamr@2: 
williamr@2: /** not implemented */
williamr@2: #define	NOTIMP		4		
williamr@2: 
williamr@2: /** query refused */
williamr@2: #define	REFUSED		5		
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2: Type values for resources and queries
williamr@2: */
williamr@2: 
williamr@2: /** host address */
williamr@2: #define	T_A		1		
williamr@2: 
williamr@2: /** authoritative server */
williamr@2: #define	T_NS		2		
williamr@2: 
williamr@2: /** mail destination */
williamr@2: #define	T_MD		3		
williamr@2: 
williamr@2: /** mail forwarder */
williamr@2: #define	T_MF		4	
williamr@2: 
williamr@2: /** canonical name */
williamr@2: #define T_CNAME		5		
williamr@2: 
williamr@2: /** start of authority zone */
williamr@2: #define	T_SOA		6		
williamr@2: 
williamr@2: /** mailbox domain name */
williamr@2: #define	T_MB		7		
williamr@2: 
williamr@2: /** mail group member */
williamr@2: #define	T_MG		8		
williamr@2: 
williamr@2: /** mail rename name */
williamr@2: #define	T_MR		9		
williamr@2: 
williamr@2: /** null resource record */
williamr@2: #define	T_NULL		10		
williamr@2: 
williamr@2: /** well known service */
williamr@2: #define	T_WKS		11		
williamr@2: 
williamr@2: /** domain name pointer */
williamr@2: #define	T_PTR		12		
williamr@2: 
williamr@2: /** host information */
williamr@2: #define	T_HINFO		13		
williamr@2: 
williamr@2: /** mailbox information */
williamr@2: #define	T_MINFO		14		
williamr@2: 
williamr@2: /** mail routing information */
williamr@2: #define	T_MX		15		
williamr@2: 
williamr@2: /** text strings */
williamr@2: #define	T_TXT		16		
williamr@2: 
williamr@2: /** responsible person */
williamr@2: #define	T_RP		17		
williamr@2: 
williamr@2: /** AFS cell database */
williamr@2: #define	T_AFSDB		18		
williamr@2: 
williamr@2: /** X_25 calling address */
williamr@2: #define	T_X25		19		
williamr@2: 
williamr@2: /** ISDN calling address */
williamr@2: #define	T_ISDN		20		
williamr@2: 
williamr@2: /** router */
williamr@2: #define	T_RT		21		
williamr@2: 
williamr@2: /** NSAP address */
williamr@2: #define	T_NSAP		22		
williamr@2: 
williamr@2: /** reverse NSAP lookup (deprecated) */
williamr@2: #define	T_NSAP_PTR	23		
williamr@2: 
williamr@2: /** security signature */
williamr@2: #define	T_SIG		24		
williamr@2: 
williamr@2: /** security key */
williamr@2: #define	T_KEY		25	
williamr@2: 
williamr@2: /** X.400 mail mapping */
williamr@2: #define	T_PX		26		
williamr@2: 
williamr@2: /** geographical position (withdrawn) */
williamr@2: #define	T_GPOS		27	
williamr@2: 
williamr@2: /** IP6 Address */
williamr@2: #define	T_AAAA		28		
williamr@2: 
williamr@2: /** Location Information */
williamr@2: #define	T_LOC		29		
williamr@2: 
williamr@2: /** Next Valid Name in Zone */
williamr@2: #define T_NXT		30		
williamr@2: 
williamr@2: /** Endpoint identifier */
williamr@2: #define T_EID		31		
williamr@2: 
williamr@2: /** Nimrod locator */
williamr@2: #define T_NIMLOC	32	
williamr@2: 
williamr@2: /** Server selection */
williamr@2: #define T_SRV		33		
williamr@2: 
williamr@2: /** ATM Address */
williamr@2: #define T_ATMA		34		
williamr@2: 
williamr@2: /** Naming Authority PoinTeR */
williamr@2: #define T_NAPTR		35		
williamr@2: 
williamr@2: /** user (finger) information
williamr@2: non standard 
williamr@2: */
williamr@2: #define	T_UINFO		100		
williamr@2: 
williamr@2: /** user ID */
williamr@2: #define	T_UID		101		
williamr@2: 
williamr@2: /** group ID */
williamr@2: #define	T_GID		102		
williamr@2: 
williamr@2: /** Unspecified format (binary data) */
williamr@2: #define	T_UNSPEC	103		
williamr@2: 
williamr@2: /** Query type values which do not appear in resource records
williamr@2: incremental zone transfer */
williamr@2: #define T_IXFR		251		
williamr@2: 
williamr@2: /** transfer zone of authority */
williamr@2: #define	T_AXFR		252		
williamr@2: 
williamr@2: /** transfer mailbox records */
williamr@2: #define	T_MAILB		253		
williamr@2: 
williamr@2: /** transfer mail agent records */
williamr@2: #define	T_MAILA		254		
williamr@2: 
williamr@2: /** wildcard match */
williamr@2: #define	T_ANY		255		
williamr@2: 
williamr@2: /**
williamr@2: Values for class field
williamr@2: */
williamr@2: #define	C_IN		1		/* the arpa internet */
williamr@2: #define	C_CHAOS		3		/* for chaos net (MIT) */
williamr@2: #define	C_HS		4		/* for Hesiod name server (MIT) (XXX) */
williamr@2: 	/* Query class values which do not appear in resource records */
williamr@2: #define	C_ANY		255		/* wildcard match */
williamr@2: 
williamr@2: /**
williamr@2: Flags field of the KEY RR rdata
williamr@2: */
williamr@2: #define	KEYFLAG_TYPEMASK	0xC000	/* Mask for "type" bits */
williamr@2: #define	KEYFLAG_TYPE_AUTH_CONF	0x0000	/* Key usable for both */
williamr@2: #define	KEYFLAG_TYPE_CONF_ONLY	0x8000	/* Key usable for confidentiality */
williamr@2: #define	KEYFLAG_TYPE_AUTH_ONLY	0x4000	/* Key usable for authentication */
williamr@2: #define	KEYFLAG_TYPE_NO_KEY	0xC000	/* No key usable for either; no key */
williamr@2: /** The type bits can also be interpreted independently, as single bits: */
williamr@2: #define	KEYFLAG_NO_AUTH		0x8000	/* Key not usable for authentication */
williamr@2: #define	KEYFLAG_NO_CONF		0x4000	/* Key not usable for confidentiality */
williamr@2: 
williamr@2: #define	KEYFLAG_EXPERIMENTAL	0x2000	/* Security is *mandatory* if bit=0 */
williamr@2: #define	KEYFLAG_RESERVED3	0x1000  /* reserved - must be zero */
williamr@2: #define	KEYFLAG_RESERVED4	0x0800  /* reserved - must be zero */
williamr@2: #define	KEYFLAG_USERACCOUNT	0x0400	/* key is assoc. with a user acct */
williamr@2: #define	KEYFLAG_ENTITY		0x0200	/* key is assoc. with entity eg host */
williamr@2: #define	KEYFLAG_ZONEKEY		0x0100	/* key is zone key for the zone named */
williamr@2: #define	KEYFLAG_IPSEC		0x0080  /* key is for IPSEC use (host or user)*/
williamr@2: #define	KEYFLAG_EMAIL		0x0040  /* key is for email (MIME security) */
williamr@2: #define	KEYFLAG_RESERVED10	0x0020  /* reserved - must be zero */
williamr@2: #define	KEYFLAG_RESERVED11	0x0010  /* reserved - must be zero */
williamr@2: #define	KEYFLAG_SIGNATORYMASK	0x000F	/* key can sign DNS RR's of same name */
williamr@2: 
williamr@2: #define  KEYFLAG_RESERVED_BITMASK ( KEYFLAG_RESERVED3 | \
williamr@2: 				    KEYFLAG_RESERVED4 | \
williamr@2: 				    KEYFLAG_RESERVED10| KEYFLAG_RESERVED11) 
williamr@2: 
williamr@2: /**
williamr@2: The Algorithm field of the KEY and SIG RR's is an integer, {1..254} 
williamr@2: */
williamr@2: #define	ALGORITHM_MD5RSA	1	/* MD5 with RSA */
williamr@2: #define	ALGORITHM_EXPIRE_ONLY	253	/* No alg, no security */
williamr@2: #define	ALGORITHM_PRIVATE_OID	254	/* Key begins with OID indicating alg */
williamr@2: 
williamr@2: /**
williamr@2: Signatures 
williamr@2: */
williamr@2: 					/** Size of a mod or exp in bits */
williamr@2: #define	MIN_MD5RSA_KEY_PART_BITS	 512
williamr@2: #define	MAX_MD5RSA_KEY_PART_BITS	2552
williamr@2: 					/** Total of binary mod and exp, bytes */
williamr@2: #define	MAX_MD5RSA_KEY_BYTES		((MAX_MD5RSA_KEY_PART_BITS+7/8)*2+3)
williamr@2: 					/** Max length of text sig block */
williamr@2: #define	MAX_KEY_BASE64			(((MAX_MD5RSA_KEY_BYTES+2)/3)*4)
williamr@2: 
williamr@2: /**
williamr@2: Status return codes for T_UNSPEC conversion routines
williamr@2: */
williamr@2: #define	CONV_SUCCESS	0
williamr@2: #define	CONV_OVERFLOW	(-1)
williamr@2: #define	CONV_BADFMT	(-2)
williamr@2: #define	CONV_BADCKSUM	(-3)
williamr@2: #define	CONV_BADBUFLEN	(-4)
williamr@2: 
williamr@2: /**
williamr@2: Structure for query header.  The order of the fields is machine- and
williamr@2: compiler-dependent, depending on the byte/bit order and the layout
williamr@2: of bit fields.  We use bit fields only in int variables, as this
williamr@2: is all ANSI requires.  This requires a somewhat confusing rearrangement.
williamr@2: EPOC32 is little-endian
williamr@2: */
williamr@2: typedef struct {
williamr@2: 	unsigned	id :16;		/* query identification number */
williamr@2: 			/* fields in third byte */
williamr@2: 	unsigned	rd :1;		/* recursion desired */
williamr@2: 	unsigned	tc :1;		/* truncated message */
williamr@2: 	unsigned	aa :1;		/* authoritative answer */
williamr@2: 	unsigned	opcode :4;	/* purpose of message */
williamr@2: 	unsigned	qr :1;		/* response flag */
williamr@2: 			/* fields in fourth byte */
williamr@2: 	unsigned	rcode :4;	/* response code */
williamr@2: 	unsigned	cd: 1;		/* checking disabled by resolver */
williamr@2: 	unsigned	ad: 1;		/* authentic data from named */
williamr@2: 	unsigned	unused :1;	/* unused bits (MBZ as of 4.9.3a3) */
williamr@2: 	unsigned	ra :1;		/* recursion available */
williamr@2: 			/* remaining bytes */
williamr@2: 	unsigned	qdcount :16;	/* number of question entries */
williamr@2: 	unsigned	ancount :16;	/* number of answer entries */
williamr@2: 	unsigned	nscount :16;	/* number of authority entries */
williamr@2: 	unsigned	arcount :16;	/* number of resource entries */
williamr@2: } HEADER;
williamr@2: 
williamr@2: /**
williamr@2: Defines for handling compressed domain names
williamr@2: */
williamr@2: #define	INDIR_MASK	0xc0
williamr@2: 
williamr@2: extern	u_int16_t	_getshort (const u_char *);
williamr@2: extern	u_int32_t	_getlong (const u_char *);
williamr@2: 
williamr@2: /**
williamr@2: Inline versions of get/put short/long.  Pointer is advanced.
williamr@2: 
williamr@2: These macros demonstrate the property of C whereby it can be
williamr@2: portable or it can be elegant but rarely both.
williamr@2: */
williamr@2: #define	GETSHORT(s, cp) { \
williamr@2: 	register u_char *t_cp = (u_char *)(cp); \
williamr@2: 	(s) = ((u_int16_t)t_cp[0] << 8) \
williamr@2: 	    | ((u_int16_t)t_cp[1]) \
williamr@2: 	    ; \
williamr@2: 	(cp) += INT16SZ; \
williamr@2: }
williamr@2: 
williamr@2: #define	GETLONG(l, cp) { \
williamr@2: 	register u_char *t_cp = (u_char *)(cp); \
williamr@2: 	(l) = ((u_int32_t)t_cp[0] << 24) \
williamr@2: 	    | ((u_int32_t)t_cp[1] << 16) \
williamr@2: 	    | ((u_int32_t)t_cp[2] << 8) \
williamr@2: 	    | ((u_int32_t)t_cp[3]) \
williamr@2: 	    ; \
williamr@2: 	(cp) += INT32SZ; \
williamr@2: }
williamr@2: 
williamr@2: #define	PUTSHORT(s, cp) { \
williamr@2: 	register u_int16_t t_s = (u_int16_t)(s); \
williamr@2: 	register u_char *t_cp = (u_char *)(cp); \
williamr@2: 	*t_cp++ = t_s >> 8; \
williamr@2: 	*t_cp   = t_s; \
williamr@2: 	(cp) += INT16SZ; \
williamr@2: }
williamr@2: 
williamr@2: #define	PUTLONG(l, cp) { \
williamr@2: 	register u_int32_t t_l = (u_int32_t)(l); \
williamr@2: 	register u_char *t_cp = (u_char *)(cp); \
williamr@2: 	*t_cp++ = t_l >> 24; \
williamr@2: 	*t_cp++ = t_l >> 16; \
williamr@2: 	*t_cp++ = t_l >> 8; \
williamr@2: 	*t_cp   = t_l; \
williamr@2: 	(cp) += INT32SZ; \
williamr@2: }
williamr@2: 
williamr@2: #ifdef __cplusplus
williamr@2: }
williamr@2: #endif
williamr@2: #endif /* !_ARPA_NAMESER_H_ */