[thirdparty/glibc.git] / resolv / arpa / nameser.h

/*
 * Copyright (c) 1983, 1989, 1993
 *    The 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.
 * 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.
 */

/*
 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
 * Copyright (c) 1996-1999 by Internet Software Consortium.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
 * SOFTWARE.
 */

/*
 *	$BINDId: nameser.h,v 8.37 2000/03/30 21:16:49 vixie Exp $
 */

#ifndef _ARPA_NAMESER_H_
#define _ARPA_NAMESER_H_

/*! \file */

#define BIND_4_COMPAT

#include <sys/param.h>
#include <sys/types.h>
#include <sys/cdefs.h>

/*%
 * Revision information.  This is the release date in YYYYMMDD format.
 * It can change every day so the right thing to do with it is use it
 * in preprocessor commands such as "#if (__NAMESER > 19931104)".  Do not
 * compare for equality; rather, use it to determine whether your libbind.a
 * contains a new enough lib/nameser/ to support the feature you need.
 */

#define __NAMESER	19991006	/*%< New interface version stamp. */
/*
 * Define constants based on RFC 883, RFC 1034, RFC 1035
 */
#define NS_PACKETSZ	512	/*%< default UDP packet size */
#define NS_MAXDNAME	1025	/*%< maximum domain name */
#define NS_MAXMSG	65535	/*%< maximum message size */
#define NS_MAXCDNAME	255	/*%< maximum compressed domain name */
#define NS_MAXLABEL	63	/*%< maximum length of domain label */
#define NS_HFIXEDSZ	12	/*%< #/bytes of fixed data in header */
#define NS_QFIXEDSZ	4	/*%< #/bytes of fixed data in query */
#define NS_RRFIXEDSZ	10	/*%< #/bytes of fixed data in r record */
#define NS_INT32SZ	4	/*%< #/bytes of data in a u_int32_t */
#define NS_INT16SZ	2	/*%< #/bytes of data in a u_int16_t */
#define NS_INT8SZ	1	/*%< #/bytes of data in a u_int8_t */
#define NS_INADDRSZ	4	/*%< IPv4 T_A */
#define NS_IN6ADDRSZ	16	/*%< IPv6 T_AAAA */
#define NS_CMPRSFLGS	0xc0	/*%< Flag bits indicating name compression. */
#define NS_DEFAULTPORT	53	/*%< For both TCP and UDP. */
/*
 * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
 * in synch with it.
 */
typedef enum __ns_sect {
	ns_s_qd = 0,		/*%< Query: Question. */
	ns_s_zn = 0,		/*%< Update: Zone. */
	ns_s_an = 1,		/*%< Query: Answer. */
	ns_s_pr = 1,		/*%< Update: Prerequisites. */
	ns_s_ns = 2,		/*%< Query: Name servers. */
	ns_s_ud = 2,		/*%< Update: Update. */
	ns_s_ar = 3,		/*%< Query|Update: Additional records. */
	ns_s_max = 4
} ns_sect;

/*%
 * This is a message handle.  It is caller allocated and has no dynamic data.
 * This structure is intended to be opaque to all but ns_parse.c, thus the
 * leading _'s on the member names.  Use the accessor functions, not the _'s.
 */
typedef struct __ns_msg {
	const u_char	*_msg, *_eom;
	u_int16_t	_id, _flags, _counts[ns_s_max];
	const u_char	*_sections[ns_s_max];
	ns_sect		_sect;
	int		_rrnum;
	const u_char	*_msg_ptr;
} ns_msg;

/* Private data structure - do not use from outside library. */
struct _ns_flagdata {  int mask, shift;  };
extern const struct _ns_flagdata _ns_flagdata[];

/* Accessor macros - this is part of the public interface. */

#define ns_msg_id(handle) ((handle)._id + 0)
#define ns_msg_base(handle) ((handle)._msg + 0)
#define ns_msg_end(handle) ((handle)._eom + 0)
#define ns_msg_size(handle) ((handle)._eom - (handle)._msg)
#define ns_msg_count(handle, section) ((handle)._counts[section] + 0)

/*%
 * This is a parsed record.  It is caller allocated and has no dynamic data.
 */
typedef	struct __ns_rr {
	char		name[NS_MAXDNAME];
	u_int16_t	type;
	u_int16_t	rr_class;
	u_int32_t	ttl;
	u_int16_t	rdlength;
	const u_char *	rdata;
} ns_rr;

/* Accessor macros - this is part of the public interface. */
#define ns_rr_name(rr)	(((rr).name[0] != '\0') ? (rr).name : ".")
#define ns_rr_type(rr)	((ns_type)((rr).type + 0))
#define ns_rr_class(rr)	((ns_class)((rr).rr_class + 0))
#define ns_rr_ttl(rr)	((rr).ttl + 0)
#define ns_rr_rdlen(rr)	((rr).rdlength + 0)
#define ns_rr_rdata(rr)	((rr).rdata + 0)

/*%
 * These don't have to be in the same order as in the packet flags word,
 * and they can even overlap in some cases, but they will need to be kept
 * in synch with ns_parse.c:ns_flagdata[].
 */
typedef enum __ns_flag {
	ns_f_qr,		/*%< Question/Response. */
	ns_f_opcode,		/*%< Operation code. */
	ns_f_aa,		/*%< Authoritative Answer. */
	ns_f_tc,		/*%< Truncation occurred. */
	ns_f_rd,		/*%< Recursion Desired. */
	ns_f_ra,		/*%< Recursion Available. */
	ns_f_z,			/*%< MBZ. */
	ns_f_ad,		/*%< Authentic Data (DNSSEC). */
	ns_f_cd,		/*%< Checking Disabled (DNSSEC). */
	ns_f_rcode,		/*%< Response code. */
	ns_f_max
} ns_flag;

/*%
 * Currently defined opcodes.
 */
typedef enum __ns_opcode {
	ns_o_query = 0,		/*%< Standard query. */
	ns_o_iquery = 1,	/*%< Inverse query (deprecated/unsupported). */
	ns_o_status = 2,	/*%< Name server status query (unsupported). */
				/* Opcode 3 is undefined/reserved. */
	ns_o_notify = 4,	/*%< Zone change notification. */
	ns_o_update = 5,	/*%< Zone update message. */
	ns_o_max = 6
} ns_opcode;

/*%
 * Currently defined response codes.
 */
typedef	enum __ns_rcode {
	ns_r_noerror = 0,	/*%< No error occurred. */
	ns_r_formerr = 1,	/*%< Format error. */
	ns_r_servfail = 2,	/*%< Server failure. */
	ns_r_nxdomain = 3,	/*%< Name error. */
	ns_r_notimpl = 4,	/*%< Unimplemented. */
	ns_r_refused = 5,	/*%< Operation refused. */
	/* these are for BIND_UPDATE */
	ns_r_yxdomain = 6,	/*%< Name exists */
	ns_r_yxrrset = 7,	/*%< RRset exists */
	ns_r_nxrrset = 8,	/*%< RRset does not exist */
	ns_r_notauth = 9,	/*%< Not authoritative for zone */
	ns_r_notzone = 10,	/*%< Zone of record different from zone section */
	ns_r_max = 11,
	/* The following are EDNS extended rcodes */
	ns_r_badvers = 16,
	/* The following are TSIG errors */
	ns_r_badsig = 16,
	ns_r_badkey = 17,
	ns_r_badtime = 18
} ns_rcode;

/* BIND_UPDATE */
typedef enum __ns_update_operation {
	ns_uop_delete = 0,
	ns_uop_add = 1,
	ns_uop_max = 2
} ns_update_operation;

/*%
 * This structure is used for TSIG authenticated messages
 */
struct ns_tsig_key {
        char name[NS_MAXDNAME], alg[NS_MAXDNAME];
        unsigned char *data;
        int len;
};
typedef struct ns_tsig_key ns_tsig_key;

/*%
 * This structure is used for TSIG authenticated TCP messages
 */
struct ns_tcp_tsig_state {
	int counter;
	struct dst_key *key;
	void *ctx;
	unsigned char sig[NS_PACKETSZ];
	int siglen;
};
typedef struct ns_tcp_tsig_state ns_tcp_tsig_state;

#define NS_TSIG_FUDGE 300
#define NS_TSIG_TCP_COUNT 100
#define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"

#define NS_TSIG_ERROR_NO_TSIG -10
#define NS_TSIG_ERROR_NO_SPACE -11
#define NS_TSIG_ERROR_FORMERR -12

/*%
 * Currently defined type values for resources and queries.
 */
typedef enum __ns_type {
	ns_t_invalid = 0,	/*%< Cookie. */
	ns_t_a = 1,		/*%< Host address. */
	ns_t_ns = 2,		/*%< Authoritative server. */
	ns_t_md = 3,		/*%< Mail destination. */
	ns_t_mf = 4,		/*%< Mail forwarder. */
	ns_t_cname = 5,		/*%< Canonical name. */
	ns_t_soa = 6,		/*%< Start of authority zone. */
	ns_t_mb = 7,		/*%< Mailbox domain name. */
	ns_t_mg = 8,		/*%< Mail group member. */
	ns_t_mr = 9,		/*%< Mail rename name. */
	ns_t_null = 10,		/*%< Null resource record. */
	ns_t_wks = 11,		/*%< Well known service. */
	ns_t_ptr = 12,		/*%< Domain name pointer. */
	ns_t_hinfo = 13,	/*%< Host information. */
	ns_t_minfo = 14,	/*%< Mailbox information. */
	ns_t_mx = 15,		/*%< Mail routing information. */
	ns_t_txt = 16,		/*%< Text strings. */
	ns_t_rp = 17,		/*%< Responsible person. */
	ns_t_afsdb = 18,	/*%< AFS cell database. */
	ns_t_x25 = 19,		/*%< X_25 calling address. */
	ns_t_isdn = 20,		/*%< ISDN calling address. */
	ns_t_rt = 21,		/*%< Router. */
	ns_t_nsap = 22,		/*%< NSAP address. */
	ns_t_nsap_ptr = 23,	/*%< Reverse NSAP lookup (deprecated). */
	ns_t_sig = 24,		/*%< Security signature. */
	ns_t_key = 25,		/*%< Security key. */
	ns_t_px = 26,		/*%< X.400 mail mapping. */
	ns_t_gpos = 27,		/*%< Geographical position (withdrawn). */
	ns_t_aaaa = 28,		/*%< Ip6 Address. */
	ns_t_loc = 29,		/*%< Location Information. */
	ns_t_nxt = 30,		/*%< Next domain (security). */
	ns_t_eid = 31,		/*%< Endpoint identifier. */
	ns_t_nimloc = 32,	/*%< Nimrod Locator. */
	ns_t_srv = 33,		/*%< Server Selection. */
	ns_t_atma = 34,		/*%< ATM Address */
	ns_t_naptr = 35,	/*%< Naming Authority PoinTeR */
	ns_t_kx = 36,		/*%< Key Exchange */
	ns_t_cert = 37,		/*%< Certification record */
	ns_t_a6 = 38,		/*%< IPv6 address (deprecated, use ns_t_aaaa) */
	ns_t_dname = 39,	/*%< Non-terminal DNAME (for IPv6) */
	ns_t_sink = 40,		/*%< Kitchen sink (experimentatl) */
	ns_t_opt = 41,		/*%< EDNS0 option (meta-RR) */
	ns_t_apl = 42,		/*%< Address prefix list (RFC3123) */
	ns_t_tkey = 249,	/*%< Transaction key */
	ns_t_tsig = 250,	/*%< Transaction signature. */
	ns_t_ixfr = 251,	/*%< Incremental zone transfer. */
	ns_t_axfr = 252,	/*%< Transfer zone of authority. */
	ns_t_mailb = 253,	/*%< Transfer mailbox records. */
	ns_t_maila = 254,	/*%< Transfer mail agent records. */
	ns_t_any = 255,		/*%< Wildcard match. */
	ns_t_zxfr = 256,	/*%< BIND-specific, nonstandard. */
	ns_t_max = 65536
} ns_type;

/* Exclusively a QTYPE? (not also an RTYPE) */
#define	ns_t_qt_p(t) (ns_t_xfr_p(t) || (t) == ns_t_any || \
		      (t) == ns_t_mailb || (t) == ns_t_maila)
/* Some kind of meta-RR? (not a QTYPE, but also not an RTYPE) */
#define	ns_t_mrr_p(t) ((t) == ns_t_tsig || (t) == ns_t_opt)
/* Exclusively an RTYPE? (not also a QTYPE or a meta-RR) */
#define ns_t_rr_p(t) (!ns_t_qt_p(t) && !ns_t_mrr_p(t))
#define ns_t_udp_p(t) ((t) != ns_t_axfr && (t) != ns_t_zxfr)
#define ns_t_xfr_p(t) ((t) == ns_t_axfr || (t) == ns_t_ixfr || \
		       (t) == ns_t_zxfr)

/*%
 * Values for class field
 */
typedef enum __ns_class {
	ns_c_invalid = 0,	/*%< Cookie. */
	ns_c_in = 1,		/*%< Internet. */
	ns_c_2 = 2,		/*%< unallocated/unsupported. */
	ns_c_chaos = 3,		/*%< MIT Chaos-net. */
	ns_c_hs = 4,		/*%< MIT Hesiod. */
	/* Query class values which do not appear in resource records */
	ns_c_none = 254,	/*%< for prereq. sections in update requests */
	ns_c_any = 255,		/*%< Wildcard match. */
	ns_c_max = 65536
} ns_class;

/* Certificate type values in CERT resource records.  */
typedef enum __ns_cert_types {
	cert_t_pkix = 1,	/*%< PKIX (X.509v3) */
	cert_t_spki = 2,	/*%< SPKI */
	cert_t_pgp  = 3,	/*%< PGP */
	cert_t_url  = 253,	/*%< URL private type */
	cert_t_oid  = 254	/*%< OID private type */
} ns_cert_types;

/*%
 * EDNS0 extended flags and option codes, host order.
 */
#define NS_OPT_DNSSEC_OK        0x8000U
#define NS_OPT_NSID		3

/*%
 * Inline versions of get/put short/long.  Pointer is advanced.
 */
#define NS_GET16(s, cp) do { \
	const u_char *t_cp = (const u_char *)(cp); \
	(s) = ((u_int16_t)t_cp[0] << 8) \
	    | ((u_int16_t)t_cp[1]) \
	    ; \
	(cp) += NS_INT16SZ; \
} while (0)

#define NS_GET32(l, cp) do { \
	const u_char *t_cp = (const u_char *)(cp); \
	(l) = ((u_int32_t)t_cp[0] << 24) \
	    | ((u_int32_t)t_cp[1] << 16) \
	    | ((u_int32_t)t_cp[2] << 8) \
	    | ((u_int32_t)t_cp[3]) \
	    ; \
	(cp) += NS_INT32SZ; \
} while (0)

#define NS_PUT16(s, cp) do { \
	u_int16_t t_s = (u_int16_t)(s); \
	u_char *t_cp = (u_char *)(cp); \
	*t_cp++ = t_s >> 8; \
	*t_cp   = t_s; \
	(cp) += NS_INT16SZ; \
} while (0)

#define NS_PUT32(l, cp) do { \
	u_int32_t t_l = (u_int32_t)(l); \
	u_char *t_cp = (u_char *)(cp); \
	*t_cp++ = t_l >> 24; \
	*t_cp++ = t_l >> 16; \
	*t_cp++ = t_l >> 8; \
	*t_cp   = t_l; \
	(cp) += NS_INT32SZ; \
} while (0)

__BEGIN_DECLS
int		ns_msg_getflag (ns_msg, int) __THROW;
u_int		ns_get16 (const u_char *) __THROW;
u_long		ns_get32 (const u_char *) __THROW;
void		ns_put16 (u_int, u_char *) __THROW;
void		ns_put32 (u_long, u_char *) __THROW;
int		ns_initparse (const u_char *, int, ns_msg *) __THROW;
int		ns_skiprr (const u_char *, const u_char *, ns_sect, int)
     __THROW;
int		ns_parserr (ns_msg *, ns_sect, int, ns_rr *) __THROW;
int		ns_sprintrr (const ns_msg *, const ns_rr *,
			     const char *, const char *, char *, size_t)
     __THROW;
int		ns_sprintrrf (const u_char *, size_t, const char *,
			      ns_class, ns_type, u_long, const u_char *,
			      size_t, const char *, const char *,
			      char *, size_t) __THROW;
int		ns_format_ttl (u_long, char *, size_t) __THROW;
int		ns_parse_ttl (const char *, u_long *) __THROW;
u_int32_t	ns_datetosecs (const char *, int *) __THROW;
int		ns_name_ntol (const u_char *, u_char *, size_t) __THROW;
int		ns_name_ntop (const u_char *, char *, size_t) __THROW;
int		ns_name_pton (const char *, u_char *, size_t) __THROW;
int		ns_name_unpack (const u_char *, const u_char *,
				const u_char *, u_char *, size_t) __THROW;
int		ns_name_pack (const u_char *, u_char *, int,
			      const u_char **, const u_char **) __THROW;
int		ns_name_uncompress (const u_char *, const u_char *,
				    const u_char *, char *, size_t) __THROW;
int		ns_name_compress (const char *, u_char *, size_t,
				  const u_char **, const u_char **) __THROW;
int		ns_name_skip (const u_char **, const u_char *) __THROW;
void		ns_name_rollback (const u_char *, const u_char **,
				  const u_char **) __THROW;
int		ns_samedomain (const char *, const char *) __THROW;
int		ns_subdomain (const char *, const char *) __THROW;
int		ns_makecanon (const char *, char *, size_t) __THROW;
int		ns_samename (const char *, const char *) __THROW;
__END_DECLS

#ifdef BIND_4_COMPAT
#include <arpa/nameser_compat.h>
#endif

#endif /* !_ARPA_NAMESER_H_ */
/*! \file */
Commit	Line	Data
28f540f4	1	/*
28f540f4 RM	2	* Copyright (c) 1983, 1989, 1993
28f540f4 RM	3	* The Regents of the University of California. All rights reserved.
79937577	4	*
28f540f4 RM	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.
28f540f4 RM	13	* 4. Neither the name of the University nor the names of its contributors
	14	* may be used to endorse or promote products derived from this software
	15	* without specific prior written permission.
79937577	16	*
28f540f4 RM	17	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	18	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	19	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	20	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	21	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	22	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	23	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	24	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	25	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	26	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	27	* SUCH DAMAGE.
b43b13ac UD	28	*/
	29
	30	/*
cd5743fd	31	* Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
b43b13ac	32	* Copyright (c) 1996-1999 by Internet Software Consortium.
fa0bc87c	33	*
28f540f4 RM	34	* Permission to use, copy, modify, and distribute this software for any
28f540f4 RM	35	* purpose with or without fee is hereby granted, provided that the above
b43b13ac	36	* copyright notice and this permission notice appear in all copies.
fa0bc87c	37	*
b43b13ac UD	38	* THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
	39	* ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
	40	* OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
	41	* CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
28f540f4 RM	42	* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
	43	* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
	44	* ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
	45	* SOFTWARE.
28f540f4 RM	46	*/
	47
	48	/*
e685e07d	49	* $BINDId: nameser.h,v 8.37 2000/03/30 21:16:49 vixie Exp $
28f540f4 RM	50	*/
28f540f4 RM	51
b43b13ac UD	52	#ifndef _ARPA_NAMESER_H_
	53	#define _ARPA_NAMESER_H_
	54
cd5743fd UD	55	/! \file /
cd5743fd UD	56
b43b13ac	57	#define BIND_4_COMPAT
28f540f4 RM	58
28f540f4 RM	59	#include <sys/param.h>
c40226cb	60	#include <sys/types.h>
e685e07d	61	#include <sys/cdefs.h>
28f540f4	62
cd5743fd	63	/*%
b43b13ac UD	64	* Revision information. This is the release date in YYYYMMDD format.
	65	* It can change every day so the right thing to do with it is use it
	66	* in preprocessor commands such as "#if (__NAMESER > 19931104)". Do not
	67	* compare for equality; rather, use it to determine whether your libbind.a
	68	* contains a new enough lib/nameser/ to support the feature you need.
28f540f4 RM	69	*/
28f540f4 RM	70
cd5743fd	71	#define __NAMESER 19991006 /%< New interface version stamp. /
28f540f4	72	/*
b43b13ac	73	* Define constants based on RFC 883, RFC 1034, RFC 1035
28f540f4	74	*/
cd5743fd UD	75	#define NS_PACKETSZ 512 /%< default UDP packet size /
	76	#define NS_MAXDNAME 1025 /%< maximum domain name /
	77	#define NS_MAXMSG 65535 /%< maximum message size /
	78	#define NS_MAXCDNAME 255 /%< maximum compressed domain name /
	79	#define NS_MAXLABEL 63 /%< maximum length of domain label /
	80	#define NS_HFIXEDSZ 12 /%< #/bytes of fixed data in header /
	81	#define NS_QFIXEDSZ 4 /%< #/bytes of fixed data in query /
	82	#define NS_RRFIXEDSZ 10 /%< #/bytes of fixed data in r record /
	83	#define NS_INT32SZ 4 /%< #/bytes of data in a u_int32_t /
	84	#define NS_INT16SZ 2 /%< #/bytes of data in a u_int16_t /
	85	#define NS_INT8SZ 1 /%< #/bytes of data in a u_int8_t /
	86	#define NS_INADDRSZ 4 /%< IPv4 T_A /
	87	#define NS_IN6ADDRSZ 16 /%< IPv6 T_AAAA /
	88	#define NS_CMPRSFLGS 0xc0 /%< Flag bits indicating name compression. /
	89	#define NS_DEFAULTPORT 53 /%< For both TCP and UDP. /
28f540f4	90	/*
b43b13ac UD	91	* These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
b43b13ac UD	92	* in synch with it.
28f540f4	93	*/
b43b13ac	94	typedef enum __ns_sect {
cd5743fd UD	95	ns_s_qd = 0, /%< Query: Question. /
	96	ns_s_zn = 0, /%< Update: Zone. /
	97	ns_s_an = 1, /%< Query: Answer. /
	98	ns_s_pr = 1, /%< Update: Prerequisites. /
	99	ns_s_ns = 2, /%< Query: Name servers. /
	100	ns_s_ud = 2, /%< Update: Update. /
	101	ns_s_ar = 3, /%< Query\|Update: Additional records. /
b43b13ac UD	102	ns_s_max = 4
b43b13ac UD	103	} ns_sect;
28f540f4	104
cd5743fd	105	/*%
b43b13ac UD	106	* This is a message handle. It is caller allocated and has no dynamic data.
	107	* This structure is intended to be opaque to all but ns_parse.c, thus the
	108	* leading _'s on the member names. Use the accessor functions, not the _'s.
28f540f4	109	*/
b43b13ac UD	110	typedef struct __ns_msg {
	111	const u_char _msg, _eom;
	112	u_int16_t _id, _flags, _counts[ns_s_max];
	113	const u_char *_sections[ns_s_max];
	114	ns_sect _sect;
	115	int _rrnum;
cd5743fd	116	const u_char *_msg_ptr;
b43b13ac UD	117	} ns_msg;
	118
	119	/* Private data structure - do not use from outside library. */
	120	struct _ns_flagdata { int mask, shift; };
cd5743fd	121	extern const struct _ns_flagdata _ns_flagdata[];
b43b13ac UD	122
b43b13ac UD	123	/* Accessor macros - this is part of the public interface. */
cd5743fd	124
b43b13ac UD	125	#define ns_msg_id(handle) ((handle)._id + 0)
	126	#define ns_msg_base(handle) ((handle)._msg + 0)
	127	#define ns_msg_end(handle) ((handle)._eom + 0)
	128	#define ns_msg_size(handle) ((handle)._eom - (handle)._msg)
	129	#define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
	130
cd5743fd	131	/*%
b43b13ac	132	* This is a parsed record. It is caller allocated and has no dynamic data.
28f540f4	133	*/
b43b13ac UD	134	typedef struct __ns_rr {
	135	char name[NS_MAXDNAME];
	136	u_int16_t type;
	137	u_int16_t rr_class;
	138	u_int32_t ttl;
	139	u_int16_t rdlength;
	140	const u_char * rdata;
	141	} ns_rr;
	142
	143	/* Accessor macros - this is part of the public interface. */
	144	#define ns_rr_name(rr) (((rr).name[0] != '\0') ? (rr).name : ".")
	145	#define ns_rr_type(rr) ((ns_type)((rr).type + 0))
	146	#define ns_rr_class(rr) ((ns_class)((rr).rr_class + 0))
	147	#define ns_rr_ttl(rr) ((rr).ttl + 0)
	148	#define ns_rr_rdlen(rr) ((rr).rdlength + 0)
	149	#define ns_rr_rdata(rr) ((rr).rdata + 0)
28f540f4	150
cd5743fd	151	/*%
b43b13ac UD	152	* These don't have to be in the same order as in the packet flags word,
	153	* and they can even overlap in some cases, but they will need to be kept
	154	* in synch with ns_parse.c:ns_flagdata[].
28f540f4	155	*/
b43b13ac	156	typedef enum __ns_flag {
cd5743fd UD	157	ns_f_qr, /%< Question/Response. /
	158	ns_f_opcode, /%< Operation code. /
	159	ns_f_aa, /%< Authoritative Answer. /
	160	ns_f_tc, /%< Truncation occurred. /
	161	ns_f_rd, /%< Recursion Desired. /
	162	ns_f_ra, /%< Recursion Available. /
	163	ns_f_z, /%< MBZ. /
	164	ns_f_ad, /%< Authentic Data (DNSSEC). /
	165	ns_f_cd, /%< Checking Disabled (DNSSEC). /
	166	ns_f_rcode, /%< Response code. /
b43b13ac UD	167	ns_f_max
b43b13ac UD	168	} ns_flag;
28f540f4	169
cd5743fd	170	/*%
b43b13ac	171	* Currently defined opcodes.
28f540f4	172	*/
b43b13ac	173	typedef enum __ns_opcode {
cd5743fd UD	174	ns_o_query = 0, /%< Standard query. /
	175	ns_o_iquery = 1, /%< Inverse query (deprecated/unsupported). /
	176	ns_o_status = 2, /%< Name server status query (unsupported). /
b43b13ac	177	/* Opcode 3 is undefined/reserved. */
cd5743fd UD	178	ns_o_notify = 4, /%< Zone change notification. /
cd5743fd UD	179	ns_o_update = 5, /%< Zone update message. /
b43b13ac UD	180	ns_o_max = 6
b43b13ac UD	181	} ns_opcode;
28f540f4	182
cd5743fd	183	/*%
b43b13ac	184	* Currently defined response codes.
df21c858	185	*/
b43b13ac	186	typedef enum __ns_rcode {
cd5743fd UD	187	ns_r_noerror = 0, /%< No error occurred. /
	188	ns_r_formerr = 1, /%< Format error. /
	189	ns_r_servfail = 2, /%< Server failure. /
	190	ns_r_nxdomain = 3, /%< Name error. /
	191	ns_r_notimpl = 4, /%< Unimplemented. /
	192	ns_r_refused = 5, /%< Operation refused. /
b43b13ac	193	/* these are for BIND_UPDATE */
cd5743fd UD	194	ns_r_yxdomain = 6, /%< Name exists /
	195	ns_r_yxrrset = 7, /%< RRset exists /
	196	ns_r_nxrrset = 8, /%< RRset does not exist /
	197	ns_r_notauth = 9, /%< Not authoritative for zone /
	198	ns_r_notzone = 10, /%< Zone of record different from zone section /
b43b13ac	199	ns_r_max = 11,
cd5743fd UD	200	/* The following are EDNS extended rcodes */
	201	ns_r_badvers = 16,
	202	/* The following are TSIG errors */
b43b13ac UD	203	ns_r_badsig = 16,
	204	ns_r_badkey = 17,
	205	ns_r_badtime = 18
	206	} ns_rcode;
df21c858	207
b43b13ac UD	208	/* BIND_UPDATE */
	209	typedef enum __ns_update_operation {
	210	ns_uop_delete = 0,
	211	ns_uop_add = 1,
	212	ns_uop_max = 2
	213	} ns_update_operation;
df21c858	214
cd5743fd	215	/*%
b43b13ac UD	216	* This structure is used for TSIG authenticated messages
	217	*/
	218	struct ns_tsig_key {
	219	char name[NS_MAXDNAME], alg[NS_MAXDNAME];
	220	unsigned char *data;
	221	int len;
	222	};
	223	typedef struct ns_tsig_key ns_tsig_key;
df21c858	224
cd5743fd	225	/*%
b43b13ac	226	* This structure is used for TSIG authenticated TCP messages
28f540f4	227	*/
b43b13ac UD	228	struct ns_tcp_tsig_state {
	229	int counter;
	230	struct dst_key *key;
	231	void *ctx;
	232	unsigned char sig[NS_PACKETSZ];
	233	int siglen;
	234	};
	235	typedef struct ns_tcp_tsig_state ns_tcp_tsig_state;
28f540f4	236
b43b13ac UD	237	#define NS_TSIG_FUDGE 300
	238	#define NS_TSIG_TCP_COUNT 100
	239	#define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"
28f540f4	240
b43b13ac UD	241	#define NS_TSIG_ERROR_NO_TSIG -10
	242	#define NS_TSIG_ERROR_NO_SPACE -11
	243	#define NS_TSIG_ERROR_FORMERR -12
fa5ba5d9	244
cd5743fd	245	/*%
b43b13ac	246	* Currently defined type values for resources and queries.
28f540f4	247	*/
b43b13ac	248	typedef enum __ns_type {
cd5743fd UD	249	ns_t_invalid = 0, /%< Cookie. /
	250	ns_t_a = 1, /%< Host address. /
	251	ns_t_ns = 2, /%< Authoritative server. /
	252	ns_t_md = 3, /%< Mail destination. /
	253	ns_t_mf = 4, /%< Mail forwarder. /
	254	ns_t_cname = 5, /%< Canonical name. /
	255	ns_t_soa = 6, /%< Start of authority zone. /
	256	ns_t_mb = 7, /%< Mailbox domain name. /
	257	ns_t_mg = 8, /%< Mail group member. /
	258	ns_t_mr = 9, /%< Mail rename name. /
	259	ns_t_null = 10, /%< Null resource record. /
	260	ns_t_wks = 11, /%< Well known service. /
	261	ns_t_ptr = 12, /%< Domain name pointer. /
	262	ns_t_hinfo = 13, /%< Host information. /
	263	ns_t_minfo = 14, /%< Mailbox information. /
	264	ns_t_mx = 15, /%< Mail routing information. /
	265	ns_t_txt = 16, /%< Text strings. /
	266	ns_t_rp = 17, /%< Responsible person. /
	267	ns_t_afsdb = 18, /%< AFS cell database. /
	268	ns_t_x25 = 19, /%< X_25 calling address. /
	269	ns_t_isdn = 20, /%< ISDN calling address. /
	270	ns_t_rt = 21, /%< Router. /
	271	ns_t_nsap = 22, /%< NSAP address. /
	272	ns_t_nsap_ptr = 23, /%< Reverse NSAP lookup (deprecated). /
	273	ns_t_sig = 24, /%< Security signature. /
	274	ns_t_key = 25, /%< Security key. /
	275	ns_t_px = 26, /%< X.400 mail mapping. /
	276	ns_t_gpos = 27, /%< Geographical position (withdrawn). /
	277	ns_t_aaaa = 28, /%< Ip6 Address. /
	278	ns_t_loc = 29, /%< Location Information. /
	279	ns_t_nxt = 30, /%< Next domain (security). /
	280	ns_t_eid = 31, /%< Endpoint identifier. /
	281	ns_t_nimloc = 32, /%< Nimrod Locator. /
	282	ns_t_srv = 33, /%< Server Selection. /
	283	ns_t_atma = 34, /%< ATM Address /
	284	ns_t_naptr = 35, /%< Naming Authority PoinTeR /
	285	ns_t_kx = 36, /%< Key Exchange /
	286	ns_t_cert = 37, /%< Certification record /
	287	ns_t_a6 = 38, /%< IPv6 address (deprecated, use ns_t_aaaa) /
	288	ns_t_dname = 39, /%< Non-terminal DNAME (for IPv6) /
	289	ns_t_sink = 40, /%< Kitchen sink (experimentatl) /
	290	ns_t_opt = 41, /%< EDNS0 option (meta-RR) /
	291	ns_t_apl = 42, /%< Address prefix list (RFC3123) /
	292	ns_t_tkey = 249, /%< Transaction key /
	293	ns_t_tsig = 250, /%< Transaction signature. /
	294	ns_t_ixfr = 251, /%< Incremental zone transfer. /
	295	ns_t_axfr = 252, /%< Transfer zone of authority. /
	296	ns_t_mailb = 253, /%< Transfer mailbox records. /
	297	ns_t_maila = 254, /%< Transfer mail agent records. /
	298	ns_t_any = 255, /%< Wildcard match. /
	299	ns_t_zxfr = 256, /%< BIND-specific, nonstandard. /
b43b13ac UD	300	ns_t_max = 65536
b43b13ac UD	301	} ns_type;
28f540f4	302
b43b13ac UD	303	/* Exclusively a QTYPE? (not also an RTYPE) */
	304	#define ns_t_qt_p(t) (ns_t_xfr_p(t) \|\| (t) == ns_t_any \|\| \
	305	(t) == ns_t_mailb \|\| (t) == ns_t_maila)
	306	/* Some kind of meta-RR? (not a QTYPE, but also not an RTYPE) */
	307	#define ns_t_mrr_p(t) ((t) == ns_t_tsig \|\| (t) == ns_t_opt)
	308	/* Exclusively an RTYPE? (not also a QTYPE or a meta-RR) */
	309	#define ns_t_rr_p(t) (!ns_t_qt_p(t) && !ns_t_mrr_p(t))
	310	#define ns_t_udp_p(t) ((t) != ns_t_axfr && (t) != ns_t_zxfr)
	311	#define ns_t_xfr_p(t) ((t) == ns_t_axfr \|\| (t) == ns_t_ixfr \|\| \
	312	(t) == ns_t_zxfr)
28f540f4	313
cd5743fd	314	/*%
b43b13ac	315	* Values for class field
28f540f4	316	*/
b43b13ac	317	typedef enum __ns_class {
cd5743fd UD	318	ns_c_invalid = 0, /%< Cookie. /
	319	ns_c_in = 1, /%< Internet. /
	320	ns_c_2 = 2, /%< unallocated/unsupported. /
	321	ns_c_chaos = 3, /%< MIT Chaos-net. /
	322	ns_c_hs = 4, /%< MIT Hesiod. /
b43b13ac	323	/* Query class values which do not appear in resource records */
cd5743fd UD	324	ns_c_none = 254, /%< for prereq. sections in update requests /
cd5743fd UD	325	ns_c_any = 255, /%< Wildcard match. /
b43b13ac UD	326	ns_c_max = 65536
	327	} ns_class;
	328
3a2a1d2c	329	/* Certificate type values in CERT resource records. */
b43b13ac	330	typedef enum __ns_cert_types {
cd5743fd UD	331	cert_t_pkix = 1, /%< PKIX (X.509v3) /
	332	cert_t_spki = 2, /%< SPKI /
	333	cert_t_pgp = 3, /%< PGP /
	334	cert_t_url = 253, /%< URL private type /
	335	cert_t_oid = 254 /%< OID private type /
b43b13ac UD	336	} ns_cert_types;
b43b13ac UD	337
cd5743fd UD	338	/*%
cd5743fd UD	339	* EDNS0 extended flags and option codes, host order.
88f61aaf UD	340	*/
88f61aaf UD	341	#define NS_OPT_DNSSEC_OK 0x8000U
cd5743fd	342	#define NS_OPT_NSID 3
88f61aaf	343
cd5743fd	344	/*%
28f540f4	345	* Inline versions of get/put short/long. Pointer is advanced.
28f540f4	346	*/
b43b13ac	347	#define NS_GET16(s, cp) do { \
2e09a79a	348	const u_char t_cp = (const u_char )(cp); \
28f540f4 RM	349	(s) = ((u_int16_t)t_cp[0] << 8) \
	350	\| ((u_int16_t)t_cp[1]) \
	351	; \
b43b13ac UD	352	(cp) += NS_INT16SZ; \
b43b13ac UD	353	} while (0)
28f540f4	354
b43b13ac	355	#define NS_GET32(l, cp) do { \
2e09a79a	356	const u_char t_cp = (const u_char )(cp); \
28f540f4 RM	357	(l) = ((u_int32_t)t_cp[0] << 24) \
	358	\| ((u_int32_t)t_cp[1] << 16) \
	359	\| ((u_int32_t)t_cp[2] << 8) \
	360	\| ((u_int32_t)t_cp[3]) \
	361	; \
b43b13ac UD	362	(cp) += NS_INT32SZ; \
b43b13ac UD	363	} while (0)
28f540f4	364
b43b13ac	365	#define NS_PUT16(s, cp) do { \
2e09a79a JM	366	u_int16_t t_s = (u_int16_t)(s); \
2e09a79a JM	367	u_char t_cp = (u_char )(cp); \
28f540f4 RM	368	*t_cp++ = t_s >> 8; \
28f540f4 RM	369	*t_cp = t_s; \
b43b13ac UD	370	(cp) += NS_INT16SZ; \
b43b13ac UD	371	} while (0)
28f540f4	372
b43b13ac	373	#define NS_PUT32(l, cp) do { \
2e09a79a JM	374	u_int32_t t_l = (u_int32_t)(l); \
2e09a79a JM	375	u_char t_cp = (u_char )(cp); \
28f540f4 RM	376	*t_cp++ = t_l >> 24; \
	377	*t_cp++ = t_l >> 16; \
	378	*t_cp++ = t_l >> 8; \
	379	*t_cp = t_l; \
b43b13ac UD	380	(cp) += NS_INT32SZ; \
b43b13ac UD	381	} while (0)
28f540f4	382
b43b13ac	383	__BEGIN_DECLS
cd5743fd	384	int ns_msg_getflag (ns_msg, int) __THROW;
79937577 UD	385	u_int ns_get16 (const u_char *) __THROW;
	386	u_long ns_get32 (const u_char *) __THROW;
	387	void ns_put16 (u_int, u_char *) __THROW;
	388	void ns_put32 (u_long, u_char *) __THROW;
	389	int ns_initparse (const u_char , int, ns_msg ) __THROW;
	390	int ns_skiprr (const u_char , const u_char , ns_sect, int)
	391	__THROW;
	392	int ns_parserr (ns_msg , ns_sect, int, ns_rr ) __THROW;
	393	int ns_sprintrr (const ns_msg , const ns_rr ,
	394	const char , const char , char *, size_t)
	395	__THROW;
	396	int ns_sprintrrf (const u_char , size_t, const char ,
	397	ns_class, ns_type, u_long, const u_char *,
	398	size_t, const char , const char ,
	399	char *, size_t) __THROW;
	400	int ns_format_ttl (u_long, char *, size_t) __THROW;
	401	int ns_parse_ttl (const char , u_long ) __THROW;
d82a27f8	402	u_int32_t ns_datetosecs (const char , int ) __THROW;
79937577 UD	403	int ns_name_ntol (const u_char , u_char , size_t) __THROW;
	404	int ns_name_ntop (const u_char , char , size_t) __THROW;
	405	int ns_name_pton (const char , u_char , size_t) __THROW;
	406	int ns_name_unpack (const u_char , const u_char ,
	407	const u_char , u_char , size_t) __THROW;
	408	int ns_name_pack (const u_char , u_char , int,
	409	const u_char , const u_char ) __THROW;
	410	int ns_name_uncompress (const u_char , const u_char ,
	411	const u_char , char , size_t) __THROW;
	412	int ns_name_compress (const char , u_char , size_t,
	413	const u_char , const u_char ) __THROW;
	414	int ns_name_skip (const u_char *, const u_char ) __THROW;
	415	void ns_name_rollback (const u_char , const u_char *,
	416	const u_char **) __THROW;
79937577 UD	417	int ns_samedomain (const char , const char ) __THROW;
	418	int ns_subdomain (const char , const char ) __THROW;
	419	int ns_makecanon (const char , char , size_t) __THROW;
	420	int ns_samename (const char , const char ) __THROW;
fa5ba5d9 UD	421	__END_DECLS
fa5ba5d9 UD	422
b43b13ac UD	423	#ifdef BIND_4_COMPAT
	424	#include <arpa/nameser_compat.h>
	425	#endif
	426
	427	#endif /* !_ARPA_NAMESER_H_ */
cd5743fd	428	/! \file /