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 8192
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_16BYTES 16
38 
39 #define LDNS_NSEC3_VARS_OPTOUT_MASK 0x01
40 
45 {
108 };
110 
115 {
126 };
128 
129 
130 
139 {
141  size_t _size;
143  ldns_rdf_type _type;
145  void *_data;
146 };
147 typedef struct ldns_struct_rdf ldns_rdf;
148 
149 /* prototypes */
150 
151 /* write access functions */
152 
159 void ldns_rdf_set_size(ldns_rdf *rd, size_t size);
160 
167 void ldns_rdf_set_type(ldns_rdf *rd, ldns_rdf_type type);
168 
175 void ldns_rdf_set_data(ldns_rdf *rd, void *data);
176 
177 /* read access */
178 
184 size_t ldns_rdf_size(const ldns_rdf *rd);
185 
192 ldns_rdf_type ldns_rdf_get_type(const ldns_rdf *rd);
193 
200 uint8_t *ldns_rdf_data(const ldns_rdf *rd);
201 
202 /* creator functions */
203 
213 ldns_rdf *ldns_rdf_new(ldns_rdf_type type, size_t size, void *data);
214 
224 ldns_rdf *ldns_rdf_new_frm_data(ldns_rdf_type type, size_t size, const void *data);
225 
232 ldns_rdf *ldns_rdf_new_frm_str(ldns_rdf_type type, const char *str);
233 
241 ldns_status ldns_rdf_new_frm_fp(ldns_rdf **r, ldns_rdf_type type, FILE *fp);
242 
251 ldns_status ldns_rdf_new_frm_fp_l(ldns_rdf **r, ldns_rdf_type type, FILE *fp, int *line_nr);
252 
253 /* destroy functions */
254 
261 void ldns_rdf_free(ldns_rdf *rd);
262 
269 void ldns_rdf_deep_free(ldns_rdf *rd);
270 
271 /* conversion functions */
272 
279 ldns_rdf *ldns_native2rdf_int8(ldns_rdf_type type, uint8_t value);
280 
287 ldns_rdf *ldns_native2rdf_int16(ldns_rdf_type type, uint16_t value);
288 
298 ldns_rdf *ldns_native2rdf_int32(ldns_rdf_type type, uint32_t value);
299 
310 ldns_rdf *ldns_native2rdf_int16_data(size_t size, uint8_t *data);
311 
319 
325 uint8_t ldns_rdf2native_int8(const ldns_rdf *rd);
326 
332 uint16_t ldns_rdf2native_int16(const ldns_rdf *rd);
333 
339 uint32_t ldns_rdf2native_int32(const ldns_rdf *rd);
340 
346 time_t ldns_rdf2native_time_t(const ldns_rdf *rd);
347 
354 uint32_t ldns_str2period(const char *nptr, const char **endptr);
355 
363 ldns_status ldns_octet(char *word, size_t *length);
364 
370 ldns_rdf *ldns_rdf_clone(const ldns_rdf *rd);
371 
381 int ldns_rdf_compare(const ldns_rdf *rd1, const ldns_rdf *rd2);
382 
383 #ifdef __cplusplus
384 }
385 #endif
386 
387 #endif /* LDNS_RDATA_H */
enum ldns_enum_cert_algorithm ldns_cert_algorithm
Definition: rdata.h:127
time (32 bits)
Definition: rdata.h:83
void ldns_rdf_deep_free(ldns_rdf *rd)
frees a rdf structure and frees the data.
Definition: rdata.c:230
b64 string
Definition: rdata.h:67
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
uint8_t ldns_rdf2native_int8(const ldns_rdf *rd)
returns the native uint8_t representation from the rdf.
Definition: rdata.c:70
unknown types
Definition: rdata.h:81
ldns_rdf * ldns_rdf_address_reverse(ldns_rdf *rd)
reverses an rdf, only actually useful for AAAA and A records.
Definition: rdata.c:389
a RR type
Definition: rdata.h:73
size_t ldns_rdf_size(const ldns_rdf *rd)
returns the size of the rdf.
Definition: rdata.c:24
ldns_rdf * ldns_rdf_clone(const ldns_rdf *rd)
clones a rdf structure.
Definition: rdata.c:222
a class
Definition: rdata.h:75
void ldns_rdf_set_size(ldns_rdf *rd, size_t size)
sets the size of the rdf.
Definition: rdata.c:46
ldns_enum_rdf_type
The different types of RDATA fields.
Definition: rdata.h:44
IPSECKEY.
Definition: rdata.h:103
void ldns_rdf_set_data(ldns_rdf *rd, void *data)
sets the size of the rdf.
Definition: rdata.c:60
protocol and port bitmaps
Definition: rdata.h:93
apl data
Definition: rdata.h:63
void ldns_rdf_free(ldns_rdf *rd)
frees a rdf structure, leaving the data pointer intact.
Definition: rdata.c:241
ldns_enum_cert_algorithm
algorithms used in CERT rrs
Definition: rdata.h:114
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
certificate algorithm
Definition: rdata.h:77
Defines error numbers and functions to translate those to a readable string.
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
uint8_t * ldns_rdf_data(const ldns_rdf *rd)
returns the data of the rdf.
Definition: rdata.c:38
enum ldns_enum_rdf_type ldns_rdf_type
Definition: rdata.h:109
void ldns_rdf_set_type(ldns_rdf *rd, ldns_rdf_type type)
sets the size of the rdf.
Definition: rdata.c:53
16 bits
Definition: rdata.h:53
ldns_status ldns_rdf_new_frm_fp(ldns_rdf **rdf, ldns_rdf_type type, FILE *fp)
creates a new rdf from a file containing a string.
Definition: rdata.c:356
void * _data
Pointer to the data (raw octets)
Definition: rdata.h:145
variable length any type rdata where the length is specified by the first 2 bytes ...
Definition: rdata.h:91
a key algorithm
Definition: rdata.h:79
uint16_t ldns_rdf2native_int16(const ldns_rdf *rd)
returns the native uint16_t representation from the rdf.
Definition: rdata.c:84
time_t ldns_rdf2native_time_t(const ldns_rdf *rd)
returns the native time_t representation from the rdf.
Definition: rdata.c:112
b32 string
Definition: rdata.h:65
A record.
Definition: rdata.h:57
nsec type codes
Definition: rdata.h:71
AAAA record.
Definition: rdata.h:59
32 bits
Definition: rdata.h:55
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_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
hex string
Definition: rdata.h:69
ldns_rdf_type ldns_rdf_get_type(const ldns_rdf *rd)
returns the type of the rdf.
Definition: rdata.c:31
txt string
Definition: rdata.h:61
uint32_t ldns_rdf2native_int32(const ldns_rdf *rd)
returns the native uint32_t representation from the rdf.
Definition: rdata.c:98
ldns_status ldns_octet(char *word, size_t *length)
removes \DDD, \[space] and other escapes from the input.
Definition: rdata.c:507
tsig time 48 bits
Definition: rdata.h:87
uint32_t ldns_str2period(const char *nptr, const char **endptr)
converts a ttl value (like 5d2h) to a long.
Definition: rdata.c:603
nsec3 base32 string (with length byte on wire
Definition: rdata.h:107
enum ldns_enum_status ldns_status
Definition: error.h:122
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
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
size_t _size
The size of the data (in octets)
Definition: rdata.h:141
Resource record data field.
Definition: rdata.h:138
Common definitions for LDNS.
ldns_status ldns_rdf_new_frm_fp_l(ldns_rdf **rdf, ldns_rdf_type type, FILE *fp, int *line_nr)
creates a new rdf from a file containing a string.
Definition: rdata.c:362
nsec3 hash salt
Definition: rdata.h:105
8 bits
Definition: rdata.h:51
ldns_rdf_type _type
The type of the data.
Definition: rdata.h:143
domain name
Definition: rdata.h:49
location data
Definition: rdata.h:95
well known services
Definition: rdata.h:97
int ldns_rdf_compare(const ldns_rdf *rd1, const ldns_rdf *rd2)
compares two rdf&#39;s on their wire formats.
Definition: rdata.c:569