include/arpa/nameser.h

   1 /*-
   2  * SPDX-License-Identifier: (ISC AND BSD-3-Clause)
   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  */
  19
  20 /*-
  21  * Copyright (c) 1983, 1989, 1993
  22  *    The Regents of the University of California.  All rights reserved.
  23  *
  24  * Redistribution and use in source and binary forms, with or without
  25  * modification, are permitted provided that the following conditions
  26  * are met:
  27  * 1. Redistributions of source code must retain the above copyright
  28  *    notice, this list of conditions and the following disclaimer.
  29  * 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.
  35  *
  36  * 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
  46  * SUCH DAMAGE.
  47  */
  48
  49 /*
  50  *      $Id: nameser.h,v 1.16 2009/03/03 01:52:48 each Exp $
  51  */
  52
  53 #ifndef _ARPA_NAMESER_H_
  54 #define _ARPA_NAMESER_H_
  55
  56 /*! \file */
  57
  58 #define BIND_4_COMPAT
  59
  60 #include <sys/param.h>
  61 #include <sys/types.h>
  62 #include <sys/cdefs.h>
  63
  64 /*%
  65  * Revision information.  This is the release date in YYYYMMDD format.
  66  * It can change every day so the right thing to do with it is use it
  67  * in preprocessor commands such as "#if (__NAMESER > 19931104)".  Do not
  68  * compare for equality; rather, use it to determine whether your libbind.a
  69  * contains a new enough lib/nameser/ to support the feature you need.
  70  */
  71
  72 #define __NAMESER       20090302        /*%< New interface version stamp. */
  73 /*
  74  * Define constants based on RFC0883, RFC1034, RFC 1035
  75  */
  76 #define NS_PACKETSZ     512     /*%< default UDP packet size */
  77 #define NS_MAXDNAME     1025    /*%< maximum domain name (presentation format)*/
  78 #define NS_MAXMSG       65535   /*%< maximum message size */
  79 #define NS_MAXCDNAME    255     /*%< maximum compressed domain name */
  80 #define NS_MAXLABEL     63      /*%< maximum length of domain label */
  81 #define NS_MAXLABELS    128     /*%< theoretical max #/labels per domain name */
  82 #define NS_MAXNNAME     256     /*%< maximum uncompressed (binary) domain name*/
  83 #define NS_MAXPADDR     (sizeof "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff")
  84 #define NS_HFIXEDSZ     12      /*%< #/bytes of fixed data in header */
  85 #define NS_QFIXEDSZ     4       /*%< #/bytes of fixed data in query */
  86 #define NS_RRFIXEDSZ    10      /*%< #/bytes of fixed data in r record */
  87 #define NS_INT32SZ      4       /*%< #/bytes of data in a u_int32_t */
  88 #define NS_INT16SZ      2       /*%< #/bytes of data in a u_int16_t */
  89 #define NS_INT8SZ       1       /*%< #/bytes of data in a u_int8_t */
  90 #define NS_INADDRSZ     4       /*%< IPv4 T_A */
  91 #define NS_IN6ADDRSZ    16      /*%< IPv6 T_AAAA */
  92 #define NS_CMPRSFLGS    0xc0    /*%< Flag bits indicating name compression. */
  93 #define NS_DEFAULTPORT  53      /*%< For both TCP and UDP. */
  94 /*
  95  * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
  96  * in synch with it.
  97  */
  98 typedef enum __ns_sect {
  99         ns_s_qd = 0,            /*%< Query: Question. */
 100         ns_s_zn = 0,            /*%< Update: Zone. */
 101         ns_s_an = 1,            /*%< Query: Answer. */
 102         ns_s_pr = 1,            /*%< Update: Prerequisites. */
 103         ns_s_ns = 2,            /*%< Query: Name servers. */
 104         ns_s_ud = 2,            /*%< Update: Update. */
 105         ns_s_ar = 3,            /*%< Query|Update: Additional records. */
 106         ns_s_max = 4
 107 } ns_sect;
 108
 109 /*%
 110  * Network name (compressed or not) type.  Equivalent to a pointer when used
 111  * in a function prototype.  Can be const'd.
 112  */
 113 typedef u_char ns_nname[NS_MAXNNAME];
 114 typedef const u_char *ns_nname_ct;
 115 typedef u_char *ns_nname_t;
 116
 117 struct ns_namemap { ns_nname_ct base; int len; };
 118 typedef struct ns_namemap *ns_namemap_t;
 119 typedef const struct ns_namemap *ns_namemap_ct;
 120
 121 /*%
 122  * This is a message handle.  It is caller allocated and has no dynamic data.
 123  * This structure is intended to be opaque to all but ns_parse.c, thus the
 124  * leading _'s on the member names.  Use the accessor functions, not the _'s.
 125  */
 126 typedef struct __ns_msg {
 127         const u_char    *_msg, *_eom;
 128         u_int16_t       _id, _flags, _counts[ns_s_max];
 129         const u_char    *_sections[ns_s_max];
 130         ns_sect         _sect;
 131         int             _rrnum;
 132         const u_char    *_msg_ptr;
 133 } ns_msg;
 134
 135 /*
 136  * This is a newmsg handle, used when constructing new messages with
 137  * ns_newmsg_init, et al.
 138  */
 139 struct ns_newmsg {
 140         ns_msg          msg;
 141         const u_char    *dnptrs[25];
 142         const u_char    **lastdnptr;
 143 };
 144 typedef struct ns_newmsg ns_newmsg;
 145
 146 /* Private data structure - do not use from outside library. */
 147 struct _ns_flagdata {  int mask, shift;  };
 148 extern struct _ns_flagdata _ns_flagdata[];
 149
 150 /* Accessor macros - this is part of the public interface. */
 151
 152 #define ns_msg_id(handle) ((handle)._id + 0)
 153 #define ns_msg_base(handle) ((handle)._msg + 0)
 154 #define ns_msg_end(handle) ((handle)._eom + 0)
 155 #define ns_msg_size(handle) ((handle)._eom - (handle)._msg)
 156 #define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
 157
 158 /*%
 159  * This is a parsed record.  It is caller allocated and has no dynamic data.
 160  */
 161 typedef struct __ns_rr {
 162         char            name[NS_MAXDNAME];
 163         u_int16_t       type;
 164         u_int16_t       rr_class;
 165         u_int32_t       ttl;
 166         u_int16_t       rdlength;
 167         const u_char *  rdata;
 168 } ns_rr;
 169
 170 /*
 171  * Same thing, but using uncompressed network binary names, and real C types.
 172  */
 173 typedef struct __ns_rr2 {
 174         ns_nname        nname;
 175         size_t          nnamel;
 176         int             type;
 177         int             rr_class;
 178         u_int           ttl;
 179         int             rdlength;
 180         const u_char *  rdata;
 181 } ns_rr2;
 182
 183 /* Accessor macros - this is part of the public interface. */
 184 #define ns_rr_name(rr)  (((rr).name[0] != '\0') ? (rr).name : ".")
 185 #define ns_rr_nname(rr) ((const ns_nname_t)(rr).nname)
 186 #define ns_rr_nnamel(rr) ((rr).nnamel + 0)
 187 #define ns_rr_type(rr)  ((ns_type)((rr).type + 0))
 188 #define ns_rr_class(rr) ((ns_class)((rr).rr_class + 0))
 189 #define ns_rr_ttl(rr)   ((rr).ttl + 0)
 190 #define ns_rr_rdlen(rr) ((rr).rdlength + 0)
 191 #define ns_rr_rdata(rr) ((rr).rdata + 0)
 192
 193 /*%
 194  * These don't have to be in the same order as in the packet flags word,
 195  * and they can even overlap in some cases, but they will need to be kept
 196  * in synch with ns_parse.c:ns_flagdata[].
 197  */
 198 typedef enum __ns_flag {
 199         ns_f_qr,                /*%< Question/Response. */
 200         ns_f_opcode,            /*%< Operation code. */
 201         ns_f_aa,                /*%< Authoritative Answer. */
 202         ns_f_tc,                /*%< Truncation occurred. */
 203         ns_f_rd,                /*%< Recursion Desired. */
 204         ns_f_ra,                /*%< Recursion Available. */
 205         ns_f_z,                 /*%< MBZ. */
 206         ns_f_ad,                /*%< Authentic Data (DNSSEC). */
 207         ns_f_cd,                /*%< Checking Disabled (DNSSEC). */
 208         ns_f_rcode,             /*%< Response code. */
 209         ns_f_max
 210 } ns_flag;
 211
 212 /*%
 213  * Currently defined opcodes.
 214  */
 215 typedef enum __ns_opcode {
 216         ns_o_query = 0,         /*%< Standard query. */
 217         ns_o_iquery = 1,        /*%< Inverse query (deprecated/unsupported). */
 218         ns_o_status = 2,        /*%< Name server status query (unsupported). */
 219                                 /* Opcode 3 is undefined/reserved. */
 220         ns_o_notify = 4,        /*%< Zone change notification. */
 221         ns_o_update = 5,        /*%< Zone update message. */
 222         ns_o_max = 6
 223 } ns_opcode;
 224
 225 /*%
 226  * Currently defined response codes.
 227  */
 228 typedef enum __ns_rcode {
 229         ns_r_noerror = 0,       /*%< No error occurred. */
 230         ns_r_formerr = 1,       /*%< Format error. */
 231         ns_r_servfail = 2,      /*%< Server failure. */
 232         ns_r_nxdomain = 3,      /*%< Name error. */
 233         ns_r_notimpl = 4,       /*%< Unimplemented. */
 234         ns_r_refused = 5,       /*%< Operation refused. */
 235         /* these are for BIND_UPDATE */
 236         ns_r_yxdomain = 6,      /*%< Name exists */
 237         ns_r_yxrrset = 7,       /*%< RRset exists */
 238         ns_r_nxrrset = 8,       /*%< RRset does not exist */
 239         ns_r_notauth = 9,       /*%< Not authoritative for zone */
 240         ns_r_notzone = 10,      /*%< Zone of record different from zone section */
 241         ns_r_max = 11,
 242         /* The following are EDNS extended rcodes */
 243         ns_r_badvers = 16,
 244         /* The following are TSIG errors */
 245         ns_r_badsig = 16,
 246         ns_r_badkey = 17,
 247         ns_r_badtime = 18
 248 } ns_rcode;
 249
 250 /* BIND_UPDATE */
 251 typedef enum __ns_update_operation {
 252         ns_uop_delete = 0,
 253         ns_uop_add = 1,
 254         ns_uop_max = 2
 255 } ns_update_operation;
 256
 257 /*%
 258  * This structure is used for TSIG authenticated messages
 259  */
 260 struct ns_tsig_key {
 261         char name[NS_MAXDNAME], alg[NS_MAXDNAME];
 262         unsigned char *data;
 263         int len;
 264 };
 265 typedef struct ns_tsig_key ns_tsig_key;
 266
 267 /*%
 268  * This structure is used for TSIG authenticated TCP messages
 269  */
 270 struct ns_tcp_tsig_state {
 271         int counter;
 272         struct dst_key *key;
 273         void *ctx;
 274         unsigned char sig[NS_PACKETSZ];
 275         int siglen;
 276 };
 277 typedef struct ns_tcp_tsig_state ns_tcp_tsig_state;
 278
 279 #define NS_TSIG_FUDGE 300
 280 #define NS_TSIG_TCP_COUNT 100
 281 #define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"
 282
 283 #define NS_TSIG_ERROR_NO_TSIG -10
 284 #define NS_TSIG_ERROR_NO_SPACE -11
 285 #define NS_TSIG_ERROR_FORMERR -12
 286
 287 /*%
 288  * Currently defined type values for resources and queries.
 289  */
 290 typedef enum __ns_type {
 291         ns_t_invalid = 0,       /*%< Cookie. */
 292         ns_t_a = 1,             /*%< Host address. */
 293         ns_t_ns = 2,            /*%< Authoritative server. */
 294         ns_t_md = 3,            /*%< Mail destination. */
 295         ns_t_mf = 4,            /*%< Mail forwarder. */
 296         ns_t_cname = 5,         /*%< Canonical name. */
 297         ns_t_soa = 6,           /*%< Start of authority zone. */
 298         ns_t_mb = 7,            /*%< Mailbox domain name. */
 299         ns_t_mg = 8,            /*%< Mail group member. */
 300         ns_t_mr = 9,            /*%< Mail rename name. */
 301         ns_t_null = 10,         /*%< Null resource record. */
 302         ns_t_wks = 11,          /*%< Well known service. */
 303         ns_t_ptr = 12,          /*%< Domain name pointer. */
 304         ns_t_hinfo = 13,        /*%< Host information. */
 305         ns_t_minfo = 14,        /*%< Mailbox information. */
 306         ns_t_mx = 15,           /*%< Mail routing information. */
 307         ns_t_txt = 16,          /*%< Text strings. */
 308         ns_t_rp = 17,           /*%< Responsible person. */
 309         ns_t_afsdb = 18,        /*%< AFS cell database. */
 310         ns_t_x25 = 19,          /*%< X_25 calling address. */
 311         ns_t_isdn = 20,         /*%< ISDN calling address. */
 312         ns_t_rt = 21,           /*%< Router. */
 313         ns_t_nsap = 22,         /*%< NSAP address. */
 314         ns_t_nsap_ptr = 23,     /*%< Reverse NSAP lookup (deprecated). */
 315         ns_t_sig = 24,          /*%< Security signature. */
 316         ns_t_key = 25,          /*%< Security key. */
 317         ns_t_px = 26,           /*%< X.400 mail mapping. */
 318         ns_t_gpos = 27,         /*%< Geographical position (withdrawn). */
 319         ns_t_aaaa = 28,         /*%< IPv6 Address. */
 320         ns_t_loc = 29,          /*%< Location Information. */
 321         ns_t_nxt = 30,          /*%< Next domain (security). */
 322         ns_t_eid = 31,          /*%< Endpoint identifier. */
 323         ns_t_nimloc = 32,       /*%< Nimrod Locator. */
 324         ns_t_srv = 33,          /*%< Server Selection. */
 325         ns_t_atma = 34,         /*%< ATM Address */
 326         ns_t_naptr = 35,        /*%< Naming Authority PoinTeR */
 327         ns_t_kx = 36,           /*%< Key Exchange */
 328         ns_t_cert = 37,         /*%< Certification record */
 329         ns_t_a6 = 38,           /*%< IPv6 address (experimental) */
 330         ns_t_dname = 39,        /*%< Non-terminal DNAME */
 331         ns_t_sink = 40,         /*%< Kitchen sink (experimentatl) */
 332         ns_t_opt = 41,          /*%< EDNS0 option (meta-RR) */
 333         ns_t_apl = 42,          /*%< Address prefix list (RFC3123) */
 334         ns_t_ds = 43,           /*%< Delegation Signer */
 335         ns_t_sshfp = 44,        /*%< SSH Fingerprint */
 336         ns_t_ipseckey = 45,     /*%< IPSEC Key */
 337         ns_t_rrsig = 46,        /*%< RRset Signature */
 338         ns_t_nsec = 47,         /*%< Negative security */
 339         ns_t_dnskey = 48,       /*%< DNS Key */
 340         ns_t_dhcid = 49,        /*%< Dynamic host configuratin identifier */
 341         ns_t_nsec3 = 50,        /*%< Negative security type 3 */
 342         ns_t_nsec3param = 51,   /*%< Negative security type 3 parameters */
 343         ns_t_hip = 55,          /*%< Host Identity Protocol */
 344         ns_t_spf = 99,          /*%< Sender Policy Framework */
 345         ns_t_tkey = 249,        /*%< Transaction key */
 346         ns_t_tsig = 250,        /*%< Transaction signature. */
 347         ns_t_ixfr = 251,        /*%< Incremental zone transfer. */
 348         ns_t_axfr = 252,        /*%< Transfer zone of authority. */
 349         ns_t_mailb = 253,       /*%< Transfer mailbox records. */
 350         ns_t_maila = 254,       /*%< Transfer mail agent records. */
 351         ns_t_any = 255,         /*%< Wildcard match. */
 352         ns_t_zxfr = 256,        /*%< BIND-specific, nonstandard. */
 353         ns_t_dlv = 32769,       /*%< DNSSEC look-aside validatation. */
 354         ns_t_max = 65536
 355 } ns_type;
 356
 357 /* Exclusively a QTYPE? (not also an RTYPE) */
 358 #define ns_t_qt_p(t) (ns_t_xfr_p(t) || (t) == ns_t_any || \
 359                       (t) == ns_t_mailb || (t) == ns_t_maila)
 360 /* Some kind of meta-RR? (not a QTYPE, but also not an RTYPE) */
 361 #define ns_t_mrr_p(t) ((t) == ns_t_tsig || (t) == ns_t_opt)
 362 /* Exclusively an RTYPE? (not also a QTYPE or a meta-RR) */
 363 #define ns_t_rr_p(t) (!ns_t_qt_p(t) && !ns_t_mrr_p(t))
 364 #define ns_t_udp_p(t) ((t) != ns_t_axfr && (t) != ns_t_zxfr)
 365 #define ns_t_xfr_p(t) ((t) == ns_t_axfr || (t) == ns_t_ixfr || \
 366                        (t) == ns_t_zxfr)
 367
 368 /*%
 369  * Values for class field
 370  */
 371 typedef enum __ns_class {
 372         ns_c_invalid = 0,       /*%< Cookie. */
 373         ns_c_in = 1,            /*%< Internet. */
 374         ns_c_2 = 2,             /*%< unallocated/unsupported. */
 375         ns_c_chaos = 3,         /*%< MIT Chaos-net. */
 376         ns_c_hs = 4,            /*%< MIT Hesiod. */
 377         /* Query class values which do not appear in resource records */
 378         ns_c_none = 254,        /*%< for prereq. sections in update requests */
 379         ns_c_any = 255,         /*%< Wildcard match. */
 380         ns_c_max = 65536
 381 } ns_class;
 382
 383 /* DNSSEC constants. */
 384
 385 typedef enum __ns_key_types {
 386         ns_kt_rsa = 1,          /*%< key type RSA/MD5 */
 387         ns_kt_dh  = 2,          /*%< Diffie Hellman */
 388         ns_kt_dsa = 3,          /*%< Digital Signature Standard (MANDATORY) */
 389         ns_kt_private = 254     /*%< Private key type starts with OID */
 390 } ns_key_types;
 391
 392 typedef enum __ns_cert_types {
 393         cert_t_pkix = 1,        /*%< PKIX (X.509v3) */
 394         cert_t_spki = 2,        /*%< SPKI */
 395         cert_t_pgp  = 3,        /*%< PGP */
 396         cert_t_url  = 253,      /*%< URL private type */
 397         cert_t_oid  = 254       /*%< OID private type */
 398 } ns_cert_types;
 399
 400 /* Flags field of the KEY RR rdata. */
 401 #define NS_KEY_TYPEMASK         0xC000  /*%< Mask for "type" bits */
 402 #define NS_KEY_TYPE_AUTH_CONF   0x0000  /*%< Key usable for both */
 403 #define NS_KEY_TYPE_CONF_ONLY   0x8000  /*%< Key usable for confidentiality */
 404 #define NS_KEY_TYPE_AUTH_ONLY   0x4000  /*%< Key usable for authentication */
 405 #define NS_KEY_TYPE_NO_KEY      0xC000  /*%< No key usable for either; no key */
 406 /* The type bits can also be interpreted independently, as single bits: */
 407 #define NS_KEY_NO_AUTH          0x8000  /*%< Key unusable for authentication */
 408 #define NS_KEY_NO_CONF          0x4000  /*%< Key unusable for confidentiality */
 409 #define NS_KEY_RESERVED2        0x2000  /* Security is *mandatory* if bit=0 */
 410 #define NS_KEY_EXTENDED_FLAGS   0x1000  /*%< reserved - must be zero */
 411 #define NS_KEY_RESERVED4        0x0800  /*%< reserved - must be zero */
 412 #define NS_KEY_RESERVED5        0x0400  /*%< reserved - must be zero */
 413 #define NS_KEY_NAME_TYPE        0x0300  /*%< these bits determine the type */
 414 #define NS_KEY_NAME_USER        0x0000  /*%< key is assoc. with user */
 415 #define NS_KEY_NAME_ENTITY      0x0200  /*%< key is assoc. with entity eg host */
 416 #define NS_KEY_NAME_ZONE        0x0100  /*%< key is zone key */
 417 #define NS_KEY_NAME_RESERVED    0x0300  /*%< reserved meaning */
 418 #define NS_KEY_RESERVED8        0x0080  /*%< reserved - must be zero */
 419 #define NS_KEY_RESERVED9        0x0040  /*%< reserved - must be zero */
 420 #define NS_KEY_RESERVED10       0x0020  /*%< reserved - must be zero */
 421 #define NS_KEY_RESERVED11       0x0010  /*%< reserved - must be zero */
 422 #define NS_KEY_SIGNATORYMASK    0x000F  /*%< key can sign RR's of same name */
 423 #define NS_KEY_RESERVED_BITMASK ( NS_KEY_RESERVED2 | \
 424                                   NS_KEY_RESERVED4 | \
 425                                   NS_KEY_RESERVED5 | \
 426                                   NS_KEY_RESERVED8 | \
 427                                   NS_KEY_RESERVED9 | \
 428                                   NS_KEY_RESERVED10 | \
 429                                   NS_KEY_RESERVED11 )
 430 #define NS_KEY_RESERVED_BITMASK2 0xFFFF /*%< no bits defined here */
 431 /* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */
 432 #define NS_ALG_MD5RSA           1       /*%< MD5 with RSA */
 433 #define NS_ALG_DH               2       /*%< Diffie Hellman KEY */
 434 #define NS_ALG_DSA              3       /*%< DSA KEY */
 435 #define NS_ALG_DSS              NS_ALG_DSA
 436 #define NS_ALG_EXPIRE_ONLY      253     /*%< No alg, no security */
 437 #define NS_ALG_PRIVATE_OID      254     /*%< Key begins with OID giving alg */
 438 /* Protocol values  */
 439 /* value 0 is reserved */
 440 #define NS_KEY_PROT_TLS         1
 441 #define NS_KEY_PROT_EMAIL       2
 442 #define NS_KEY_PROT_DNSSEC      3
 443 #define NS_KEY_PROT_IPSEC       4
 444 #define NS_KEY_PROT_ANY         255
 445
 446 /* Signatures */
 447 #define NS_MD5RSA_MIN_BITS       512    /*%< Size of a mod or exp in bits */
 448 #define NS_MD5RSA_MAX_BITS      4096
 449         /* Total of binary mod and exp */
 450 #define NS_MD5RSA_MAX_BYTES     ((NS_MD5RSA_MAX_BITS+7/8)*2+3)
 451         /* Max length of text sig block */
 452 #define NS_MD5RSA_MAX_BASE64    (((NS_MD5RSA_MAX_BYTES+2)/3)*4)
 453 #define NS_MD5RSA_MIN_SIZE      ((NS_MD5RSA_MIN_BITS+7)/8)
 454 #define NS_MD5RSA_MAX_SIZE      ((NS_MD5RSA_MAX_BITS+7)/8)
 455
 456 #define NS_DSA_SIG_SIZE         41
 457 #define NS_DSA_MIN_SIZE         213
 458 #define NS_DSA_MAX_BYTES        405
 459
 460 /* Offsets into SIG record rdata to find various values */
 461 #define NS_SIG_TYPE     0       /*%< Type flags */
 462 #define NS_SIG_ALG      2       /*%< Algorithm */
 463 #define NS_SIG_LABELS   3       /*%< How many labels in name */
 464 #define NS_SIG_OTTL     4       /*%< Original TTL */
 465 #define NS_SIG_EXPIR    8       /*%< Expiration time */
 466 #define NS_SIG_SIGNED   12      /*%< Signature time */
 467 #define NS_SIG_FOOT     16      /*%< Key footprint */
 468 #define NS_SIG_SIGNER   18      /*%< Domain name of who signed it */
 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 /*%
 477  * EDNS0 extended flags and option codes, host order.
 478  */
 479 #define NS_OPT_DNSSEC_OK        0x8000U
 480 #define NS_OPT_NSID             3
 481
 482 /*%
 483  * Inline versions of get/put short/long.  Pointer is advanced.
 484  */
 485 #define NS_GET16(s, cp) do { \
 486         register const u_char *t_cp = (const u_char *)(cp); \
 487         (s) = ((u_int16_t)t_cp[0] << 8) \
 488             | ((u_int16_t)t_cp[1]) \
 489             ; \
 490         (cp) += NS_INT16SZ; \
 491 } while (0)
 492
 493 #define NS_GET32(l, cp) do { \
 494         register const u_char *t_cp = (const u_char *)(cp); \
 495         (l) = ((u_int32_t)t_cp[0] << 24) \
 496             | ((u_int32_t)t_cp[1] << 16) \
 497             | ((u_int32_t)t_cp[2] << 8) \
 498             | ((u_int32_t)t_cp[3]) \
 499             ; \
 500         (cp) += NS_INT32SZ; \
 501 } while (0)
 502
 503 #define NS_PUT16(s, cp) do { \
 504         register u_int16_t t_s = (u_int16_t)(s); \
 505         register u_char *t_cp = (u_char *)(cp); \
 506         *t_cp++ = t_s >> 8; \
 507         *t_cp   = t_s; \
 508         (cp) += NS_INT16SZ; \
 509 } while (0)
 510
 511 #define NS_PUT32(l, cp) do { \
 512         register u_int32_t t_l = (u_int32_t)(l); \
 513         register u_char *t_cp = (u_char *)(cp); \
 514         *t_cp++ = t_l >> 24; \
 515         *t_cp++ = t_l >> 16; \
 516         *t_cp++ = t_l >> 8; \
 517         *t_cp   = t_l; \
 518         (cp) += NS_INT32SZ; \
 519 } while (0)
 520
 521 /*%
 522  * ANSI C identifier hiding for bind's lib/nameser.
 523  */
 524 #define ns_msg_getflag          __ns_msg_getflag
 525 #define ns_get16                __ns_get16
 526 #define ns_get32                __ns_get32
 527 #define ns_put16                __ns_put16
 528 #define ns_put32                __ns_put32
 529 #define ns_initparse            __ns_initparse
 530 #define ns_skiprr               __ns_skiprr
 531 #define ns_parserr              __ns_parserr
 532 #define ns_parserr2             __ns_parserr2
 533 #define ns_sprintrr             __ns_sprintrr
 534 #define ns_sprintrrf            __ns_sprintrrf
 535 #define ns_format_ttl           __ns_format_ttl
 536 #define ns_parse_ttl            __ns_parse_ttl
 537 #if 0
 538 #define ns_datetosecs           __ns_datetosecs
 539 #endif
 540 #define ns_name_ntol            __ns_name_ntol
 541 #define ns_name_ntop            __ns_name_ntop
 542 #define ns_name_pton            __ns_name_pton
 543 #define ns_name_pton2           __ns_name_pton2
 544 #define ns_name_unpack          __ns_name_unpack
 545 #define ns_name_unpack2         __ns_name_unpack2
 546 #define ns_name_pack            __ns_name_pack
 547 #define ns_name_compress        __ns_name_compress
 548 #define ns_name_uncompress      __ns_name_uncompress
 549 #define ns_name_skip            __ns_name_skip
 550 #define ns_name_rollback        __ns_name_rollback
 551 #define ns_name_length          __ns_name_length
 552 #define ns_name_eq              __ns_name_eq
 553 #define ns_name_owned           __ns_name_owned
 554 #define ns_name_map             __ns_name_map
 555 #define ns_name_labels          __ns_name_labels
 556 #if 0
 557 #define ns_sign                 __ns_sign
 558 #define ns_sign2                __ns_sign2
 559 #define ns_sign_tcp             __ns_sign_tcp
 560 #define ns_sign_tcp2            __ns_sign_tcp2
 561 #define ns_sign_tcp_init        __ns_sign_tcp_init
 562 #define ns_find_tsig            __ns_find_tsig
 563 #define ns_verify               __ns_verify
 564 #define ns_verify_tcp           __ns_verify_tcp
 565 #define ns_verify_tcp_init      __ns_verify_tcp_init
 566 #endif
 567 #define ns_samedomain           __ns_samedomain
 568 #if 0
 569 #define ns_subdomain            __ns_subdomain
 570 #endif
 571 #define ns_makecanon            __ns_makecanon
 572 #define ns_samename             __ns_samename
 573 #define ns_newmsg_init          __ns_newmsg_init
 574 #define ns_newmsg_copy          __ns_newmsg_copy
 575 #define ns_newmsg_id            __ns_newmsg_id
 576 #define ns_newmsg_flag          __ns_newmsg_flag
 577 #define ns_newmsg_q             __ns_newmsg_q
 578 #define ns_newmsg_rr            __ns_newmsg_rr
 579 #define ns_newmsg_done          __ns_newmsg_done
 580 #define ns_rdata_unpack         __ns_rdata_unpack
 581 #define ns_rdata_equal          __ns_rdata_equal
 582 #define ns_rdata_refers         __ns_rdata_refers
 583
 584 __BEGIN_DECLS
 585 int             ns_msg_getflag(ns_msg, int);
 586 u_int           ns_get16(const u_char *);
 587 u_long          ns_get32(const u_char *);
 588 void            ns_put16(u_int, u_char *);
 589 void            ns_put32(u_long, u_char *);
 590 int             ns_initparse(const u_char *, int, ns_msg *);
 591 int             ns_skiprr(const u_char *, const u_char *, ns_sect, int);
 592 int             ns_parserr(ns_msg *, ns_sect, int, ns_rr *);
 593 int             ns_parserr2(ns_msg *, ns_sect, int, ns_rr2 *);
 594 int             ns_sprintrr(const ns_msg *, const ns_rr *,
 595                             const char *, const char *, char *, size_t);
 596 int             ns_sprintrrf(const u_char *, size_t, const char *,
 597                              ns_class, ns_type, u_long, const u_char *,
 598                              size_t, const char *, const char *,
 599                              char *, size_t);
 600 int             ns_format_ttl(u_long, char *, size_t);
 601 int             ns_parse_ttl(const char *, u_long *);
 602 #if 0
 603 u_int32_t       ns_datetosecs(const char *cp, int *errp);
 604 #endif
 605 int             ns_name_ntol(const u_char *, u_char *, size_t);
 606 int             ns_name_ntop(const u_char *, char *, size_t);
 607 int             ns_name_pton(const char *, u_char *, size_t);
 608 int             ns_name_pton2(const char *, u_char *, size_t, size_t *);
 609 int             ns_name_unpack(const u_char *, const u_char *,
 610                                const u_char *, u_char *, size_t);
 611 int             ns_name_unpack2(const u_char *, const u_char *,
 612                                 const u_char *, u_char *, size_t,
 613                                 size_t *);
 614 int             ns_name_pack(const u_char *, u_char *, int,
 615                              const u_char **, const u_char **);
 616 int             ns_name_uncompress(const u_char *, const u_char *,
 617                                    const u_char *, char *, size_t);
 618 int             ns_name_compress(const char *, u_char *, size_t,
 619                                  const u_char **, const u_char **);
 620 int             ns_name_skip(const u_char **, const u_char *);
 621 void            ns_name_rollback(const u_char *, const u_char **,
 622                                  const u_char **);
 623 ssize_t         ns_name_length(ns_nname_ct, size_t);
 624 int             ns_name_eq(ns_nname_ct, size_t, ns_nname_ct, size_t);
 625 int             ns_name_owned(ns_namemap_ct, int, ns_namemap_ct, int);
 626 int             ns_name_map(ns_nname_ct, size_t, ns_namemap_t, int);
 627 int             ns_name_labels(ns_nname_ct, size_t);
 628 #if 0
 629 int             ns_sign(u_char *, int *, int, int, void *,
 630                         const u_char *, int, u_char *, int *, time_t);
 631 int             ns_sign2(u_char *, int *, int, int, void *,
 632                          const u_char *, int, u_char *, int *, time_t,
 633                          u_char **, u_char **);
 634 int             ns_sign_tcp(u_char *, int *, int, int,
 635                             ns_tcp_tsig_state *, int);
 636 int             ns_sign_tcp2(u_char *, int *, int, int,
 637                              ns_tcp_tsig_state *, int,
 638                              u_char **, u_char **);
 639 int             ns_sign_tcp_init(void *, const u_char *, int,
 640                                  ns_tcp_tsig_state *);
 641 u_char          *ns_find_tsig(u_char *, u_char *);
 642 int             ns_verify(u_char *, int *, void *,
 643                           const u_char *, int, u_char *, int *,
 644                           time_t *, int);
 645 int             ns_verify_tcp(u_char *, int *, ns_tcp_tsig_state *, int);
 646 int             ns_verify_tcp_init(void *, const u_char *, int,
 647                                    ns_tcp_tsig_state *);
 648 #endif
 649 int             ns_samedomain(const char *, const char *);
 650 #if 0
 651 int             ns_subdomain(const char *, const char *);
 652 #endif
 653 int             ns_makecanon(const char *, char *, size_t);
 654 int             ns_samename(const char *, const char *);
 655 int             ns_newmsg_init(u_char *buffer, size_t bufsiz, ns_newmsg *);
 656 int             ns_newmsg_copy(ns_newmsg *, ns_msg *);
 657 void            ns_newmsg_id(ns_newmsg *handle, u_int16_t id);
 658 void            ns_newmsg_flag(ns_newmsg *handle, ns_flag flag, u_int value);
 659 int             ns_newmsg_q(ns_newmsg *handle, ns_nname_ct qname,
 660                             ns_type qtype, ns_class qclass);
 661 int             ns_newmsg_rr(ns_newmsg *handle, ns_sect sect,
 662                              ns_nname_ct name, ns_type type,
 663                              ns_class rr_class, u_int32_t ttl,
 664                              u_int16_t rdlen, const u_char *rdata);
 665 size_t          ns_newmsg_done(ns_newmsg *handle);
 666 ssize_t         ns_rdata_unpack(const u_char *, const u_char *, ns_type,
 667                                 const u_char *, size_t, u_char *, size_t);
 668 int             ns_rdata_equal(ns_type,
 669                                const u_char *, size_t,
 670                                const u_char *, size_t);
 671 int             ns_rdata_refers(ns_type,
 672                                 const u_char *, size_t,
 673                                 const u_char *);
 674 __END_DECLS
 675
 676 #ifdef BIND_4_COMPAT
 677 #include <arpa/nameser_compat.h>
 678 #endif
 679
 680 #endif /* !_ARPA_NAMESER_H_ */
 681 /*! \file */