Home | History | Annotate | Line # | Download | only in arpa
nameser.h revision 1.1.1.7
      1 /*	$NetBSD: nameser.h,v 1.1.1.7 2009/04/12 16:06:27 christos Exp $	*/
      2 
      3 /*
      4  * Portions Copyright (C) 2004, 2005, 2008, 2009  Internet Systems Consortium, Inc. ("ISC")
      5  * Portions Copyright (C) 1996-2003  Internet Software Consortium.
      6  *
      7  * Permission to use, copy, modify, and/or distribute this software for any
      8  * purpose with or without fee is hereby granted, provided that the above
      9  * copyright notice and this permission notice appear in all copies.
     10  *
     11  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
     12  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
     13  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
     14  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
     15  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
     16  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
     17  * PERFORMANCE OF THIS SOFTWARE.
     18  */
     19 
     20 /*
     21  * Copyright (c) 1983, 1989, 1993
     22  *    The Regents of the University of California.  All rights reserved.
     23  *
     24  * Redistribution and use in source and binary forms, with or without
     25  * modification, are permitted provided that the following conditions
     26  * are met:
     27  * 1. Redistributions of source code must retain the above copyright
     28  *    notice, this list of conditions and the following disclaimer.
     29  * 2. Redistributions in binary form must reproduce the above copyright
     30  *    notice, this list of conditions and the following disclaimer in the
     31  *    documentation and/or other materials provided with the distribution.
     32  * 3. All advertising materials mentioning features or use of this software
     33  *    must display the following acknowledgement:
     34  * 	This product includes software developed by the University of
     35  * 	California, Berkeley and its contributors.
     36  * 4. Neither the name of the University nor the names of its contributors
     37  *    may be used to endorse or promote products derived from this software
     38  *    without specific prior written permission.
     39  *
     40  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     50  * SUCH DAMAGE.
     51  */
     52 
     53 /*
     54  *	Id: nameser.h,v 1.16 2009/03/03 01:52:48 each Exp
     55  */
     56 
     57 #ifndef _ARPA_NAMESER_H_
     58 #define _ARPA_NAMESER_H_
     59 
     60 
     61 #define BIND_4_COMPAT
     62 
     63 #include <sys/param.h>
     64 #if (!defined(BSD)) || (BSD < 199306)
     65 # include <sys/bitypes.h>
     66 #else
     67 # include <sys/types.h>
     68 #endif
     69 #include <sys/cdefs.h>
     70 
     71 /*%
     72  * Revision information.  This is the release date in YYYYMMDD format.
     73  * It can change every day so the right thing to do with it is use it
     74  * in preprocessor commands such as "#if (__NAMESER > 19931104)".  Do not
     75  * compare for equality; rather, use it to determine whether your libbind.a
     76  * contains a new enough lib/nameser/ to support the feature you need.
     77  */
     78 
     79 #define __NAMESER	20090302	/*%< New interface version stamp. */
     80 /*
     81  * Define constants based on RFC0883, RFC1034, RFC 1035
     82  */
     83 #define NS_PACKETSZ	512	/*%< default UDP packet size */
     84 #define NS_MAXDNAME	1025	/*%< maximum domain name (presentation format)*/
     85 #define NS_MAXMSG	65535	/*%< maximum message size */
     86 #define NS_MAXCDNAME	255	/*%< maximum compressed domain name */
     87 #define NS_MAXLABEL	63	/*%< maximum length of domain label */
     88 #define NS_MAXLABELS	128	/*%< theoretical max #/labels per domain name */
     89 #define NS_MAXNNAME	256	/*%< maximum uncompressed (binary) domain name*/
     90 #define	NS_MAXPADDR	(sizeof "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff")
     91 #define NS_HFIXEDSZ	12	/*%< #/bytes of fixed data in header */
     92 #define NS_QFIXEDSZ	4	/*%< #/bytes of fixed data in query */
     93 #define NS_RRFIXEDSZ	10	/*%< #/bytes of fixed data in r record */
     94 #define NS_INT32SZ	4	/*%< #/bytes of data in a uint32_t */
     95 #define NS_INT16SZ	2	/*%< #/bytes of data in a uint16_t */
     96 #define NS_INT8SZ	1	/*%< #/bytes of data in a u_int8_t */
     97 #define NS_INADDRSZ	4	/*%< IPv4 T_A */
     98 #define NS_IN6ADDRSZ	16	/*%< IPv6 T_AAAA */
     99 #define NS_CMPRSFLGS	0xc0	/*%< Flag bits indicating name compression. */
    100 #define NS_DEFAULTPORT	53	/*%< For both TCP and UDP. */
    101 /*
    102  * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
    103  * in synch with it.
    104  */
    105 typedef enum __ns_sect {
    106 	ns_s_qd = 0,		/*%< Query: Question. */
    107 	ns_s_zn = 0,		/*%< Update: Zone. */
    108 	ns_s_an = 1,		/*%< Query: Answer. */
    109 	ns_s_pr = 1,		/*%< Update: Prerequisites. */
    110 	ns_s_ns = 2,		/*%< Query: Name servers. */
    111 	ns_s_ud = 2,		/*%< Update: Update. */
    112 	ns_s_ar = 3,		/*%< Query|Update: Additional records. */
    113 	ns_s_max = 4
    114 } ns_sect;
    115 
    116 /*%
    117  * Network name (compressed or not) type.  Equivilent to a pointer when used
    118  * in a function prototype.  Can be const'd.
    119  */
    120 typedef u_char ns_nname[NS_MAXNNAME];
    121 typedef const u_char *ns_nname_ct;
    122 typedef u_char *ns_nname_t;
    123 
    124 struct ns_namemap { ns_nname_ct base; int len; };
    125 typedef struct ns_namemap *ns_namemap_t;
    126 typedef const struct ns_namemap *ns_namemap_ct;
    127 
    128 /*%
    129  * This is a message handle.  It is caller allocated and has no dynamic data.
    130  * This structure is intended to be opaque to all but ns_parse.c, thus the
    131  * leading _'s on the member names.  Use the accessor functions, not the _'s.
    132  */
    133 typedef struct __ns_msg {
    134 	const u_char	*_msg, *_eom;
    135 	uint16_t	_id, _flags, _counts[ns_s_max];
    136 	const u_char	*_sections[ns_s_max];
    137 	ns_sect		_sect;
    138 	int		_rrnum;
    139 	const u_char	*_msg_ptr;
    140 } ns_msg;
    141 
    142 /*
    143  * This is a newmsg handle, used when constructing new messages with
    144  * ns_newmsg_init, et al.
    145  */
    146 struct ns_newmsg {
    147 	ns_msg		msg;
    148 	const u_char	*dnptrs[25];
    149 	const u_char	**lastdnptr;
    150 };
    151 typedef struct ns_newmsg ns_newmsg;
    152 
    153 /* Private data structure - do not use from outside library. */
    154 struct _ns_flagdata {  int mask, shift;  };
    155 extern struct _ns_flagdata _ns_flagdata[];
    156 
    157 /* Accessor macros - this is part of the public interface. */
    158 
    159 #define ns_msg_id(handle) ((handle)._id + 0)
    160 #define ns_msg_base(handle) ((handle)._msg + 0)
    161 #define ns_msg_end(handle) ((handle)._eom + 0)
    162 #define ns_msg_size(handle) ((handle)._eom - (handle)._msg)
    163 #define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
    164 
    165 /*%
    166  * This is a parsed record.  It is caller allocated and has no dynamic data.
    167  */
    168 typedef	struct __ns_rr {
    169 	char		name[NS_MAXDNAME];
    170 	uint16_t	type;
    171 	uint16_t	rr_class;
    172 	uint32_t	ttl;
    173 	uint16_t	rdlength;
    174 	const u_char *	rdata;
    175 } ns_rr;
    176 
    177 /*
    178  * Same thing, but using uncompressed network binary names, and real C types.
    179  */
    180 typedef	struct __ns_rr2 {
    181 	ns_nname	nname;
    182 	size_t		nnamel;
    183 	int		type;
    184 	int		rr_class;
    185 	u_int		ttl;
    186 	int		rdlength;
    187 	const u_char *	rdata;
    188 } ns_rr2;
    189 
    190 /* Accessor macros - this is part of the public interface. */
    191 #define ns_rr_name(rr)	(((rr).name[0] != '\0') ? (rr).name : ".")
    192 #define ns_rr_nname(rr)	((const ns_nname_t)(rr).nname)
    193 #define ns_rr_nnamel(rr) ((rr).nnamel + 0)
    194 #define ns_rr_type(rr)	((ns_type)((rr).type + 0))
    195 #define ns_rr_class(rr)	((ns_class)((rr).rr_class + 0))
    196 #define ns_rr_ttl(rr)	((rr).ttl + 0)
    197 #define ns_rr_rdlen(rr)	((rr).rdlength + 0)
    198 #define ns_rr_rdata(rr)	((rr).rdata + 0)
    199 
    200 /*%
    201  * These don't have to be in the same order as in the packet flags word,
    202  * and they can even overlap in some cases, but they will need to be kept
    203  * in synch with ns_parse.c:ns_flagdata[].
    204  */
    205 typedef enum __ns_flag {
    206 	ns_f_qr,		/*%< Question/Response. */
    207 	ns_f_opcode,		/*%< Operation code. */
    208 	ns_f_aa,		/*%< Authoritative Answer. */
    209 	ns_f_tc,		/*%< Truncation occurred. */
    210 	ns_f_rd,		/*%< Recursion Desired. */
    211 	ns_f_ra,		/*%< Recursion Available. */
    212 	ns_f_z,			/*%< MBZ. */
    213 	ns_f_ad,		/*%< Authentic Data (DNSSEC). */
    214 	ns_f_cd,		/*%< Checking Disabled (DNSSEC). */
    215 	ns_f_rcode,		/*%< Response code. */
    216 	ns_f_max
    217 } ns_flag;
    218 
    219 /*%
    220  * Currently defined opcodes.
    221  */
    222 typedef enum __ns_opcode {
    223 	ns_o_query = 0,		/*%< Standard query. */
    224 	ns_o_iquery = 1,	/*%< Inverse query (deprecated/unsupported). */
    225 	ns_o_status = 2,	/*%< Name server status query (unsupported). */
    226 				/* Opcode 3 is undefined/reserved. */
    227 	ns_o_notify = 4,	/*%< Zone change notification. */
    228 	ns_o_update = 5,	/*%< Zone update message. */
    229 	ns_o_max = 6
    230 } ns_opcode;
    231 
    232 /*%
    233  * Currently defined response codes.
    234  */
    235 typedef	enum __ns_rcode {
    236 	ns_r_noerror = 0,	/*%< No error occurred. */
    237 	ns_r_formerr = 1,	/*%< Format error. */
    238 	ns_r_servfail = 2,	/*%< Server failure. */
    239 	ns_r_nxdomain = 3,	/*%< Name error. */
    240 	ns_r_notimpl = 4,	/*%< Unimplemented. */
    241 	ns_r_refused = 5,	/*%< Operation refused. */
    242 	/* these are for BIND_UPDATE */
    243 	ns_r_yxdomain = 6,	/*%< Name exists */
    244 	ns_r_yxrrset = 7,	/*%< RRset exists */
    245 	ns_r_nxrrset = 8,	/*%< RRset does not exist */
    246 	ns_r_notauth = 9,	/*%< Not authoritative for zone */
    247 	ns_r_notzone = 10,	/*%< Zone of record different from zone section */
    248 	ns_r_max = 11,
    249 	/* The following are EDNS extended rcodes */
    250 	ns_r_badvers = 16,
    251 	/* The following are TSIG errors */
    252 	ns_r_badsig = 16,
    253 	ns_r_badkey = 17,
    254 	ns_r_badtime = 18
    255 } ns_rcode;
    256 
    257 /* BIND_UPDATE */
    258 typedef enum __ns_update_operation {
    259 	ns_uop_delete = 0,
    260 	ns_uop_add = 1,
    261 	ns_uop_max = 2
    262 } ns_update_operation;
    263 
    264 /*%
    265  * This structure is used for TSIG authenticated messages
    266  */
    267 struct ns_tsig_key {
    268 	char name[NS_MAXDNAME], alg[NS_MAXDNAME];
    269 	unsigned char *data;
    270 	int len;
    271 };
    272 typedef struct ns_tsig_key ns_tsig_key;
    273 
    274 /*%
    275  * This structure is used for TSIG authenticated TCP messages
    276  */
    277 struct ns_tcp_tsig_state {
    278 	int counter;
    279 	struct dst_key *key;
    280 	void *ctx;
    281 	unsigned char sig[NS_PACKETSZ];
    282 	int siglen;
    283 };
    284 typedef struct ns_tcp_tsig_state ns_tcp_tsig_state;
    285 
    286 #define NS_TSIG_FUDGE 300
    287 #define NS_TSIG_TCP_COUNT 100
    288 #define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"
    289 
    290 #define NS_TSIG_ERROR_NO_TSIG -10
    291 #define NS_TSIG_ERROR_NO_SPACE -11
    292 #define NS_TSIG_ERROR_FORMERR -12
    293 
    294 /*%
    295  * Currently defined type values for resources and queries.
    296  */
    297 typedef enum __ns_type {
    298 	ns_t_invalid = 0,	/*%< Cookie. */
    299 	ns_t_a = 1,		/*%< Host address. */
    300 	ns_t_ns = 2,		/*%< Authoritative server. */
    301 	ns_t_md = 3,		/*%< Mail destination. */
    302 	ns_t_mf = 4,		/*%< Mail forwarder. */
    303 	ns_t_cname = 5,		/*%< Canonical name. */
    304 	ns_t_soa = 6,		/*%< Start of authority zone. */
    305 	ns_t_mb = 7,		/*%< Mailbox domain name. */
    306 	ns_t_mg = 8,		/*%< Mail group member. */
    307 	ns_t_mr = 9,		/*%< Mail rename name. */
    308 	ns_t_null = 10,		/*%< Null resource record. */
    309 	ns_t_wks = 11,		/*%< Well known service. */
    310 	ns_t_ptr = 12,		/*%< Domain name pointer. */
    311 	ns_t_hinfo = 13,	/*%< Host information. */
    312 	ns_t_minfo = 14,	/*%< Mailbox information. */
    313 	ns_t_mx = 15,		/*%< Mail routing information. */
    314 	ns_t_txt = 16,		/*%< Text strings. */
    315 	ns_t_rp = 17,		/*%< Responsible person. */
    316 	ns_t_afsdb = 18,	/*%< AFS cell database. */
    317 	ns_t_x25 = 19,		/*%< X_25 calling address. */
    318 	ns_t_isdn = 20,		/*%< ISDN calling address. */
    319 	ns_t_rt = 21,		/*%< Router. */
    320 	ns_t_nsap = 22,		/*%< NSAP address. */
    321 	ns_t_nsap_ptr = 23,	/*%< Reverse NSAP lookup (deprecated). */
    322 	ns_t_sig = 24,		/*%< Security signature. */
    323 	ns_t_key = 25,		/*%< Security key. */
    324 	ns_t_px = 26,		/*%< X.400 mail mapping. */
    325 	ns_t_gpos = 27,		/*%< Geographical position (withdrawn). */
    326 	ns_t_aaaa = 28,		/*%< IPv6 Address. */
    327 	ns_t_loc = 29,		/*%< Location Information. */
    328 	ns_t_nxt = 30,		/*%< Next domain (security). */
    329 	ns_t_eid = 31,		/*%< Endpoint identifier. */
    330 	ns_t_nimloc = 32,	/*%< Nimrod Locator. */
    331 	ns_t_srv = 33,		/*%< Server Selection. */
    332 	ns_t_atma = 34,		/*%< ATM Address */
    333 	ns_t_naptr = 35,	/*%< Naming Authority PoinTeR */
    334 	ns_t_kx = 36,		/*%< Key Exchange */
    335 	ns_t_cert = 37,		/*%< Certification record */
    336 	ns_t_a6 = 38,		/*%< IPv6 address (experimental) */
    337 	ns_t_dname = 39,	/*%< Non-terminal DNAME */
    338 	ns_t_sink = 40,		/*%< Kitchen sink (experimentatl) */
    339 	ns_t_opt = 41,		/*%< EDNS0 option (meta-RR) */
    340 	ns_t_apl = 42,		/*%< Address prefix list (RFC3123) */
    341 	ns_t_ds = 43,		/*%< Delegation Signer */
    342 	ns_t_sshfp = 44,	/*%< SSH Fingerprint */
    343 	ns_t_ipseckey = 45,	/*%< IPSEC Key */
    344 	ns_t_rrsig = 46,	/*%< RRset Signature */
    345 	ns_t_nsec = 47,		/*%< Negative security */
    346 	ns_t_dnskey = 48,	/*%< DNS Key */
    347 	ns_t_dhcid = 49,	/*%< Dynamic host configuratin identifier */
    348 	ns_t_nsec3 = 50,	/*%< Negative security type 3 */
    349 	ns_t_nsec3param = 51,	/*%< Negative security type 3 parameters */
    350 	ns_t_hip = 55,		/*%< Host Identity Protocol */
    351 	ns_t_spf = 99,		/*%< Sender Policy Framework */
    352 	ns_t_tkey = 249,	/*%< Transaction key */
    353 	ns_t_tsig = 250,	/*%< Transaction signature. */
    354 	ns_t_ixfr = 251,	/*%< Incremental zone transfer. */
    355 	ns_t_axfr = 252,	/*%< Transfer zone of authority. */
    356 	ns_t_mailb = 253,	/*%< Transfer mailbox records. */
    357 	ns_t_maila = 254,	/*%< Transfer mail agent records. */
    358 	ns_t_any = 255,		/*%< Wildcard match. */
    359 	ns_t_zxfr = 256,	/*%< BIND-specific, nonstandard. */
    360 	ns_t_dlv = 32769,	/*%< DNSSEC look-aside validatation. */
    361 	ns_t_max = 65536
    362 } ns_type;
    363 
    364 /* Exclusively a QTYPE? (not also an RTYPE) */
    365 #define	ns_t_qt_p(t) (ns_t_xfr_p(t) || (t) == ns_t_any || \
    366 		      (t) == ns_t_mailb || (t) == ns_t_maila)
    367 /* Some kind of meta-RR? (not a QTYPE, but also not an RTYPE) */
    368 #define	ns_t_mrr_p(t) ((t) == ns_t_tsig || (t) == ns_t_opt)
    369 /* Exclusively an RTYPE? (not also a QTYPE or a meta-RR) */
    370 #define ns_t_rr_p(t) (!ns_t_qt_p(t) && !ns_t_mrr_p(t))
    371 #define ns_t_udp_p(t) ((t) != ns_t_axfr && (t) != ns_t_zxfr)
    372 #define ns_t_xfr_p(t) ((t) == ns_t_axfr || (t) == ns_t_ixfr || \
    373 		       (t) == ns_t_zxfr)
    374 
    375 /*%
    376  * Values for class field
    377  */
    378 typedef enum __ns_class {
    379 	ns_c_invalid = 0,	/*%< Cookie. */
    380 	ns_c_in = 1,		/*%< Internet. */
    381 	ns_c_2 = 2,		/*%< unallocated/unsupported. */
    382 	ns_c_chaos = 3,		/*%< MIT Chaos-net. */
    383 	ns_c_hs = 4,		/*%< MIT Hesiod. */
    384 	/* Query class values which do not appear in resource records */
    385 	ns_c_none = 254,	/*%< for prereq. sections in update requests */
    386 	ns_c_any = 255,		/*%< Wildcard match. */
    387 	ns_c_max = 65536
    388 } ns_class;
    389 
    390 /* DNSSEC constants. */
    391 
    392 typedef enum __ns_key_types {
    393 	ns_kt_rsa = 1,		/*%< key type RSA/MD5 */
    394 	ns_kt_dh  = 2,		/*%< Diffie Hellman */
    395 	ns_kt_dsa = 3,		/*%< Digital Signature Standard (MANDATORY) */
    396 	ns_kt_private = 254	/*%< Private key type starts with OID */
    397 } ns_key_types;
    398 
    399 typedef enum __ns_cert_types {
    400 	cert_t_pkix = 1,	/*%< PKIX (X.509v3) */
    401 	cert_t_spki = 2,	/*%< SPKI */
    402 	cert_t_pgp  = 3,	/*%< PGP */
    403 	cert_t_url  = 253,	/*%< URL private type */
    404 	cert_t_oid  = 254	/*%< OID private type */
    405 } ns_cert_types;
    406 
    407 /* Flags field of the KEY RR rdata. */
    408 #define	NS_KEY_TYPEMASK		0xC000	/*%< Mask for "type" bits */
    409 #define	NS_KEY_TYPE_AUTH_CONF	0x0000	/*%< Key usable for both */
    410 #define	NS_KEY_TYPE_CONF_ONLY	0x8000	/*%< Key usable for confidentiality */
    411 #define	NS_KEY_TYPE_AUTH_ONLY	0x4000	/*%< Key usable for authentication */
    412 #define	NS_KEY_TYPE_NO_KEY	0xC000	/*%< No key usable for either; no key */
    413 /* The type bits can also be interpreted independently, as single bits: */
    414 #define	NS_KEY_NO_AUTH		0x8000	/*%< Key unusable for authentication */
    415 #define	NS_KEY_NO_CONF		0x4000	/*%< Key unusable for confidentiality */
    416 #define	NS_KEY_RESERVED2	0x2000	/* Security is *mandatory* if bit=0 */
    417 #define	NS_KEY_EXTENDED_FLAGS	0x1000	/*%< reserved - must be zero */
    418 #define	NS_KEY_RESERVED4	0x0800  /*%< reserved - must be zero */
    419 #define	NS_KEY_RESERVED5	0x0400  /*%< reserved - must be zero */
    420 #define	NS_KEY_NAME_TYPE	0x0300	/*%< these bits determine the type */
    421 #define	NS_KEY_NAME_USER	0x0000	/*%< key is assoc. with user */
    422 #define	NS_KEY_NAME_ENTITY	0x0200	/*%< key is assoc. with entity eg host */
    423 #define	NS_KEY_NAME_ZONE	0x0100	/*%< key is zone key */
    424 #define	NS_KEY_NAME_RESERVED	0x0300	/*%< reserved meaning */
    425 #define	NS_KEY_RESERVED8	0x0080  /*%< reserved - must be zero */
    426 #define	NS_KEY_RESERVED9	0x0040  /*%< reserved - must be zero */
    427 #define	NS_KEY_RESERVED10	0x0020  /*%< reserved - must be zero */
    428 #define	NS_KEY_RESERVED11	0x0010  /*%< reserved - must be zero */
    429 #define	NS_KEY_SIGNATORYMASK	0x000F	/*%< key can sign RR's of same name */
    430 #define	NS_KEY_RESERVED_BITMASK ( NS_KEY_RESERVED2 | \
    431 				  NS_KEY_RESERVED4 | \
    432 				  NS_KEY_RESERVED5 | \
    433 				  NS_KEY_RESERVED8 | \
    434 				  NS_KEY_RESERVED9 | \
    435 				  NS_KEY_RESERVED10 | \
    436 				  NS_KEY_RESERVED11 )
    437 #define NS_KEY_RESERVED_BITMASK2 0xFFFF /*%< no bits defined here */
    438 /* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */
    439 #define	NS_ALG_MD5RSA		1	/*%< MD5 with RSA */
    440 #define	NS_ALG_DH               2	/*%< Diffie Hellman KEY */
    441 #define	NS_ALG_DSA              3	/*%< DSA KEY */
    442 #define	NS_ALG_DSS              NS_ALG_DSA
    443 #define	NS_ALG_EXPIRE_ONLY	253	/*%< No alg, no security */
    444 #define	NS_ALG_PRIVATE_OID	254	/*%< Key begins with OID giving alg */
    445 /* Protocol values  */
    446 /* value 0 is reserved */
    447 #define NS_KEY_PROT_TLS         1
    448 #define NS_KEY_PROT_EMAIL       2
    449 #define NS_KEY_PROT_DNSSEC      3
    450 #define NS_KEY_PROT_IPSEC       4
    451 #define NS_KEY_PROT_ANY		255
    452 
    453 /* Signatures */
    454 #define	NS_MD5RSA_MIN_BITS	 512	/*%< Size of a mod or exp in bits */
    455 #define	NS_MD5RSA_MAX_BITS	4096
    456 	/* Total of binary mod and exp */
    457 #define	NS_MD5RSA_MAX_BYTES	((NS_MD5RSA_MAX_BITS+7/8)*2+3)
    458 	/* Max length of text sig block */
    459 #define	NS_MD5RSA_MAX_BASE64	(((NS_MD5RSA_MAX_BYTES+2)/3)*4)
    460 #define NS_MD5RSA_MIN_SIZE	((NS_MD5RSA_MIN_BITS+7)/8)
    461 #define NS_MD5RSA_MAX_SIZE	((NS_MD5RSA_MAX_BITS+7)/8)
    462 
    463 #define NS_DSA_SIG_SIZE         41
    464 #define NS_DSA_MIN_SIZE         213
    465 #define NS_DSA_MAX_BYTES        405
    466 
    467 /* Offsets into SIG record rdata to find various values */
    468 #define	NS_SIG_TYPE	0	/*%< Type flags */
    469 #define	NS_SIG_ALG	2	/*%< Algorithm */
    470 #define	NS_SIG_LABELS	3	/*%< How many labels in name */
    471 #define	NS_SIG_OTTL	4	/*%< Original TTL */
    472 #define	NS_SIG_EXPIR	8	/*%< Expiration time */
    473 #define	NS_SIG_SIGNED	12	/*%< Signature time */
    474 #define	NS_SIG_FOOT	16	/*%< Key footprint */
    475 #define	NS_SIG_SIGNER	18	/*%< Domain name of who signed it */
    476 /* How RR types are represented as bit-flags in NXT records */
    477 #define	NS_NXT_BITS 8
    478 #define	NS_NXT_BIT_SET(  n,p) (p[(n)/NS_NXT_BITS] |=  (0x80>>((n)%NS_NXT_BITS)))
    479 #define	NS_NXT_BIT_CLEAR(n,p) (p[(n)/NS_NXT_BITS] &= ~(0x80>>((n)%NS_NXT_BITS)))
    480 #define	NS_NXT_BIT_ISSET(n,p) (p[(n)/NS_NXT_BITS] &   (0x80>>((n)%NS_NXT_BITS)))
    481 #define NS_NXT_MAX 127
    482 
    483 /*%
    484  * EDNS0 extended flags and option codes, host order.
    485  */
    486 #define NS_OPT_DNSSEC_OK	0x8000U
    487 #define NS_OPT_NSID             3
    488 
    489 /*%
    490  * Inline versions of get/put short/long.  Pointer is advanced.
    491  */
    492 #define NS_GET16(s, cp) do { \
    493 	register const u_char *t_cp = (const u_char *)(cp); \
    494 	(s) = ((uint16_t)t_cp[0] << 8) \
    495 	    | ((uint16_t)t_cp[1]) \
    496 	    ; \
    497 	(cp) += NS_INT16SZ; \
    498 } while (0)
    499 
    500 #define NS_GET32(l, cp) do { \
    501 	register const u_char *t_cp = (const u_char *)(cp); \
    502 	(l) = ((uint32_t)t_cp[0] << 24) \
    503 	    | ((uint32_t)t_cp[1] << 16) \
    504 	    | ((uint32_t)t_cp[2] << 8) \
    505 	    | ((uint32_t)t_cp[3]) \
    506 	    ; \
    507 	(cp) += NS_INT32SZ; \
    508 } while (0)
    509 
    510 #define NS_PUT16(s, cp) do { \
    511 	register uint16_t t_s = (uint16_t)(s); \
    512 	register u_char *t_cp = (u_char *)(cp); \
    513 	*t_cp++ = t_s >> 8; \
    514 	*t_cp   = t_s; \
    515 	(cp) += NS_INT16SZ; \
    516 } while (0)
    517 
    518 #define NS_PUT32(l, cp) do { \
    519 	register uint32_t t_l = (uint32_t)(l); \
    520 	register u_char *t_cp = (u_char *)(cp); \
    521 	*t_cp++ = t_l >> 24; \
    522 	*t_cp++ = t_l >> 16; \
    523 	*t_cp++ = t_l >> 8; \
    524 	*t_cp   = t_l; \
    525 	(cp) += NS_INT32SZ; \
    526 } while (0)
    527 
    528 /*%
    529  * ANSI C identifier hiding for bind's lib/nameser.
    530  */
    531 #define	ns_msg_getflag		__ns_msg_getflag
    532 #define ns_get16		__ns_get16
    533 #define ns_get32		__ns_get32
    534 #define ns_put16		__ns_put16
    535 #define ns_put32		__ns_put32
    536 #define ns_initparse		__ns_initparse
    537 #define ns_skiprr		__ns_skiprr
    538 #define ns_parserr		__ns_parserr
    539 #define ns_parserr2		__ns_parserr2
    540 #define	ns_sprintrr		__ns_sprintrr
    541 #define	ns_sprintrrf		__ns_sprintrrf
    542 #define	ns_format_ttl		__ns_format_ttl
    543 #define	ns_parse_ttl		__ns_parse_ttl
    544 #define ns_datetosecs		__ns_datetosecs
    545 #define	ns_name_ntol		__ns_name_ntol
    546 #define	ns_name_ntop		__ns_name_ntop
    547 #define	ns_name_pton		__ns_name_pton
    548 #define	ns_name_pton2		__ns_name_pton2
    549 #define	ns_name_unpack		__ns_name_unpack
    550 #define	ns_name_unpack2		__ns_name_unpack2
    551 #define	ns_name_pack		__ns_name_pack
    552 #define	ns_name_compress	__ns_name_compress
    553 #define	ns_name_uncompress	__ns_name_uncompress
    554 #define	ns_name_skip		__ns_name_skip
    555 #define	ns_name_rollback	__ns_name_rollback
    556 #define	ns_name_length		__ns_name_length
    557 #define	ns_name_eq		__ns_name_eq
    558 #define	ns_name_owned		__ns_name_owned
    559 #define	ns_name_map		__ns_name_map
    560 #define	ns_name_labels		__ns_name_labels
    561 #define	ns_sign			__ns_sign
    562 #define	ns_sign2		__ns_sign2
    563 #define	ns_sign_tcp		__ns_sign_tcp
    564 #define	ns_sign_tcp2		__ns_sign_tcp2
    565 #define	ns_sign_tcp_init	__ns_sign_tcp_init
    566 #define ns_find_tsig		__ns_find_tsig
    567 #define	ns_verify		__ns_verify
    568 #define	ns_verify_tcp		__ns_verify_tcp
    569 #define	ns_verify_tcp_init	__ns_verify_tcp_init
    570 #define	ns_samedomain		__ns_samedomain
    571 #define	ns_subdomain		__ns_subdomain
    572 #define	ns_makecanon		__ns_makecanon
    573 #define	ns_samename		__ns_samename
    574 #define	ns_newmsg_init		__ns_newmsg_init
    575 #define	ns_newmsg_copy		__ns_newmsg_copy
    576 #define	ns_newmsg_id		__ns_newmsg_id
    577 #define	ns_newmsg_flag		__ns_newmsg_flag
    578 #define	ns_newmsg_q		__ns_newmsg_q
    579 #define	ns_newmsg_rr		__ns_newmsg_rr
    580 #define	ns_newmsg_done		__ns_newmsg_done
    581 #define	ns_rdata_unpack		__ns_rdata_unpack
    582 #define	ns_rdata_equal		__ns_rdata_equal
    583 #define	ns_rdata_refers		__ns_rdata_refers
    584 
    585 __BEGIN_DECLS
    586 int		ns_msg_getflag(ns_msg, int);
    587 u_int		ns_get16(const u_char *);
    588 u_long		ns_get32(const u_char *);
    589 void		ns_put16(u_int, u_char *);
    590 void		ns_put32(u_long, u_char *);
    591 int		ns_initparse(const u_char *, int, ns_msg *);
    592 int		ns_skiprr(const u_char *, const u_char *, ns_sect, int);
    593 int		ns_parserr(ns_msg *, ns_sect, int, ns_rr *);
    594 int		ns_parserr2(ns_msg *, ns_sect, int, ns_rr2 *);
    595 int		ns_sprintrr(const ns_msg *, const ns_rr *,
    596 				 const char *, const char *, char *, size_t);
    597 int		ns_sprintrrf(const u_char *, size_t, const char *,
    598 				  ns_class, ns_type, u_long, const u_char *,
    599 				  size_t, const char *, const char *,
    600 				  char *, size_t);
    601 int		ns_format_ttl(u_long, char *, size_t);
    602 int		ns_parse_ttl(const char *, u_long *);
    603 uint32_t	ns_datetosecs(const char *cp, int *errp);
    604 int		ns_name_ntol(const u_char *, u_char *, size_t);
    605 int		ns_name_ntop(const u_char *, char *, size_t);
    606 int		ns_name_pton(const char *, u_char *, size_t);
    607 int		ns_name_pton2(const char *, u_char *, size_t, size_t *);
    608 int		ns_name_unpack(const u_char *, const u_char *,
    609 				    const u_char *, u_char *, size_t);
    610 int		ns_name_unpack2(const u_char *, const u_char *,
    611 				     const u_char *, u_char *, size_t,
    612 				     size_t *);
    613 int		ns_name_pack(const u_char *, u_char *, int,
    614 				  const u_char **, const u_char **);
    615 int		ns_name_uncompress(const u_char *, const u_char *,
    616 					const u_char *, char *, size_t);
    617 int		ns_name_compress(const char *, u_char *, size_t,
    618 				      const u_char **, const u_char **);
    619 int		ns_name_skip(const u_char **, const u_char *);
    620 void		ns_name_rollback(const u_char *, const u_char **,
    621 				      const u_char **);
    622 ssize_t		ns_name_length(ns_nname_ct, size_t);
    623 int		ns_name_eq(ns_nname_ct, size_t, ns_nname_ct, size_t);
    624 int		ns_name_owned(ns_namemap_ct, int, ns_namemap_ct, int);
    625 int		ns_name_map(ns_nname_ct, size_t, ns_namemap_t, int);
    626 int		ns_name_labels(ns_nname_ct, size_t);
    627 int		ns_sign(u_char *, int *, int, int, void *,
    628 			     const u_char *, int, u_char *, int *, time_t);
    629 int		ns_sign2(u_char *, int *, int, int, void *,
    630 			      const u_char *, int, u_char *, int *, time_t,
    631 			      u_char **, u_char **);
    632 int		ns_sign_tcp(u_char *, int *, int, int,
    633 				 ns_tcp_tsig_state *, int);
    634 int		ns_sign_tcp2(u_char *, int *, int, int,
    635 				  ns_tcp_tsig_state *, int,
    636 				  u_char **, u_char **);
    637 int		ns_sign_tcp_init(void *, const u_char *, int,
    638 					ns_tcp_tsig_state *);
    639 u_char		*ns_find_tsig(u_char *, u_char *);
    640 int		ns_verify(u_char *, int *, void *,
    641 			       const u_char *, int, u_char *, int *,
    642 			       time_t *, int);
    643 int		ns_verify_tcp(u_char *, int *, ns_tcp_tsig_state *, int);
    644 int		ns_verify_tcp_init(void *, const u_char *, int,
    645 					ns_tcp_tsig_state *);
    646 int		ns_samedomain(const char *, const char *);
    647 int		ns_subdomain(const char *, const char *);
    648 int		ns_makecanon(const char *, char *, size_t);
    649 int		ns_samename(const char *, const char *);
    650 int		ns_newmsg_init(u_char *buffer, size_t bufsiz, ns_newmsg *);
    651 int		ns_newmsg_copy(ns_newmsg *, ns_msg *);
    652 void		ns_newmsg_id(ns_newmsg *handle, uint16_t id);
    653 void		ns_newmsg_flag(ns_newmsg *handle, ns_flag flag, u_int value);
    654 int		ns_newmsg_q(ns_newmsg *handle, ns_nname_ct qname,
    655 			    ns_type qtype, ns_class qclass);
    656 int		ns_newmsg_rr(ns_newmsg *handle, ns_sect sect,
    657 			     ns_nname_ct name, ns_type type,
    658 			     ns_class rr_class, uint32_t ttl,
    659 			     uint16_t rdlen, const u_char *rdata);
    660 size_t		ns_newmsg_done(ns_newmsg *handle);
    661 ssize_t		ns_rdata_unpack(const u_char *, const u_char *, ns_type,
    662 				const u_char *, size_t, u_char *, size_t);
    663 int		ns_rdata_equal(ns_type,
    664 			       const u_char *, size_t,
    665 			       const u_char *, size_t);
    666 int		ns_rdata_refers(ns_type,
    667 				const u_char *, size_t,
    668 				const u_char *);
    669 __END_DECLS
    670 
    671 #ifdef BIND_4_COMPAT
    672 #include <arpa/nameser_compat.h>
    673 #endif
    674 
    675 #endif /* !_ARPA_NAMESER_H_ */
    676