contrib/unbound/sldns/rrdef.h

   1 /*
   2  * rrdef.h
   3  *
   4  * RR definitions
   5  *
   6  * a Net::DNS like library for C
   7  *
   8  * (c) NLnet Labs, 2005-2006
   9  *
  10  * See the file LICENSE for the license
  11  */
  12
  13 /**
  14  * \file
  15  *
  16  * Defines resource record types and constants.
  17  */
  18
  19 #ifndef LDNS_RRDEF_H
  20 #define LDNS_RRDEF_H
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 /** Maximum length of a dname label */
  27 #define LDNS_MAX_LABELLEN     63
  28 /** Maximum length of a complete dname */
  29 #define LDNS_MAX_DOMAINLEN    255
  30 /** Maximum number of pointers in 1 dname */
  31 #define LDNS_MAX_POINTERS       65535
  32 /** The bytes TTL, CLASS and length use up in an rr */
  33 #define LDNS_RR_OVERHEAD        10
  34
  35 #define LDNS_DNSSEC_KEYPROTO    3
  36 #define LDNS_KEY_ZONE_KEY   0x0100 /* set for ZSK&KSK, rfc 4034 */
  37 #define LDNS_KEY_SEP_KEY    0x0001 /* set for KSK, rfc 4034 */
  38 #define LDNS_KEY_REVOKE_KEY 0x0080 /* used to revoke KSK, rfc 5011 */
  39
  40 /* The first fields are contiguous and can be referenced instantly */
  41 #define LDNS_RDATA_FIELD_DESCRIPTORS_COMMON 258
  42
  43 /** lookuptable for rr classes  */
  44 extern struct sldns_struct_lookup_table* sldns_rr_classes;
  45
  46 /**
  47  *  The different RR classes.
  48  */
  49 enum sldns_enum_rr_class
  50 {
  51         /** the Internet */
  52         LDNS_RR_CLASS_IN        = 1,
  53         /** Chaos class */
  54         LDNS_RR_CLASS_CH        = 3,
  55         /** Hesiod (Dyer 87) */
  56         LDNS_RR_CLASS_HS        = 4,
  57         /** None class, dynamic update */
  58         LDNS_RR_CLASS_NONE      = 254,
  59         /** Any class */
  60         LDNS_RR_CLASS_ANY       = 255,
  61
  62         LDNS_RR_CLASS_FIRST     = 0,
  63         LDNS_RR_CLASS_LAST      = 65535,
  64         LDNS_RR_CLASS_COUNT     = LDNS_RR_CLASS_LAST - LDNS_RR_CLASS_FIRST + 1
  65 };
  66 typedef enum sldns_enum_rr_class sldns_rr_class;
  67
  68 /**
  69  *  Used to specify whether compression is allowed.
  70  */
  71 enum sldns_enum_rr_compress
  72 {
  73         /** compression is allowed */
  74         LDNS_RR_COMPRESS,
  75         LDNS_RR_NO_COMPRESS
  76 };
  77 typedef enum sldns_enum_rr_compress sldns_rr_compress;
  78
  79 /**
  80  * The different RR types.
  81  */
  82 enum sldns_enum_rr_type
  83 {
  84         /**  a host address */
  85         LDNS_RR_TYPE_A = 1,
  86         /**  an authoritative name server */
  87         LDNS_RR_TYPE_NS = 2,
  88         /**  a mail destination (Obsolete - use MX) */
  89         LDNS_RR_TYPE_MD = 3,
  90         /**  a mail forwarder (Obsolete - use MX) */
  91         LDNS_RR_TYPE_MF = 4,
  92         /**  the canonical name for an alias */
  93         LDNS_RR_TYPE_CNAME = 5,
  94         /**  marks the start of a zone of authority */
  95         LDNS_RR_TYPE_SOA = 6,
  96         /**  a mailbox domain name (EXPERIMENTAL) */
  97         LDNS_RR_TYPE_MB = 7,
  98         /**  a mail group member (EXPERIMENTAL) */
  99         LDNS_RR_TYPE_MG = 8,
 100         /**  a mail rename domain name (EXPERIMENTAL) */
 101         LDNS_RR_TYPE_MR = 9,
 102         /**  a null RR (EXPERIMENTAL) */
 103         LDNS_RR_TYPE_NULL = 10,
 104         /**  a well known service description */
 105         LDNS_RR_TYPE_WKS = 11,
 106         /**  a domain name pointer */
 107         LDNS_RR_TYPE_PTR = 12,
 108         /**  host information */
 109         LDNS_RR_TYPE_HINFO = 13,
 110         /**  mailbox or mail list information */
 111         LDNS_RR_TYPE_MINFO = 14,
 112         /**  mail exchange */
 113         LDNS_RR_TYPE_MX = 15,
 114         /**  text strings */
 115         LDNS_RR_TYPE_TXT = 16,
 116         /**  RFC1183 */
 117         LDNS_RR_TYPE_RP = 17,
 118         /**  RFC1183 */
 119         LDNS_RR_TYPE_AFSDB = 18,
 120         /**  RFC1183 */
 121         LDNS_RR_TYPE_X25 = 19,
 122         /**  RFC1183 */
 123         LDNS_RR_TYPE_ISDN = 20,
 124         /**  RFC1183 */
 125         LDNS_RR_TYPE_RT = 21,
 126         /**  RFC1706 */
 127         LDNS_RR_TYPE_NSAP = 22,
 128         /**  RFC1348 */
 129         LDNS_RR_TYPE_NSAP_PTR = 23,
 130         /**  2535typecode */
 131         LDNS_RR_TYPE_SIG = 24,
 132         /**  2535typecode */
 133         LDNS_RR_TYPE_KEY = 25,
 134         /**  RFC2163 */
 135         LDNS_RR_TYPE_PX = 26,
 136         /**  RFC1712 */
 137         LDNS_RR_TYPE_GPOS = 27,
 138         /**  ipv6 address */
 139         LDNS_RR_TYPE_AAAA = 28,
 140         /**  LOC record  RFC1876 */
 141         LDNS_RR_TYPE_LOC = 29,
 142         /**  2535typecode */
 143         LDNS_RR_TYPE_NXT = 30,
 144         /**  draft-ietf-nimrod-dns-01.txt */
 145         LDNS_RR_TYPE_EID = 31,
 146         /**  draft-ietf-nimrod-dns-01.txt */
 147         LDNS_RR_TYPE_NIMLOC = 32,
 148         /**  SRV record RFC2782 */
 149         LDNS_RR_TYPE_SRV = 33,
 150         /**  http://www.jhsoft.com/rfc/af-saa-0069.000.rtf */
 151         LDNS_RR_TYPE_ATMA = 34,
 152         /**  RFC2915 */
 153         LDNS_RR_TYPE_NAPTR = 35,
 154         /**  RFC2230 */
 155         LDNS_RR_TYPE_KX = 36,
 156         /**  RFC2538 */
 157         LDNS_RR_TYPE_CERT = 37,
 158         /**  RFC2874 */
 159         LDNS_RR_TYPE_A6 = 38,
 160         /**  RFC2672 */
 161         LDNS_RR_TYPE_DNAME = 39,
 162         /**  dnsind-kitchen-sink-02.txt */
 163         LDNS_RR_TYPE_SINK = 40,
 164         /**  Pseudo OPT record... */
 165         LDNS_RR_TYPE_OPT = 41,
 166         /**  RFC3123 */
 167         LDNS_RR_TYPE_APL = 42,
 168         /**  RFC4034, RFC3658 */
 169         LDNS_RR_TYPE_DS = 43,
 170         /**  SSH Key Fingerprint */
 171         LDNS_RR_TYPE_SSHFP = 44, /* RFC 4255 */
 172         /**  IPsec Key */
 173         LDNS_RR_TYPE_IPSECKEY = 45, /* RFC 4025 */
 174         /**  DNSSEC */
 175         LDNS_RR_TYPE_RRSIG = 46, /* RFC 4034 */
 176         LDNS_RR_TYPE_NSEC = 47, /* RFC 4034 */
 177         LDNS_RR_TYPE_DNSKEY = 48, /* RFC 4034 */
 178
 179         LDNS_RR_TYPE_DHCID = 49, /* RFC 4701 */
 180         /* NSEC3 */
 181         LDNS_RR_TYPE_NSEC3 = 50, /* RFC 5155 */
 182         LDNS_RR_TYPE_NSEC3PARAM = 51, /* RFC 5155 */
 183         LDNS_RR_TYPE_NSEC3PARAMS = 51,
 184         LDNS_RR_TYPE_TLSA = 52, /* RFC 6698 */
 185
 186         LDNS_RR_TYPE_HIP = 55, /* RFC 5205 */
 187
 188         /** draft-reid-dnsext-zs */
 189         LDNS_RR_TYPE_NINFO = 56,
 190         /** draft-reid-dnsext-rkey */
 191         LDNS_RR_TYPE_RKEY = 57,
 192         /** draft-ietf-dnsop-trust-history */
 193         LDNS_RR_TYPE_TALINK = 58,
 194         LDNS_RR_TYPE_CDS = 59, /** RFC 7344 */
 195         LDNS_RR_TYPE_CDNSKEY = 60, /** RFC 7344 */
 196
 197         LDNS_RR_TYPE_SPF = 99, /* RFC 4408 */
 198
 199         LDNS_RR_TYPE_UINFO = 100,
 200         LDNS_RR_TYPE_UID = 101,
 201         LDNS_RR_TYPE_GID = 102,
 202         LDNS_RR_TYPE_UNSPEC = 103,
 203
 204         LDNS_RR_TYPE_NID = 104, /* RFC 6742 */
 205         LDNS_RR_TYPE_L32 = 105, /* RFC 6742 */
 206         LDNS_RR_TYPE_L64 = 106, /* RFC 6742 */
 207         LDNS_RR_TYPE_LP = 107, /* RFC 6742 */
 208
 209         /** draft-jabley-dnsext-eui48-eui64-rrtypes */
 210         LDNS_RR_TYPE_EUI48 = 108,
 211         LDNS_RR_TYPE_EUI64 = 109,
 212
 213         LDNS_RR_TYPE_TKEY = 249, /* RFC 2930 */
 214         LDNS_RR_TYPE_TSIG = 250,
 215         LDNS_RR_TYPE_IXFR = 251,
 216         LDNS_RR_TYPE_AXFR = 252,
 217         /**  A request for mailbox-related records (MB, MG or MR) */
 218         LDNS_RR_TYPE_MAILB = 253,
 219         /**  A request for mail agent RRs (Obsolete - see MX) */
 220         LDNS_RR_TYPE_MAILA = 254,
 221         /**  any type (wildcard) */
 222         LDNS_RR_TYPE_ANY = 255,
 223         LDNS_RR_TYPE_URI = 256, /* RFC 7553 */
 224         LDNS_RR_TYPE_CAA = 257, /* RFC 6844 */
 225
 226         /** DNSSEC Trust Authorities */
 227         LDNS_RR_TYPE_TA = 32768,
 228         /* RFC 4431, 5074, DNSSEC Lookaside Validation */
 229         LDNS_RR_TYPE_DLV = 32769,
 230
 231         /* type codes from nsec3 experimental phase
 232         LDNS_RR_TYPE_NSEC3 = 65324,
 233         LDNS_RR_TYPE_NSEC3PARAMS = 65325, */
 234         LDNS_RR_TYPE_FIRST = 0,
 235         LDNS_RR_TYPE_LAST  = 65535,
 236         LDNS_RR_TYPE_COUNT = LDNS_RR_TYPE_LAST - LDNS_RR_TYPE_FIRST + 1
 237 };
 238 typedef enum sldns_enum_rr_type sldns_rr_type;
 239
 240 /* RDATA */
 241 #define LDNS_MAX_RDFLEN 65535
 242
 243 #define LDNS_RDF_SIZE_BYTE              1
 244 #define LDNS_RDF_SIZE_WORD              2
 245 #define LDNS_RDF_SIZE_DOUBLEWORD        4
 246 #define LDNS_RDF_SIZE_6BYTES            6
 247 #define LDNS_RDF_SIZE_8BYTES            8
 248 #define LDNS_RDF_SIZE_16BYTES           16
 249
 250 #define LDNS_NSEC3_VARS_OPTOUT_MASK 0x01
 251
 252 #define LDNS_APL_IP4            1
 253 #define LDNS_APL_IP6            2
 254 #define LDNS_APL_MASK           0x7f
 255 #define LDNS_APL_NEGATION       0x80
 256
 257 /**
 258  * The different types of RDATA fields.
 259  */
 260 enum sldns_enum_rdf_type
 261 {
 262         /** none */
 263         LDNS_RDF_TYPE_NONE,
 264         /** domain name */
 265         LDNS_RDF_TYPE_DNAME,
 266         /** 8 bits */
 267         LDNS_RDF_TYPE_INT8,
 268         /** 16 bits */
 269         LDNS_RDF_TYPE_INT16,
 270         /** 32 bits */
 271         LDNS_RDF_TYPE_INT32,
 272         /** A record */
 273         LDNS_RDF_TYPE_A,
 274         /** AAAA record */
 275         LDNS_RDF_TYPE_AAAA,
 276         /** txt string */
 277         LDNS_RDF_TYPE_STR,
 278         /** apl data */
 279         LDNS_RDF_TYPE_APL,
 280         /** b32 string */
 281         LDNS_RDF_TYPE_B32_EXT,
 282         /** b64 string */
 283         LDNS_RDF_TYPE_B64,
 284         /** hex string */
 285         LDNS_RDF_TYPE_HEX,
 286         /** nsec type codes */
 287         LDNS_RDF_TYPE_NSEC,
 288         /** a RR type */
 289         LDNS_RDF_TYPE_TYPE,
 290         /** a class */
 291         LDNS_RDF_TYPE_CLASS,
 292         /** certificate algorithm */
 293         LDNS_RDF_TYPE_CERT_ALG,
 294         /** a key algorithm */
 295         LDNS_RDF_TYPE_ALG,
 296         /** unknown types */
 297         LDNS_RDF_TYPE_UNKNOWN,
 298         /** time (32 bits) */
 299         LDNS_RDF_TYPE_TIME,
 300         /** period */
 301         LDNS_RDF_TYPE_PERIOD,
 302         /** tsig time 48 bits */
 303         LDNS_RDF_TYPE_TSIGTIME,
 304         /** Represents the Public Key Algorithm, HIT and Public Key fields
 305             for the HIP RR types.  A HIP specific rdf type is used because of
 306             the unusual layout in wireformat (see RFC 5205 Section 5) */
 307         LDNS_RDF_TYPE_HIP,
 308         /** variable length any type rdata where the length
 309             is specified by the first 2 bytes */
 310         LDNS_RDF_TYPE_INT16_DATA,
 311         /** protocol and port bitmaps */
 312         LDNS_RDF_TYPE_SERVICE,
 313         /** location data */
 314         LDNS_RDF_TYPE_LOC,
 315         /** well known services */
 316         LDNS_RDF_TYPE_WKS,
 317         /** NSAP */
 318         LDNS_RDF_TYPE_NSAP,
 319         /** ATMA */
 320         LDNS_RDF_TYPE_ATMA,
 321         /** IPSECKEY */
 322         LDNS_RDF_TYPE_IPSECKEY,
 323         /** nsec3 hash salt */
 324         LDNS_RDF_TYPE_NSEC3_SALT,
 325         /** nsec3 base32 string (with length byte on wire */
 326         LDNS_RDF_TYPE_NSEC3_NEXT_OWNER,
 327
 328         /** 4 shorts represented as 4 * 16 bit hex numbers
 329          *  seperated by colons. For NID and L64.
 330          */
 331         LDNS_RDF_TYPE_ILNP64,
 332
 333         /** 6 * 8 bit hex numbers seperated by dashes. For EUI48. */
 334         LDNS_RDF_TYPE_EUI48,
 335         /** 8 * 8 bit hex numbers seperated by dashes. For EUI64. */
 336         LDNS_RDF_TYPE_EUI64,
 337
 338         /** A non-zero sequence of US-ASCII letters and numbers in lower case.
 339          *  For CAA.
 340          */
 341         LDNS_RDF_TYPE_TAG,
 342
 343         /** A <character-string> encoding of the value field as specified
 344          * [RFC1035], Section 5.1., encoded as remaining rdata.
 345          * For CAA, URI.
 346          */
 347         LDNS_RDF_TYPE_LONG_STR,
 348
 349         /* Aliases */
 350         LDNS_RDF_TYPE_BITMAP = LDNS_RDF_TYPE_NSEC
 351 };
 352 typedef enum sldns_enum_rdf_type sldns_rdf_type;
 353
 354 /**
 355  * Algorithms used in dns
 356  */
 357 enum sldns_enum_algorithm
 358 {
 359         LDNS_RSAMD5             = 1,   /* RFC 4034,4035 */
 360         LDNS_DH                 = 2,
 361         LDNS_DSA                = 3,
 362         LDNS_ECC                = 4,
 363         LDNS_RSASHA1            = 5,
 364         LDNS_DSA_NSEC3          = 6,
 365         LDNS_RSASHA1_NSEC3      = 7,
 366         LDNS_RSASHA256          = 8,   /* RFC 5702 */
 367         LDNS_RSASHA512          = 10,  /* RFC 5702 */
 368         LDNS_ECC_GOST           = 12,  /* RFC 5933 */
 369         LDNS_ECDSAP256SHA256    = 13,  /* RFC 6605 */
 370         LDNS_ECDSAP384SHA384    = 14,  /* RFC 6605 */
 371         LDNS_INDIRECT           = 252,
 372         LDNS_PRIVATEDNS         = 253,
 373         LDNS_PRIVATEOID         = 254
 374 };
 375 typedef enum sldns_enum_algorithm sldns_algorithm;
 376
 377 /**
 378  * Hashing algorithms used in the DS record
 379  */
 380 enum sldns_enum_hash
 381 {
 382         LDNS_SHA1               = 1,  /* RFC 4034 */
 383         LDNS_SHA256             = 2,  /* RFC 4509 */
 384         LDNS_HASH_GOST          = 3,  /* RFC 5933 */
 385         LDNS_SHA384             = 4   /* RFC 6605 */
 386 };
 387 typedef enum sldns_enum_hash sldns_hash;
 388
 389 /**
 390  * algorithms used in CERT rrs
 391  */
 392 enum sldns_enum_cert_algorithm
 393 {
 394         LDNS_CERT_PKIX          = 1,
 395         LDNS_CERT_SPKI          = 2,
 396         LDNS_CERT_PGP           = 3,
 397         LDNS_CERT_IPKIX         = 4,
 398         LDNS_CERT_ISPKI         = 5,
 399         LDNS_CERT_IPGP          = 6,
 400         LDNS_CERT_ACPKIX        = 7,
 401         LDNS_CERT_IACPKIX       = 8,
 402         LDNS_CERT_URI           = 253,
 403         LDNS_CERT_OID           = 254
 404 };
 405 typedef enum sldns_enum_cert_algorithm sldns_cert_algorithm;
 406
 407 /**
 408  * EDNS option codes
 409  */
 410 enum sldns_enum_edns_option
 411 {
 412         LDNS_EDNS_LLQ = 1, /* http://files.dns-sd.org/draft-sekar-dns-llq.txt */
 413         LDNS_EDNS_UL = 2, /* http://files.dns-sd.org/draft-sekar-dns-ul.txt */
 414         LDNS_EDNS_NSID = 3, /* RFC5001 */
 415         /* 4 draft-cheshire-edns0-owner-option */
 416         LDNS_EDNS_DAU = 5, /* RFC6975 */
 417         LDNS_EDNS_DHU = 6, /* RFC6975 */
 418         LDNS_EDNS_N3U = 7, /* RFC6975 */
 419         LDNS_EDNS_CLIENT_SUBNET = 8 /* draft-vandergaast-edns-client-subnet */
 420 };
 421 typedef enum sldns_enum_edns_option sldns_edns_option;
 422
 423 #define LDNS_EDNS_MASK_DO_BIT 0x8000
 424
 425 /**
 426  * Contains all information about resource record types.
 427  *
 428  * This structure contains, for all rr types, the rdata fields that are defined.
 429  */
 430 struct sldns_struct_rr_descriptor
 431 {
 432         /** Type of the RR that is described here */
 433         sldns_rr_type    _type;
 434         /** Textual name of the RR type.  */
 435         const char *_name;
 436         /** Minimum number of rdata fields in the RRs of this type.  */
 437         uint8_t     _minimum;
 438         /** Maximum number of rdata fields in the RRs of this type.  */
 439         uint8_t     _maximum;
 440         /** Wireformat specification for the rr, i.e. the types of rdata fields in their respective order. */
 441         const sldns_rdf_type *_wireformat;
 442         /** Special rdf types */
 443         sldns_rdf_type _variable;
 444         /** Specifies whether compression can be used for dnames in this RR type. */
 445         sldns_rr_compress _compress;
 446         /** The number of DNAMEs in the _wireformat string, for parsing. */
 447         uint8_t _dname_count;
 448 };
 449 typedef struct sldns_struct_rr_descriptor sldns_rr_descriptor;
 450
 451 /**
 452  * returns the resource record descriptor for the given rr type.
 453  *
 454  * \param[in] type the type value of the rr type
 455  *\return the sldns_rr_descriptor for this type
 456  */
 457 const sldns_rr_descriptor *sldns_rr_descript(uint16_t type);
 458
 459 /**
 460  * returns the minimum number of rdata fields of the rr type this descriptor describes.
 461  *
 462  * \param[in]  descriptor for an rr type
 463  * \return the minimum number of rdata fields
 464  */
 465 size_t sldns_rr_descriptor_minimum(const sldns_rr_descriptor *descriptor);
 466
 467 /**
 468  * returns the maximum number of rdata fields of the rr type this descriptor describes.
 469  *
 470  * \param[in]  descriptor for an rr type
 471  * \return the maximum number of rdata fields
 472  */
 473 size_t sldns_rr_descriptor_maximum(const sldns_rr_descriptor *descriptor);
 474
 475 /**
 476  * returns the rdf type for the given rdata field number of the rr type for the given descriptor.
 477  *
 478  * \param[in] descriptor for an rr type
 479  * \param[in] field the field number
 480  * \return the rdf type for the field
 481  */
 482 sldns_rdf_type sldns_rr_descriptor_field_type(const sldns_rr_descriptor *descriptor, size_t field);
 483
 484 /**
 485  * retrieves a rrtype by looking up its name.
 486  * \param[in] name a string with the name
 487  * \return the type which corresponds with the name
 488  */
 489 sldns_rr_type sldns_get_rr_type_by_name(const char *name);
 490
 491 /**
 492  * retrieves a class by looking up its name.
 493  * \param[in] name string with the name
 494  * \return the cass which corresponds with the name
 495  */
 496 sldns_rr_class sldns_get_rr_class_by_name(const char *name);
 497
 498 #ifdef __cplusplus
 499 }
 500 #endif
 501
 502 #endif /* LDNS_RRDEF_H */