nameser.h revision 186090
11539Srgrimes/*
21539Srgrimes * Copyright (c) 1983, 1989, 1993
336888Speter *    The Regents of the University of California.  All rights reserved.
436888Speter *
51539Srgrimes * Redistribution and use in source and binary forms, with or without
61539Srgrimes * modification, are permitted provided that the following conditions
71539Srgrimes * are met:
81539Srgrimes * 1. Redistributions of source code must retain the above copyright
91539Srgrimes *    notice, this list of conditions and the following disclaimer.
101539Srgrimes * 2. Redistributions in binary form must reproduce the above copyright
111539Srgrimes *    notice, this list of conditions and the following disclaimer in the
121539Srgrimes *    documentation and/or other materials provided with the distribution.
131539Srgrimes * 3. All advertising materials mentioning features or use of this software
141539Srgrimes *    must display the following acknowledgement:
1536888Speter * 	This product includes software developed by the University of
1636888Speter * 	California, Berkeley and its contributors.
171539Srgrimes * 4. Neither the name of the University nor the names of its contributors
181539Srgrimes *    may be used to endorse or promote products derived from this software
191539Srgrimes *    without specific prior written permission.
2036888Speter *
211539Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
221539Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
231539Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
241539Srgrimes * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
251539Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
261539Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
271539Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
281539Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
291539Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
301539Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
311539Srgrimes * SUCH DAMAGE.
3236888Speter */
3336888Speter
3436888Speter/*
35156960Sume * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
36156960Sume * Copyright (c) 1996-1999 by Internet Software Consortium.
371539Srgrimes *
381539Srgrimes * Permission to use, copy, modify, and distribute this software for any
391539Srgrimes * purpose with or without fee is hereby granted, provided that the above
4036888Speter * copyright notice and this permission notice appear in all copies.
418858Srgrimes *
42156960Sume * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
43156960Sume * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
44156960Sume * MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
45156960Sume * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
46156960Sume * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
47156960Sume * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
48156960Sume * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
4936888Speter */
5036888Speter
5136888Speter/*
52186090Sume *	$Id: nameser.h,v 1.7.18.2 2008/04/03 23:15:15 marka Exp $
5350473Speter * $FreeBSD: head/include/arpa/nameser.h 186090 2008-12-14 19:39:53Z ume $
541539Srgrimes */
551539Srgrimes
5610132Speter#ifndef _ARPA_NAMESER_H_
5736888Speter#define _ARPA_NAMESER_H_
581539Srgrimes
59170244Sume/*! \file */
60170244Sume
6136888Speter#define BIND_4_COMPAT
6236888Speter
63156960Sume#include <sys/param.h>
641539Srgrimes#include <sys/types.h>
653070Spst#include <sys/cdefs.h>
661539Srgrimes
67170244Sume/*%
68156960Sume * Revision information.  This is the release date in YYYYMMDD format.
69156960Sume * It can change every day so the right thing to do with it is use it
70156960Sume * in preprocessor commands such as "#if (__NAMESER > 19931104)".  Do not
71156960Sume * compare for equality; rather, use it to determine whether your libbind.a
72156960Sume * contains a new enough lib/nameser/ to support the feature you need.
733070Spst */
743070Spst
75170244Sume#define __NAMESER	19991006	/*%< New interface version stamp. */
763070Spst/*
77170244Sume * Define constants based on RFC0883, RFC1034, RFC 1035
781539Srgrimes */
79170244Sume#define NS_PACKETSZ	512	/*%< default UDP packet size */
80170244Sume#define NS_MAXDNAME	1025	/*%< maximum domain name */
81170244Sume#define NS_MAXMSG	65535	/*%< maximum message size */
82170244Sume#define NS_MAXCDNAME	255	/*%< maximum compressed domain name */
83170244Sume#define NS_MAXLABEL	63	/*%< maximum length of domain label */
84170244Sume#define NS_HFIXEDSZ	12	/*%< #/bytes of fixed data in header */
85170244Sume#define NS_QFIXEDSZ	4	/*%< #/bytes of fixed data in query */
86170244Sume#define NS_RRFIXEDSZ	10	/*%< #/bytes of fixed data in r record */
87170244Sume#define NS_INT32SZ	4	/*%< #/bytes of data in a u_int32_t */
88170244Sume#define NS_INT16SZ	2	/*%< #/bytes of data in a u_int16_t */
89170244Sume#define NS_INT8SZ	1	/*%< #/bytes of data in a u_int8_t */
90170244Sume#define NS_INADDRSZ	4	/*%< IPv4 T_A */
91170244Sume#define NS_IN6ADDRSZ	16	/*%< IPv6 T_AAAA */
92170244Sume#define NS_CMPRSFLGS	0xc0	/*%< Flag bits indicating name compression. */
93170244Sume#define NS_DEFAULTPORT	53	/*%< For both TCP and UDP. */
941539Srgrimes/*
9536888Speter * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
9636888Speter * in synch with it.
971539Srgrimes */
9836888Spetertypedef enum __ns_sect {
99170244Sume	ns_s_qd = 0,		/*%< Query: Question. */
100170244Sume	ns_s_zn = 0,		/*%< Update: Zone. */
101170244Sume	ns_s_an = 1,		/*%< Query: Answer. */
102170244Sume	ns_s_pr = 1,		/*%< Update: Prerequisites. */
103170244Sume	ns_s_ns = 2,		/*%< Query: Name servers. */
104170244Sume	ns_s_ud = 2,		/*%< Update: Update. */
105170244Sume	ns_s_ar = 3,		/*%< Query|Update: Additional records. */
10636888Speter	ns_s_max = 4
10736888Speter} ns_sect;
1081539Srgrimes
109170244Sume/*%
11036888Speter * This is a message handle.  It is caller allocated and has no dynamic data.
11136888Speter * This structure is intended to be opaque to all but ns_parse.c, thus the
11236888Speter * leading _'s on the member names.  Use the accessor functions, not the _'s.
1131539Srgrimes */
11436888Spetertypedef struct __ns_msg {
11536888Speter	const u_char	*_msg, *_eom;
11636888Speter	u_int16_t	_id, _flags, _counts[ns_s_max];
11736888Speter	const u_char	*_sections[ns_s_max];
11836888Speter	ns_sect		_sect;
11936888Speter	int		_rrnum;
120156960Sume	const u_char	*_msg_ptr;
12136888Speter} ns_msg;
12236888Speter
12336888Speter/* Private data structure - do not use from outside library. */
12436888Speterstruct _ns_flagdata {  int mask, shift;  };
12536888Speterextern struct _ns_flagdata _ns_flagdata[];
12636888Speter
12736888Speter/* Accessor macros - this is part of the public interface. */
128156960Sume
12936888Speter#define ns_msg_id(handle) ((handle)._id + 0)
13036888Speter#define ns_msg_base(handle) ((handle)._msg + 0)
13136888Speter#define ns_msg_end(handle) ((handle)._eom + 0)
13236888Speter#define ns_msg_size(handle) ((handle)._eom - (handle)._msg)
13336888Speter#define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
13436888Speter
135170244Sume/*%
13636888Speter * This is a parsed record.  It is caller allocated and has no dynamic data.
1371539Srgrimes */
13836888Spetertypedef	struct __ns_rr {
139156960Sume	char		name[NS_MAXDNAME];
14036888Speter	u_int16_t	type;
14147742Speter	u_int16_t	rr_class;
14236888Speter	u_int32_t	ttl;
14336888Speter	u_int16_t	rdlength;
144156960Sume	const u_char *	rdata;
14536888Speter} ns_rr;
1461539Srgrimes
14736888Speter/* Accessor macros - this is part of the public interface. */
14836888Speter#define ns_rr_name(rr)	(((rr).name[0] != '\0') ? (rr).name : ".")
149156960Sume#define ns_rr_type(rr)	((ns_type)((rr).type + 0))
150156960Sume#define ns_rr_class(rr)	((ns_class)((rr).rr_class + 0))
15136888Speter#define ns_rr_ttl(rr)	((rr).ttl + 0)
15236888Speter#define ns_rr_rdlen(rr)	((rr).rdlength + 0)
15336888Speter#define ns_rr_rdata(rr)	((rr).rdata + 0)
15436888Speter
155170244Sume/*%
15636888Speter * These don't have to be in the same order as in the packet flags word,
15736888Speter * and they can even overlap in some cases, but they will need to be kept
15836888Speter * in synch with ns_parse.c:ns_flagdata[].
1591539Srgrimes */
16036888Spetertypedef enum __ns_flag {
161170244Sume	ns_f_qr,		/*%< Question/Response. */
162170244Sume	ns_f_opcode,		/*%< Operation code. */
163170244Sume	ns_f_aa,		/*%< Authoritative Answer. */
164170244Sume	ns_f_tc,		/*%< Truncation occurred. */
165170244Sume	ns_f_rd,		/*%< Recursion Desired. */
166170244Sume	ns_f_ra,		/*%< Recursion Available. */
167170244Sume	ns_f_z,			/*%< MBZ. */
168170244Sume	ns_f_ad,		/*%< Authentic Data (DNSSEC). */
169170244Sume	ns_f_cd,		/*%< Checking Disabled (DNSSEC). */
170170244Sume	ns_f_rcode,		/*%< Response code. */
17136888Speter	ns_f_max
17236888Speter} ns_flag;
1731539Srgrimes
174170244Sume/*%
17536888Speter * Currently defined opcodes.
17636888Speter */
17736888Spetertypedef enum __ns_opcode {
178170244Sume	ns_o_query = 0,		/*%< Standard query. */
179170244Sume	ns_o_iquery = 1,	/*%< Inverse query (deprecated/unsupported). */
180170244Sume	ns_o_status = 2,	/*%< Name server status query (unsupported). */
18136888Speter				/* Opcode 3 is undefined/reserved. */
182170244Sume	ns_o_notify = 4,	/*%< Zone change notification. */
183170244Sume	ns_o_update = 5,	/*%< Zone update message. */
18436888Speter	ns_o_max = 6
18536888Speter} ns_opcode;
18636888Speter
187170244Sume/*%
18836888Speter * Currently defined response codes.
18936888Speter */
19036888Spetertypedef	enum __ns_rcode {
191170244Sume	ns_r_noerror = 0,	/*%< No error occurred. */
192170244Sume	ns_r_formerr = 1,	/*%< Format error. */
193170244Sume	ns_r_servfail = 2,	/*%< Server failure. */
194170244Sume	ns_r_nxdomain = 3,	/*%< Name error. */
195170244Sume	ns_r_notimpl = 4,	/*%< Unimplemented. */
196170244Sume	ns_r_refused = 5,	/*%< Operation refused. */
19736888Speter	/* these are for BIND_UPDATE */
198170244Sume	ns_r_yxdomain = 6,	/*%< Name exists */
199170244Sume	ns_r_yxrrset = 7,	/*%< RRset exists */
200170244Sume	ns_r_nxrrset = 8,	/*%< RRset does not exist */
201170244Sume	ns_r_notauth = 9,	/*%< Not authoritative for zone */
202170244Sume	ns_r_notzone = 10,	/*%< Zone of record different from zone section */
203156960Sume	ns_r_max = 11,
204156960Sume	/* The following are EDNS extended rcodes */
205156960Sume	ns_r_badvers = 16,
206156960Sume	/* The following are TSIG errors */
207156960Sume	ns_r_badsig = 16,
208156960Sume	ns_r_badkey = 17,
209156960Sume	ns_r_badtime = 18
21036888Speter} ns_rcode;
21136888Speter
21236888Speter/* BIND_UPDATE */
21336888Spetertypedef enum __ns_update_operation {
21436888Speter	ns_uop_delete = 0,
21536888Speter	ns_uop_add = 1,
21636888Speter	ns_uop_max = 2
21736888Speter} ns_update_operation;
21836888Speter
219170244Sume/*%
220156960Sume * This structure is used for TSIG authenticated messages
22136888Speter */
222156960Sumestruct ns_tsig_key {
223156960Sume        char name[NS_MAXDNAME], alg[NS_MAXDNAME];
224156960Sume        unsigned char *data;
225156960Sume        int len;
22636888Speter};
227156960Sumetypedef struct ns_tsig_key ns_tsig_key;
22836888Speter
229170244Sume/*%
230156960Sume * This structure is used for TSIG authenticated TCP messages
231156960Sume */
232156960Sumestruct ns_tcp_tsig_state {
233156960Sume	int counter;
234156960Sume	struct dst_key *key;
235156960Sume	void *ctx;
236156960Sume	unsigned char sig[NS_PACKETSZ];
237156960Sume	int siglen;
238156960Sume};
239156960Sumetypedef struct ns_tcp_tsig_state ns_tcp_tsig_state;
240156960Sume
241156960Sume#define NS_TSIG_FUDGE 300
242156960Sume#define NS_TSIG_TCP_COUNT 100
243156960Sume#define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"
244156960Sume
245156960Sume#define NS_TSIG_ERROR_NO_TSIG -10
246156960Sume#define NS_TSIG_ERROR_NO_SPACE -11
247156960Sume#define NS_TSIG_ERROR_FORMERR -12
248156960Sume
249170244Sume/*%
25036888Speter * Currently defined type values for resources and queries.
25136888Speter */
25236888Spetertypedef enum __ns_type {
253170244Sume	ns_t_invalid = 0,	/*%< Cookie. */
254170244Sume	ns_t_a = 1,		/*%< Host address. */
255170244Sume	ns_t_ns = 2,		/*%< Authoritative server. */
256170244Sume	ns_t_md = 3,		/*%< Mail destination. */
257170244Sume	ns_t_mf = 4,		/*%< Mail forwarder. */
258170244Sume	ns_t_cname = 5,		/*%< Canonical name. */
259170244Sume	ns_t_soa = 6,		/*%< Start of authority zone. */
260170244Sume	ns_t_mb = 7,		/*%< Mailbox domain name. */
261170244Sume	ns_t_mg = 8,		/*%< Mail group member. */
262170244Sume	ns_t_mr = 9,		/*%< Mail rename name. */
263170244Sume	ns_t_null = 10,		/*%< Null resource record. */
264170244Sume	ns_t_wks = 11,		/*%< Well known service. */
265170244Sume	ns_t_ptr = 12,		/*%< Domain name pointer. */
266170244Sume	ns_t_hinfo = 13,	/*%< Host information. */
267170244Sume	ns_t_minfo = 14,	/*%< Mailbox information. */
268170244Sume	ns_t_mx = 15,		/*%< Mail routing information. */
269170244Sume	ns_t_txt = 16,		/*%< Text strings. */
270170244Sume	ns_t_rp = 17,		/*%< Responsible person. */
271170244Sume	ns_t_afsdb = 18,	/*%< AFS cell database. */
272170244Sume	ns_t_x25 = 19,		/*%< X_25 calling address. */
273170244Sume	ns_t_isdn = 20,		/*%< ISDN calling address. */
274170244Sume	ns_t_rt = 21,		/*%< Router. */
275170244Sume	ns_t_nsap = 22,		/*%< NSAP address. */
276170244Sume	ns_t_nsap_ptr = 23,	/*%< Reverse NSAP lookup (deprecated). */
277170244Sume	ns_t_sig = 24,		/*%< Security signature. */
278170244Sume	ns_t_key = 25,		/*%< Security key. */
279170244Sume	ns_t_px = 26,		/*%< X.400 mail mapping. */
280170244Sume	ns_t_gpos = 27,		/*%< Geographical position (withdrawn). */
281170244Sume	ns_t_aaaa = 28,		/*%< Ip6 Address. */
282170244Sume	ns_t_loc = 29,		/*%< Location Information. */
283170244Sume	ns_t_nxt = 30,		/*%< Next domain (security). */
284170244Sume	ns_t_eid = 31,		/*%< Endpoint identifier. */
285170244Sume	ns_t_nimloc = 32,	/*%< Nimrod Locator. */
286170244Sume	ns_t_srv = 33,		/*%< Server Selection. */
287170244Sume	ns_t_atma = 34,		/*%< ATM Address */
288170244Sume	ns_t_naptr = 35,	/*%< Naming Authority PoinTeR */
289170244Sume	ns_t_kx = 36,		/*%< Key Exchange */
290170244Sume	ns_t_cert = 37,		/*%< Certification record */
291170244Sume	ns_t_a6 = 38,		/*%< IPv6 address (deprecates AAAA) */
292170244Sume	ns_t_dname = 39,	/*%< Non-terminal DNAME (for IPv6) */
293170244Sume	ns_t_sink = 40,		/*%< Kitchen sink (experimentatl) */
294170244Sume	ns_t_opt = 41,		/*%< EDNS0 option (meta-RR) */
295170244Sume	ns_t_apl = 42,		/*%< Address prefix list (RFC3123) */
296170244Sume	ns_t_tkey = 249,	/*%< Transaction key */
297170244Sume	ns_t_tsig = 250,	/*%< Transaction signature. */
298170244Sume	ns_t_ixfr = 251,	/*%< Incremental zone transfer. */
299170244Sume	ns_t_axfr = 252,	/*%< Transfer zone of authority. */
300170244Sume	ns_t_mailb = 253,	/*%< Transfer mailbox records. */
301170244Sume	ns_t_maila = 254,	/*%< Transfer mail agent records. */
302170244Sume	ns_t_any = 255,		/*%< Wildcard match. */
303170244Sume	ns_t_zxfr = 256,	/*%< BIND-specific, nonstandard. */
30436888Speter	ns_t_max = 65536
30536888Speter} ns_type;
30636888Speter
307156960Sume/* Exclusively a QTYPE? (not also an RTYPE) */
308156960Sume#define	ns_t_qt_p(t) (ns_t_xfr_p(t) || (t) == ns_t_any || \
309156960Sume		      (t) == ns_t_mailb || (t) == ns_t_maila)
310156960Sume/* Some kind of meta-RR? (not a QTYPE, but also not an RTYPE) */
311156960Sume#define	ns_t_mrr_p(t) ((t) == ns_t_tsig || (t) == ns_t_opt)
312156960Sume/* Exclusively an RTYPE? (not also a QTYPE or a meta-RR) */
313156960Sume#define ns_t_rr_p(t) (!ns_t_qt_p(t) && !ns_t_mrr_p(t))
314156960Sume#define ns_t_udp_p(t) ((t) != ns_t_axfr && (t) != ns_t_zxfr)
315156960Sume#define ns_t_xfr_p(t) ((t) == ns_t_axfr || (t) == ns_t_ixfr || \
316156960Sume		       (t) == ns_t_zxfr)
317156960Sume
318170244Sume/*%
3191539Srgrimes * Values for class field
3201539Srgrimes */
32136888Spetertypedef enum __ns_class {
322170244Sume	ns_c_invalid = 0,	/*%< Cookie. */
323170244Sume	ns_c_in = 1,		/*%< Internet. */
324170244Sume	ns_c_2 = 2,		/*%< unallocated/unsupported. */
325170244Sume	ns_c_chaos = 3,		/*%< MIT Chaos-net. */
326170244Sume	ns_c_hs = 4,		/*%< MIT Hesiod. */
3271539Srgrimes	/* Query class values which do not appear in resource records */
328170244Sume	ns_c_none = 254,	/*%< for prereq. sections in update requests */
329170244Sume	ns_c_any = 255,		/*%< Wildcard match. */
33036888Speter	ns_c_max = 65536
33136888Speter} ns_class;
3321539Srgrimes
333156960Sume/* DNSSEC constants. */
334156960Sume
335156960Sumetypedef enum __ns_key_types {
336170244Sume	ns_kt_rsa = 1,		/*%< key type RSA/MD5 */
337170244Sume	ns_kt_dh  = 2,		/*%< Diffie Hellman */
338170244Sume	ns_kt_dsa = 3,		/*%< Digital Signature Standard (MANDATORY) */
339170244Sume	ns_kt_private = 254	/*%< Private key type starts with OID */
340156960Sume} ns_key_types;
341156960Sume
342156960Sumetypedef enum __ns_cert_types {
343170244Sume	cert_t_pkix = 1,	/*%< PKIX (X.509v3) */
344170244Sume	cert_t_spki = 2,	/*%< SPKI */
345170244Sume	cert_t_pgp  = 3,	/*%< PGP */
346170244Sume	cert_t_url  = 253,	/*%< URL private type */
347170244Sume	cert_t_oid  = 254	/*%< OID private type */
348156960Sume} ns_cert_types;
349156960Sume
350156960Sume/* Flags field of the KEY RR rdata. */
351170244Sume#define	NS_KEY_TYPEMASK		0xC000	/*%< Mask for "type" bits */
352170244Sume#define	NS_KEY_TYPE_AUTH_CONF	0x0000	/*%< Key usable for both */
353170244Sume#define	NS_KEY_TYPE_CONF_ONLY	0x8000	/*%< Key usable for confidentiality */
354170244Sume#define	NS_KEY_TYPE_AUTH_ONLY	0x4000	/*%< Key usable for authentication */
355170244Sume#define	NS_KEY_TYPE_NO_KEY	0xC000	/*%< No key usable for either; no key */
35621056Speter/* The type bits can also be interpreted independently, as single bits: */
357170244Sume#define	NS_KEY_NO_AUTH		0x8000	/*%< Key unusable for authentication */
358170244Sume#define	NS_KEY_NO_CONF		0x4000	/*%< Key unusable for confidentiality */
359156960Sume#define	NS_KEY_RESERVED2	0x2000	/* Security is *mandatory* if bit=0 */
360170244Sume#define	NS_KEY_EXTENDED_FLAGS	0x1000	/*%< reserved - must be zero */
361170244Sume#define	NS_KEY_RESERVED4	0x0800  /*%< reserved - must be zero */
362170244Sume#define	NS_KEY_RESERVED5	0x0400  /*%< reserved - must be zero */
363170244Sume#define	NS_KEY_NAME_TYPE	0x0300	/*%< these bits determine the type */
364170244Sume#define	NS_KEY_NAME_USER	0x0000	/*%< key is assoc. with user */
365170244Sume#define	NS_KEY_NAME_ENTITY	0x0200	/*%< key is assoc. with entity eg host */
366170244Sume#define	NS_KEY_NAME_ZONE	0x0100	/*%< key is zone key */
367170244Sume#define	NS_KEY_NAME_RESERVED	0x0300	/*%< reserved meaning */
368170244Sume#define	NS_KEY_RESERVED8	0x0080  /*%< reserved - must be zero */
369170244Sume#define	NS_KEY_RESERVED9	0x0040  /*%< reserved - must be zero */
370170244Sume#define	NS_KEY_RESERVED10	0x0020  /*%< reserved - must be zero */
371170244Sume#define	NS_KEY_RESERVED11	0x0010  /*%< reserved - must be zero */
372170244Sume#define	NS_KEY_SIGNATORYMASK	0x000F	/*%< key can sign RR's of same name */
373156960Sume#define	NS_KEY_RESERVED_BITMASK ( NS_KEY_RESERVED2 | \
37436888Speter				  NS_KEY_RESERVED4 | \
375156960Sume				  NS_KEY_RESERVED5 | \
376156960Sume				  NS_KEY_RESERVED8 | \
377156960Sume				  NS_KEY_RESERVED9 | \
37836888Speter				  NS_KEY_RESERVED10 | \
37936888Speter				  NS_KEY_RESERVED11 )
380170244Sume#define NS_KEY_RESERVED_BITMASK2 0xFFFF /*%< no bits defined here */
38121056Speter/* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */
382170244Sume#define	NS_ALG_MD5RSA		1	/*%< MD5 with RSA */
383170244Sume#define	NS_ALG_DH               2	/*%< Diffie Hellman KEY */
384170244Sume#define	NS_ALG_DSA              3	/*%< DSA KEY */
385156960Sume#define	NS_ALG_DSS              NS_ALG_DSA
386170244Sume#define	NS_ALG_EXPIRE_ONLY	253	/*%< No alg, no security */
387170244Sume#define	NS_ALG_PRIVATE_OID	254	/*%< Key begins with OID giving alg */
388156960Sume/* Protocol values  */
389156960Sume/* value 0 is reserved */
390156960Sume#define NS_KEY_PROT_TLS         1
391156960Sume#define NS_KEY_PROT_EMAIL       2
392156960Sume#define NS_KEY_PROT_DNSSEC      3
393156960Sume#define NS_KEY_PROT_IPSEC       4
394156960Sume#define NS_KEY_PROT_ANY		255
395156960Sume
39621056Speter/* Signatures */
397170244Sume#define	NS_MD5RSA_MIN_BITS	 512	/*%< Size of a mod or exp in bits */
398156960Sume#define	NS_MD5RSA_MAX_BITS	4096
39936888Speter	/* Total of binary mod and exp */
40036888Speter#define	NS_MD5RSA_MAX_BYTES	((NS_MD5RSA_MAX_BITS+7/8)*2+3)
40136888Speter	/* Max length of text sig block */
40236888Speter#define	NS_MD5RSA_MAX_BASE64	(((NS_MD5RSA_MAX_BYTES+2)/3)*4)
403156960Sume#define NS_MD5RSA_MIN_SIZE	((NS_MD5RSA_MIN_BITS+7)/8)
404156960Sume#define NS_MD5RSA_MAX_SIZE	((NS_MD5RSA_MAX_BITS+7)/8)
40521056Speter
406156960Sume#define NS_DSA_SIG_SIZE         41
407156960Sume#define NS_DSA_MIN_SIZE         213
408156960Sume#define NS_DSA_MAX_BYTES        405
409156960Sume
41036888Speter/* Offsets into SIG record rdata to find various values */
411170244Sume#define	NS_SIG_TYPE	0	/*%< Type flags */
412170244Sume#define	NS_SIG_ALG	2	/*%< Algorithm */
413170244Sume#define	NS_SIG_LABELS	3	/*%< How many labels in name */
414170244Sume#define	NS_SIG_OTTL	4	/*%< Original TTL */
415170244Sume#define	NS_SIG_EXPIR	8	/*%< Expiration time */
416170244Sume#define	NS_SIG_SIGNED	12	/*%< Signature time */
417170244Sume#define	NS_SIG_FOOT	16	/*%< Key footprint */
418170244Sume#define	NS_SIG_SIGNER	18	/*%< Domain name of who signed it */
41936888Speter/* How RR types are represented as bit-flags in NXT records */
42036888Speter#define	NS_NXT_BITS 8
42136888Speter#define	NS_NXT_BIT_SET(  n,p) (p[(n)/NS_NXT_BITS] |=  (0x80>>((n)%NS_NXT_BITS)))
42236888Speter#define	NS_NXT_BIT_CLEAR(n,p) (p[(n)/NS_NXT_BITS] &= ~(0x80>>((n)%NS_NXT_BITS)))
42336888Speter#define	NS_NXT_BIT_ISSET(n,p) (p[(n)/NS_NXT_BITS] &   (0x80>>((n)%NS_NXT_BITS)))
424156960Sume#define NS_NXT_MAX 127
42521056Speter
426170244Sume/*%
427186090Sume * EDNS0 extended flags and option codes, host order.
428156960Sume */
429156960Sume#define NS_OPT_DNSSEC_OK	0x8000U
430186090Sume#define NS_OPT_NSID             3
4311539Srgrimes
432170244Sume/*%
4331539Srgrimes * Inline versions of get/put short/long.  Pointer is advanced.
4341539Srgrimes */
435156960Sume#define NS_GET16(s, cp) do { \
436156960Sume	register const u_char *t_cp = (const u_char *)(cp); \
4373070Spst	(s) = ((u_int16_t)t_cp[0] << 8) \
4383070Spst	    | ((u_int16_t)t_cp[1]) \
4393070Spst	    ; \
44036888Speter	(cp) += NS_INT16SZ; \
441156960Sume} while (0)
4421539Srgrimes
443156960Sume#define NS_GET32(l, cp) do { \
444156960Sume	register const u_char *t_cp = (const u_char *)(cp); \
4453070Spst	(l) = ((u_int32_t)t_cp[0] << 24) \
4463070Spst	    | ((u_int32_t)t_cp[1] << 16) \
4473070Spst	    | ((u_int32_t)t_cp[2] << 8) \
4483070Spst	    | ((u_int32_t)t_cp[3]) \
4493070Spst	    ; \
45036888Speter	(cp) += NS_INT32SZ; \
451156960Sume} while (0)
4521539Srgrimes
453156960Sume#define NS_PUT16(s, cp) do { \
4541539Srgrimes	register u_int16_t t_s = (u_int16_t)(s); \
4551539Srgrimes	register u_char *t_cp = (u_char *)(cp); \
4561539Srgrimes	*t_cp++ = t_s >> 8; \
4571539Srgrimes	*t_cp   = t_s; \
45836888Speter	(cp) += NS_INT16SZ; \
459156960Sume} while (0)
4601539Srgrimes
461156960Sume#define NS_PUT32(l, cp) do { \
4621539Srgrimes	register u_int32_t t_l = (u_int32_t)(l); \
4631539Srgrimes	register u_char *t_cp = (u_char *)(cp); \
4641539Srgrimes	*t_cp++ = t_l >> 24; \
4651539Srgrimes	*t_cp++ = t_l >> 16; \
4661539Srgrimes	*t_cp++ = t_l >> 8; \
4671539Srgrimes	*t_cp   = t_l; \
46836888Speter	(cp) += NS_INT32SZ; \
469156960Sume} while (0)
4701539Srgrimes
471170244Sume/*%
472156960Sume * ANSI C identifier hiding for bind's lib/nameser.
47336888Speter */
474156960Sume#define	ns_msg_getflag		__ns_msg_getflag
47536888Speter#define ns_get16		__ns_get16
47636888Speter#define ns_get32		__ns_get32
47736888Speter#define ns_put16		__ns_put16
47836888Speter#define ns_put32		__ns_put32
47936888Speter#define ns_initparse		__ns_initparse
480156960Sume#define ns_skiprr		__ns_skiprr
48136888Speter#define ns_parserr		__ns_parserr
48236888Speter#define	ns_sprintrr		__ns_sprintrr
48336888Speter#define	ns_sprintrrf		__ns_sprintrrf
48436888Speter#define	ns_format_ttl		__ns_format_ttl
48536888Speter#define	ns_parse_ttl		__ns_parse_ttl
486156960Sume#if 0
487156960Sume#define ns_datetosecs		__ns_datetosecs
488156960Sume#endif
489156960Sume#define	ns_name_ntol		__ns_name_ntol
49036888Speter#define	ns_name_ntop		__ns_name_ntop
49136888Speter#define	ns_name_pton		__ns_name_pton
49236888Speter#define	ns_name_unpack		__ns_name_unpack
49336888Speter#define	ns_name_pack		__ns_name_pack
49436888Speter#define	ns_name_compress	__ns_name_compress
49536888Speter#define	ns_name_uncompress	__ns_name_uncompress
496156467Sume#define	ns_name_skip		__ns_name_skip
497156960Sume#define	ns_name_rollback	__ns_name_rollback
498156960Sume#if 0
499156960Sume#define	ns_sign			__ns_sign
500156960Sume#define	ns_sign2		__ns_sign2
501156960Sume#define	ns_sign_tcp		__ns_sign_tcp
502156960Sume#define	ns_sign_tcp2		__ns_sign_tcp2
503156960Sume#define	ns_sign_tcp_init	__ns_sign_tcp_init
504156960Sume#define ns_find_tsig		__ns_find_tsig
505156960Sume#define	ns_verify		__ns_verify
506156960Sume#define	ns_verify_tcp		__ns_verify_tcp
507156960Sume#define	ns_verify_tcp_init	__ns_verify_tcp_init
508158787Sume#endif
509156960Sume#define	ns_samedomain		__ns_samedomain
510158787Sume#if 0
511156960Sume#define	ns_subdomain		__ns_subdomain
512156960Sume#endif
513156960Sume#define	ns_makecanon		__ns_makecanon
514156960Sume#define	ns_samename		__ns_samename
51536888Speter
51636888Speter__BEGIN_DECLS
517156960Sumeint		ns_msg_getflag(ns_msg, int);
51893032Simpu_int		ns_get16(const u_char *);
51993032Simpu_long		ns_get32(const u_char *);
52093032Simpvoid		ns_put16(u_int, u_char *);
52193032Simpvoid		ns_put32(u_long, u_char *);
52293032Simpint		ns_initparse(const u_char *, int, ns_msg *);
523156960Sumeint		ns_skiprr(const u_char *, const u_char *, ns_sect, int);
52493032Simpint		ns_parserr(ns_msg *, ns_sect, int, ns_rr *);
52593032Simpint		ns_sprintrr(const ns_msg *, const ns_rr *,
52693032Simp			    const char *, const char *, char *, size_t);
52793032Simpint		ns_sprintrrf(const u_char *, size_t, const char *,
52893032Simp			     ns_class, ns_type, u_long, const u_char *,
52993032Simp			     size_t, const char *, const char *,
53093032Simp			     char *, size_t);
53193032Simpint		ns_format_ttl(u_long, char *, size_t);
53293032Simpint		ns_parse_ttl(const char *, u_long *);
533156960Sume#if 0
534156960Sumeu_int32_t	ns_datetosecs(const char *cp, int *errp);
535156960Sume#endif
536156960Sumeint		ns_name_ntol(const u_char *, u_char *, size_t);
53793032Simpint		ns_name_ntop(const u_char *, char *, size_t);
53893032Simpint		ns_name_pton(const char *, u_char *, size_t);
53993032Simpint		ns_name_unpack(const u_char *, const u_char *,
54093032Simp			       const u_char *, u_char *, size_t);
54193032Simpint		ns_name_pack(const u_char *, u_char *, int,
54293032Simp			     const u_char **, const u_char **);
54393032Simpint		ns_name_uncompress(const u_char *, const u_char *,
54493032Simp				   const u_char *, char *, size_t);
54593032Simpint		ns_name_compress(const char *, u_char *, size_t,
54693032Simp				 const u_char **, const u_char **);
54793032Simpint		ns_name_skip(const u_char **, const u_char *);
548156960Sumevoid		ns_name_rollback(const u_char *, const u_char **,
549156960Sume				 const u_char **);
550156960Sume#if 0
551156960Sumeint		ns_sign(u_char *, int *, int, int, void *,
552156960Sume			const u_char *, int, u_char *, int *, time_t);
553156960Sumeint		ns_sign2(u_char *, int *, int, int, void *,
554156960Sume			 const u_char *, int, u_char *, int *, time_t,
555156960Sume			 u_char **, u_char **);
556156960Sumeint		ns_sign_tcp(u_char *, int *, int, int,
557156960Sume			    ns_tcp_tsig_state *, int);
558156960Sumeint		ns_sign_tcp2(u_char *, int *, int, int,
559156960Sume			     ns_tcp_tsig_state *, int,
560156960Sume			     u_char **, u_char **);
561156960Sumeint		ns_sign_tcp_init(void *, const u_char *, int,
562156960Sume				 ns_tcp_tsig_state *);
563156960Sumeu_char		*ns_find_tsig(u_char *, u_char *);
564156960Sumeint		ns_verify(u_char *, int *, void *,
565156960Sume			  const u_char *, int, u_char *, int *,
566156960Sume			  time_t *, int);
567156960Sumeint		ns_verify_tcp(u_char *, int *, ns_tcp_tsig_state *, int);
568156960Sumeint		ns_verify_tcp_init(void *, const u_char *, int,
569156960Sume				   ns_tcp_tsig_state *);
570158787Sume#endif
571156960Sumeint		ns_samedomain(const char *, const char *);
572158787Sume#if 0
573156960Sumeint		ns_subdomain(const char *, const char *);
574156960Sume#endif
575156960Sumeint		ns_makecanon(const char *, char *, size_t);
576156960Sumeint		ns_samename(const char *, const char *);
57736888Speter__END_DECLS
57836888Speter
57936888Speter#ifdef BIND_4_COMPAT
58036888Speter#include <arpa/nameser_compat.h>
58136888Speter#endif
58236888Speter
58310132Speter#endif /* !_ARPA_NAMESER_H_ */
584170244Sume/*! \file */
585