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