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