1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
/* Copyright (C) 2011 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/*!
* \file descriptor.h
*
* \author Jan Kadlec <jan.kadlec@nic.cz>
*
* \addtogroup common_lib
* @{
*/
#ifndef _KNOT_DESCRIPTOR_H_
#define _KNOT_DESCRIPTOR_H_
#include <stdint.h> // uint16_t
#include <stdio.h> // size_t
#define KNOT_MAX_RDATA_BLOCKS 8
/*!
* \brief Resource record class codes.
*/
enum knot_rr_class {
KNOT_CLASS_IN = 1,
KNOT_CLASS_CH = 3,
KNOT_CLASS_NONE = 254,
KNOT_CLASS_ANY = 255
};
/*!
* \brief Resource record type constants.
*
* http://www.iana.org/assignments/dns-parameters/dns-parameters.xml
*
* METATYPE: Contains DNS data that can't be in a zone file.
* QTYPE: Specifies DNS query type; can't be in a zone file.
*/
enum knot_rr_type {
KNOT_RRTYPE_A = 1, /*!< An IPv4 host address. */
KNOT_RRTYPE_NS = 2, /*!< An authoritative name server. */
KNOT_RRTYPE_CNAME = 5, /*!< The canonical name for an alias. */
KNOT_RRTYPE_SOA = 6, /*!< The start of a zone of authority. */
KNOT_RRTYPE_PTR = 12, /*!< A domain name pointer. */
KNOT_RRTYPE_HINFO = 13, /*!< A host information. */
KNOT_RRTYPE_MINFO = 14, /*!< A mailbox information. */
KNOT_RRTYPE_MX = 15, /*!< Mail exchange. */
KNOT_RRTYPE_TXT = 16, /*!< Text strings. */
KNOT_RRTYPE_RP = 17, /*!< For responsible person. */
KNOT_RRTYPE_AFSDB = 18, /*!< For AFS Data Base location. */
KNOT_RRTYPE_RT = 21, /*!< For route through. */
KNOT_RRTYPE_SIG = 24, /*!< METATYPE. Transaction signature. */
KNOT_RRTYPE_KEY = 25, /*!< For security key. */
KNOT_RRTYPE_AAAA = 28, /*!< IPv6 address. */
KNOT_RRTYPE_LOC = 29, /*!< Location information. */
KNOT_RRTYPE_SRV = 33, /*!< Server selection. */
KNOT_RRTYPE_NAPTR = 35, /*!< Naming authority pointer . */
KNOT_RRTYPE_KX = 36, /*!< Key exchanger. */
KNOT_RRTYPE_CERT = 37, /*!< Certificate record. */
KNOT_RRTYPE_DNAME = 39, /*!< Delegation name. */
KNOT_RRTYPE_OPT = 41, /*!< METATYPE. Option for EDNS. */
KNOT_RRTYPE_APL = 42, /*!< Address prefix list. */
KNOT_RRTYPE_DS = 43, /*!< Delegation signer. */
KNOT_RRTYPE_SSHFP = 44, /*!< SSH public key fingerprint. */
KNOT_RRTYPE_IPSECKEY = 45, /*!< IPSEC key. */
KNOT_RRTYPE_RRSIG = 46, /*!< DNSSEC signature. */
KNOT_RRTYPE_NSEC = 47, /*!< Next-secure record. */
KNOT_RRTYPE_DNSKEY = 48, /*!< DNS key. */
KNOT_RRTYPE_DHCID = 49, /*!< DHCP identifier. */
KNOT_RRTYPE_NSEC3 = 50, /*!< NSEC version 3. */
KNOT_RRTYPE_NSEC3PARAM = 51, /*!< NSEC3 parameters. */
KNOT_RRTYPE_TLSA = 52, /*!< DANE record. */
KNOT_RRTYPE_SPF = 99, /*!< Sender policy framework. */
KNOT_RRTYPE_NID = 104, /*!< Node identifier. */
KNOT_RRTYPE_L32 = 105, /*!< 32-bit network locator. */
KNOT_RRTYPE_L64 = 106, /*!< 64-bit network locator. */
KNOT_RRTYPE_LP = 107, /*!< Subnetwork name. */
KNOT_RRTYPE_EUI48 = 108, /*!< 48-bit extended unique identifier. */
KNOT_RRTYPE_EUI64 = 109, /*!< 64-bit extended unique identifier. */
KNOT_RRTYPE_TKEY = 249, /*!< METATYPE. Transaction key. */
KNOT_RRTYPE_TSIG = 250, /*!< METATYPE. Transaction signature. */
KNOT_RRTYPE_IXFR = 251, /*!< QTYPE. Incremental zone transfer. */
KNOT_RRTYPE_AXFR = 252, /*!< QTYPE. Authoritative zone transfer. */
KNOT_RRTYPE_ANY = 255 /*!< QTYPE. Any record. */
};
/*!
* \brief Constants characterising the wire format of RDATA items.
*/
enum knot_rdata_wireformat {
/*!< Possibly compressed dname. */
KNOT_RDATA_WF_COMPRESSED_DNAME = -10,
/*!< Uncompressed dname. */
KNOT_RDATA_WF_UNCOMPRESSED_DNAME,
/*!< Dname with preserved letter cases. */
KNOT_RDATA_WF_LITERAL_DNAME,
/*!< Initial part of NAPTR record before dname. */
KNOT_RDATA_WF_NAPTR_HEADER,
/*!< Uninteresting final part of a record. */
KNOT_RDATA_WF_REMAINDER,
/*!< The last descriptor in array. */
KNOT_RDATA_WF_END = 0
};
/*!
* \brief Structure describing rdata.
*/
typedef struct {
/*!< Item types describing rdata. */
const int block_types[KNOT_MAX_RDATA_BLOCKS];
/*!< RR type name. */
const char *type_name;
} rdata_descriptor_t;
/*!
* \brief Gets rdata descriptor for given RR name.
*
* \param name Mnemonic of RR type whose descriptor should be retvaled.
*
* \retval RR descriptor for given name, NULL descriptor if
* unknown type.
*/
const rdata_descriptor_t *get_rdata_descriptor(const uint16_t type);
/*!
* \brief Converts numeric type representation to mnemonic string.
*
* \param rrtype Type RR type code to be converted.
* \param out Output buffer.
* \param out_len Length of the output buffer.
*
* \retval Length of output string.
* \retval -1 if error.
*/
int knot_rrtype_to_string(const uint16_t rrtype,
char *out,
const size_t out_len);
/*!
* \brief Converts mnemonic string representation of a type to numeric one.
*
* \param name Mnemonic string to be converted.
* \param num Output variable.
*
* \retval 0 if OK.
* \retval -1 if error.
*/
int knot_rrtype_from_string(const char *name, uint16_t *num);
/*!
* \brief Converts numeric class representation to the string one.
*
* \param rrclass Class code to be converted.
* \param out Output buffer.
* \param out_len Length of the output buffer.
*
* \retval Length of output string.
* \retval -1 if error.
*/
int knot_rrclass_to_string(const uint16_t rrclass,
char *out,
const size_t out_len);
/*!
* \brief Converts string representation of a class to numeric one.
*
* \param name Mnemonic string to be converted.
* \param num Output variable.
*
* \retval 0 if OK.
* \retval -1 if error.
*/
int knot_rrclass_from_string(const char *name, uint16_t *num);
/*!
* \brief Checks if given item is one of dname types.
*
* \param item Item value.
*
* \retval 1 if YES.
* \retval 0 if NO.
*/
int descriptor_item_is_dname(const int item);
/*!
* \brief Checks if given item is compressible dname.
*
* \param item Item value.
*
* \retval 1 if YES.
* \retval 0 if NO.
*/
int descriptor_item_is_compr_dname(const int item);
/*!
* \brief Checks if given item has fixed size.
*
* \param item Item value.
*
* \retval 1 if YES.
* \retval 0 if NO.
*/
int descriptor_item_is_fixed(const int item);
/*!
* \brief Checks if given item is remainder.
*
* \param item Item value.
*
* \retval 1 if YES.
* \retval 0 if NO.
*/
int descriptor_item_is_remainder(const int item);
/*!
* \brief Checks if given item is one of metatypes or qtypes.
*
* \param item Item value.
*
* \retval 1 if YES.
* \retval 0 if NO.
*/
int knot_rrtype_is_metatype(const uint16_t type);
#endif // _KNOT_DESCRIPTOR_H_
/*! @} */
|
