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