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