blob: 97109eebbe83f7aa23cc28663d3d608dd2a7f5b1 [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
zijunzhaoc412f652023-04-21 23:09:48 +0000116#pragma clang diagnostic push
117#pragma clang diagnostic ignored "-Wnullability-completeness"
Calin Juravlefcb502e2014-03-05 15:06:52 +0000118struct ns_namemap { ns_nname_ct base; int len; };
119typedef struct ns_namemap *ns_namemap_t;
120typedef const struct ns_namemap *ns_namemap_ct;
121
122/*
Calin Juravle569fb982014-03-04 15:01:29 +0000123 * This is a message handle. It is caller allocated and has no dynamic data.
124 * This structure is intended to be opaque to all but ns_parse.c, thus the
125 * leading _'s on the member names. Use the accessor functions, not the _'s.
126 */
127typedef struct __ns_msg {
128 const u_char *_msg, *_eom;
129 uint16_t _id, _flags, _counts[ns_s_max];
130 const u_char *_sections[ns_s_max];
131 ns_sect _sect;
132 int _rrnum;
133 const u_char *_msg_ptr;
134} ns_msg;
Calin Juravlefcb502e2014-03-05 15:06:52 +0000135/*
136 * This is a newmsg handle, used when constructing new messages with
137 * ns_newmsg_init, et al.
138 */
139struct ns_newmsg {
140 ns_msg msg;
141 const u_char *dnptrs[25];
142 const u_char **lastdnptr;
143};
144typedef struct ns_newmsg ns_newmsg;
Calin Juravle569fb982014-03-04 15:01:29 +0000145
Calin Juravle569fb982014-03-04 15:01:29 +0000146/* Accessor macros - this is part of the public interface. */
147
148#define ns_msg_id(handle) ((handle)._id + 0)
149#define ns_msg_base(handle) ((handle)._msg + 0)
150#define ns_msg_end(handle) ((handle)._eom + 0)
151#define ns_msg_size(handle) ((size_t)((handle)._eom - (handle)._msg))
152#define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
153
154/*
155 * This is a parsed record. It is caller allocated and has no dynamic data.
156 */
157typedef struct __ns_rr {
158 char name[NS_MAXDNAME];
159 uint16_t type;
160 uint16_t rr_class;
161 uint32_t ttl;
162 uint16_t rdlength;
163 const u_char * rdata;
164} ns_rr;
165
Calin Juravlefcb502e2014-03-05 15:06:52 +0000166/*
167 * Same thing, but using uncompressed network binary names, and real C types.
168 */
169typedef struct __ns_rr2 {
170 ns_nname nname;
171 size_t nnamel;
172 int type;
173 int rr_class;
174 u_int ttl;
175 int rdlength;
176 const u_char * rdata;
177} ns_rr2;
Calin Juravle569fb982014-03-04 15:01:29 +0000178/* Accessor macros - this is part of the public interface. */
179#define ns_rr_name(rr) (((rr).name[0] != '\0') ? (rr).name : ".")
Calin Juravlefcb502e2014-03-05 15:06:52 +0000180#define ns_rr_nname(rr) ((const ns_nname_t)(rr).nname)
181#define ns_rr_nnamel(rr) ((rr).nnamel + 0)
Calin Juravle569fb982014-03-04 15:01:29 +0000182#define ns_rr_type(rr) ((ns_type)((rr).type + 0))
183#define ns_rr_class(rr) ((ns_class)((rr).rr_class + 0))
184#define ns_rr_ttl(rr) ((u_long)(rr).ttl + 0)
185#define ns_rr_rdlen(rr) ((size_t)(rr).rdlength + 0)
186#define ns_rr_rdata(rr) ((rr).rdata + 0)
187
188/*
189 * These don't have to be in the same order as in the packet flags word,
190 * and they can even overlap in some cases, but they will need to be kept
191 * in synch with ns_parse.c:ns_flagdata[].
192 */
193typedef enum __ns_flag {
194 ns_f_qr, /* Question/Response. */
195 ns_f_opcode, /* Operation code. */
196 ns_f_aa, /* Authoritative Answer. */
197 ns_f_tc, /* Truncation occurred. */
198 ns_f_rd, /* Recursion Desired. */
199 ns_f_ra, /* Recursion Available. */
200 ns_f_z, /* MBZ. */
201 ns_f_ad, /* Authentic Data (DNSSEC). */
202 ns_f_cd, /* Checking Disabled (DNSSEC). */
203 ns_f_rcode, /* Response code. */
204 ns_f_max
205} ns_flag;
206
207/*
208 * Currently defined opcodes.
209 */
210typedef enum __ns_opcode {
211 ns_o_query = 0, /* Standard query. */
212 ns_o_iquery = 1, /* Inverse query (deprecated/unsupported). */
213 ns_o_status = 2, /* Name server status query (unsupported). */
214 /* Opcode 3 is undefined/reserved. */
215 ns_o_notify = 4, /* Zone change notification. */
216 ns_o_update = 5, /* Zone update message. */
217 ns_o_max = 6
218} ns_opcode;
219
220/*
221 * Currently defined response codes.
222 */
223typedef enum __ns_rcode {
224 ns_r_noerror = 0, /* No error occurred. */
225 ns_r_formerr = 1, /* Format error. */
226 ns_r_servfail = 2, /* Server failure. */
227 ns_r_nxdomain = 3, /* Name error. */
228 ns_r_notimpl = 4, /* Unimplemented. */
229 ns_r_refused = 5, /* Operation refused. */
230 /* these are for BIND_UPDATE */
231 ns_r_yxdomain = 6, /* Name exists */
232 ns_r_yxrrset = 7, /* RRset exists */
233 ns_r_nxrrset = 8, /* RRset does not exist */
234 ns_r_notauth = 9, /* Not authoritative for zone */
235 ns_r_notzone = 10, /* Zone of record different from zone section */
236 ns_r_max = 11,
237 /* The following are EDNS extended rcodes */
238 ns_r_badvers = 16,
239 /* The following are TSIG errors */
240 ns_r_badsig = 16,
241 ns_r_badkey = 17,
242 ns_r_badtime = 18
243} ns_rcode;
244
245/* BIND_UPDATE */
246typedef enum __ns_update_operation {
247 ns_uop_delete = 0,
248 ns_uop_add = 1,
249 ns_uop_max = 2
250} ns_update_operation;
251
252/*
253 * This structure is used for TSIG authenticated messages
254 */
255struct ns_tsig_key {
256 char name[NS_MAXDNAME], alg[NS_MAXDNAME];
257 unsigned char *data;
258 int len;
259};
260typedef struct ns_tsig_key ns_tsig_key;
261
262/*
263 * This structure is used for TSIG authenticated TCP messages
264 */
265struct ns_tcp_tsig_state {
266 int counter;
267 struct dst_key *key;
268 void *ctx;
269 unsigned char sig[NS_PACKETSZ];
270 int siglen;
271};
272typedef struct ns_tcp_tsig_state ns_tcp_tsig_state;
273
zijunzhaoc412f652023-04-21 23:09:48 +0000274#pragma clang diagnostic pop
275
Calin Juravle569fb982014-03-04 15:01:29 +0000276#define NS_TSIG_FUDGE 300
277#define NS_TSIG_TCP_COUNT 100
278#define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"
279
280#define NS_TSIG_ERROR_NO_TSIG -10
281#define NS_TSIG_ERROR_NO_SPACE -11
282#define NS_TSIG_ERROR_FORMERR -12
283
284/*
285 * Currently defined type values for resources and queries.
286 */
287typedef enum __ns_type {
288 ns_t_invalid = 0, /* Cookie. */
289 ns_t_a = 1, /* Host address. */
290 ns_t_ns = 2, /* Authoritative server. */
291 ns_t_md = 3, /* Mail destination. */
292 ns_t_mf = 4, /* Mail forwarder. */
293 ns_t_cname = 5, /* Canonical name. */
294 ns_t_soa = 6, /* Start of authority zone. */
295 ns_t_mb = 7, /* Mailbox domain name. */
296 ns_t_mg = 8, /* Mail group member. */
297 ns_t_mr = 9, /* Mail rename name. */
298 ns_t_null = 10, /* Null resource record. */
299 ns_t_wks = 11, /* Well known service. */
300 ns_t_ptr = 12, /* Domain name pointer. */
301 ns_t_hinfo = 13, /* Host information. */
302 ns_t_minfo = 14, /* Mailbox information. */
303 ns_t_mx = 15, /* Mail routing information. */
304 ns_t_txt = 16, /* Text strings. */
305 ns_t_rp = 17, /* Responsible person. */
306 ns_t_afsdb = 18, /* AFS cell database. */
307 ns_t_x25 = 19, /* X_25 calling address. */
308 ns_t_isdn = 20, /* ISDN calling address. */
309 ns_t_rt = 21, /* Router. */
310 ns_t_nsap = 22, /* NSAP address. */
311 ns_t_nsap_ptr = 23, /* Reverse NSAP lookup (deprecated). */
312 ns_t_sig = 24, /* Security signature. */
313 ns_t_key = 25, /* Security key. */
314 ns_t_px = 26, /* X.400 mail mapping. */
315 ns_t_gpos = 27, /* Geographical position (withdrawn). */
Calin Juravlefcb502e2014-03-05 15:06:52 +0000316 ns_t_aaaa = 28, /* IPv6 Address. */
Calin Juravle569fb982014-03-04 15:01:29 +0000317 ns_t_loc = 29, /* Location Information. */
318 ns_t_nxt = 30, /* Next domain (security). */
319 ns_t_eid = 31, /* Endpoint identifier. */
320 ns_t_nimloc = 32, /* Nimrod Locator. */
321 ns_t_srv = 33, /* Server Selection. */
322 ns_t_atma = 34, /* ATM Address */
323 ns_t_naptr = 35, /* Naming Authority PoinTeR */
324 ns_t_kx = 36, /* Key Exchange */
325 ns_t_cert = 37, /* Certification record */
Calin Juravlefcb502e2014-03-05 15:06:52 +0000326 ns_t_a6 = 38, /* IPv6 address (experimental) */
327 ns_t_dname = 39, /* Non-terminal DNAME */
Calin Juravle569fb982014-03-04 15:01:29 +0000328 ns_t_sink = 40, /* Kitchen sink (experimentatl) */
329 ns_t_opt = 41, /* EDNS0 option (meta-RR) */
330 ns_t_apl = 42, /* Address prefix list (RFC 3123) */
Calin Juravlefcb502e2014-03-05 15:06:52 +0000331 ns_t_ds = 43, /* Delegation Signer */
332 ns_t_sshfp = 44, /* SSH Fingerprint */
333 ns_t_ipseckey = 45, /* IPSEC Key */
334 ns_t_rrsig = 46, /* RRset Signature */
335 ns_t_nsec = 47, /* Negative security */
336 ns_t_dnskey = 48, /* DNS Key */
337 ns_t_dhcid = 49, /* Dynamic host configuratin identifier */
338 ns_t_nsec3 = 50, /* Negative security type 3 */
339 ns_t_nsec3param = 51, /* Negative security type 3 parameters */
340 ns_t_hip = 55, /* Host Identity Protocol */
341 ns_t_spf = 99, /* Sender Policy Framework */
Calin Juravle569fb982014-03-04 15:01:29 +0000342 ns_t_tkey = 249, /* Transaction key */
343 ns_t_tsig = 250, /* Transaction signature. */
344 ns_t_ixfr = 251, /* Incremental zone transfer. */
345 ns_t_axfr = 252, /* Transfer zone of authority. */
346 ns_t_mailb = 253, /* Transfer mailbox records. */
347 ns_t_maila = 254, /* Transfer mail agent records. */
348 ns_t_any = 255, /* Wildcard match. */
349 ns_t_zxfr = 256, /* BIND-specific, nonstandard. */
Calin Juravlefcb502e2014-03-05 15:06:52 +0000350 ns_t_dlv = 32769, /* DNSSEC look-aside validatation. */
Calin Juravle569fb982014-03-04 15:01:29 +0000351 ns_t_max = 65536
352} ns_type;
353
354/* Exclusively a QTYPE? (not also an RTYPE) */
355#define ns_t_qt_p(t) (ns_t_xfr_p(t) || (t) == ns_t_any || \
356 (t) == ns_t_mailb || (t) == ns_t_maila)
357/* Some kind of meta-RR? (not a QTYPE, but also not an RTYPE) */
358#define ns_t_mrr_p(t) ((t) == ns_t_tsig || (t) == ns_t_opt)
359/* Exclusively an RTYPE? (not also a QTYPE or a meta-RR) */
360#define ns_t_rr_p(t) (!ns_t_qt_p(t) && !ns_t_mrr_p(t))
361#define ns_t_udp_p(t) ((t) != ns_t_axfr && (t) != ns_t_zxfr)
362#define ns_t_xfr_p(t) ((t) == ns_t_axfr || (t) == ns_t_ixfr || \
363 (t) == ns_t_zxfr)
364
365/*
366 * Values for class field
367 */
368typedef enum __ns_class {
369 ns_c_invalid = 0, /* Cookie. */
370 ns_c_in = 1, /* Internet. */
371 ns_c_2 = 2, /* unallocated/unsupported. */
372 ns_c_chaos = 3, /* MIT Chaos-net. */
373 ns_c_hs = 4, /* MIT Hesiod. */
374 /* Query class values which do not appear in resource records */
375 ns_c_none = 254, /* for prereq. sections in update requests */
376 ns_c_any = 255, /* Wildcard match. */
377 ns_c_max = 65536
378} ns_class;
379
380/* DNSSEC constants. */
381
382typedef enum __ns_key_types {
383 ns_kt_rsa = 1, /* key type RSA/MD5 */
384 ns_kt_dh = 2, /* Diffie Hellman */
385 ns_kt_dsa = 3, /* Digital Signature Standard (MANDATORY) */
386 ns_kt_private = 254 /* Private key type starts with OID */
387} ns_key_types;
388
389typedef enum __ns_cert_types {
390 cert_t_pkix = 1, /* PKIX (X.509v3) */
391 cert_t_spki = 2, /* SPKI */
392 cert_t_pgp = 3, /* PGP */
393 cert_t_url = 253, /* URL private type */
394 cert_t_oid = 254 /* OID private type */
395} ns_cert_types;
396
397/* Flags field of the KEY RR rdata. */
398#define NS_KEY_TYPEMASK 0xC000 /* Mask for "type" bits */
399#define NS_KEY_TYPE_AUTH_CONF 0x0000 /* Key usable for both */
400#define NS_KEY_TYPE_CONF_ONLY 0x8000 /* Key usable for confidentiality */
401#define NS_KEY_TYPE_AUTH_ONLY 0x4000 /* Key usable for authentication */
402#define NS_KEY_TYPE_NO_KEY 0xC000 /* No key usable for either; no key */
403/* The type bits can also be interpreted independently, as single bits: */
404#define NS_KEY_NO_AUTH 0x8000 /* Key unusable for authentication */
405#define NS_KEY_NO_CONF 0x4000 /* Key unusable for confidentiality */
406#define NS_KEY_RESERVED2 0x2000 /* Security is *mandatory* if bit=0 */
407#define NS_KEY_EXTENDED_FLAGS 0x1000 /* reserved - must be zero */
408#define NS_KEY_RESERVED4 0x0800 /* reserved - must be zero */
409#define NS_KEY_RESERVED5 0x0400 /* reserved - must be zero */
410#define NS_KEY_NAME_TYPE 0x0300 /* these bits determine the type */
411#define NS_KEY_NAME_USER 0x0000 /* key is assoc. with user */
412#define NS_KEY_NAME_ENTITY 0x0200 /* key is assoc. with entity eg host */
413#define NS_KEY_NAME_ZONE 0x0100 /* key is zone key */
414#define NS_KEY_NAME_RESERVED 0x0300 /* reserved meaning */
415#define NS_KEY_RESERVED8 0x0080 /* reserved - must be zero */
416#define NS_KEY_RESERVED9 0x0040 /* reserved - must be zero */
417#define NS_KEY_RESERVED10 0x0020 /* reserved - must be zero */
418#define NS_KEY_RESERVED11 0x0010 /* reserved - must be zero */
419#define NS_KEY_SIGNATORYMASK 0x000F /* key can sign RR's of same name */
420#define NS_KEY_RESERVED_BITMASK ( NS_KEY_RESERVED2 | \
421 NS_KEY_RESERVED4 | \
422 NS_KEY_RESERVED5 | \
423 NS_KEY_RESERVED8 | \
424 NS_KEY_RESERVED9 | \
425 NS_KEY_RESERVED10 | \
426 NS_KEY_RESERVED11 )
427#define NS_KEY_RESERVED_BITMASK2 0xFFFF /* no bits defined here */
428
429/* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */
430#define NS_ALG_MD5RSA 1 /* MD5 with RSA */
431#define NS_ALG_DH 2 /* Diffie Hellman KEY */
432#define NS_ALG_DSA 3 /* DSA KEY */
433#define NS_ALG_DSS NS_ALG_DSA
434#define NS_ALG_EXPIRE_ONLY 253 /* No alg, no security */
435#define NS_ALG_PRIVATE_OID 254 /* Key begins with OID giving alg */
436
437/* Protocol values */
438/* value 0 is reserved */
439#define NS_KEY_PROT_TLS 1
440#define NS_KEY_PROT_EMAIL 2
441#define NS_KEY_PROT_DNSSEC 3
442#define NS_KEY_PROT_IPSEC 4
443#define NS_KEY_PROT_ANY 255
444
445/* Signatures */
446#define NS_MD5RSA_MIN_BITS 512 /* Size of a mod or exp in bits */
447#define NS_MD5RSA_MAX_BITS 4096
448 /* Total of binary mod and exp */
449#define NS_MD5RSA_MAX_BYTES ((NS_MD5RSA_MAX_BITS+7/8)*2+3)
450 /* Max length of text sig block */
451#define NS_MD5RSA_MAX_BASE64 (((NS_MD5RSA_MAX_BYTES+2)/3)*4)
452#define NS_MD5RSA_MIN_SIZE ((NS_MD5RSA_MIN_BITS+7)/8)
453#define NS_MD5RSA_MAX_SIZE ((NS_MD5RSA_MAX_BITS+7)/8)
454
455#define NS_DSA_SIG_SIZE 41
456#define NS_DSA_MIN_SIZE 213
457#define NS_DSA_MAX_BYTES 405
458
459/* Offsets into SIG record rdata to find various values */
460#define NS_SIG_TYPE 0 /* Type flags */
461#define NS_SIG_ALG 2 /* Algorithm */
462#define NS_SIG_LABELS 3 /* How many labels in name */
463#define NS_SIG_OTTL 4 /* Original TTL */
464#define NS_SIG_EXPIR 8 /* Expiration time */
465#define NS_SIG_SIGNED 12 /* Signature time */
466#define NS_SIG_FOOT 16 /* Key footprint */
467#define NS_SIG_SIGNER 18 /* Domain name of who signed it */
468
469/* How RR types are represented as bit-flags in NXT records */
470#define NS_NXT_BITS 8
471#define NS_NXT_BIT_SET( n,p) (p[(n)/NS_NXT_BITS] |= (0x80>>((n)%NS_NXT_BITS)))
472#define NS_NXT_BIT_CLEAR(n,p) (p[(n)/NS_NXT_BITS] &= ~(0x80>>((n)%NS_NXT_BITS)))
473#define NS_NXT_BIT_ISSET(n,p) (p[(n)/NS_NXT_BITS] & (0x80>>((n)%NS_NXT_BITS)))
474#define NS_NXT_MAX 127
475
476/*
Calin Juravlefcb502e2014-03-05 15:06:52 +0000477 * EDNS0 extended flags and option codes, host order.
Calin Juravle569fb982014-03-04 15:01:29 +0000478 */
479#define NS_OPT_DNSSEC_OK 0x8000U
Calin Juravlefcb502e2014-03-05 15:06:52 +0000480#define NS_OPT_NSID 3
Ben Schwartz27dd9152018-02-05 17:54:06 -0500481#define NS_OPT_PADDING 12
Calin Juravle569fb982014-03-04 15:01:29 +0000482
483/*
484 * Inline versions of get/put short/long. Pointer is advanced.
485 */
486#define NS_GET16(s, cp) do { \
487 const u_char *t_cp = (const u_char *)(cp); \
488 (s) = ((uint16_t)t_cp[0] << 8) \
489 | ((uint16_t)t_cp[1]) \
490 ; \
491 (cp) += NS_INT16SZ; \
492} while (/*CONSTCOND*/0)
493
494#define NS_GET32(l, cp) do { \
495 const u_char *t_cp = (const u_char *)(cp); \
496 (l) = ((uint32_t)t_cp[0] << 24) \
497 | ((uint32_t)t_cp[1] << 16) \
498 | ((uint32_t)t_cp[2] << 8) \
499 | ((uint32_t)t_cp[3]) \
500 ; \
501 (cp) += NS_INT32SZ; \
502} while (/*CONSTCOND*/0)
503
504#define NS_PUT16(s, cp) do { \
505 uint32_t t_s = (uint32_t)(s); \
506 u_char *t_cp = (u_char *)(cp); \
507 *t_cp++ = t_s >> 8; \
508 *t_cp = t_s; \
509 (cp) += NS_INT16SZ; \
510} while (/*CONSTCOND*/0)
511
512#define NS_PUT32(l, cp) do { \
513 uint32_t t_l = (uint32_t)(l); \
514 u_char *t_cp = (u_char *)(cp); \
515 *t_cp++ = t_l >> 24; \
516 *t_cp++ = t_l >> 16; \
517 *t_cp++ = t_l >> 8; \
518 *t_cp = t_l; \
519 (cp) += NS_INT32SZ; \
520} while (/*CONSTCOND*/0)
521
Josh Gao8a03c832016-07-26 16:47:48 -0700522__BEGIN_DECLS
523
Elliott Hughes42804c42014-12-04 12:39:46 -0800524#if !defined(__LP64__)
525/* Annoyingly, LP32 shipped with __ names. */
Elliott Hughes9dbfe8b2023-06-15 09:09:58 -0700526#define ns_format_ttl __ns_format_ttl
527#define ns_get16 __ns_get16
528#define ns_get32 __ns_get32
529#define ns_initparse __ns_initparse
530#define ns_makecanon __ns_makecanon
531#define ns_msg_getflag __ns_msg_getflag
532#define ns_name_compress __ns_name_compress
533#define ns_name_ntol __ns_name_ntol
534#define ns_name_ntop __ns_name_ntop
535#define ns_name_pack __ns_name_pack
536#define ns_name_pton __ns_name_pton
537#define ns_name_rollback __ns_name_rollback
538#define ns_name_skip __ns_name_skip
539#define ns_name_uncompress __ns_name_uncompress
540#define ns_name_unpack __ns_name_unpack
541#define ns_parserr __ns_parserr
542#define ns_put16 __ns_put16
543#define ns_put32 __ns_put32
544#define ns_samename __ns_samename
545#define ns_skiprr __ns_skiprr
546#define ns_sprintrr __ns_sprintrr
547#define ns_sprintrrf __ns_sprintrrf
548#endif
Calin Juravle569fb982014-03-04 15:01:29 +0000549
Elliott Hughes6dd4a902023-06-12 08:09:56 -0700550int ns_msg_getflag(ns_msg __handle, int __flag) __INTRODUCED_IN(22);
551uint16_t ns_get16(const u_char* _Nonnull __src) __INTRODUCED_IN(22);
552uint32_t ns_get32(const u_char* _Nonnull __src) __INTRODUCED_IN(22);
553void ns_put16(uint16_t __src, u_char* _Nonnull __dst) __INTRODUCED_IN(22);
554void ns_put32(uint32_t __src, u_char* _Nonnull __dst) __INTRODUCED_IN(22);
555int ns_initparse(const u_char* _Nonnull __msg, int __msg_size, ns_msg* _Nonnull __handle) __INTRODUCED_IN(22);
556int ns_skiprr(const u_char* _Nonnull __ptr, const u_char* _Nonnull __eom, ns_sect __section, int __count) __INTRODUCED_IN(22);
557int ns_parserr(ns_msg* _Nonnull __handle, ns_sect __section, int __rr_number, ns_rr* _Nonnull __rr) __INTRODUCED_IN(22);
558int ns_sprintrr(const ns_msg* _Nonnull __handle, const ns_rr* _Nonnull __rr, const char* _Nullable __name_ctx, const char* _Nullable __origin, char* _Nonnull __buf, size_t __buf_size) __INTRODUCED_IN(22);
559int ns_sprintrrf(const u_char* _Nonnull __msg, size_t __msg_size, const char* _Nonnull __name, ns_class __class, ns_type __type, u_long __ttl, const u_char* _Nonnull __rdata, size_t __rdata_size, const char* _Nullable __name_ctx, const char* _Nullable __origin, char* _Nonnull __buf, size_t __buf_size) __INTRODUCED_IN(22);
560int ns_format_ttl(u_long __ttl, char* _Nonnull __dst, size_t __dst_size) __INTRODUCED_IN(22);
561int ns_name_ntol(const u_char* _Nonnull __src, u_char* _Nonnull __dst, size_t __dst_size) __INTRODUCED_IN(22);
562int ns_name_ntop(const u_char* _Nonnull __src, char* _Nonnull __dst, size_t __dst_size) __INTRODUCED_IN(22);
563int ns_name_pton(const char* _Nonnull __src, u_char* _Nonnull __dst, size_t __dst_size) __INTRODUCED_IN(22);
564int ns_name_unpack(const u_char* _Nonnull __msg, const u_char* _Nonnull __eom, const u_char* _Nonnull __src, u_char* _Nonnull __dst, size_t __dst_size) __INTRODUCED_IN(22);
565int ns_name_pack(const u_char* _Nonnull __src, u_char* _Nonnull __dst, int __dst_size, const u_char* _Nullable * _Nullable __dn_ptrs, const u_char* _Nullable * _Nullable __last_dn_ptr) __INTRODUCED_IN(22);
566int ns_name_uncompress(const u_char* _Nonnull __msg, const u_char* _Nonnull __eom, const u_char* _Nonnull __src, char* _Nonnull __dst, size_t __dst_size) __INTRODUCED_IN(22);
567int ns_name_compress(const char* _Nonnull __src, u_char* _Nonnull __dst, size_t __dst_size, const u_char* _Nullable * _Nullable __dn_ptrs, const u_char* _Nullable * _Nullable __last_dn_ptr) __INTRODUCED_IN(22);
568int ns_name_skip(const u_char* _Nullable * _Nonnull __ptr_ptr, const u_char* _Nonnull __eom) __INTRODUCED_IN(22);
569void ns_name_rollback(const u_char* _Nonnull __src, const u_char* _Nullable * _Nonnull __dn_ptrs, const u_char* _Nullable * _Nonnull __last_dn_ptr) __INTRODUCED_IN(22);
Josh Gaoc194fd32016-04-25 17:04:10 -0700570
Elliott Hughes6dd4a902023-06-12 08:09:56 -0700571int ns_makecanon(const char* _Nonnull __src, char* _Nonnull __dst, size_t __dst_size) __INTRODUCED_IN(22);
572int ns_samename(const char* _Nonnull __lhs, const char* _Nonnull __rhs) __INTRODUCED_IN(22);
Josh Gao8a03c832016-07-26 16:47:48 -0700573
Calin Juravle569fb982014-03-04 15:01:29 +0000574__END_DECLS
575
576#ifdef BIND_4_COMPAT
577#include <arpa/nameser_compat.h>
578#endif
579
Calin Juravle569fb982014-03-04 15:01:29 +0000580#endif /* !_ARPA_NAMESER_H_ */