rrdef.h revision 307729
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 23extern "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 */ 44extern struct sldns_struct_lookup_table* sldns_rr_classes; 45 46/** 47 * The different RR classes. 48 */ 49enum 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}; 66typedef enum sldns_enum_rr_class sldns_rr_class; 67 68/** 69 * Used to specify whether compression is allowed. 70 */ 71enum sldns_enum_rr_compress 72{ 73 /** compression is allowed */ 74 LDNS_RR_COMPRESS, 75 LDNS_RR_NO_COMPRESS 76}; 77typedef enum sldns_enum_rr_compress sldns_rr_compress; 78 79/** 80 * The different RR types. 81 */ 82enum 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 LDNS_RR_TYPE_SMIMEA = 53, /* draft-ietf-dane-smime, TLSA-like but may 186 be extended */ 187 188 LDNS_RR_TYPE_HIP = 55, /* RFC 5205 */ 189 190 /** draft-reid-dnsext-zs */ 191 LDNS_RR_TYPE_NINFO = 56, 192 /** draft-reid-dnsext-rkey */ 193 LDNS_RR_TYPE_RKEY = 57, 194 /** draft-ietf-dnsop-trust-history */ 195 LDNS_RR_TYPE_TALINK = 58, 196 LDNS_RR_TYPE_CDS = 59, /** RFC 7344 */ 197 LDNS_RR_TYPE_CDNSKEY = 60, /** RFC 7344 */ 198 LDNS_RR_TYPE_OPENPGPKEY = 61, /* RFC 7929 */ 199 LDNS_RR_TYPE_CSYNC = 62, /* RFC 7477 */ 200 201 LDNS_RR_TYPE_SPF = 99, /* RFC 4408 */ 202 203 LDNS_RR_TYPE_UINFO = 100, 204 LDNS_RR_TYPE_UID = 101, 205 LDNS_RR_TYPE_GID = 102, 206 LDNS_RR_TYPE_UNSPEC = 103, 207 208 LDNS_RR_TYPE_NID = 104, /* RFC 6742 */ 209 LDNS_RR_TYPE_L32 = 105, /* RFC 6742 */ 210 LDNS_RR_TYPE_L64 = 106, /* RFC 6742 */ 211 LDNS_RR_TYPE_LP = 107, /* RFC 6742 */ 212 213 /** draft-jabley-dnsext-eui48-eui64-rrtypes */ 214 LDNS_RR_TYPE_EUI48 = 108, 215 LDNS_RR_TYPE_EUI64 = 109, 216 217 LDNS_RR_TYPE_TKEY = 249, /* RFC 2930 */ 218 LDNS_RR_TYPE_TSIG = 250, 219 LDNS_RR_TYPE_IXFR = 251, 220 LDNS_RR_TYPE_AXFR = 252, 221 /** A request for mailbox-related records (MB, MG or MR) */ 222 LDNS_RR_TYPE_MAILB = 253, 223 /** A request for mail agent RRs (Obsolete - see MX) */ 224 LDNS_RR_TYPE_MAILA = 254, 225 /** any type (wildcard) */ 226 LDNS_RR_TYPE_ANY = 255, 227 LDNS_RR_TYPE_URI = 256, /* RFC 7553 */ 228 LDNS_RR_TYPE_CAA = 257, /* RFC 6844 */ 229 230 /** DNSSEC Trust Authorities */ 231 LDNS_RR_TYPE_TA = 32768, 232 /* RFC 4431, 5074, DNSSEC Lookaside Validation */ 233 LDNS_RR_TYPE_DLV = 32769, 234 235 /* type codes from nsec3 experimental phase 236 LDNS_RR_TYPE_NSEC3 = 65324, 237 LDNS_RR_TYPE_NSEC3PARAMS = 65325, */ 238 LDNS_RR_TYPE_FIRST = 0, 239 LDNS_RR_TYPE_LAST = 65535, 240 LDNS_RR_TYPE_COUNT = LDNS_RR_TYPE_LAST - LDNS_RR_TYPE_FIRST + 1 241}; 242typedef enum sldns_enum_rr_type sldns_rr_type; 243 244/* RDATA */ 245#define LDNS_MAX_RDFLEN 65535 246 247#define LDNS_RDF_SIZE_BYTE 1 248#define LDNS_RDF_SIZE_WORD 2 249#define LDNS_RDF_SIZE_DOUBLEWORD 4 250#define LDNS_RDF_SIZE_6BYTES 6 251#define LDNS_RDF_SIZE_8BYTES 8 252#define LDNS_RDF_SIZE_16BYTES 16 253 254#define LDNS_NSEC3_VARS_OPTOUT_MASK 0x01 255 256#define LDNS_APL_IP4 1 257#define LDNS_APL_IP6 2 258#define LDNS_APL_MASK 0x7f 259#define LDNS_APL_NEGATION 0x80 260 261/** 262 * The different types of RDATA fields. 263 */ 264enum sldns_enum_rdf_type 265{ 266 /** none */ 267 LDNS_RDF_TYPE_NONE, 268 /** domain name */ 269 LDNS_RDF_TYPE_DNAME, 270 /** 8 bits */ 271 LDNS_RDF_TYPE_INT8, 272 /** 16 bits */ 273 LDNS_RDF_TYPE_INT16, 274 /** 32 bits */ 275 LDNS_RDF_TYPE_INT32, 276 /** A record */ 277 LDNS_RDF_TYPE_A, 278 /** AAAA record */ 279 LDNS_RDF_TYPE_AAAA, 280 /** txt string */ 281 LDNS_RDF_TYPE_STR, 282 /** apl data */ 283 LDNS_RDF_TYPE_APL, 284 /** b32 string */ 285 LDNS_RDF_TYPE_B32_EXT, 286 /** b64 string */ 287 LDNS_RDF_TYPE_B64, 288 /** hex string */ 289 LDNS_RDF_TYPE_HEX, 290 /** nsec type codes */ 291 LDNS_RDF_TYPE_NSEC, 292 /** a RR type */ 293 LDNS_RDF_TYPE_TYPE, 294 /** a class */ 295 LDNS_RDF_TYPE_CLASS, 296 /** certificate algorithm */ 297 LDNS_RDF_TYPE_CERT_ALG, 298 /** a key algorithm */ 299 LDNS_RDF_TYPE_ALG, 300 /** unknown types */ 301 LDNS_RDF_TYPE_UNKNOWN, 302 /** time (32 bits) */ 303 LDNS_RDF_TYPE_TIME, 304 /** period */ 305 LDNS_RDF_TYPE_PERIOD, 306 /** tsig time 48 bits */ 307 LDNS_RDF_TYPE_TSIGTIME, 308 /** Represents the Public Key Algorithm, HIT and Public Key fields 309 for the HIP RR types. A HIP specific rdf type is used because of 310 the unusual layout in wireformat (see RFC 5205 Section 5) */ 311 LDNS_RDF_TYPE_HIP, 312 /** variable length any type rdata where the length 313 is specified by the first 2 bytes */ 314 LDNS_RDF_TYPE_INT16_DATA, 315 /** protocol and port bitmaps */ 316 LDNS_RDF_TYPE_SERVICE, 317 /** location data */ 318 LDNS_RDF_TYPE_LOC, 319 /** well known services */ 320 LDNS_RDF_TYPE_WKS, 321 /** NSAP */ 322 LDNS_RDF_TYPE_NSAP, 323 /** ATMA */ 324 LDNS_RDF_TYPE_ATMA, 325 /** IPSECKEY */ 326 LDNS_RDF_TYPE_IPSECKEY, 327 /** nsec3 hash salt */ 328 LDNS_RDF_TYPE_NSEC3_SALT, 329 /** nsec3 base32 string (with length byte on wire */ 330 LDNS_RDF_TYPE_NSEC3_NEXT_OWNER, 331 332 /** 4 shorts represented as 4 * 16 bit hex numbers 333 * seperated by colons. For NID and L64. 334 */ 335 LDNS_RDF_TYPE_ILNP64, 336 337 /** 6 * 8 bit hex numbers seperated by dashes. For EUI48. */ 338 LDNS_RDF_TYPE_EUI48, 339 /** 8 * 8 bit hex numbers seperated by dashes. For EUI64. */ 340 LDNS_RDF_TYPE_EUI64, 341 342 /** A non-zero sequence of US-ASCII letters and numbers in lower case. 343 * For CAA. 344 */ 345 LDNS_RDF_TYPE_TAG, 346 347 /** A <character-string> encoding of the value field as specified 348 * [RFC1035], Section 5.1., encoded as remaining rdata. 349 * For CAA, URI. 350 */ 351 LDNS_RDF_TYPE_LONG_STR, 352 353 /* Aliases */ 354 LDNS_RDF_TYPE_BITMAP = LDNS_RDF_TYPE_NSEC 355}; 356typedef enum sldns_enum_rdf_type sldns_rdf_type; 357 358/** 359 * Algorithms used in dns 360 */ 361enum sldns_enum_algorithm 362{ 363 LDNS_RSAMD5 = 1, /* RFC 4034,4035 */ 364 LDNS_DH = 2, 365 LDNS_DSA = 3, 366 LDNS_ECC = 4, 367 LDNS_RSASHA1 = 5, 368 LDNS_DSA_NSEC3 = 6, 369 LDNS_RSASHA1_NSEC3 = 7, 370 LDNS_RSASHA256 = 8, /* RFC 5702 */ 371 LDNS_RSASHA512 = 10, /* RFC 5702 */ 372 LDNS_ECC_GOST = 12, /* RFC 5933 */ 373 LDNS_ECDSAP256SHA256 = 13, /* RFC 6605 */ 374 LDNS_ECDSAP384SHA384 = 14, /* RFC 6605 */ 375 LDNS_INDIRECT = 252, 376 LDNS_PRIVATEDNS = 253, 377 LDNS_PRIVATEOID = 254 378}; 379typedef enum sldns_enum_algorithm sldns_algorithm; 380 381/** 382 * Hashing algorithms used in the DS record 383 */ 384enum sldns_enum_hash 385{ 386 LDNS_SHA1 = 1, /* RFC 4034 */ 387 LDNS_SHA256 = 2, /* RFC 4509 */ 388 LDNS_HASH_GOST = 3, /* RFC 5933 */ 389 LDNS_SHA384 = 4 /* RFC 6605 */ 390}; 391typedef enum sldns_enum_hash sldns_hash; 392 393/** 394 * algorithms used in CERT rrs 395 */ 396enum sldns_enum_cert_algorithm 397{ 398 LDNS_CERT_PKIX = 1, 399 LDNS_CERT_SPKI = 2, 400 LDNS_CERT_PGP = 3, 401 LDNS_CERT_IPKIX = 4, 402 LDNS_CERT_ISPKI = 5, 403 LDNS_CERT_IPGP = 6, 404 LDNS_CERT_ACPKIX = 7, 405 LDNS_CERT_IACPKIX = 8, 406 LDNS_CERT_URI = 253, 407 LDNS_CERT_OID = 254 408}; 409typedef enum sldns_enum_cert_algorithm sldns_cert_algorithm; 410 411/** 412 * EDNS option codes 413 */ 414enum sldns_enum_edns_option 415{ 416 LDNS_EDNS_LLQ = 1, /* http://files.dns-sd.org/draft-sekar-dns-llq.txt */ 417 LDNS_EDNS_UL = 2, /* http://files.dns-sd.org/draft-sekar-dns-ul.txt */ 418 LDNS_EDNS_NSID = 3, /* RFC5001 */ 419 /* 4 draft-cheshire-edns0-owner-option */ 420 LDNS_EDNS_DAU = 5, /* RFC6975 */ 421 LDNS_EDNS_DHU = 6, /* RFC6975 */ 422 LDNS_EDNS_N3U = 7, /* RFC6975 */ 423 LDNS_EDNS_CLIENT_SUBNET = 8, /* draft-vandergaast-edns-client-subnet */ 424 LDNS_EDNS_PADDING = 12 /* RFC7830 */ 425}; 426typedef enum sldns_enum_edns_option sldns_edns_option; 427 428#define LDNS_EDNS_MASK_DO_BIT 0x8000 429 430/** 431 * Contains all information about resource record types. 432 * 433 * This structure contains, for all rr types, the rdata fields that are defined. 434 */ 435struct sldns_struct_rr_descriptor 436{ 437 /** Type of the RR that is described here */ 438 sldns_rr_type _type; 439 /** Textual name of the RR type. */ 440 const char *_name; 441 /** Minimum number of rdata fields in the RRs of this type. */ 442 uint8_t _minimum; 443 /** Maximum number of rdata fields in the RRs of this type. */ 444 uint8_t _maximum; 445 /** Wireformat specification for the rr, i.e. the types of rdata fields in their respective order. */ 446 const sldns_rdf_type *_wireformat; 447 /** Special rdf types */ 448 sldns_rdf_type _variable; 449 /** Specifies whether compression can be used for dnames in this RR type. */ 450 sldns_rr_compress _compress; 451 /** The number of DNAMEs in the _wireformat string, for parsing. */ 452 uint8_t _dname_count; 453}; 454typedef struct sldns_struct_rr_descriptor sldns_rr_descriptor; 455 456/** 457 * returns the resource record descriptor for the given rr type. 458 * 459 * \param[in] type the type value of the rr type 460 *\return the sldns_rr_descriptor for this type 461 */ 462const sldns_rr_descriptor *sldns_rr_descript(uint16_t type); 463 464/** 465 * returns the minimum number of rdata fields of the rr type this descriptor describes. 466 * 467 * \param[in] descriptor for an rr type 468 * \return the minimum number of rdata fields 469 */ 470size_t sldns_rr_descriptor_minimum(const sldns_rr_descriptor *descriptor); 471 472/** 473 * returns the maximum number of rdata fields of the rr type this descriptor describes. 474 * 475 * \param[in] descriptor for an rr type 476 * \return the maximum number of rdata fields 477 */ 478size_t sldns_rr_descriptor_maximum(const sldns_rr_descriptor *descriptor); 479 480/** 481 * returns the rdf type for the given rdata field number of the rr type for the given descriptor. 482 * 483 * \param[in] descriptor for an rr type 484 * \param[in] field the field number 485 * \return the rdf type for the field 486 */ 487sldns_rdf_type sldns_rr_descriptor_field_type(const sldns_rr_descriptor *descriptor, size_t field); 488 489/** 490 * retrieves a rrtype by looking up its name. 491 * \param[in] name a string with the name 492 * \return the type which corresponds with the name 493 */ 494sldns_rr_type sldns_get_rr_type_by_name(const char *name); 495 496/** 497 * retrieves a class by looking up its name. 498 * \param[in] name string with the name 499 * \return the cass which corresponds with the name 500 */ 501sldns_rr_class sldns_get_rr_class_by_name(const char *name); 502 503#ifdef __cplusplus 504} 505#endif 506 507#endif /* LDNS_RRDEF_H */ 508