2 * Copyright (c) 1983, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * Copyright (c) 1996-1999 by Internet Software Consortium.
37 * Permission to use, copy, modify, and distribute this software for any
38 * purpose with or without fee is hereby granted, provided that the above
39 * copyright notice and this permission notice appear in all copies.
41 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
42 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
44 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
45 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
46 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
47 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
52 * $Id: nameser.h,v 1.4 2000/02/02 07:23:18 mellon Exp $
55 #ifndef _ARPA_NAMESER_H_
56 #define _ARPA_NAMESER_H_
59 * Revision information. This is the release date in YYYYMMDD format.
60 * It can change every day so the right thing to do with it is use it
61 * in preprocessor commands such as "#if (__NAMESER > 19931104)". Do not
62 * compare for equality; rather, use it to determine whether your libbind.a
63 * contains a new enough lib/nameser/ to support the feature you need.
66 #define __NAMESER 19991006 /* New interface version stamp. */
69 * Define constants based on RFC 883, RFC 1034, RFC 1035
71 #define NS_PACKETSZ 512 /* maximum packet size */
72 #define NS_MAXDNAME 1025 /* maximum domain name */
73 #define NS_MAXCDNAME 255 /* maximum compressed domain name */
74 #define NS_MAXLABEL 63 /* maximum length of domain label */
75 #define NS_HFIXEDSZ 12 /* #/bytes of fixed data in header */
76 #define NS_QFIXEDSZ 4 /* #/bytes of fixed data in query */
77 #define NS_RRFIXEDSZ 10 /* #/bytes of fixed data in r record */
78 #define NS_INT32SZ 4 /* #/bytes of data in a u_int32_t */
79 #define NS_INT16SZ 2 /* #/bytes of data in a u_int16_t */
80 #define NS_INT8SZ 1 /* #/bytes of data in a u_int8_t */
81 #define NS_INADDRSZ 4 /* IPv4 T_A */
82 #define NS_IN6ADDRSZ 16 /* IPv6 T_AAAA */
83 #define NS_CMPRSFLGS 0xc0 /* Flag bits indicating name compression. */
84 #define NS_DEFAULTPORT 53 /* For both TCP and UDP. */
87 * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
90 typedef enum __ns_sect {
91 ns_s_qd = 0, /* Query: Question. */
92 ns_s_zn = 0, /* Update: Zone. */
93 ns_s_an = 1, /* Query: Answer. */
94 ns_s_pr = 1, /* Update: Prerequisites. */
95 ns_s_ns = 2, /* Query: Name servers. */
96 ns_s_ud = 2, /* Update: Update. */
97 ns_s_ar = 3, /* Query|Update: Additional records. */
102 * This is a message handle. It is caller allocated and has no dynamic data.
103 * This structure is intended to be opaque to all but ns_parse.c, thus the
104 * leading _'s on the member names. Use the accessor functions, not the _'s.
106 typedef struct __ns_msg {
107 const u_int8_t *_msg, *_eom;
108 u_int16_t _id, _flags, _counts[ns_s_max];
109 const u_int8_t *_sections[ns_s_max];
112 const u_int8_t *_ptr;
115 /* Private data structure - do not use from outside library. */
116 struct _ns_flagdata { int mask, shift; };
117 extern struct _ns_flagdata _ns_flagdata[];
119 /* Accessor macros - this is part of the public interface. */
120 #define ns_msg_getflag(handle, flag) ( \
121 ((handle)._flags & _ns_flagdata[flag].mask) \
122 >> _ns_flagdata[flag].shift \
124 #define ns_msg_id(handle) ((handle)._id + 0)
125 #define ns_msg_base(handle) ((handle)._msg + 0)
126 #define ns_msg_end(handle) ((handle)._eom + 0)
127 #define ns_msg_size(handle) ((handle)._eom - (handle)._msg)
128 #define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
131 * This is a parsed record. It is caller allocated and has no dynamic data.
133 typedef struct __ns_rr {
134 char name[NS_MAXDNAME];
139 const u_int8_t *rdata;
142 /* Accessor macros - this is part of the public interface. */
143 #define ns_rr_name(rr) (((rr).name[0] != '\0') ? (rr).name : ".")
144 #define ns_rr_type(rr) ((ns_type)((rr).type + 0))
145 #define ns_rr_class(rr) ((ns_class)((rr).rr_class + 0))
146 #define ns_rr_ttl(rr) ((rr).ttl + 0)
147 #define ns_rr_rdlen(rr) ((rr).rdlength + 0)
148 #define ns_rr_rdata(rr) ((rr).rdata + 0)
151 * These don't have to be in the same order as in the packet flags word,
152 * and they can even overlap in some cases, but they will need to be kept
153 * in synch with ns_parse.c:ns_flagdata[].
155 typedef enum __ns_flag {
156 ns_f_qr, /* Question/Response. */
157 ns_f_opcode, /* Operation code. */
158 ns_f_aa, /* Authoritative Answer. */
159 ns_f_tc, /* Truncation occurred. */
160 ns_f_rd, /* Recursion Desired. */
161 ns_f_ra, /* Recursion Available. */
163 ns_f_ad, /* Authentic Data (DNSSEC). */
164 ns_f_cd, /* Checking Disabled (DNSSEC). */
165 ns_f_rcode, /* Response code. */
170 * Currently defined opcodes.
172 typedef enum __ns_opcode {
173 ns_o_query = 0, /* Standard query. */
174 ns_o_iquery = 1, /* Inverse query (deprecated/unsupported). */
175 ns_o_status = 2, /* Name server status query (unsupported). */
176 /* Opcode 3 is undefined/reserved. */
177 ns_o_notify = 4, /* Zone change notification. */
178 ns_o_update = 5, /* Zone update message. */
183 * Currently defined response codes.
185 typedef enum __ns_rcode {
186 ns_r_noerror = 0, /* No error occurred. */
187 ns_r_formerr = 1, /* Format error. */
188 ns_r_servfail = 2, /* Server failure. */
189 ns_r_nxdomain = 3, /* Name error. */
190 ns_r_notimpl = 4, /* Unimplemented. */
191 ns_r_refused = 5, /* Operation refused. */
192 /* these are for BIND_UPDATE */
193 ns_r_yxdomain = 6, /* Name exists */
194 ns_r_yxrrset = 7, /* RRset exists */
195 ns_r_nxrrset = 8, /* RRset does not exist */
196 ns_r_notauth = 9, /* Not authoritative for zone */
197 ns_r_notzone = 10, /* Zone of record different from zone section */
199 /* The following are TSIG extended errors */
206 typedef enum __ns_update_operation {
210 } ns_update_operation;
213 * This structure is used for TSIG authenticated messages
216 char name[NS_MAXDNAME], alg[NS_MAXDNAME];
220 typedef struct ns_tsig_key ns_tsig_key;
223 * This structure is used for TSIG authenticated TCP messages
225 struct ns_tcp_tsig_state {
229 unsigned char sig[NS_PACKETSZ];
232 typedef struct ns_tcp_tsig_state ns_tcp_tsig_state;
234 #define NS_TSIG_FUDGE 300
235 #define NS_TSIG_TCP_COUNT 100
236 #define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"
238 #define NS_TSIG_ERROR_NO_TSIG -10
239 #define NS_TSIG_ERROR_NO_SPACE -11
240 #define NS_TSIG_ERROR_FORMERR -12
243 * Currently defined type values for resources and queries.
245 typedef enum __ns_type {
246 ns_t_invalid = 0, /* Cookie. */
247 ns_t_a = 1, /* Host address. */
248 ns_t_ns = 2, /* Authoritative server. */
249 ns_t_md = 3, /* Mail destination. */
250 ns_t_mf = 4, /* Mail forwarder. */
251 ns_t_cname = 5, /* Canonical name. */
252 ns_t_soa = 6, /* Start of authority zone. */
253 ns_t_mb = 7, /* Mailbox domain name. */
254 ns_t_mg = 8, /* Mail group member. */
255 ns_t_mr = 9, /* Mail rename name. */
256 ns_t_null = 10, /* Null resource record. */
257 ns_t_wks = 11, /* Well known service. */
258 ns_t_ptr = 12, /* Domain name pointer. */
259 ns_t_hinfo = 13, /* Host information. */
260 ns_t_minfo = 14, /* Mailbox information. */
261 ns_t_mx = 15, /* Mail routing information. */
262 ns_t_txt = 16, /* Text strings. */
263 ns_t_rp = 17, /* Responsible person. */
264 ns_t_afsdb = 18, /* AFS cell database. */
265 ns_t_x25 = 19, /* X_25 calling address. */
266 ns_t_isdn = 20, /* ISDN calling address. */
267 ns_t_rt = 21, /* Router. */
268 ns_t_nsap = 22, /* NSAP address. */
269 ns_t_nsap_ptr = 23, /* Reverse NSAP lookup (deprecated). */
270 ns_t_sig = 24, /* Security signature. */
271 ns_t_key = 25, /* Security key. */
272 ns_t_px = 26, /* X.400 mail mapping. */
273 ns_t_gpos = 27, /* Geographical position (withdrawn). */
274 ns_t_aaaa = 28, /* Ip6 Address. */
275 ns_t_loc = 29, /* Location Information. */
276 ns_t_nxt = 30, /* Next domain (security). */
277 ns_t_eid = 31, /* Endpoint identifier. */
278 ns_t_nimloc = 32, /* Nimrod Locator. */
279 ns_t_srv = 33, /* Server Selection. */
280 ns_t_atma = 34, /* ATM Address */
281 ns_t_naptr = 35, /* Naming Authority PoinTeR */
282 ns_t_kx = 36, /* Key Exchange */
283 ns_t_cert = 37, /* Certification record */
284 ns_t_a6 = 38, /* IPv6 address (deprecates AAAA) */
285 ns_t_dname = 39, /* Non-terminal DNAME (for IPv6) */
286 ns_t_sink = 40, /* Kitchen sink (experimentatl) */
287 ns_t_opt = 41, /* EDNS0 option (meta-RR) */
288 ns_t_tsig = 250, /* Transaction signature. */
289 ns_t_ixfr = 251, /* Incremental zone transfer. */
290 ns_t_axfr = 252, /* Transfer zone of authority. */
291 ns_t_mailb = 253, /* Transfer mailbox records. */
292 ns_t_maila = 254, /* Transfer mail agent records. */
293 ns_t_any = 255, /* Wildcard match. */
294 ns_t_zxfr = 256, /* BIND-specific, nonstandard. */
298 /* Exclusively a QTYPE? (not also an RTYPE) */
299 #define ns_t_qt_p(t) (ns_t_xfr_p(t) || (t) == ns_t_any || \
300 (t) == ns_t_mailb || (t) == ns_t_maila)
301 /* Some kind of meta-RR? (not a QTYPE, but also not an RTYPE) */
302 #define ns_t_mrr_p(t) ((t) == ns_t_tsig || (t) == ns_t_opt)
303 /* Exclusively an RTYPE? (not also a QTYPE or a meta-RR) */
304 #define ns_t_rr_p(t) (!ns_t_qt_p(t) && !ns_t_mrr_p(t))
305 #define ns_t_udp_p(t) ((t) != ns_t_axfr && (t) != ns_t_zxfr)
306 #define ns_t_xfr_p(t) ((t) == ns_t_axfr || (t) == ns_t_ixfr || \
310 * Values for class field
312 typedef enum __ns_class {
313 ns_c_invalid = 0, /* Cookie. */
314 ns_c_in = 1, /* Internet. */
315 ns_c_2 = 2, /* unallocated/unsupported. */
316 ns_c_chaos = 3, /* MIT Chaos-net. */
317 ns_c_hs = 4, /* MIT Hesiod. */
318 /* Query class values which do not appear in resource records */
319 ns_c_none = 254, /* for prereq. sections in update requests */
320 ns_c_any = 255, /* Wildcard match. */
324 /* DNSSEC constants. */
326 typedef enum __ns_key_types {
327 ns_kt_rsa = 1, /* key type RSA/MD5 */
328 ns_kt_dh = 2, /* Diffie Hellman */
329 ns_kt_dsa = 3, /* Digital Signature Standard (MANDATORY) */
330 ns_kt_private = 254 /* Private key type starts with OID */
333 typedef enum __ns_cert_types {
334 cert_t_pkix = 1, /* PKIX (X.509v3) */
335 cert_t_spki = 2, /* SPKI */
336 cert_t_pgp = 3, /* PGP */
337 cert_t_url = 253, /* URL private type */
338 cert_t_oid = 254 /* OID private type */
341 /* Flags field of the KEY RR rdata. */
342 #define NS_KEY_TYPEMASK 0xC000 /* Mask for "type" bits */
343 #define NS_KEY_TYPE_AUTH_CONF 0x0000 /* Key usable for both */
344 #define NS_KEY_TYPE_CONF_ONLY 0x8000 /* Key usable for confidentiality */
345 #define NS_KEY_TYPE_AUTH_ONLY 0x4000 /* Key usable for authentication */
346 #define NS_KEY_TYPE_NO_KEY 0xC000 /* No key usable for either; no key */
347 /* The type bits can also be interpreted independently, as single bits: */
348 #define NS_KEY_NO_AUTH 0x8000 /* Key unusable for authentication */
349 #define NS_KEY_NO_CONF 0x4000 /* Key unusable for confidentiality */
350 #define NS_KEY_RESERVED2 0x2000 /* Security is *mandatory* if bit=0 */
351 #define NS_KEY_EXTENDED_FLAGS 0x1000 /* reserved - must be zero */
352 #define NS_KEY_RESERVED4 0x0800 /* reserved - must be zero */
353 #define NS_KEY_RESERVED5 0x0400 /* reserved - must be zero */
354 #define NS_KEY_NAME_TYPE 0x0300 /* these bits determine the type */
355 #define NS_KEY_NAME_USER 0x0000 /* key is assoc. with user */
356 #define NS_KEY_NAME_ENTITY 0x0200 /* key is assoc. with entity eg host */
357 #define NS_KEY_NAME_ZONE 0x0100 /* key is zone key */
358 #define NS_KEY_NAME_RESERVED 0x0300 /* reserved meaning */
359 #define NS_KEY_RESERVED8 0x0080 /* reserved - must be zero */
360 #define NS_KEY_RESERVED9 0x0040 /* reserved - must be zero */
361 #define NS_KEY_RESERVED10 0x0020 /* reserved - must be zero */
362 #define NS_KEY_RESERVED11 0x0010 /* reserved - must be zero */
363 #define NS_KEY_SIGNATORYMASK 0x000F /* key can sign RR's of same name */
364 #define NS_KEY_RESERVED_BITMASK ( NS_KEY_RESERVED2 | \
369 NS_KEY_RESERVED10 | \
371 #define NS_KEY_RESERVED_BITMASK2 0xFFFF /* no bits defined here */
373 /* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */
374 #define NS_ALG_MD5RSA 1 /* MD5 with RSA */
375 #define NS_ALG_DH 2 /* Diffie Hellman KEY */
376 #define NS_ALG_DSA 3 /* DSA KEY */
377 #define NS_ALG_DSS NS_ALG_DSA
378 #define NS_ALG_EXPIRE_ONLY 253 /* No alg, no security */
379 #define NS_ALG_PRIVATE_OID 254 /* Key begins with OID giving alg */
381 /* Protocol values */
382 /* value 0 is reserved */
383 #define NS_KEY_PROT_TLS 1
384 #define NS_KEY_PROT_EMAIL 2
385 #define NS_KEY_PROT_DNSSEC 3
386 #define NS_KEY_PROT_IPSEC 4
387 #define NS_KEY_PROT_ANY 255
390 #define NS_MD5RSA_MIN_BITS 512 /* Size of a mod or exp in bits */
391 #define NS_MD5RSA_MAX_BITS 2552
392 /* Total of binary mod and exp */
393 #define NS_MD5RSA_MAX_BYTES ((NS_MD5RSA_MAX_BITS+7/8)*2+3)
394 /* Max length of text sig block */
395 #define NS_MD5RSA_MAX_BASE64 (((NS_MD5RSA_MAX_BYTES+2)/3)*4)
396 #define NS_MD5RSA_MIN_SIZE ((NS_MD5RSA_MIN_BITS+7)/8)
397 #define NS_MD5RSA_MAX_SIZE ((NS_MD5RSA_MAX_BITS+7)/8)
399 #define NS_DSA_SIG_SIZE 41
400 #define NS_DSA_MIN_SIZE 213
401 #define NS_DSA_MAX_BYTES 405
403 /* Offsets into SIG record rdata to find various values */
404 #define NS_SIG_TYPE 0 /* Type flags */
405 #define NS_SIG_ALG 2 /* Algorithm */
406 #define NS_SIG_LABELS 3 /* How many labels in name */
407 #define NS_SIG_OTTL 4 /* Original TTL */
408 #define NS_SIG_EXPIR 8 /* Expiration time */
409 #define NS_SIG_SIGNED 12 /* Signature time */
410 #define NS_SIG_FOOT 16 /* Key footprint */
411 #define NS_SIG_SIGNER 18 /* Domain name of who signed it */
413 /* How RR types are represented as bit-flags in NXT records */
414 #define NS_NXT_BITS 8
415 #define NS_NXT_BIT_SET( n,p) (p[(n)/NS_NXT_BITS] |= (0x80>>((n)%NS_NXT_BITS)))
416 #define NS_NXT_BIT_CLEAR(n,p) (p[(n)/NS_NXT_BITS] &= ~(0x80>>((n)%NS_NXT_BITS)))
417 #define NS_NXT_BIT_ISSET(n,p) (p[(n)/NS_NXT_BITS] & (0x80>>((n)%NS_NXT_BITS)))
418 #define NS_NXT_MAX 127
421 * Inline versions of get/put short/long. Pointer is advanced.
423 #define NS_GET16(s, cp) do { \
424 register u_int8_t *t_cp = (u_int8_t *)(cp); \
425 (s) = ((u_int16_t)t_cp[0] << 8) \
426 | ((u_int16_t)t_cp[1]) \
428 (cp) += NS_INT16SZ; \
431 #define NS_GET32(l, cp) do { \
432 register u_int8_t *t_cp = (u_int8_t *)(cp); \
433 (l) = ((u_int32_t)t_cp[0] << 24) \
434 | ((u_int32_t)t_cp[1] << 16) \
435 | ((u_int32_t)t_cp[2] << 8) \
436 | ((u_int32_t)t_cp[3]) \
438 (cp) += NS_INT32SZ; \
441 #define NS_PUT16(s, cp) do { \
442 register u_int16_t t_s = (u_int16_t)(s); \
443 register u_int8_t *t_cp = (u_int8_t *)(cp); \
444 *t_cp++ = t_s >> 8; \
446 (cp) += NS_INT16SZ; \
449 #define NS_PUT32(l, cp) do { \
450 register u_int32_t t_l = (u_int32_t)(l); \
451 register u_int8_t *t_cp = (u_int8_t *)(cp); \
452 *t_cp++ = t_l >> 24; \
453 *t_cp++ = t_l >> 16; \
454 *t_cp++ = t_l >> 8; \
456 (cp) += NS_INT32SZ; \
459 #include <arpa/nameser_compat.h>
461 #endif /* !_ARPA_NAMESER_H_ */