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 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * Copyright (c) 1996 by Internet Software Consortium.
32 * Permission to use, copy, modify, and distribute this software for any
33 * purpose with or without fee is hereby granted, provided that the above
34 * copyright notice and this permission notice appear in all copies.
36 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
37 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
38 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
39 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
40 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
41 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
42 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
44 * Portions Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
48 * From: Id: nameser.h,v 8.16 1998/02/06 00:35:58 halley Exp
49 * $FreeBSD: src/include/arpa/nameser.h,v 1.16 2002/03/23 17:24:55 imp Exp $
52 #ifndef _ARPA_NAMESER_H_
53 #define _ARPA_NAMESER_H_
57 #include <sys/types.h>
58 #include <sys/cdefs.h>
61 * revision information. this is the release date in YYYYMMDD format.
62 * it can change every day so the right thing to do with it is use it
63 * in preprocessor commands such as "#if (__NAMESER > 19931104)". do not
64 * compare for equality; rather, use it to determine whether your libnameser.a
65 * is new enough to contain a certain feature.
68 /* XXXRTH I made this bigger than __BIND in 4.9.5 T6B */
69 #define __NAMESER 19961001 /* 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_char *_msg, *_eom;
111 u_int16_t _id, _flags, _counts[ns_s_max];
112 const u_char *_sections[ns_s_max];
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]; /* XXX need to malloc */
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) ((rr).type + 0)
148 #define ns_rr_class(rr) ((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 */
205 typedef enum __ns_update_operation {
209 } ns_update_operation;
212 * This RR-like structure is particular to UPDATE.
215 struct ns_updrec *r_prev; /* prev record */
216 struct ns_updrec *r_next; /* next record */
217 u_int8_t r_section; /* ZONE/PREREQUISITE/UPDATE */
218 char * r_dname; /* owner of the RR */
219 u_int16_t r_class; /* class number */
220 u_int16_t r_type; /* type number */
221 u_int32_t r_ttl; /* time to live */
222 u_char * r_data; /* rdata fields as text string */
223 u_int16_t r_size; /* size of r_data field */
224 int r_opcode; /* type of operation */
225 /* following fields for private use by the resolver/server routines */
226 struct ns_updrec *r_grpnext; /* next record when grouped */
227 struct databuf *r_dp; /* databuf to process */
228 struct databuf *r_deldp; /* databuf's deleted/overwritten */
229 u_int16_t r_zone; /* zone number on server */
231 typedef struct ns_updrec ns_updrec;
234 * Currently defined type values for resources and queries.
236 typedef enum __ns_type {
237 ns_t_a = 1, /* Host address. */
238 ns_t_ns = 2, /* Authoritative server. */
239 ns_t_md = 3, /* Mail destination. */
240 ns_t_mf = 4, /* Mail forwarder. */
241 ns_t_cname = 5, /* Canonical name. */
242 ns_t_soa = 6, /* Start of authority zone. */
243 ns_t_mb = 7, /* Mailbox domain name. */
244 ns_t_mg = 8, /* Mail group member. */
245 ns_t_mr = 9, /* Mail rename name. */
246 ns_t_null = 10, /* Null resource record. */
247 ns_t_wks = 11, /* Well known service. */
248 ns_t_ptr = 12, /* Domain name pointer. */
249 ns_t_hinfo = 13, /* Host information. */
250 ns_t_minfo = 14, /* Mailbox information. */
251 ns_t_mx = 15, /* Mail routing information. */
252 ns_t_txt = 16, /* Text strings. */
253 ns_t_rp = 17, /* Responsible person. */
254 ns_t_afsdb = 18, /* AFS cell database. */
255 ns_t_x25 = 19, /* X_25 calling address. */
256 ns_t_isdn = 20, /* ISDN calling address. */
257 ns_t_rt = 21, /* Router. */
258 ns_t_nsap = 22, /* NSAP address. */
259 ns_t_nsap_ptr = 23, /* Reverse NSAP lookup (deprecated). */
260 ns_t_sig = 24, /* Security signature. */
261 ns_t_key = 25, /* Security key. */
262 ns_t_px = 26, /* X.400 mail mapping. */
263 ns_t_gpos = 27, /* Geographical position (withdrawn). */
264 ns_t_aaaa = 28, /* Ip6 Address. */
265 ns_t_loc = 29, /* Location Information. */
266 ns_t_nxt = 30, /* Next domain (security). */
267 ns_t_eid = 31, /* Endpoint identifier. */
268 ns_t_nimloc = 32, /* Nimrod Locator. */
269 ns_t_srv = 33, /* Server Selection. */
270 ns_t_atma = 34, /* ATM Address */
271 ns_t_naptr = 35, /* Naming Authority PoinTeR */
272 ns_t_opt = 41, /* OPT pseudo-RR, RFC2761 */
273 /* Query type values which do not appear in resource records. */
274 ns_t_ixfr = 251, /* Incremental zone transfer. */
275 ns_t_axfr = 252, /* Transfer zone of authority. */
276 ns_t_mailb = 253, /* Transfer mailbox records. */
277 ns_t_maila = 254, /* Transfer mail agent records. */
278 ns_t_any = 255, /* Wildcard match. */
283 * Values for class field
285 typedef enum __ns_class {
286 ns_c_in = 1, /* Internet. */
287 /* Class 2 unallocated/unsupported. */
288 ns_c_chaos = 3, /* MIT Chaos-net. */
289 ns_c_hs = 4, /* MIT Hesiod. */
290 /* Query class values which do not appear in resource records */
291 ns_c_none = 254, /* for prereq. sections in update requests */
292 ns_c_any = 255, /* Wildcard match. */
297 * Flags field of the KEY RR rdata
299 #define NS_KEY_TYPEMASK 0xC000 /* Mask for "type" bits */
300 #define NS_KEY_TYPE_AUTH_CONF 0x0000 /* Key usable for both */
301 #define NS_KEY_TYPE_CONF_ONLY 0x8000 /* Key usable for confidentiality */
302 #define NS_KEY_TYPE_AUTH_ONLY 0x4000 /* Key usable for authentication */
303 #define NS_KEY_TYPE_NO_KEY 0xC000 /* No key usable for either; no key */
304 /* The type bits can also be interpreted independently, as single bits: */
305 #define NS_KEY_NO_AUTH 0x8000 /* Key unusable for authentication */
306 #define NS_KEY_NO_CONF 0x4000 /* Key unusable for confidentiality */
307 #define NS_KEY_EXPERIMENTAL 0x2000 /* Security is *mandatory* if bit=0 */
308 #define NS_KEY_RESERVED3 0x1000 /* reserved - must be zero */
309 #define NS_KEY_RESERVED4 0x0800 /* reserved - must be zero */
310 #define NS_KEY_USERACCOUNT 0x0400 /* key is assoc. with a user acct */
311 #define NS_KEY_ENTITY 0x0200 /* key is assoc. with entity eg host */
312 #define NS_KEY_ZONEKEY 0x0100 /* key is zone key */
313 #define NS_KEY_IPSEC 0x0080 /* key is for IPSEC (host or user)*/
314 #define NS_KEY_EMAIL 0x0040 /* key is for email (MIME security) */
315 #define NS_KEY_RESERVED10 0x0020 /* reserved - must be zero */
316 #define NS_KEY_RESERVED11 0x0010 /* reserved - must be zero */
317 #define NS_KEY_SIGNATORYMASK 0x000F /* key can sign RR's of same name */
319 #define NS_KEY_RESERVED_BITMASK ( NS_KEY_RESERVED3 | \
321 NS_KEY_RESERVED10 | \
324 /* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */
325 #define NS_ALG_MD5RSA 1 /* MD5 with RSA */
326 #define NS_ALG_EXPIRE_ONLY 253 /* No alg, no security */
327 #define NS_ALG_PRIVATE_OID 254 /* Key begins with OID giving alg */
330 #define NS_MD5RSA_MIN_BITS 512 /* Size of a mod or exp in bits */
331 #define NS_MD5RSA_MAX_BITS 2552
332 /* Total of binary mod and exp */
333 #define NS_MD5RSA_MAX_BYTES ((NS_MD5RSA_MAX_BITS+7/8)*2+3)
334 /* Max length of text sig block */
335 #define NS_MD5RSA_MAX_BASE64 (((NS_MD5RSA_MAX_BYTES+2)/3)*4)
337 /* Offsets into SIG record rdata to find various values */
338 #define NS_SIG_TYPE 0 /* Type flags */
339 #define NS_SIG_ALG 2 /* Algorithm */
340 #define NS_SIG_LABELS 3 /* How many labels in name */
341 #define NS_SIG_OTTL 4 /* Original TTL */
342 #define NS_SIG_EXPIR 8 /* Expiration time */
343 #define NS_SIG_SIGNED 12 /* Signature time */
344 #define NS_SIG_FOOT 16 /* Key footprint */
345 #define NS_SIG_SIGNER 18 /* Domain name of who signed it */
347 /* How RR types are represented as bit-flags in NXT records */
348 #define NS_NXT_BITS 8
349 #define NS_NXT_BIT_SET( n,p) (p[(n)/NS_NXT_BITS] |= (0x80>>((n)%NS_NXT_BITS)))
350 #define NS_NXT_BIT_CLEAR(n,p) (p[(n)/NS_NXT_BITS] &= ~(0x80>>((n)%NS_NXT_BITS)))
351 #define NS_NXT_BIT_ISSET(n,p) (p[(n)/NS_NXT_BITS] & (0x80>>((n)%NS_NXT_BITS)))
355 * Inline versions of get/put short/long. Pointer is advanced.
357 #define NS_GET16(s, cp) { \
358 register u_char *t_cp = (u_char *)(cp); \
359 (s) = ((u_int16_t)t_cp[0] << 8) \
360 | ((u_int16_t)t_cp[1]) \
362 (cp) += NS_INT16SZ; \
365 #define NS_GET32(l, cp) { \
366 register u_char *t_cp = (u_char *)(cp); \
367 (l) = ((u_int32_t)t_cp[0] << 24) \
368 | ((u_int32_t)t_cp[1] << 16) \
369 | ((u_int32_t)t_cp[2] << 8) \
370 | ((u_int32_t)t_cp[3]) \
372 (cp) += NS_INT32SZ; \
375 #define NS_PUT16(s, cp) { \
376 register u_int16_t t_s = (u_int16_t)(s); \
377 register u_char *t_cp = (u_char *)(cp); \
378 *t_cp++ = t_s >> 8; \
380 (cp) += NS_INT16SZ; \
383 #define NS_PUT32(l, cp) { \
384 register u_int32_t t_l = (u_int32_t)(l); \
385 register u_char *t_cp = (u_char *)(cp); \
386 *t_cp++ = t_l >> 24; \
387 *t_cp++ = t_l >> 16; \
388 *t_cp++ = t_l >> 8; \
390 (cp) += NS_INT32SZ; \
394 * ANSI C identifier hiding.
396 #define ns_get16 __ns_get16
397 #define ns_get32 __ns_get32
398 #define ns_put16 __ns_put16
399 #define ns_put32 __ns_put32
400 #define ns_initparse __ns_initparse
401 #define ns_parserr __ns_parserr
402 #define ns_sprintrr __ns_sprintrr
403 #define ns_sprintrrf __ns_sprintrrf
404 #define ns_format_ttl __ns_format_ttl
405 #define ns_parse_ttl __ns_parse_ttl
406 #define ns_name_ntop __ns_name_ntop
407 #define ns_name_pton __ns_name_pton
408 #define ns_name_unpack __ns_name_unpack
409 #define ns_name_pack __ns_name_pack
410 #define ns_name_compress __ns_name_compress
411 #define ns_name_uncompress __ns_name_uncompress
414 #include <stdapis/arpa/nameser_compat.h>
417 #endif /* !_ARPA_NAMESER_H_ */