1 /* 2 * rdata.h 3 * 4 * rdata 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 /** 15 * \file 16 * 17 * Defines ldns_rdf and functions to manipulate those. 18 */ 19 20 21 #ifndef LDNS_RDATA_H 22 #define LDNS_RDATA_H 23 24 #include <ldns/common.h> 25 #include <ldns/error.h> 26 27 #ifdef __cplusplus 28 extern "C" { 29 #endif 30 31 #define LDNS_MAX_RDFLEN 65535 32 33 #define LDNS_RDF_SIZE_BYTE 1 34 #define LDNS_RDF_SIZE_WORD 2 35 #define LDNS_RDF_SIZE_DOUBLEWORD 4 36 #define LDNS_RDF_SIZE_6BYTES 6 37 #define LDNS_RDF_SIZE_8BYTES 8 38 #define LDNS_RDF_SIZE_16BYTES 16 39 40 #define LDNS_NSEC3_VARS_OPTOUT_MASK 0x01 41 42 /** 43 * The different types of RDATA fields. 44 */ 45 enum ldns_enum_rdf_type 46 { 47 /** none */ 48 LDNS_RDF_TYPE_NONE, 49 /** domain name */ 50 LDNS_RDF_TYPE_DNAME, 51 /** 8 bits */ 52 LDNS_RDF_TYPE_INT8, 53 /** 16 bits */ 54 LDNS_RDF_TYPE_INT16, 55 /** 32 bits */ 56 LDNS_RDF_TYPE_INT32, 57 /** A record */ 58 LDNS_RDF_TYPE_A, 59 /** AAAA record */ 60 LDNS_RDF_TYPE_AAAA, 61 /** txt string */ 62 LDNS_RDF_TYPE_STR, 63 /** apl data */ 64 LDNS_RDF_TYPE_APL, 65 /** b32 string */ 66 LDNS_RDF_TYPE_B32_EXT, 67 /** b64 string */ 68 LDNS_RDF_TYPE_B64, 69 /** hex string */ 70 LDNS_RDF_TYPE_HEX, 71 /** nsec type codes */ 72 LDNS_RDF_TYPE_NSEC, 73 /** a RR type */ 74 LDNS_RDF_TYPE_TYPE, 75 /** a class */ 76 LDNS_RDF_TYPE_CLASS, 77 /** certificate algorithm */ 78 LDNS_RDF_TYPE_CERT_ALG, 79 /** a key algorithm */ 80 LDNS_RDF_TYPE_ALG, 81 /** unknown types */ 82 LDNS_RDF_TYPE_UNKNOWN, 83 /** time (32 bits) */ 84 LDNS_RDF_TYPE_TIME, 85 /** period */ 86 LDNS_RDF_TYPE_PERIOD, 87 /** tsig time 48 bits */ 88 LDNS_RDF_TYPE_TSIGTIME, 89 /** Represents the Public Key Algorithm, HIT and Public Key fields 90 for the HIP RR types. A HIP specific rdf type is used because of 91 the unusual layout in wireformat (see RFC 5205 Section 5) */ 92 LDNS_RDF_TYPE_HIP, 93 /** variable length any type rdata where the length 94 is specified by the first 2 bytes */ 95 LDNS_RDF_TYPE_INT16_DATA, 96 /** protocol and port bitmaps */ 97 LDNS_RDF_TYPE_SERVICE, 98 /** location data */ 99 LDNS_RDF_TYPE_LOC, 100 /** well known services */ 101 LDNS_RDF_TYPE_WKS, 102 /** NSAP */ 103 LDNS_RDF_TYPE_NSAP, 104 /** ATMA */ 105 LDNS_RDF_TYPE_ATMA, 106 /** IPSECKEY */ 107 LDNS_RDF_TYPE_IPSECKEY, 108 /** nsec3 hash salt */ 109 LDNS_RDF_TYPE_NSEC3_SALT, 110 /** nsec3 base32 string (with length byte on wire */ 111 LDNS_RDF_TYPE_NSEC3_NEXT_OWNER, 112 113 /** 4 shorts represented as 4 * 16 bit hex numbers 114 * separated by colons. For NID and L64. 115 */ 116 LDNS_RDF_TYPE_ILNP64, 117 118 /** 6 * 8 bit hex numbers separated by dashes. For EUI48. */ 119 LDNS_RDF_TYPE_EUI48, 120 /** 8 * 8 bit hex numbers separated by dashes. For EUI64. */ 121 LDNS_RDF_TYPE_EUI64, 122 123 /** A non-zero sequence of US-ASCII letters and numbers in lower case. 124 * For CAA. 125 */ 126 LDNS_RDF_TYPE_TAG, 127 128 /** A <character-string> encoding of the value field as specified 129 * [RFC1035], Section 5.1., encoded as remaining rdata. 130 * For CAA. 131 */ 132 LDNS_RDF_TYPE_LONG_STR, 133 134 /** Since RFC7218 TLSA records can be given with mnemonics, 135 * hence these rdata field types. But as with DNSKEYs, the output 136 * is always numeric. 137 */ 138 LDNS_RDF_TYPE_CERTIFICATE_USAGE, 139 LDNS_RDF_TYPE_SELECTOR, 140 LDNS_RDF_TYPE_MATCHING_TYPE, 141 142 /** draft-ietf-mboned-driad-amt-discovery **/ 143 LDNS_RDF_TYPE_AMTRELAY, 144 145 /* Aliases */ 146 LDNS_RDF_TYPE_BITMAP = LDNS_RDF_TYPE_NSEC 147 }; 148 typedef enum ldns_enum_rdf_type ldns_rdf_type; 149 150 /** 151 * algorithms used in CERT rrs 152 */ 153 enum ldns_enum_cert_algorithm 154 { 155 LDNS_CERT_PKIX = 1, 156 LDNS_CERT_SPKI = 2, 157 LDNS_CERT_PGP = 3, 158 LDNS_CERT_IPKIX = 4, 159 LDNS_CERT_ISPKI = 5, 160 LDNS_CERT_IPGP = 6, 161 LDNS_CERT_ACPKIX = 7, 162 LDNS_CERT_IACPKIX = 8, 163 LDNS_CERT_URI = 253, 164 LDNS_CERT_OID = 254 165 }; 166 typedef enum ldns_enum_cert_algorithm ldns_cert_algorithm; 167 168 169 170 /** 171 * Resource record data field. 172 * 173 * The data is a network ordered array of bytes, which size is specified by 174 * the (16-bit) size field. To correctly parse it, use the type 175 * specified in the (16-bit) type field with a value from \ref ldns_rdf_type. 176 */ 177 struct ldns_struct_rdf 178 { 179 /** The size of the data (in octets) */ 180 size_t _size; 181 /** The type of the data */ 182 ldns_rdf_type _type; 183 /** Pointer to the data (raw octets) */ 184 void *_data; 185 }; 186 typedef struct ldns_struct_rdf ldns_rdf; 187 188 /* prototypes */ 189 190 /* write access functions */ 191 192 /** 193 * sets the size of the rdf. 194 * \param[in] *rd the rdf to operate on 195 * \param[in] size the new size 196 * \return void 197 */ 198 void ldns_rdf_set_size(ldns_rdf *rd, size_t size); 199 200 /** 201 * sets the size of the rdf. 202 * \param[in] *rd the rdf to operate on 203 * \param[in] type the new type 204 * \return void 205 */ 206 void ldns_rdf_set_type(ldns_rdf *rd, ldns_rdf_type type); 207 208 /** 209 * sets the size of the rdf. 210 * \param[in] *rd the rdf to operate on 211 * \param[in] *data pointer to the new data 212 * \return void 213 */ 214 void ldns_rdf_set_data(ldns_rdf *rd, void *data); 215 216 /* read access */ 217 218 /** 219 * returns the size of the rdf. 220 * \param[in] *rd the rdf to read from 221 * \return uint16_t with the size 222 */ 223 size_t ldns_rdf_size(const ldns_rdf *rd); 224 225 /** 226 * returns the type of the rdf. We need to insert _get_ 227 * here to prevent conflict the the rdf_type TYPE. 228 * \param[in] *rd the rdf to read from 229 * \return ldns_rdf_type with the type 230 */ 231 ldns_rdf_type ldns_rdf_get_type(const ldns_rdf *rd); 232 233 /** 234 * returns the data of the rdf. 235 * \param[in] *rd the rdf to read from 236 * 237 * \return uint8_t* pointer to the rdf's data 238 */ 239 uint8_t *ldns_rdf_data(const ldns_rdf *rd); 240 241 /* creator functions */ 242 243 /** 244 * allocates a new rdf structure and fills it. 245 * This function DOES NOT copy the contents from 246 * the buffer, unlinke ldns_rdf_new_frm_data() 247 * \param[in] type type of the rdf 248 * \param[in] size size of the buffer 249 * \param[in] data pointer to the buffer to be copied 250 * \return the new rdf structure or NULL on failure 251 */ 252 ldns_rdf *ldns_rdf_new(ldns_rdf_type type, size_t size, void *data); 253 254 /** 255 * allocates a new rdf structure and fills it. 256 * This function _does_ copy the contents from 257 * the buffer, unlinke ldns_rdf_new() 258 * \param[in] type type of the rdf 259 * \param[in] size size of the buffer 260 * \param[in] data pointer to the buffer to be copied 261 * \return the new rdf structure or NULL on failure 262 */ 263 ldns_rdf *ldns_rdf_new_frm_data(ldns_rdf_type type, size_t size, const void *data); 264 265 /** 266 * creates a new rdf from a string. 267 * \param[in] type type to use 268 * \param[in] str string to use 269 * \return ldns_rdf* or NULL in case of an error 270 */ 271 ldns_rdf *ldns_rdf_new_frm_str(ldns_rdf_type type, const char *str); 272 273 /** 274 * creates a new rdf from a file containing a string. 275 * \param[out] r the new rdf 276 * \param[in] type type to use 277 * \param[in] fp the file pointer to use 278 * \return LDNS_STATUS_OK or the error 279 */ 280 ldns_status ldns_rdf_new_frm_fp(ldns_rdf **r, ldns_rdf_type type, FILE *fp); 281 282 /** 283 * creates a new rdf from a file containing a string. 284 * \param[out] r the new rdf 285 * \param[in] type type to use 286 * \param[in] fp the file pointer to use 287 * \param[in] line_nr pointer to an integer containing the current line number (for debugging purposes) 288 * \return LDNS_STATUS_OK or the error 289 */ 290 ldns_status ldns_rdf_new_frm_fp_l(ldns_rdf **r, ldns_rdf_type type, FILE *fp, int *line_nr); 291 292 /* destroy functions */ 293 294 /** 295 * frees a rdf structure, leaving the 296 * data pointer intact. 297 * \param[in] rd the pointer to be freed 298 * \return void 299 */ 300 void ldns_rdf_free(ldns_rdf *rd); 301 302 /** 303 * frees a rdf structure _and_ frees the 304 * data. rdf should be created with _new_frm_data 305 * \param[in] rd the rdf structure to be freed 306 * \return void 307 */ 308 void ldns_rdf_deep_free(ldns_rdf *rd); 309 310 /* conversion functions */ 311 312 /** 313 * returns the rdf containing the native uint8_t repr. 314 * \param[in] type the ldns_rdf type to use 315 * \param[in] value the uint8_t to use 316 * \return ldns_rdf* with the converted value 317 */ 318 ldns_rdf *ldns_native2rdf_int8(ldns_rdf_type type, uint8_t value); 319 320 /** 321 * returns the rdf containing the native uint16_t representation. 322 * \param[in] type the ldns_rdf type to use 323 * \param[in] value the uint16_t to use 324 * \return ldns_rdf* with the converted value 325 */ 326 ldns_rdf *ldns_native2rdf_int16(ldns_rdf_type type, uint16_t value); 327 328 /** 329 * returns an rdf that contains the given int32 value. 330 * 331 * Because multiple rdf types can contain an int32, the 332 * type must be specified 333 * \param[in] type the ldns_rdf type to use 334 * \param[in] value the uint32_t to use 335 * \return ldns_rdf* with the converted value 336 */ 337 ldns_rdf *ldns_native2rdf_int32(ldns_rdf_type type, uint32_t value); 338 339 /** 340 * returns an int16_data rdf that contains the data in the 341 * given array, preceded by an int16 specifying the length. 342 * 343 * The memory is copied, and an LDNS_RDF_TYPE_INT16DATA is returned 344 * \param[in] size the size of the data 345 * \param[in] *data pointer to the actual data 346 * 347 * \return ldns_rd* the rdf with the data 348 */ 349 ldns_rdf *ldns_native2rdf_int16_data(size_t size, uint8_t *data); 350 351 /** 352 * reverses an rdf, only actually useful for AAAA and A records. 353 * The returned rdf has the type LDNS_RDF_TYPE_DNAME! 354 * \param[in] *rd rdf to be reversed 355 * \return the reversed rdf (a newly created rdf) 356 */ 357 ldns_rdf *ldns_rdf_address_reverse(const ldns_rdf *rd); 358 359 /** 360 * returns the native uint8_t representation from the rdf. 361 * \param[in] rd the ldns_rdf to operate on 362 * \return uint8_t the value extracted 363 */ 364 uint8_t ldns_rdf2native_int8(const ldns_rdf *rd); 365 366 /** 367 * returns the native uint16_t representation from the rdf. 368 * \param[in] rd the ldns_rdf to operate on 369 * \return uint16_t the value extracted 370 */ 371 uint16_t ldns_rdf2native_int16(const ldns_rdf *rd); 372 373 /** 374 * returns the native uint32_t representation from the rdf. 375 * \param[in] rd the ldns_rdf to operate on 376 * \return uint32_t the value extracted 377 */ 378 uint32_t ldns_rdf2native_int32(const ldns_rdf *rd); 379 380 /** 381 * returns the native time_t representation from the rdf. 382 * \param[in] rd the ldns_rdf to operate on 383 * \return time_t the value extracted (32 bits currently) 384 */ 385 time_t ldns_rdf2native_time_t(const ldns_rdf *rd); 386 387 /** 388 * converts a ttl value (like 5d2h) to a long. 389 * \param[in] nptr the start of the string 390 * \param[out] endptr points to the last char in case of error 391 * \return the convert duration value 392 */ 393 uint32_t ldns_str2period(const char *nptr, const char **endptr); 394 395 /** 396 * removes \\DDD, \\[space] and other escapes from the input. 397 * See RFC 1035, section 5.1. 398 * \param[in] word what to check 399 * \param[in] length the string 400 * \return ldns_status mesg 401 */ 402 ldns_status ldns_octet(char *word, size_t *length); 403 404 /** 405 * clones a rdf structure. The data is copied. 406 * \param[in] rd rdf to be copied 407 * \return a new rdf structure 408 */ 409 ldns_rdf *ldns_rdf_clone(const ldns_rdf *rd); 410 411 /** 412 * compares two rdf's on their wire formats. 413 * (To order dnames according to rfc4034, use ldns_dname_compare) 414 * \param[in] rd1 the first one 415 * \param[in] rd2 the second one 416 * \return 0 if equal 417 * \return -1 if rd1 comes before rd2 418 * \return +1 if rd2 comes before rd1 419 */ 420 int ldns_rdf_compare(const ldns_rdf *rd1, const ldns_rdf *rd2); 421 422 /** 423 * Gets the algorithm value, the HIT and Public Key data from the rdf with 424 * type LDNS_RDF_TYPE_HIP. 425 * \param[in] rdf the rdf with type LDNS_RDF_TYPE_HIP 426 * \param[out] alg the algorithm 427 * \param[out] hit_size the size of the HIT data 428 * \param[out] hit the hit data 429 * \param[out] pk_size the size of the Public Key data 430 * \param[out] pk the Public Key data 431 * \return LDNS_STATUS_OK on success, and the error otherwise 432 */ 433 ldns_status ldns_rdf_hip_get_alg_hit_pk(ldns_rdf *rdf, uint8_t* alg, 434 uint8_t *hit_size, uint8_t** hit, 435 uint16_t *pk_size, uint8_t** pk); 436 437 /** 438 * Creates a new LDNS_RDF_TYPE_HIP rdf from given data. 439 * \param[out] rdf the newly created LDNS_RDF_TYPE_HIP rdf 440 * \param[in] alg the algorithm 441 * \param[in] hit_size the size of the HIT data 442 * \param[in] hit the hit data 443 * \param[in] pk_size the size of the Public Key data 444 * \param[in] pk the Public Key data 445 * \return LDNS_STATUS_OK on success, and the error otherwise 446 */ 447 ldns_status ldns_rdf_hip_new_frm_alg_hit_pk(ldns_rdf** rdf, uint8_t alg, 448 uint8_t hit_size, uint8_t *hit, uint16_t pk_size, uint8_t *pk); 449 450 #ifdef __cplusplus 451 } 452 #endif 453 454 #endif /* LDNS_RDATA_H */ 455