blob: 89ece1c5e45e24eda8431e6e23257eecd552d13d [file] [log] [blame]
Calin Juravlefcb502e2014-03-05 15:06:52 +00001/* $NetBSD: nameser.h,v 1.25 2009/04/12 17:07:34 christos Exp $ */
2
3/*
4 * Portions Copyright (C) 2004, 2005, 2008, 2009 Internet Systems Consortium, Inc. ("ISC")
5 * Portions Copyright (C) 1996-2003 Internet Software Consortium.
6 *
7 * Permission to use, copy, modify, and/or distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17 * PERFORMANCE OF THIS SOFTWARE.
18 */
Calin Juravle569fb982014-03-04 15:01:29 +000019
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080020/*
Calin Juravle569fb982014-03-04 15:01:29 +000021 * Copyright (c) 1983, 1989, 1993
22 * The Regents of the University of California. All rights reserved.
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080023 *
24 * Redistribution and use in source and binary forms, with or without
25 * modification, are permitted provided that the following conditions
26 * are met:
Calin Juravle569fb982014-03-04 15:01:29 +000027 * 1. Redistributions of source code must retain the above copyright
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080028 * notice, this list of conditions and the following disclaimer.
Calin Juravle569fb982014-03-04 15:01:29 +000029 * 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.
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080035 *
Calin Juravle569fb982014-03-04 15:01:29 +000036 * 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
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080046 * SUCH DAMAGE.
47 */
Calin Juravle569fb982014-03-04 15:01:29 +000048
49/*
Calin Juravlefcb502e2014-03-05 15:06:52 +000050 * Id: nameser.h,v 1.16 2009/03/03 01:52:48 each Exp
Calin Juravle569fb982014-03-04 15:01:29 +000051 */
52
53#ifndef _ARPA_NAMESER_H_
54#define _ARPA_NAMESER_H_
55
56#define BIND_4_COMPAT
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080057
58#include <sys/types.h>
59#include <sys/cdefs.h>
60
Calin Juravle569fb982014-03-04 15:01:29 +000061/*
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.
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080067 */
68
Calin Juravlefcb502e2014-03-05 15:06:52 +000069#define __NAMESER 20090302 /*%< New interface version stamp. */
Calin Juravle569fb982014-03-04 15:01:29 +000070
71/*
Calin Juravlefcb502e2014-03-05 15:06:52 +000072 * Define constants based on RFC0883, RFC1034, RFC 1035
Calin Juravle569fb982014-03-04 15:01:29 +000073 */
74#define NS_PACKETSZ 512 /* default UDP packet size */
Calin Juravlefcb502e2014-03-05 15:06:52 +000075#define NS_MAXDNAME 1025 /* maximum domain name (presentation format)*/
Calin Juravle569fb982014-03-04 15:01:29 +000076#define NS_MAXMSG 65535 /* maximum message size */
77#define NS_MAXCDNAME 255 /* maximum compressed domain name */
78#define NS_MAXLABEL 63 /* maximum length of domain label */
Calin Juravlefcb502e2014-03-05 15:06:52 +000079#define NS_MAXLABELS 128 /* theoretical max #/labels per domain name */
80#define NS_MAXNNAME 256 /* maximum uncompressed (binary) domain name*/
81#define NS_MAXPADDR (sizeof "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff")
Calin Juravle569fb982014-03-04 15:01:29 +000082#define NS_HFIXEDSZ 12 /* #/bytes of fixed data in header */
83#define NS_QFIXEDSZ 4 /* #/bytes of fixed data in query */
84#define NS_RRFIXEDSZ 10 /* #/bytes of fixed data in r record */
85#define NS_INT32SZ 4 /* #/bytes of data in a uint32_t */
86#define NS_INT16SZ 2 /* #/bytes of data in a uint16_t */
87#define NS_INT8SZ 1 /* #/bytes of data in a uint8_t */
88#define NS_INADDRSZ 4 /* IPv4 T_A */
89#define NS_IN6ADDRSZ 16 /* IPv6 T_AAAA */
90#define NS_CMPRSFLGS 0xc0 /* Flag bits indicating name compression. */
91#define NS_DEFAULTPORT 53 /* For both TCP and UDP. */
92
93/*
94 * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
95 * in synch with it.
96 */
97typedef enum __ns_sect {
98 ns_s_qd = 0, /* Query: Question. */
99 ns_s_zn = 0, /* Update: Zone. */
100 ns_s_an = 1, /* Query: Answer. */
101 ns_s_pr = 1, /* Update: Prerequisites. */
102 ns_s_ns = 2, /* Query: Name servers. */
103 ns_s_ud = 2, /* Update: Update. */
104 ns_s_ar = 3, /* Query|Update: Additional records. */
105 ns_s_max = 4
106} ns_sect;
107
108/*
Calin Juravlefcb502e2014-03-05 15:06:52 +0000109 * Network name (compressed or not) type. Equivilent to a pointer when used
110 * in a function prototype. Can be const'd.
111 */
112typedef u_char ns_nname[NS_MAXNNAME];
113typedef const u_char *ns_nname_ct;
114typedef u_char *ns_nname_t;
115
116struct ns_namemap { ns_nname_ct base; int len; };
117typedef struct ns_namemap *ns_namemap_t;
118typedef const struct ns_namemap *ns_namemap_ct;
119
120/*
Calin Juravle569fb982014-03-04 15:01:29 +0000121 * This is a message handle. It is caller allocated and has no dynamic data.
122 * This structure is intended to be opaque to all but ns_parse.c, thus the
123 * leading _'s on the member names. Use the accessor functions, not the _'s.
124 */
125typedef struct __ns_msg {
126 const u_char *_msg, *_eom;
127 uint16_t _id, _flags, _counts[ns_s_max];
128 const u_char *_sections[ns_s_max];
129 ns_sect _sect;
130 int _rrnum;
131 const u_char *_msg_ptr;
132} ns_msg;
Calin Juravlefcb502e2014-03-05 15:06:52 +0000133/*
134 * This is a newmsg handle, used when constructing new messages with
135 * ns_newmsg_init, et al.
136 */
137struct ns_newmsg {
138 ns_msg msg;
139 const u_char *dnptrs[25];
140 const u_char **lastdnptr;
141};
142typedef struct ns_newmsg ns_newmsg;
Calin Juravle569fb982014-03-04 15:01:29 +0000143
Calin Juravle569fb982014-03-04 15:01:29 +0000144/* Accessor macros - this is part of the public interface. */
145
146#define ns_msg_id(handle) ((handle)._id + 0)
147#define ns_msg_base(handle) ((handle)._msg + 0)
148#define ns_msg_end(handle) ((handle)._eom + 0)
149#define ns_msg_size(handle) ((size_t)((handle)._eom - (handle)._msg))
150#define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
151
152/*
153 * This is a parsed record. It is caller allocated and has no dynamic data.
154 */
155typedef struct __ns_rr {
156 char name[NS_MAXDNAME];
157 uint16_t type;
158 uint16_t rr_class;
159 uint32_t ttl;
160 uint16_t rdlength;
161 const u_char * rdata;
162} ns_rr;
163
Calin Juravlefcb502e2014-03-05 15:06:52 +0000164/*
165 * Same thing, but using uncompressed network binary names, and real C types.
166 */
167typedef struct __ns_rr2 {
168 ns_nname nname;
169 size_t nnamel;
170 int type;
171 int rr_class;
172 u_int ttl;
173 int rdlength;
174 const u_char * rdata;
175} ns_rr2;
Calin Juravle569fb982014-03-04 15:01:29 +0000176/* Accessor macros - this is part of the public interface. */
177#define ns_rr_name(rr) (((rr).name[0] != '\0') ? (rr).name : ".")
Calin Juravlefcb502e2014-03-05 15:06:52 +0000178#define ns_rr_nname(rr) ((const ns_nname_t)(rr).nname)
179#define ns_rr_nnamel(rr) ((rr).nnamel + 0)
Calin Juravle569fb982014-03-04 15:01:29 +0000180#define ns_rr_type(rr) ((ns_type)((rr).type + 0))
181#define ns_rr_class(rr) ((ns_class)((rr).rr_class + 0))
182#define ns_rr_ttl(rr) ((u_long)(rr).ttl + 0)
183#define ns_rr_rdlen(rr) ((size_t)(rr).rdlength + 0)
184#define ns_rr_rdata(rr) ((rr).rdata + 0)
185
186/*
187 * These don't have to be in the same order as in the packet flags word,
188 * and they can even overlap in some cases, but they will need to be kept
189 * in synch with ns_parse.c:ns_flagdata[].
190 */
191typedef enum __ns_flag {
192 ns_f_qr, /* Question/Response. */
193 ns_f_opcode, /* Operation code. */
194 ns_f_aa, /* Authoritative Answer. */
195 ns_f_tc, /* Truncation occurred. */
196 ns_f_rd, /* Recursion Desired. */
197 ns_f_ra, /* Recursion Available. */
198 ns_f_z, /* MBZ. */
199 ns_f_ad, /* Authentic Data (DNSSEC). */
200 ns_f_cd, /* Checking Disabled (DNSSEC). */
201 ns_f_rcode, /* Response code. */
202 ns_f_max
203} ns_flag;
204
205/*
206 * Currently defined opcodes.
207 */
208typedef enum __ns_opcode {
209 ns_o_query = 0, /* Standard query. */
210 ns_o_iquery = 1, /* Inverse query (deprecated/unsupported). */
211 ns_o_status = 2, /* Name server status query (unsupported). */
212 /* Opcode 3 is undefined/reserved. */
213 ns_o_notify = 4, /* Zone change notification. */
214 ns_o_update = 5, /* Zone update message. */
215 ns_o_max = 6
216} ns_opcode;
217
218/*
219 * Currently defined response codes.
220 */
221typedef enum __ns_rcode {
222 ns_r_noerror = 0, /* No error occurred. */
223 ns_r_formerr = 1, /* Format error. */
224 ns_r_servfail = 2, /* Server failure. */
225 ns_r_nxdomain = 3, /* Name error. */
226 ns_r_notimpl = 4, /* Unimplemented. */
227 ns_r_refused = 5, /* Operation refused. */
228 /* these are for BIND_UPDATE */
229 ns_r_yxdomain = 6, /* Name exists */
230 ns_r_yxrrset = 7, /* RRset exists */
231 ns_r_nxrrset = 8, /* RRset does not exist */
232 ns_r_notauth = 9, /* Not authoritative for zone */
233 ns_r_notzone = 10, /* Zone of record different from zone section */
234 ns_r_max = 11,
235 /* The following are EDNS extended rcodes */
236 ns_r_badvers = 16,
237 /* The following are TSIG errors */
238 ns_r_badsig = 16,
239 ns_r_badkey = 17,
240 ns_r_badtime = 18
241} ns_rcode;
242
243/* BIND_UPDATE */
244typedef enum __ns_update_operation {
245 ns_uop_delete = 0,
246 ns_uop_add = 1,
247 ns_uop_max = 2
248} ns_update_operation;
249
250/*
251 * This structure is used for TSIG authenticated messages
252 */
253struct ns_tsig_key {
254 char name[NS_MAXDNAME], alg[NS_MAXDNAME];
255 unsigned char *data;
256 int len;
257};
258typedef struct ns_tsig_key ns_tsig_key;
259
260/*
261 * This structure is used for TSIG authenticated TCP messages
262 */
263struct ns_tcp_tsig_state {
264 int counter;
265 struct dst_key *key;
266 void *ctx;
267 unsigned char sig[NS_PACKETSZ];
268 int siglen;
269};
270typedef struct ns_tcp_tsig_state ns_tcp_tsig_state;
271
272#define NS_TSIG_FUDGE 300
273#define NS_TSIG_TCP_COUNT 100
274#define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"
275
276#define NS_TSIG_ERROR_NO_TSIG -10
277#define NS_TSIG_ERROR_NO_SPACE -11
278#define NS_TSIG_ERROR_FORMERR -12
279
280/*
281 * Currently defined type values for resources and queries.
282 */
283typedef enum __ns_type {
284 ns_t_invalid = 0, /* Cookie. */
285 ns_t_a = 1, /* Host address. */
286 ns_t_ns = 2, /* Authoritative server. */
287 ns_t_md = 3, /* Mail destination. */
288 ns_t_mf = 4, /* Mail forwarder. */
289 ns_t_cname = 5, /* Canonical name. */
290 ns_t_soa = 6, /* Start of authority zone. */
291 ns_t_mb = 7, /* Mailbox domain name. */
292 ns_t_mg = 8, /* Mail group member. */
293 ns_t_mr = 9, /* Mail rename name. */
294 ns_t_null = 10, /* Null resource record. */
295 ns_t_wks = 11, /* Well known service. */
296 ns_t_ptr = 12, /* Domain name pointer. */
297 ns_t_hinfo = 13, /* Host information. */
298 ns_t_minfo = 14, /* Mailbox information. */
299 ns_t_mx = 15, /* Mail routing information. */
300 ns_t_txt = 16, /* Text strings. */
301 ns_t_rp = 17, /* Responsible person. */
302 ns_t_afsdb = 18, /* AFS cell database. */
303 ns_t_x25 = 19, /* X_25 calling address. */
304 ns_t_isdn = 20, /* ISDN calling address. */
305 ns_t_rt = 21, /* Router. */
306 ns_t_nsap = 22, /* NSAP address. */
307 ns_t_nsap_ptr = 23, /* Reverse NSAP lookup (deprecated). */
308 ns_t_sig = 24, /* Security signature. */
309 ns_t_key = 25, /* Security key. */
310 ns_t_px = 26, /* X.400 mail mapping. */
311 ns_t_gpos = 27, /* Geographical position (withdrawn). */
Calin Juravlefcb502e2014-03-05 15:06:52 +0000312 ns_t_aaaa = 28, /* IPv6 Address. */
Calin Juravle569fb982014-03-04 15:01:29 +0000313 ns_t_loc = 29, /* Location Information. */
314 ns_t_nxt = 30, /* Next domain (security). */
315 ns_t_eid = 31, /* Endpoint identifier. */
316 ns_t_nimloc = 32, /* Nimrod Locator. */
317 ns_t_srv = 33, /* Server Selection. */
318 ns_t_atma = 34, /* ATM Address */
319 ns_t_naptr = 35, /* Naming Authority PoinTeR */
320 ns_t_kx = 36, /* Key Exchange */
321 ns_t_cert = 37, /* Certification record */
Calin Juravlefcb502e2014-03-05 15:06:52 +0000322 ns_t_a6 = 38, /* IPv6 address (experimental) */
323 ns_t_dname = 39, /* Non-terminal DNAME */
Calin Juravle569fb982014-03-04 15:01:29 +0000324 ns_t_sink = 40, /* Kitchen sink (experimentatl) */
325 ns_t_opt = 41, /* EDNS0 option (meta-RR) */
326 ns_t_apl = 42, /* Address prefix list (RFC 3123) */
Calin Juravlefcb502e2014-03-05 15:06:52 +0000327 ns_t_ds = 43, /* Delegation Signer */
328 ns_t_sshfp = 44, /* SSH Fingerprint */
329 ns_t_ipseckey = 45, /* IPSEC Key */
330 ns_t_rrsig = 46, /* RRset Signature */
331 ns_t_nsec = 47, /* Negative security */
332 ns_t_dnskey = 48, /* DNS Key */
333 ns_t_dhcid = 49, /* Dynamic host configuratin identifier */
334 ns_t_nsec3 = 50, /* Negative security type 3 */
335 ns_t_nsec3param = 51, /* Negative security type 3 parameters */
336 ns_t_hip = 55, /* Host Identity Protocol */
337 ns_t_spf = 99, /* Sender Policy Framework */
Calin Juravle569fb982014-03-04 15:01:29 +0000338 ns_t_tkey = 249, /* Transaction key */
339 ns_t_tsig = 250, /* Transaction signature. */
340 ns_t_ixfr = 251, /* Incremental zone transfer. */
341 ns_t_axfr = 252, /* Transfer zone of authority. */
342 ns_t_mailb = 253, /* Transfer mailbox records. */
343 ns_t_maila = 254, /* Transfer mail agent records. */
344 ns_t_any = 255, /* Wildcard match. */
345 ns_t_zxfr = 256, /* BIND-specific, nonstandard. */
Calin Juravlefcb502e2014-03-05 15:06:52 +0000346 ns_t_dlv = 32769, /* DNSSEC look-aside validatation. */
Calin Juravle569fb982014-03-04 15:01:29 +0000347 ns_t_max = 65536
348} ns_type;
349
350/* Exclusively a QTYPE? (not also an RTYPE) */
351#define ns_t_qt_p(t) (ns_t_xfr_p(t) || (t) == ns_t_any || \
352 (t) == ns_t_mailb || (t) == ns_t_maila)
353/* Some kind of meta-RR? (not a QTYPE, but also not an RTYPE) */
354#define ns_t_mrr_p(t) ((t) == ns_t_tsig || (t) == ns_t_opt)
355/* Exclusively an RTYPE? (not also a QTYPE or a meta-RR) */
356#define ns_t_rr_p(t) (!ns_t_qt_p(t) && !ns_t_mrr_p(t))
357#define ns_t_udp_p(t) ((t) != ns_t_axfr && (t) != ns_t_zxfr)
358#define ns_t_xfr_p(t) ((t) == ns_t_axfr || (t) == ns_t_ixfr || \
359 (t) == ns_t_zxfr)
360
361/*
362 * Values for class field
363 */
364typedef enum __ns_class {
365 ns_c_invalid = 0, /* Cookie. */
366 ns_c_in = 1, /* Internet. */
367 ns_c_2 = 2, /* unallocated/unsupported. */
368 ns_c_chaos = 3, /* MIT Chaos-net. */
369 ns_c_hs = 4, /* MIT Hesiod. */
370 /* Query class values which do not appear in resource records */
371 ns_c_none = 254, /* for prereq. sections in update requests */
372 ns_c_any = 255, /* Wildcard match. */
373 ns_c_max = 65536
374} ns_class;
375
376/* DNSSEC constants. */
377
378typedef enum __ns_key_types {
379 ns_kt_rsa = 1, /* key type RSA/MD5 */
380 ns_kt_dh = 2, /* Diffie Hellman */
381 ns_kt_dsa = 3, /* Digital Signature Standard (MANDATORY) */
382 ns_kt_private = 254 /* Private key type starts with OID */
383} ns_key_types;
384
385typedef enum __ns_cert_types {
386 cert_t_pkix = 1, /* PKIX (X.509v3) */
387 cert_t_spki = 2, /* SPKI */
388 cert_t_pgp = 3, /* PGP */
389 cert_t_url = 253, /* URL private type */
390 cert_t_oid = 254 /* OID private type */
391} ns_cert_types;
392
393/* Flags field of the KEY RR rdata. */
394#define NS_KEY_TYPEMASK 0xC000 /* Mask for "type" bits */
395#define NS_KEY_TYPE_AUTH_CONF 0x0000 /* Key usable for both */
396#define NS_KEY_TYPE_CONF_ONLY 0x8000 /* Key usable for confidentiality */
397#define NS_KEY_TYPE_AUTH_ONLY 0x4000 /* Key usable for authentication */
398#define NS_KEY_TYPE_NO_KEY 0xC000 /* No key usable for either; no key */
399/* The type bits can also be interpreted independently, as single bits: */
400#define NS_KEY_NO_AUTH 0x8000 /* Key unusable for authentication */
401#define NS_KEY_NO_CONF 0x4000 /* Key unusable for confidentiality */
402#define NS_KEY_RESERVED2 0x2000 /* Security is *mandatory* if bit=0 */
403#define NS_KEY_EXTENDED_FLAGS 0x1000 /* reserved - must be zero */
404#define NS_KEY_RESERVED4 0x0800 /* reserved - must be zero */
405#define NS_KEY_RESERVED5 0x0400 /* reserved - must be zero */
406#define NS_KEY_NAME_TYPE 0x0300 /* these bits determine the type */
407#define NS_KEY_NAME_USER 0x0000 /* key is assoc. with user */
408#define NS_KEY_NAME_ENTITY 0x0200 /* key is assoc. with entity eg host */
409#define NS_KEY_NAME_ZONE 0x0100 /* key is zone key */
410#define NS_KEY_NAME_RESERVED 0x0300 /* reserved meaning */
411#define NS_KEY_RESERVED8 0x0080 /* reserved - must be zero */
412#define NS_KEY_RESERVED9 0x0040 /* reserved - must be zero */
413#define NS_KEY_RESERVED10 0x0020 /* reserved - must be zero */
414#define NS_KEY_RESERVED11 0x0010 /* reserved - must be zero */
415#define NS_KEY_SIGNATORYMASK 0x000F /* key can sign RR's of same name */
416#define NS_KEY_RESERVED_BITMASK ( NS_KEY_RESERVED2 | \
417 NS_KEY_RESERVED4 | \
418 NS_KEY_RESERVED5 | \
419 NS_KEY_RESERVED8 | \
420 NS_KEY_RESERVED9 | \
421 NS_KEY_RESERVED10 | \
422 NS_KEY_RESERVED11 )
423#define NS_KEY_RESERVED_BITMASK2 0xFFFF /* no bits defined here */
424
425/* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */
426#define NS_ALG_MD5RSA 1 /* MD5 with RSA */
427#define NS_ALG_DH 2 /* Diffie Hellman KEY */
428#define NS_ALG_DSA 3 /* DSA KEY */
429#define NS_ALG_DSS NS_ALG_DSA
430#define NS_ALG_EXPIRE_ONLY 253 /* No alg, no security */
431#define NS_ALG_PRIVATE_OID 254 /* Key begins with OID giving alg */
432
433/* Protocol values */
434/* value 0 is reserved */
435#define NS_KEY_PROT_TLS 1
436#define NS_KEY_PROT_EMAIL 2
437#define NS_KEY_PROT_DNSSEC 3
438#define NS_KEY_PROT_IPSEC 4
439#define NS_KEY_PROT_ANY 255
440
441/* Signatures */
442#define NS_MD5RSA_MIN_BITS 512 /* Size of a mod or exp in bits */
443#define NS_MD5RSA_MAX_BITS 4096
444 /* Total of binary mod and exp */
445#define NS_MD5RSA_MAX_BYTES ((NS_MD5RSA_MAX_BITS+7/8)*2+3)
446 /* Max length of text sig block */
447#define NS_MD5RSA_MAX_BASE64 (((NS_MD5RSA_MAX_BYTES+2)/3)*4)
448#define NS_MD5RSA_MIN_SIZE ((NS_MD5RSA_MIN_BITS+7)/8)
449#define NS_MD5RSA_MAX_SIZE ((NS_MD5RSA_MAX_BITS+7)/8)
450
451#define NS_DSA_SIG_SIZE 41
452#define NS_DSA_MIN_SIZE 213
453#define NS_DSA_MAX_BYTES 405
454
455/* Offsets into SIG record rdata to find various values */
456#define NS_SIG_TYPE 0 /* Type flags */
457#define NS_SIG_ALG 2 /* Algorithm */
458#define NS_SIG_LABELS 3 /* How many labels in name */
459#define NS_SIG_OTTL 4 /* Original TTL */
460#define NS_SIG_EXPIR 8 /* Expiration time */
461#define NS_SIG_SIGNED 12 /* Signature time */
462#define NS_SIG_FOOT 16 /* Key footprint */
463#define NS_SIG_SIGNER 18 /* Domain name of who signed it */
464
465/* How RR types are represented as bit-flags in NXT records */
466#define NS_NXT_BITS 8
467#define NS_NXT_BIT_SET( n,p) (p[(n)/NS_NXT_BITS] |= (0x80>>((n)%NS_NXT_BITS)))
468#define NS_NXT_BIT_CLEAR(n,p) (p[(n)/NS_NXT_BITS] &= ~(0x80>>((n)%NS_NXT_BITS)))
469#define NS_NXT_BIT_ISSET(n,p) (p[(n)/NS_NXT_BITS] & (0x80>>((n)%NS_NXT_BITS)))
470#define NS_NXT_MAX 127
471
472/*
Calin Juravlefcb502e2014-03-05 15:06:52 +0000473 * EDNS0 extended flags and option codes, host order.
Calin Juravle569fb982014-03-04 15:01:29 +0000474 */
475#define NS_OPT_DNSSEC_OK 0x8000U
Calin Juravlefcb502e2014-03-05 15:06:52 +0000476#define NS_OPT_NSID 3
Ben Schwartz27dd9152018-02-05 17:54:06 -0500477#define NS_OPT_PADDING 12
Calin Juravle569fb982014-03-04 15:01:29 +0000478
479/*
480 * Inline versions of get/put short/long. Pointer is advanced.
481 */
482#define NS_GET16(s, cp) do { \
483 const u_char *t_cp = (const u_char *)(cp); \
484 (s) = ((uint16_t)t_cp[0] << 8) \
485 | ((uint16_t)t_cp[1]) \
486 ; \
487 (cp) += NS_INT16SZ; \
488} while (/*CONSTCOND*/0)
489
490#define NS_GET32(l, cp) do { \
491 const u_char *t_cp = (const u_char *)(cp); \
492 (l) = ((uint32_t)t_cp[0] << 24) \
493 | ((uint32_t)t_cp[1] << 16) \
494 | ((uint32_t)t_cp[2] << 8) \
495 | ((uint32_t)t_cp[3]) \
496 ; \
497 (cp) += NS_INT32SZ; \
498} while (/*CONSTCOND*/0)
499
500#define NS_PUT16(s, cp) do { \
501 uint32_t t_s = (uint32_t)(s); \
502 u_char *t_cp = (u_char *)(cp); \
503 *t_cp++ = t_s >> 8; \
504 *t_cp = t_s; \
505 (cp) += NS_INT16SZ; \
506} while (/*CONSTCOND*/0)
507
508#define NS_PUT32(l, cp) do { \
509 uint32_t t_l = (uint32_t)(l); \
510 u_char *t_cp = (u_char *)(cp); \
511 *t_cp++ = t_l >> 24; \
512 *t_cp++ = t_l >> 16; \
513 *t_cp++ = t_l >> 8; \
514 *t_cp = t_l; \
515 (cp) += NS_INT32SZ; \
516} while (/*CONSTCOND*/0)
517
Josh Gao8a03c832016-07-26 16:47:48 -0700518__BEGIN_DECLS
519
Elliott Hughes42804c42014-12-04 12:39:46 -0800520#if !defined(__LP64__)
521/* Annoyingly, LP32 shipped with __ names. */
Calin Juravle569fb982014-03-04 15:01:29 +0000522#define ns_msg_getflag __ns_msg_getflag
523#define ns_get16 __ns_get16
524#define ns_get32 __ns_get32
525#define ns_put16 __ns_put16
526#define ns_put32 __ns_put32
527#define ns_initparse __ns_initparse
528#define ns_skiprr __ns_skiprr
529#define ns_parserr __ns_parserr
Calin Juravlefcb502e2014-03-05 15:06:52 +0000530#define ns_parserr2 __ns_parserr2
Calin Juravle569fb982014-03-04 15:01:29 +0000531#define ns_sprintrr __ns_sprintrr
532#define ns_sprintrrf __ns_sprintrrf
533#define ns_format_ttl __ns_format_ttl
534#define ns_parse_ttl __ns_parse_ttl
535#define ns_datetosecs __ns_datetosecs
536#define ns_name_ntol __ns_name_ntol
537#define ns_name_ntop __ns_name_ntop
538#define ns_name_pton __ns_name_pton
Calin Juravlefcb502e2014-03-05 15:06:52 +0000539#define ns_name_pton2 __ns_name_pton2
Calin Juravle569fb982014-03-04 15:01:29 +0000540#define ns_name_unpack __ns_name_unpack
Calin Juravlefcb502e2014-03-05 15:06:52 +0000541#define ns_name_unpack2 __ns_name_unpack2
Calin Juravle569fb982014-03-04 15:01:29 +0000542#define ns_name_pack __ns_name_pack
543#define ns_name_compress __ns_name_compress
544#define ns_name_uncompress __ns_name_uncompress
545#define ns_name_skip __ns_name_skip
546#define ns_name_rollback __ns_name_rollback
Calin Juravlefcb502e2014-03-05 15:06:52 +0000547#define ns_name_length __ns_name_length
548#define ns_name_eq __ns_name_eq
549#define ns_name_owned __ns_name_owned
550#define ns_name_map __ns_name_map
551#define ns_name_labels __ns_name_labels
Calin Juravle569fb982014-03-04 15:01:29 +0000552#define ns_sign __ns_sign
553#define ns_sign2 __ns_sign2
554#define ns_sign_tcp __ns_sign_tcp
555#define ns_sign_tcp2 __ns_sign_tcp2
556#define ns_sign_tcp_init __ns_sign_tcp_init
557#define ns_find_tsig __ns_find_tsig
558#define ns_verify __ns_verify
559#define ns_verify_tcp __ns_verify_tcp
560#define ns_verify_tcp_init __ns_verify_tcp_init
561#define ns_samedomain __ns_samedomain
562#define ns_subdomain __ns_subdomain
563#define ns_makecanon __ns_makecanon
564#define ns_samename __ns_samename
565
Elliott Hughesffde5332017-08-21 14:51:59 -0700566int ns_msg_getflag(ns_msg __handle, int __flag);
567uint16_t ns_get16(const u_char* __src);
568uint32_t ns_get32(const u_char* __src);
569void ns_put16(uint16_t __src, u_char* __dst);
570void ns_put32(uint32_t __src, u_char* __dst);
571int ns_initparse(const u_char* __msg, int __msg_size, ns_msg* __handle);
572int ns_skiprr(const u_char* __ptr, const u_char* __eom, ns_sect __section, int __count);
573int ns_parserr(ns_msg* __handle, ns_sect __section, int __rr_number, ns_rr* __rr);
574int ns_sprintrr(const ns_msg* __handle, const ns_rr* __rr, const char* __name_ctx, const char* __origin, char* __buf, size_t __buf_size);
575int ns_sprintrrf(const u_char* __msg, size_t __msg_size, const char* __name, ns_class __class, ns_type __type, u_long __ttl, const u_char* __rdata, size_t __rdata_size, const char* __name_ctx, const char* __origin, char* __buf, size_t __buf_size);
576int ns_format_ttl(u_long __ttl, char* __dst, size_t __dst_size);
577int ns_name_ntol(const u_char* __src, u_char* __dst, size_t __dst_size);
578int ns_name_ntop(const u_char* __src, char* __dst, size_t __dst_size);
579int ns_name_pton(const char* __src, u_char* __dst, size_t __dst_size);
580int ns_name_unpack(const u_char* __msg, const u_char* __eom, const u_char* __src, u_char* __dst, size_t __dst_size);
581int ns_name_pack(const u_char* __src, u_char* __dst, int __dst_size, const u_char** __dn_ptrs, const u_char** __last_dn_ptr);
582int ns_name_uncompress(const u_char* __msg, const u_char* __eom, const u_char* __src, char* __dst, size_t __dst_size);
583int ns_name_compress(const char* __src, u_char* __dst, size_t __dst_size, const u_char** __dn_ptrs, const u_char** __last_dn_ptr);
584int ns_name_skip(const u_char** __ptr_ptr, const u_char* __eom);
585void ns_name_rollback(const u_char* __src, const u_char** __dn_ptrs, const u_char** __last_dn_ptr);
Josh Gao8a03c832016-07-26 16:47:48 -0700586
Elliott Hughesffde5332017-08-21 14:51:59 -0700587int ns_makecanon(const char* __src, char* __dst, size_t __dst_size);
588int ns_samename(const char* __lhs, const char* __rhs);
Josh Gao8a03c832016-07-26 16:47:48 -0700589
590#else
591/* The names of these symbols were accidentally prefixed with __ in L. */
592/* The duplication here is intentional to avoid declaring different symbols with the same
593 * declaration. */
Elliott Hughes738a6c92019-06-06 09:56:06 -0700594int ns_msg_getflag(ns_msg __handle, int __flag) __INTRODUCED_IN_64(22);
595uint16_t ns_get16(const u_char* __src) __INTRODUCED_IN_64(22);
596uint32_t ns_get32(const u_char* __src) __INTRODUCED_IN_64(22);
597void ns_put16(uint16_t __src, u_char* __dst) __INTRODUCED_IN_64(22);
598void ns_put32(uint32_t __src, u_char* __dst) __INTRODUCED_IN_64(22);
599int ns_initparse(const u_char* __msg, int __msg_size, ns_msg* __handle) __INTRODUCED_IN_64(22);
600int ns_skiprr(const u_char* __ptr, const u_char* __eom, ns_sect __section, int __count) __INTRODUCED_IN_64(22);
601int ns_parserr(ns_msg* __handle, ns_sect __section, int __rr_number, ns_rr* __rr) __INTRODUCED_IN_64(22);
602int ns_sprintrr(const ns_msg* __handle, const ns_rr* __rr, const char* __name_ctx, const char* __origin, char* __buf, size_t __buf_size) __INTRODUCED_IN_64(22);
603int ns_sprintrrf(const u_char* __msg, size_t __msg_size, const char* __name, ns_class __class, ns_type __type, u_long __ttl, const u_char* __rdata, size_t __rdata_size, const char* __name_ctx, const char* __origin, char* __buf, size_t __buf_size) __INTRODUCED_IN_64(22);
604int ns_format_ttl(u_long __ttl, char* __dst, size_t __dst_size) __INTRODUCED_IN_64(22);
605int ns_name_ntol(const u_char* __src, u_char* __dst, size_t __dst_size) __INTRODUCED_IN_64(22);
606int ns_name_ntop(const u_char* __src, char* __dst, size_t __dst_size) __INTRODUCED_IN_64(22);
607int ns_name_pton(const char* __src, u_char* __dst, size_t __dst_size) __INTRODUCED_IN_64(22);
608int ns_name_unpack(const u_char* __msg, const u_char* __eom, const u_char* __src, u_char* __dst, size_t __dst_size) __INTRODUCED_IN_64(22);
609int ns_name_pack(const u_char* __src, u_char* __dst, int __dst_size, const u_char** __dn_ptrs, const u_char** __last_dn_ptr) __INTRODUCED_IN_64(22);
610int ns_name_uncompress(const u_char* __msg, const u_char* __eom, const u_char* __src, char* __dst, size_t __dst_size) __INTRODUCED_IN_64(22);
611int ns_name_compress(const char* __src, u_char* __dst, size_t __dst_size, const u_char** __dn_ptrs, const u_char** __last_dn_ptr) __INTRODUCED_IN_64(22);
612int ns_name_skip(const u_char** __ptr_ptr, const u_char* __eom) __INTRODUCED_IN_64(22);
613void ns_name_rollback(const u_char* __src, const u_char** __dn_ptrs, const u_char** __last_dn_ptr) __INTRODUCED_IN_64(22);
Josh Gaoc194fd32016-04-25 17:04:10 -0700614
Elliott Hughes738a6c92019-06-06 09:56:06 -0700615int ns_makecanon(const char* __src, char* __dst, size_t __dst_size) __INTRODUCED_IN_64(22);
616int ns_samename(const char* __lhs, const char* __rhs) __INTRODUCED_IN_64(22);
Josh Gao8a03c832016-07-26 16:47:48 -0700617#endif /* !defined(__LP64__) */
618
Calin Juravle569fb982014-03-04 15:01:29 +0000619__END_DECLS
620
621#ifdef BIND_4_COMPAT
622#include <arpa/nameser_compat.h>
623#endif
624
Calin Juravle569fb982014-03-04 15:01:29 +0000625#endif /* !_ARPA_NAMESER_H_ */