rdata.h
Go to the documentation of this file.
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 
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 
46 {
112 
117 
122 
127 
133 
141 
144 
147 
148  /* Aliases */
150 };
151 typedef enum ldns_enum_rdf_type ldns_rdf_type;
152 
157 {
167  LDNS_CERT_OID = 254
168 };
170 
175 {
186 };
188 
197 {
199  size_t _size;
203  void *_data;
204 };
205 typedef struct ldns_struct_rdf ldns_rdf;
206 
207 /* prototypes */
208 
209 /* write access functions */
210 
217 void ldns_rdf_set_size(ldns_rdf *rd, size_t size);
218 
226 
233 void ldns_rdf_set_data(ldns_rdf *rd, void *data);
234 
235 /* read access */
236 
242 size_t ldns_rdf_size(const ldns_rdf *rd);
243 
251 
258 uint8_t *ldns_rdf_data(const ldns_rdf *rd);
259 
260 /* creator functions */
261 
271 ldns_rdf *ldns_rdf_new(ldns_rdf_type type, size_t size, void *data);
272 
282 ldns_rdf *ldns_rdf_new_frm_data(ldns_rdf_type type, size_t size, const void *data);
283 
290 ldns_rdf *ldns_rdf_new_frm_str(ldns_rdf_type type, const char *str);
291 
300 
309 ldns_status ldns_rdf_new_frm_fp_l(ldns_rdf **r, ldns_rdf_type type, FILE *fp, int *line_nr);
310 
311 /* destroy functions */
312 
319 void ldns_rdf_free(ldns_rdf *rd);
320 
327 void ldns_rdf_deep_free(ldns_rdf *rd);
328 
329 /* conversion functions */
330 
337 ldns_rdf *ldns_native2rdf_int8(ldns_rdf_type type, uint8_t value);
338 
345 ldns_rdf *ldns_native2rdf_int16(ldns_rdf_type type, uint16_t value);
346 
356 ldns_rdf *ldns_native2rdf_int32(ldns_rdf_type type, uint32_t value);
357 
368 ldns_rdf *ldns_native2rdf_int16_data(size_t size, uint8_t *data);
369 
377 
383 uint8_t ldns_rdf2native_int8(const ldns_rdf *rd);
384 
390 uint16_t ldns_rdf2native_int16(const ldns_rdf *rd);
391 
397 uint32_t ldns_rdf2native_int32(const ldns_rdf *rd);
398 
404 time_t ldns_rdf2native_time_t(const ldns_rdf *rd);
405 
412 uint32_t ldns_str2period(const char *nptr, const char **endptr);
413 
421 ldns_status ldns_octet(char *word, size_t *length);
422 
428 ldns_rdf *ldns_rdf_clone(const ldns_rdf *rd);
429 
439 int ldns_rdf_compare(const ldns_rdf *rd1, const ldns_rdf *rd2);
440 
453  uint8_t *hit_size, uint8_t** hit,
454  uint16_t *pk_size, uint8_t** pk);
455 
467  uint8_t hit_size, uint8_t *hit, uint16_t pk_size, uint8_t *pk);
468 
469 #ifdef __cplusplus
470 }
471 #endif
472 
473 #endif /* LDNS_RDATA_H */
Common definitions for LDNS.
Defines error numbers and functions to translate those to a readable string.
enum ldns_enum_status ldns_status
Definition: error.h:148
uint32_t ldns_str2period(const char *nptr, const char **endptr)
converts a ttl value (like 5d2h) to a long.
Definition: rdata.c:691
enum ldns_enum_cert_algorithm ldns_cert_algorithm
Definition: rdata.h:169
ldns_status ldns_rdf_hip_new_frm_alg_hit_pk(ldns_rdf **rdf, uint8_t alg, uint8_t hit_size, uint8_t *hit, uint16_t pk_size, uint8_t *pk)
Creates a new LDNS_RDF_TYPE_HIP rdf from given data.
Definition: rdata.c:565
ldns_rdf_type ldns_rdf_get_type(const ldns_rdf *rd)
returns the type of the rdf.
Definition: rdata.c:31
void ldns_rdf_set_type(ldns_rdf *rd, ldns_rdf_type type)
sets the size of the rdf.
Definition: rdata.c:53
ldns_rdf * ldns_native2rdf_int8(ldns_rdf_type type, uint8_t value)
returns the rdf containing the native uint8_t repr.
Definition: rdata.c:126
void ldns_rdf_deep_free(ldns_rdf *rd)
frees a rdf structure and frees the data.
Definition: rdata.c:230
ldns_rdf * ldns_rdf_new(ldns_rdf_type type, size_t size, void *data)
allocates a new rdf structure and fills it.
Definition: rdata.c:179
ldns_rdf * ldns_native2rdf_int16_data(size_t size, uint8_t *data)
returns an int16_data rdf that contains the data in the given array, preceded by an int16 specifying ...
Definition: rdata.c:162
uint32_t ldns_rdf2native_int32(const ldns_rdf *rd)
returns the native uint32_t representation from the rdf.
Definition: rdata.c:98
uint16_t ldns_rdf2native_int16(const ldns_rdf *rd)
returns the native uint16_t representation from the rdf.
Definition: rdata.c:84
ldns_status ldns_rdf_new_frm_fp_l(ldns_rdf **r, ldns_rdf_type type, FILE *fp, int *line_nr)
creates a new rdf from a file containing a string.
Definition: rdata.c:392
ldns_status ldns_octet(char *word, size_t *length)
removes \DDD, \[space] and other escapes from the input.
Definition: rdata.c:595
ldns_rdf * ldns_rdf_new_frm_str(ldns_rdf_type type, const char *str)
creates a new rdf from a string.
Definition: rdata.c:249
ldns_rdf * ldns_native2rdf_int16(ldns_rdf_type type, uint16_t value)
returns the rdf containing the native uint16_t representation.
Definition: rdata.c:132
enum ldns_enum_svcparam_key ldns_svcparam_key
Definition: rdata.h:187
uint8_t ldns_rdf2native_int8(const ldns_rdf *rd)
returns the native uint8_t representation from the rdf.
Definition: rdata.c:70
ldns_enum_rdf_type
The different types of RDATA fields.
Definition: rdata.h:46
@ LDNS_RDF_TYPE_INT32
32 bits
Definition: rdata.h:56
@ LDNS_RDF_TYPE_TAG
A non-zero sequence of US-ASCII letters and numbers in lower case.
Definition: rdata.h:126
@ LDNS_RDF_TYPE_NSAP
NSAP.
Definition: rdata.h:103
@ LDNS_RDF_TYPE_HIP
Represents the Public Key Algorithm, HIT and Public Key fields for the HIP RR types.
Definition: rdata.h:92
@ LDNS_RDF_TYPE_B32_EXT
b32 string
Definition: rdata.h:66
@ LDNS_RDF_TYPE_NSEC3_NEXT_OWNER
nsec3 base32 string (with length byte on wire
Definition: rdata.h:111
@ LDNS_RDF_TYPE_CERT_ALG
certificate algorithm
Definition: rdata.h:78
@ LDNS_RDF_TYPE_EUI48
6 * 8 bit hex numbers separated by dashes.
Definition: rdata.h:119
@ LDNS_RDF_TYPE_SERVICE
protocol and port bitmaps
Definition: rdata.h:97
@ LDNS_RDF_TYPE_EUI64
8 * 8 bit hex numbers separated by dashes.
Definition: rdata.h:121
@ LDNS_RDF_TYPE_PERIOD
period
Definition: rdata.h:86
@ LDNS_RDF_TYPE_B64
b64 string
Definition: rdata.h:68
@ LDNS_RDF_TYPE_AAAA
AAAA record.
Definition: rdata.h:60
@ LDNS_RDF_TYPE_UNKNOWN
unknown types
Definition: rdata.h:82
@ LDNS_RDF_TYPE_WKS
well known services
Definition: rdata.h:101
@ LDNS_RDF_TYPE_DNAME
domain name
Definition: rdata.h:50
@ LDNS_RDF_TYPE_TIME
time (32 bits)
Definition: rdata.h:84
@ LDNS_RDF_TYPE_BITMAP
Definition: rdata.h:149
@ LDNS_RDF_TYPE_SVCPARAMS
draft-ietf-dnsop-svcb-https
Definition: rdata.h:146
@ LDNS_RDF_TYPE_NSEC
nsec type codes
Definition: rdata.h:72
@ LDNS_RDF_TYPE_SELECTOR
Definition: rdata.h:139
@ LDNS_RDF_TYPE_NSEC3_SALT
nsec3 hash salt
Definition: rdata.h:109
@ LDNS_RDF_TYPE_APL
apl data
Definition: rdata.h:64
@ LDNS_RDF_TYPE_A
A record.
Definition: rdata.h:58
@ LDNS_RDF_TYPE_LONG_STR
A <character-string> encoding of the value field as specified [RFC1035], Section 5....
Definition: rdata.h:132
@ LDNS_RDF_TYPE_LOC
location data
Definition: rdata.h:99
@ LDNS_RDF_TYPE_INT16_DATA
variable length any type rdata where the length is specified by the first 2 bytes
Definition: rdata.h:95
@ LDNS_RDF_TYPE_ILNP64
4 shorts represented as 4 * 16 bit hex numbers separated by colons.
Definition: rdata.h:116
@ LDNS_RDF_TYPE_ATMA
ATMA.
Definition: rdata.h:105
@ LDNS_RDF_TYPE_HEX
hex string
Definition: rdata.h:70
@ LDNS_RDF_TYPE_NONE
none
Definition: rdata.h:48
@ LDNS_RDF_TYPE_CLASS
a class
Definition: rdata.h:76
@ LDNS_RDF_TYPE_INT8
8 bits
Definition: rdata.h:52
@ LDNS_RDF_TYPE_MATCHING_TYPE
Definition: rdata.h:140
@ LDNS_RDF_TYPE_IPSECKEY
IPSECKEY.
Definition: rdata.h:107
@ LDNS_RDF_TYPE_CERTIFICATE_USAGE
Since RFC7218 TLSA records can be given with mnemonics, hence these rdata field types.
Definition: rdata.h:138
@ LDNS_RDF_TYPE_STR
txt string
Definition: rdata.h:62
@ LDNS_RDF_TYPE_INT16
16 bits
Definition: rdata.h:54
@ LDNS_RDF_TYPE_ALG
a key algorithm
Definition: rdata.h:80
@ LDNS_RDF_TYPE_AMTRELAY
draft-ietf-mboned-driad-amt-discovery
Definition: rdata.h:143
@ LDNS_RDF_TYPE_TSIGTIME
tsig time 48 bits
Definition: rdata.h:88
@ LDNS_RDF_TYPE_TYPE
a RR type
Definition: rdata.h:74
ldns_rdf * ldns_rdf_address_reverse(const ldns_rdf *rd)
reverses an rdf, only actually useful for AAAA and A records.
Definition: rdata.c:419
ldns_status ldns_rdf_new_frm_fp(ldns_rdf **r, ldns_rdf_type type, FILE *fp)
creates a new rdf from a file containing a string.
Definition: rdata.c:386
ldns_status ldns_rdf_hip_get_alg_hit_pk(ldns_rdf *rdf, uint8_t *alg, uint8_t *hit_size, uint8_t **hit, uint16_t *pk_size, uint8_t **pk)
Gets the algorithm value, the HIT and Public Key data from the rdf with type LDNS_RDF_TYPE_HIP.
Definition: rdata.c:537
size_t ldns_rdf_size(const ldns_rdf *rd)
returns the size of the rdf.
Definition: rdata.c:24
time_t ldns_rdf2native_time_t(const ldns_rdf *rd)
returns the native time_t representation from the rdf.
Definition: rdata.c:112
void ldns_rdf_set_data(ldns_rdf *rd, void *data)
sets the size of the rdf.
Definition: rdata.c:60
uint8_t * ldns_rdf_data(const ldns_rdf *rd)
returns the data of the rdf.
Definition: rdata.c:38
void ldns_rdf_set_size(ldns_rdf *rd, size_t size)
sets the size of the rdf.
Definition: rdata.c:46
ldns_rdf * ldns_native2rdf_int32(ldns_rdf_type type, uint32_t value)
returns an rdf that contains the given int32 value.
Definition: rdata.c:147
void ldns_rdf_free(ldns_rdf *rd)
frees a rdf structure, leaving the data pointer intact.
Definition: rdata.c:241
int ldns_rdf_compare(const ldns_rdf *rd1, const ldns_rdf *rd2)
compares two rdf's on their wire formats.
Definition: rdata.c:657
ldns_enum_svcparam_key
keys types in SVCPARAMS rdata fields
Definition: rdata.h:175
@ LDNS_SVCPARAM_KEY_PORT
Definition: rdata.h:179
@ LDNS_SVCPARAM_KEY_ALPN
Definition: rdata.h:177
@ LDNS_SVCPARAM_KEY_ECH
Definition: rdata.h:181
@ LDNS_SVCPARAM_KEY_MANDATORY
Definition: rdata.h:176
@ LDNS_SVCPARAM_KEY_IPV4HINT
Definition: rdata.h:180
@ LDNS_SVCPARAM_KEY_IPV6HINT
Definition: rdata.h:182
@ LDNS_SVCPARAM_KEY_RESERVED
Definition: rdata.h:185
@ LDNS_SVCPARAM_KEY_LAST_KEY
Definition: rdata.h:184
@ LDNS_SVCPARAM_KEY_NO_DEFAULT_ALPN
Definition: rdata.h:178
@ LDNS_SVCPARAM_KEY_DOHPATH
Definition: rdata.h:183
ldns_enum_cert_algorithm
algorithms used in CERT rrs
Definition: rdata.h:157
@ LDNS_CERT_SPKI
Definition: rdata.h:159
@ LDNS_CERT_URI
Definition: rdata.h:166
@ LDNS_CERT_ISPKI
Definition: rdata.h:162
@ LDNS_CERT_IPGP
Definition: rdata.h:163
@ LDNS_CERT_ACPKIX
Definition: rdata.h:164
@ LDNS_CERT_IACPKIX
Definition: rdata.h:165
@ LDNS_CERT_IPKIX
Definition: rdata.h:161
@ LDNS_CERT_OID
Definition: rdata.h:167
@ LDNS_CERT_PGP
Definition: rdata.h:160
@ LDNS_CERT_PKIX
Definition: rdata.h:158
enum ldns_enum_rdf_type ldns_rdf_type
Definition: rdata.h:151
ldns_rdf * ldns_rdf_clone(const ldns_rdf *rd)
clones a rdf structure.
Definition: rdata.c:222
ldns_rdf * ldns_rdf_new_frm_data(ldns_rdf_type type, size_t size, const void *data)
allocates a new rdf structure and fills it.
Definition: rdata.c:193
Resource record data field.
Definition: rdata.h:197
ldns_rdf_type _type
The type of the data.
Definition: rdata.h:201
size_t _size
The size of the data (in octets)
Definition: rdata.h:199
void * _data
Pointer to the data (raw octets)
Definition: rdata.h:203