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
|
/* Copyright (C) 2019 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 <https://www.gnu.org/licenses/>.
*/
/*!
* \file
*
* \brief RRSet structure and API for manipulating it.
*
* \addtogroup rr
* @{
*/
#pragma once
#include <stdint.h>
#include <stdbool.h>
#include "libknot/dname.h"
#include "libknot/descriptor.h"
#include "libknot/mm_ctx.h"
#include "libknot/rdataset.h"
/*!
* \brief Structure for representing RRSet.
*
* For RRSet definition see RFC2181, Section 5.
*/
typedef struct {
knot_dname_t *owner; /*!< Domain name being the owner of the RRSet. */
uint32_t ttl; /*!< TTL of the RRset. */
uint16_t type; /*!< TYPE of the RRset. */
uint16_t rclass; /*!< CLASS of the RRSet. */
knot_rdataset_t rrs; /*!< RRSet's RRs */
/* Optional fields. */
void *additional; /*!< Additional records. */
} knot_rrset_t;
/*!
* \brief Creates a new RRSet with the given properties.
*
* The created RRSet contains no RDATAs (i.e. is actually empty).
*
* \param owner OWNER of the RRSet.
* \param type TYPE of the RRSet.
* \param rclass CLASS of the RRSet.
* \param ttl TTL of the RRSet.
* \param mm Memory context.
*
* \return New RRSet structure or NULL if an error occurred.
*/
knot_rrset_t *knot_rrset_new(const knot_dname_t *owner, uint16_t type,
uint16_t rclass, uint32_t ttl, knot_mm_t *mm);
/*!
* \brief Initializes RRSet structure with given data.
*
* \param rrset RRSet to init.
* \param owner RRSet owner to use.
* \param type RR type to use.
* \param rclass Class to use.
* \param ttl TTL to use.
*/
inline static void knot_rrset_init(knot_rrset_t *rrset, knot_dname_t *owner,
uint16_t type, uint16_t rclass, uint32_t ttl)
{
if (rrset != NULL) {
rrset->owner = owner;
rrset->type = type;
rrset->rclass = rclass;
rrset->ttl = ttl;
knot_rdataset_init(&rrset->rrs);
rrset->additional = NULL;
}
}
/*!
* \brief Initializes given RRSet structure.
*
* \param rrset RRSet to init.
*/
inline static void knot_rrset_init_empty(knot_rrset_t *rrset)
{
knot_rrset_init(rrset, NULL, 0, KNOT_CLASS_IN, 0);
}
/*!
* \brief Creates new RRSet from \a src RRSet.
*
* \param src Source RRSet.
* \param mm Memory context.
*
* \retval Pointer to new RRSet if all went OK.
* \retval NULL on error.
*/
knot_rrset_t *knot_rrset_copy(const knot_rrset_t *src, knot_mm_t *mm);
/*!
* \brief Destroys the RRSet structure and all its substructures.
*
* \param rrset RRset to be destroyed.
* \param mm Memory context.
*/
void knot_rrset_free(knot_rrset_t *rrset, knot_mm_t *mm);
/*!
* \brief Frees structures inside RRSet, but not the RRSet itself.
*
* \param rrset RRSet to be cleared.
* \param mm Memory context used for allocations.
*/
void knot_rrset_clear(knot_rrset_t *rrset, knot_mm_t *mm);
/*!
* \brief Adds the given RDATA to the RRSet.
*
* \param rrset RRSet to add the RDATA to.
* \param data RDATA to add to the RRSet.
* \param len Length of RDATA.
* \param mm Memory context.
*
* \return KNOT_E*
*/
int knot_rrset_add_rdata(knot_rrset_t *rrset, const uint8_t *data, uint16_t len,
knot_mm_t *mm);
/*!
* \brief Compares two RRSets for equality.
*
* \param r1 First RRSet.
* \param r2 Second RRSet.
* \param incl_ttl Compare also TTLs for equality.
*
* \retval True if RRSets are equal.
* \retval False if RRSets are not equal.
*/
bool knot_rrset_equal(const knot_rrset_t *r1, const knot_rrset_t *r2,
bool incl_ttl);
/*!
* \brief Checks whether RRSet is empty.
*
* \param rrset RRSet to check.
*
* \retval True if RRSet is empty.
* \retval False if RRSet is not empty.
*/
inline static bool knot_rrset_empty(const knot_rrset_t *rrset)
{
return rrset == NULL || rrset->rrs.count == 0;
}
/*!
* \brief Return whether the RR type is NSEC3 related (NSEC3 or RRSIG).
*/
bool knot_rrset_is_nsec3rel(const knot_rrset_t *rr);
/*!
* \brief Convert one RR into canonical format.
*
* Owner is always converted to lowercase. RDATA domain names are converted only
* for types listed in RFC 4034, Section 6.2, except for NSEC (updated by
* RFC 6840, Section 5.1) and A6 (not supported).
*
* \note If RRSet with more RRs is given to this function, only the first RR
* will be converted.
* \warning This function expects either empty RDATA or full, not malformed
* RDATA. If malformed RRSet is passed to this function, memory errors
* may occur.
*
* \param rrset RR to convert.
*/
int knot_rrset_rr_to_canonical(knot_rrset_t *rrset);
/*!
* \brief Size of rrset in wire format.
*
* \retval size in bytes
*/
size_t knot_rrset_size(const knot_rrset_t *rrset);
/*! @} */
|
