1/*
2 * Copyright (c) 1983, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
16 *
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
27 * SUCH DAMAGE.
28 */
29
30/*
31 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
32 * Copyright (c) 1996-1999 by Internet Software Consortium.
33 *
34 * Permission to use, copy, modify, and distribute this software for any
35 * purpose with or without fee is hereby granted, provided that the above
36 * copyright notice and this permission notice appear in all copies.
37 *
38 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
39 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
40 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
41 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
42 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
43 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
44 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
45 * SOFTWARE.
46 */
47
48#ifndef _ARPA_NAMESER_H_
49#define _ARPA_NAMESER_H_
50
51#include <sys/param.h>
52#include <sys/types.h>
53#include <stdint.h>
54
55/*
56 * Define constants based on RFC 883, RFC 1034, RFC 1035
57 */
58#define NS_PACKETSZ 512 /*%< default UDP packet size */
59#define NS_MAXDNAME 1025 /*%< maximum domain name */
60#define NS_MAXMSG 65535 /*%< maximum message size */
61#define NS_MAXCDNAME 255 /*%< maximum compressed domain name */
62#define NS_MAXLABEL 63 /*%< maximum length of domain label */
63#define NS_HFIXEDSZ 12 /*%< #/bytes of fixed data in header */
64#define NS_QFIXEDSZ 4 /*%< #/bytes of fixed data in query */
65#define NS_RRFIXEDSZ 10 /*%< #/bytes of fixed data in r record */
66#define NS_INT32SZ 4 /*%< #/bytes of data in a uint32_t */
67#define NS_INT16SZ 2 /*%< #/bytes of data in a uint16_t */
68#define NS_INT8SZ 1 /*%< #/bytes of data in a uint8_t */
69#define NS_INADDRSZ 4 /*%< IPv4 T_A */
70#define NS_IN6ADDRSZ 16 /*%< IPv6 T_AAAA */
71#define NS_CMPRSFLGS 0xc0 /*%< Flag bits indicating name compression. */
72#define NS_DEFAULTPORT 53 /*%< For both TCP and UDP. */
73/*
74 * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
75 * in synch with it.
76 */
77typedef enum __ns_sect {
78 ns_s_qd = 0, /*%< Query: Question. */
79 ns_s_zn = 0, /*%< Update: Zone. */
80 ns_s_an = 1, /*%< Query: Answer. */
81 ns_s_pr = 1, /*%< Update: Prerequisites. */
82 ns_s_ns = 2, /*%< Query: Name servers. */
83 ns_s_ud = 2, /*%< Update: Update. */
84 ns_s_ar = 3, /*%< Query|Update: Additional records. */
85 ns_s_max = 4
86} ns_sect;
87
88/*%
89 * This is a message handle. It is caller allocated and has no dynamic data.
90 * This structure is intended to be opaque to all but ns_parse.c, thus the
91 * leading _'s on the member names. Use the accessor functions, not the _'s.
92 */
93typedef struct __ns_msg {
94 const unsigned char *_msg, *_eom;
95 uint16_t _id, _flags, _counts[ns_s_max];
96 const unsigned char *_sections[ns_s_max];
97 ns_sect _sect;
98 int _rrnum;
99 const unsigned char *_msg_ptr;
100} ns_msg;
101
102/* Private data structure - do not use from outside library. */
103struct _ns_flagdata { int mask, shift; };
104extern const struct _ns_flagdata _ns_flagdata[];
105
106/* Accessor macros - this is part of the public interface. */
107
108#define ns_msg_id(handle) ((handle)._id + 0)
109#define ns_msg_base(handle) ((handle)._msg + 0)
110#define ns_msg_end(handle) ((handle)._eom + 0)
111#define ns_msg_size(handle) ((handle)._eom - (handle)._msg)
112#define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
113
114/*%
115 * This is a parsed record. It is caller allocated and has no dynamic data.
116 */
117typedef struct __ns_rr {
118 char name[NS_MAXDNAME];
119 uint16_t type;
120 uint16_t rr_class;
121 uint32_t ttl;
122 uint16_t rdlength;
123 const unsigned char * rdata;
124} ns_rr;
125
126/* Accessor macros - this is part of the public interface. */
127#define ns_rr_name(rr) (((rr).name[0] != '\0') ? (rr).name : ".")
128#define ns_rr_type(rr) ((ns_type)((rr).type + 0))
129#define ns_rr_class(rr) ((ns_class)((rr).rr_class + 0))
130#define ns_rr_ttl(rr) ((rr).ttl + 0)
131#define ns_rr_rdlen(rr) ((rr).rdlength + 0)
132#define ns_rr_rdata(rr) ((rr).rdata + 0)
133
134/*%
135 * These don't have to be in the same order as in the packet flags word,
136 * and they can even overlap in some cases, but they will need to be kept
137 * in synch with ns_parse.c:ns_flagdata[].
138 */
139typedef enum __ns_flag {
140 ns_f_qr, /*%< Question/Response. */
141 ns_f_opcode, /*%< Operation code. */
142 ns_f_aa, /*%< Authoritative Answer. */
143 ns_f_tc, /*%< Truncation occurred. */
144 ns_f_rd, /*%< Recursion Desired. */
145 ns_f_ra, /*%< Recursion Available. */
146 ns_f_z, /*%< MBZ. */
147 ns_f_ad, /*%< Authentic Data (DNSSEC). */
148 ns_f_cd, /*%< Checking Disabled (DNSSEC). */
149 ns_f_rcode, /*%< Response code. */
150 ns_f_max
151} ns_flag;
152
153/*%
154 * Currently defined opcodes.
155 */
156typedef enum __ns_opcode {
157 ns_o_query = 0, /*%< Standard query. */
158 ns_o_iquery = 1, /*%< Inverse query (deprecated/unsupported). */
159 ns_o_status = 2, /*%< Name server status query (unsupported). */
160 /* Opcode 3 is undefined/reserved. */
161 ns_o_notify = 4, /*%< Zone change notification. */
162 ns_o_update = 5, /*%< Zone update message. */
163 ns_o_max = 6
164} ns_opcode;
165
166/*%
167 * Currently defined response codes.
168 */
169typedef enum __ns_rcode {
170 ns_r_noerror = 0, /*%< No error occurred. */
171 ns_r_formerr = 1, /*%< Format error. */
172 ns_r_servfail = 2, /*%< Server failure. */
173 ns_r_nxdomain = 3, /*%< Name error. */
174 ns_r_notimpl = 4, /*%< Unimplemented. */
175 ns_r_refused = 5, /*%< Operation refused. */
176 /* these are for BIND_UPDATE */
177 ns_r_yxdomain = 6, /*%< Name exists */
178 ns_r_yxrrset = 7, /*%< RRset exists */
179 ns_r_nxrrset = 8, /*%< RRset does not exist */
180 ns_r_notauth = 9, /*%< Not authoritative for zone */
181 ns_r_notzone = 10, /*%< Zone of record different from zone section */
182 ns_r_max = 11,
183 /* The following are EDNS extended rcodes */
184 ns_r_badvers = 16,
185 /* The following are TSIG errors */
186 ns_r_badsig = 16,
187 ns_r_badkey = 17,
188 ns_r_badtime = 18
189} ns_rcode;
190
191/* BIND_UPDATE */
192typedef enum __ns_update_operation {
193 ns_uop_delete = 0,
194 ns_uop_add = 1,
195 ns_uop_max = 2
196} ns_update_operation;
197
198/*%
199 * This structure is used for TSIG authenticated messages
200 */
201struct ns_tsig_key {
202 char name[NS_MAXDNAME], alg[NS_MAXDNAME];
203 unsigned char *data;
204 int len;
205};
206typedef struct ns_tsig_key ns_tsig_key;
207
208/*%
209 * This structure is used for TSIG authenticated TCP messages
210 */
211struct ns_tcp_tsig_state {
212 int counter;
213 struct dst_key *key;
214 void *ctx;
215 unsigned char sig[NS_PACKETSZ];
216 int siglen;
217};
218typedef struct ns_tcp_tsig_state ns_tcp_tsig_state;
219
220#define NS_TSIG_FUDGE 300
221#define NS_TSIG_TCP_COUNT 100
222#define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"
223
224#define NS_TSIG_ERROR_NO_TSIG -10
225#define NS_TSIG_ERROR_NO_SPACE -11
226#define NS_TSIG_ERROR_FORMERR -12
227
228/*%
229 * Currently defined type values for resources and queries.
230 */
231typedef enum __ns_type
232 {
233 ns_t_invalid = 0,
234
235 ns_t_a = 1,
236 ns_t_ns = 2,
237 ns_t_md = 3,
238 ns_t_mf = 4,
239 ns_t_cname = 5,
240 ns_t_soa = 6,
241 ns_t_mb = 7,
242 ns_t_mg = 8,
243 ns_t_mr = 9,
244 ns_t_null = 10,
245 ns_t_wks = 11,
246 ns_t_ptr = 12,
247 ns_t_hinfo = 13,
248 ns_t_minfo = 14,
249 ns_t_mx = 15,
250 ns_t_txt = 16,
251 ns_t_rp = 17,
252 ns_t_afsdb = 18,
253 ns_t_x25 = 19,
254 ns_t_isdn = 20,
255 ns_t_rt = 21,
256 ns_t_nsap = 22,
257 ns_t_nsap_ptr = 23,
258 ns_t_sig = 24,
259 ns_t_key = 25,
260 ns_t_px = 26,
261 ns_t_gpos = 27,
262 ns_t_aaaa = 28,
263 ns_t_loc = 29,
264 ns_t_nxt = 30,
265 ns_t_eid = 31,
266 ns_t_nimloc = 32,
267 ns_t_srv = 33,
268 ns_t_atma = 34,
269 ns_t_naptr = 35,
270 ns_t_kx = 36,
271 ns_t_cert = 37,
272 ns_t_a6 = 38,
273 ns_t_dname = 39,
274 ns_t_sink = 40,
275 ns_t_opt = 41,
276 ns_t_apl = 42,
277 ns_t_ds = 43,
278 ns_t_sshfp = 44,
279 ns_t_ipseckey = 45,
280 ns_t_rrsig = 46,
281 ns_t_nsec = 47,
282 ns_t_dnskey = 48,
283 ns_t_dhcid = 49,
284 ns_t_nsec3 = 50,
285 ns_t_nsec3param = 51,
286 ns_t_tlsa = 52,
287 ns_t_smimea = 53,
288 ns_t_hip = 55,
289 ns_t_ninfo = 56,
290 ns_t_rkey = 57,
291 ns_t_talink = 58,
292 ns_t_cds = 59,
293 ns_t_cdnskey = 60,
294 ns_t_openpgpkey = 61,
295 ns_t_csync = 62,
296 ns_t_spf = 99,
297 ns_t_uinfo = 100,
298 ns_t_uid = 101,
299 ns_t_gid = 102,
300 ns_t_unspec = 103,
301 ns_t_nid = 104,
302 ns_t_l32 = 105,
303 ns_t_l64 = 106,
304 ns_t_lp = 107,
305 ns_t_eui48 = 108,
306 ns_t_eui64 = 109,
307 ns_t_tkey = 249,
308 ns_t_tsig = 250,
309 ns_t_ixfr = 251,
310 ns_t_axfr = 252,
311 ns_t_mailb = 253,
312 ns_t_maila = 254,
313 ns_t_any = 255,
314 ns_t_uri = 256,
315 ns_t_caa = 257,
316 ns_t_avc = 258,
317 ns_t_ta = 32768,
318 ns_t_dlv = 32769,
319
320 ns_t_max = 65536
321 } ns_type;
322
323/*%
324 * Values for class field
325 */
326typedef enum __ns_class {
327 ns_c_invalid = 0, /*%< Cookie. */
328 ns_c_in = 1, /*%< Internet. */
329 ns_c_2 = 2, /*%< unallocated/unsupported. */
330 ns_c_chaos = 3, /*%< MIT Chaos-net. */
331 ns_c_hs = 4, /*%< MIT Hesiod. */
332 /* Query class values which do not appear in resource records */
333 ns_c_none = 254, /*%< for prereq. sections in update requests */
334 ns_c_any = 255, /*%< Wildcard match. */
335 ns_c_max = 65536
336} ns_class;
337
338/* Certificate type values in CERT resource records. */
339typedef enum __ns_cert_types {
340 cert_t_pkix = 1, /*%< PKIX (X.509v3) */
341 cert_t_spki = 2, /*%< SPKI */
342 cert_t_pgp = 3, /*%< PGP */
343 cert_t_url = 253, /*%< URL private type */
344 cert_t_oid = 254 /*%< OID private type */
345} ns_cert_types;
346
347/*%
348 * EDNS0 extended flags and option codes, host order.
349 */
350#define NS_OPT_DNSSEC_OK 0x8000U
351#define NS_OPT_NSID 3
352
353/*%
354 * Inline versions of get/put short/long. Pointer is advanced.
355 */
356#define NS_GET16(s, cp) do { \
357 const unsigned char *t_cp = (const unsigned char *)(cp); \
358 (s) = ((uint16_t)t_cp[0] << 8) \
359 | ((uint16_t)t_cp[1]) \
360 ; \
361 (cp) += NS_INT16SZ; \
362} while (0)
363
364#define NS_GET32(l, cp) do { \
365 const unsigned char *t_cp = (const unsigned char *)(cp); \
366 (l) = ((uint32_t)t_cp[0] << 24) \
367 | ((uint32_t)t_cp[1] << 16) \
368 | ((uint32_t)t_cp[2] << 8) \
369 | ((uint32_t)t_cp[3]) \
370 ; \
371 (cp) += NS_INT32SZ; \
372} while (0)
373
374#define NS_PUT16(s, cp) do { \
375 uint16_t t_s = (uint16_t)(s); \
376 unsigned char *t_cp = (unsigned char *)(cp); \
377 *t_cp++ = t_s >> 8; \
378 *t_cp = t_s; \
379 (cp) += NS_INT16SZ; \
380} while (0)
381
382#define NS_PUT32(l, cp) do { \
383 uint32_t t_l = (uint32_t)(l); \
384 unsigned char *t_cp = (unsigned char *)(cp); \
385 *t_cp++ = t_l >> 24; \
386 *t_cp++ = t_l >> 16; \
387 *t_cp++ = t_l >> 8; \
388 *t_cp = t_l; \
389 (cp) += NS_INT32SZ; \
390} while (0)
391
392__BEGIN_DECLS
393int ns_msg_getflag (ns_msg, int) __THROW;
394unsigned int ns_get16 (const unsigned char *) __THROW;
395unsigned long ns_get32 (const unsigned char *) __THROW;
396void ns_put16 (unsigned int, unsigned char *) __THROW;
397void ns_put32 (unsigned long, unsigned char *) __THROW;
398int ns_initparse (const unsigned char *, int, ns_msg *) __THROW;
399int ns_skiprr (const unsigned char *, const unsigned char *,
400 ns_sect, int) __THROW;
401int ns_parserr (ns_msg *, ns_sect, int, ns_rr *) __THROW;
402int ns_sprintrr (const ns_msg *, const ns_rr *,
403 const char *, const char *, char *, size_t)
404 __THROW;
405int ns_sprintrrf (const unsigned char *, size_t, const char *,
406 ns_class, ns_type, unsigned long,
407 const unsigned char *, size_t, const char *,
408 const char *, char *, size_t) __THROW;
409int ns_format_ttl (unsigned long, char *, size_t) __THROW;
410int ns_parse_ttl (const char *, unsigned long *) __THROW;
411uint32_t ns_datetosecs (const char *, int *) __THROW;
412int ns_name_ntol (const unsigned char *, unsigned char *, size_t)
413 __THROW;
414int ns_name_ntop (const unsigned char *, char *, size_t) __THROW;
415int ns_name_pton (const char *, unsigned char *, size_t) __THROW;
416int ns_name_unpack (const unsigned char *, const unsigned char *,
417 const unsigned char *, unsigned char *, size_t)
418 __THROW;
419int ns_name_pack (const unsigned char *, unsigned char *, int,
420 const unsigned char **, const unsigned char **)
421 __THROW;
422int ns_name_uncompress (const unsigned char *,
423 const unsigned char *,
424 const unsigned char *,
425 char *, size_t) __THROW;
426int ns_name_compress (const char *, unsigned char *, size_t,
427 const unsigned char **,
428 const unsigned char **) __THROW;
429int ns_name_skip (const unsigned char **, const unsigned char *)
430 __THROW;
431void ns_name_rollback (const unsigned char *,
432 const unsigned char **,
433 const unsigned char **) __THROW;
434int ns_samedomain (const char *, const char *) __THROW;
435int ns_subdomain (const char *, const char *) __THROW;
436int ns_makecanon (const char *, char *, size_t) __THROW;
437int ns_samename (const char *, const char *) __THROW;
438__END_DECLS
439
440#include <arpa/nameser_compat.h>
441
442#endif /* !_ARPA_NAMESER_H_ */
443/*! \file */
444