ldns documentation

- Main Page
- Related Pages
- Data Structures
- Files

- File List
- Globals

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
45 enum ldns_enum_rdf_type
46 {
48 LDNS_RDF_TYPE_NONE,
50 LDNS_RDF_TYPE_DNAME,
52 LDNS_RDF_TYPE_INT8,
54 LDNS_RDF_TYPE_INT16,
56 LDNS_RDF_TYPE_INT32,
58 LDNS_RDF_TYPE_A,
60 LDNS_RDF_TYPE_AAAA,
62 LDNS_RDF_TYPE_STR,
64 LDNS_RDF_TYPE_APL,
66 LDNS_RDF_TYPE_B32_EXT,
68 LDNS_RDF_TYPE_B64,
70 LDNS_RDF_TYPE_HEX,
72 LDNS_RDF_TYPE_NSEC,
74 LDNS_RDF_TYPE_TYPE,
76 LDNS_RDF_TYPE_CLASS,
78 LDNS_RDF_TYPE_CERT_ALG,
80 LDNS_RDF_TYPE_ALG,
82 LDNS_RDF_TYPE_UNKNOWN,
84 LDNS_RDF_TYPE_TIME,
86 LDNS_RDF_TYPE_PERIOD,
88 LDNS_RDF_TYPE_TSIGTIME,
92 LDNS_RDF_TYPE_HIP,
95 LDNS_RDF_TYPE_INT16_DATA,
97 LDNS_RDF_TYPE_SERVICE,
99 LDNS_RDF_TYPE_LOC,
101 LDNS_RDF_TYPE_WKS,
103 LDNS_RDF_TYPE_NSAP,
105 LDNS_RDF_TYPE_ATMA,
107 LDNS_RDF_TYPE_IPSECKEY,
109 LDNS_RDF_TYPE_NSEC3_SALT,
111 LDNS_RDF_TYPE_NSEC3_NEXT_OWNER,
112
116 LDNS_RDF_TYPE_ILNP64,
117
119 LDNS_RDF_TYPE_EUI48,
121 LDNS_RDF_TYPE_EUI64,
122
126 LDNS_RDF_TYPE_TAG,
127
132 LDNS_RDF_TYPE_LONG_STR,
133
134 /* Aliases */
135 LDNS_RDF_TYPE_BITMAP = LDNS_RDF_TYPE_NSEC
136 };
137 typedef enum ldns_enum_rdf_type ldns_rdf_type;
138
142 enum ldns_enum_cert_algorithm
143 {
144 LDNS_CERT_PKIX = 1,
145 LDNS_CERT_SPKI = 2,
146 LDNS_CERT_PGP = 3,
147 LDNS_CERT_IPKIX = 4,
148 LDNS_CERT_ISPKI = 5,
149 LDNS_CERT_IPGP = 6,
150 LDNS_CERT_ACPKIX = 7,
151 LDNS_CERT_IACPKIX = 8,
152 LDNS_CERT_URI = 253,
153 LDNS_CERT_OID = 254
154 };
155 typedef enum ldns_enum_cert_algorithm ldns_cert_algorithm;
156
157
158
166 struct ldns_struct_rdf
167 {
169 size_t _size;
171 ldns_rdf_type _type;
173 void *_data;
174 };
175 typedef struct ldns_struct_rdf ldns_rdf;
176
177 /* prototypes */
178
179 /* write access functions */
180
187 void ldns_rdf_set_size(ldns_rdf *rd, size_t size);
188
195 void ldns_rdf_set_type(ldns_rdf *rd, ldns_rdf_type type);
196
203 void ldns_rdf_set_data(ldns_rdf *rd, void *data);
204
205 /* read access */
206
212 size_t ldns_rdf_size(const ldns_rdf *rd);
213
220 ldns_rdf_type ldns_rdf_get_type(const ldns_rdf *rd);
221
228 uint8_t *ldns_rdf_data(const ldns_rdf *rd);
229
230 /* creator functions */
231
241 ldns_rdf *ldns_rdf_new(ldns_rdf_type type, size_t size, void *data);
242
252 ldns_rdf *ldns_rdf_new_frm_data(ldns_rdf_type type, size_t size, const void *data);
253
260 ldns_rdf *ldns_rdf_new_frm_str(ldns_rdf_type type, const char *str);
261
269 ldns_status ldns_rdf_new_frm_fp(ldns_rdf **r, ldns_rdf_type type, FILE *fp);
270
279 ldns_status ldns_rdf_new_frm_fp_l(ldns_rdf **r, ldns_rdf_type type, FILE *fp, int *line_nr);
280
281 /* destroy functions */
282
289 void ldns_rdf_free(ldns_rdf *rd);
290
297 void ldns_rdf_deep_free(ldns_rdf *rd);
298
299 /* conversion functions */
300
307 ldns_rdf *ldns_native2rdf_int8(ldns_rdf_type type, uint8_t value);
308
315 ldns_rdf *ldns_native2rdf_int16(ldns_rdf_type type, uint16_t value);
316
326 ldns_rdf *ldns_native2rdf_int32(ldns_rdf_type type, uint32_t value);
327
338 ldns_rdf *ldns_native2rdf_int16_data(size_t size, uint8_t *data);
339
346 ldns_rdf *ldns_rdf_address_reverse(ldns_rdf *rd);
347
353 uint8_t ldns_rdf2native_int8(const ldns_rdf *rd);
354
360 uint16_t ldns_rdf2native_int16(const ldns_rdf *rd);
361
367 uint32_t ldns_rdf2native_int32(const ldns_rdf *rd);
368
374 time_t ldns_rdf2native_time_t(const ldns_rdf *rd);
375
382 uint32_t ldns_str2period(const char *nptr, const char **endptr);
383
391 ldns_status ldns_octet(char *word, size_t *length);
392
398 ldns_rdf *ldns_rdf_clone(const ldns_rdf *rd);
399
409 int ldns_rdf_compare(const ldns_rdf *rd1, const ldns_rdf *rd2);
410
422 ldns_status ldns_rdf_hip_get_alg_hit_pk(ldns_rdf *rdf, uint8_t* alg,
423 uint8_t *hit_size, uint8_t** hit,
424 uint16_t *pk_size, uint8_t** pk);
425
436 ldns_status ldns_rdf_hip_new_frm_alg_hit_pk(ldns_rdf** rdf, uint8_t alg,
437 uint8_t hit_size, uint8_t *hit, uint16_t pk_size, uint8_t *pk);
438
439 #ifdef __cplusplus
440 }
441 #endif
442
443 #endif /* LDNS_RDATA_H */
ldns_rdf_compare
int ldns_rdf_compare(const ldns_rdf *rd1, const ldns_rdf *rd2)
compares two rdf&#39;s on their wire formats.
Definition: rdata.c:642
ldns_rdf2native_int8
uint8_t ldns_rdf2native_int8(const ldns_rdf *rd)
returns the native uint8_t representation from the rdf.
Definition: rdata.c:70
ldns_rdf_free
void ldns_rdf_free(ldns_rdf *rd)
frees a rdf structure, leaving the data pointer intact.
Definition: rdata.c:241
ldns_cert_algorithm
enum ldns_enum_cert_algorithm ldns_cert_algorithm
Definition: rdata.h:155
LDNS_RDF_TYPE_TIME
time (32 bits)
Definition: rdata.h:84
LDNS_CERT_ISPKI
Definition: rdata.h:148
LDNS_RDF_TYPE_BITMAP
Definition: rdata.h:135
LDNS_CERT_OID
Definition: rdata.h:153
ldns_native2rdf_int32
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
ldns_native2rdf_int16_data
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
LDNS_CERT_IACPKIX
Definition: rdata.h:151
LDNS_RDF_TYPE_B64
b64 string
Definition: rdata.h:68
ldns_rdf_get_type
ldns_rdf_type ldns_rdf_get_type(const ldns_rdf *rd)
returns the type of the rdf.
Definition: rdata.c:31
ldns_rdf_new_frm_fp_l
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:377
LDNS_RDF_TYPE_UNKNOWN
unknown types
Definition: rdata.h:82
ldns_rdf2native_time_t
time_t ldns_rdf2native_time_t(const ldns_rdf *rd)
returns the native time_t representation from the rdf.
Definition: rdata.c:112
ldns_rdf_hip_get_alg_hit_pk
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:522
LDNS_RDF_TYPE_TYPE
a RR type
Definition: rdata.h:74
LDNS_RDF_TYPE_NONE
none
Definition: rdata.h:48
ldns_rdf_set_size
void ldns_rdf_set_size(ldns_rdf *rd, size_t size)
sets the size of the rdf.
Definition: rdata.c:46
LDNS_RDF_TYPE_CLASS
a class
Definition: rdata.h:76
ldns_rdf_data
uint8_t * ldns_rdf_data(const ldns_rdf *rd)
returns the data of the rdf.
Definition: rdata.c:38
ldns_enum_rdf_type
ldns_enum_rdf_type
The different types of RDATA fields.
Definition: rdata.h:45
LDNS_RDF_TYPE_IPSECKEY
IPSECKEY.
Definition: rdata.h:107
LDNS_RDF_TYPE_SERVICE
protocol and port bitmaps
Definition: rdata.h:97
LDNS_RDF_TYPE_TAG
A non-zero sequence of US-ASCII letters and numbers in lower case.
Definition: rdata.h:126
LDNS_RDF_TYPE_LONG_STR
A <character-string> encoding of the value field as specified [RFC1035], Section 5.1., encoded as remaining rdata.
Definition: rdata.h:132
LDNS_RDF_TYPE_APL
apl data
Definition: rdata.h:64
ldns_rdf_size
size_t ldns_rdf_size(const ldns_rdf *rd)
returns the size of the rdf.
Definition: rdata.c:24
ldns_enum_cert_algorithm
ldns_enum_cert_algorithm
algorithms used in CERT rrs
Definition: rdata.h:142
ldns_str2period
uint32_t ldns_str2period(const char *nptr, const char **endptr)
converts a ttl value (like 5d2h) to a long.
Definition: rdata.c:676
ldns_rdf_set_type
void ldns_rdf_set_type(ldns_rdf *rd, ldns_rdf_type type)
sets the size of the rdf.
Definition: rdata.c:53
LDNS_RDF_TYPE_CERT_ALG
certificate algorithm
Definition: rdata.h:78
error.h
Defines error numbers and functions to translate those to a readable string.
ldns_rdf_new
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_CERT_PGP
Definition: rdata.h:146
ldns_rdf_new_frm_str
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_type
enum ldns_enum_rdf_type ldns_rdf_type
Definition: rdata.h:137
LDNS_RDF_TYPE_INT16
16 bits
Definition: rdata.h:54
ldns_native2rdf_int16
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
ldns_struct_rdf::_data
void * _data
Pointer to the data (raw octets)
Definition: rdata.h:173
LDNS_CERT_PKIX
Definition: rdata.h:144
LDNS_RDF_TYPE_NSAP
NSAP.
Definition: rdata.h:103
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_CERT_URI
Definition: rdata.h:152
LDNS_RDF_TYPE_ALG
a key algorithm
Definition: rdata.h:80
LDNS_RDF_TYPE_B32_EXT
b32 string
Definition: rdata.h:66
LDNS_RDF_TYPE_A
A record.
Definition: rdata.h:58
LDNS_CERT_IPGP
Definition: rdata.h:149
ldns_rdf2native_int32
uint32_t ldns_rdf2native_int32(const ldns_rdf *rd)
returns the native uint32_t representation from the rdf.
Definition: rdata.c:98
LDNS_RDF_TYPE_NSEC
nsec type codes
Definition: rdata.h:72
LDNS_RDF_TYPE_AAAA
AAAA record.
Definition: rdata.h:60
LDNS_RDF_TYPE_INT32
32 bits
Definition: rdata.h:56
LDNS_CERT_SPKI
Definition: rdata.h:145
ldns_rdf_clone
ldns_rdf * ldns_rdf_clone(const ldns_rdf *rd)
clones a rdf structure.
Definition: rdata.c:222
ldns_rdf_deep_free
void ldns_rdf_deep_free(ldns_rdf *rd)
frees a rdf structure and frees the data.
Definition: rdata.c:230
LDNS_RDF_TYPE_HEX
hex string
Definition: rdata.h:70
ldns_octet
ldns_status ldns_octet(char *word, size_t *length)
removes \DDD, \[space] and other escapes from the input.
Definition: rdata.c:580
LDNS_RDF_TYPE_PERIOD
period
Definition: rdata.h:86
LDNS_RDF_TYPE_STR
txt string
Definition: rdata.h:62
LDNS_CERT_IPKIX
Definition: rdata.h:147
LDNS_RDF_TYPE_TSIGTIME
tsig time 48 bits
Definition: rdata.h:88
ldns_rdf_hip_new_frm_alg_hit_pk
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:550
LDNS_RDF_TYPE_NSEC3_NEXT_OWNER
nsec3 base32 string (with length byte on wire
Definition: rdata.h:111
ldns_status
enum ldns_enum_status ldns_status
Definition: error.h:131
ldns_native2rdf_int8
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
ldns_struct_rdf::_size
size_t _size
The size of the data (in octets)
Definition: rdata.h:169
LDNS_RDF_TYPE_ILNP64
4 shorts represented as 4 * 16 bit hex numbers separated by colons.
Definition: rdata.h:116
ldns_struct_rdf
Resource record data field.
Definition: rdata.h:166
LDNS_RDF_TYPE_HIP
Represents the Public Key Algorithm, HIT and Public Key fields for the HIP RR types.
Definition: rdata.h:92
common.h
Common definitions for LDNS.
ldns_rdf_set_data
void ldns_rdf_set_data(ldns_rdf *rd, void *data)
sets the size of the rdf.
Definition: rdata.c:60
ldns_rdf_new_frm_data
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_TYPE_NSEC3_SALT
nsec3 hash salt
Definition: rdata.h:109
LDNS_RDF_TYPE_INT8
8 bits
Definition: rdata.h:52
ldns_struct_rdf::_type
ldns_rdf_type _type
The type of the data.
Definition: rdata.h:171
ldns_rdf_address_reverse
ldns_rdf * ldns_rdf_address_reverse(ldns_rdf *rd)
reverses an rdf, only actually useful for AAAA and A records.
Definition: rdata.c:404
LDNS_RDF_TYPE_DNAME
domain name
Definition: rdata.h:50
LDNS_RDF_TYPE_LOC
location data
Definition: rdata.h:99
LDNS_CERT_ACPKIX
Definition: rdata.h:150
LDNS_RDF_TYPE_EUI64
8 * 8 bit hex numbers separated by dashes.
Definition: rdata.h:121
ldns_rdf_new_frm_fp
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:371
LDNS_RDF_TYPE_EUI48
6 * 8 bit hex numbers separated by dashes.
Definition: rdata.h:119
LDNS_RDF_TYPE_WKS
well known services
Definition: rdata.h:101
LDNS_RDF_TYPE_ATMA
ATMA.
Definition: rdata.h:105
ldns_rdf2native_int16
uint16_t ldns_rdf2native_int16(const ldns_rdf *rd)
returns the native uint16_t representation from the rdf.
Definition: rdata.c:84