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