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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
/* Copyright (C) 2023 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/>.
*/
#pragma once
#include "knot/updates/apply.h"
#include "knot/conf/conf.h"
#include "knot/updates/changesets.h"
#include "knot/zone/contents.h"
#include "knot/zone/zone.h"
typedef struct {
knot_dname_storage_t next;
const knot_dname_t *node;
uint16_t rrtype;
} dnssec_validation_hint_t;
/*! \brief Structure for zone contents updating / querying. */
typedef struct zone_update {
zone_t *zone; /*!< Zone being updated. */
zone_contents_t *new_cont; /*!< New zone contents for full updates. */
changeset_t change; /*!< Changes we want to apply. */
zone_contents_t *init_cont; /*!< Exact contents of the zonefile. */
changeset_t extra_ch; /*!< Extra changeset to store just diff btwn zonefile and result. */
apply_ctx_t *a_ctx; /*!< Context for applying changesets. */
uint32_t flags; /*!< Zone update flags. */
dnssec_validation_hint_t validation_hint;
} zone_update_t;
typedef struct {
zone_update_t *update; /*!< The update we're iterating over. */
zone_tree_it_t tree_it; /*!< Iterator for the new zone. */
const zone_node_t *cur_node; /*!< Current node in the new zone. */
bool nsec3; /*!< Set when we're using the NSEC3 node tree. */
} zone_update_iter_t;
typedef enum {
// Mutually exclusive flags
UPDATE_FULL = 1 << 0, /*!< Replace the old zone by a complete new one. */
UPDATE_HYBRID = 1 << 1, /*!< Changeset like for incremental, adjusting like full. */
UPDATE_INCREMENTAL = 1 << 2, /*!< Apply changes to the old zone. */
// Additional flags
UPDATE_STRICT = 1 << 4, /*!< Apply changes strictly, i.e. fail when removing nonexistent RR. */
UPDATE_EXTRA_CHSET = 1 << 6, /*!< Extra changeset in use, to store diff btwn zonefile and final contents. */
UPDATE_CHANGED_NSEC = 1 << 7, /*!< This incremental update affects NSEC or NSEC3 nodes in zone. */
UPDATE_NO_CHSET = 1 << 8, /*!< Avoid using changeset and serialize to journal from diff of bi-nodes. */
} zone_update_flags_t;
/*!
* \brief Inits given zone update structure, new memory context is created.
*
* \param update Zone update structure to init.
* \param zone Init with this zone.
* \param flags Flags to control the behavior of the update.
*
* \return KNOT_E*
*/
int zone_update_init(zone_update_t *update, zone_t *zone, zone_update_flags_t flags);
/*!
* \brief Inits update structure, the update is built like IXFR from differences.
*
* The existing zone with its own contents is taken as a base,
* the new candidate zone contents are taken as new contents,
* the diff is calculated, so that this update is INCREMENTAL.
*
* \param update Zone update structure to init.
* \param zone Init with this zone.
* \param old_cont The current zone contents the diff will be against. Probably zone->contents.
* \param new_cont New zone contents. Will be taken over (and later freed) by zone update.
* \param flags Flags for update. Must be UPDATE_INCREMENTAL or UPDATE_HYBRID.
* \param ignore_dnssec Ignore DNSSEC records.
* \param ignore_zonemd Ignore ZONEMD records.
*
* \return KNOT_E*
*/
int zone_update_from_differences(zone_update_t *update, zone_t *zone, zone_contents_t *old_cont,
zone_contents_t *new_cont, zone_update_flags_t flags,
bool ignore_dnssec, bool ignore_zonemd);
/*!
* \brief Inits a zone update based on new zone contents.
*
* \param update Zone update structure to init.
* \param zone_without_contents Init with this zone. Its contents may be NULL.
* \param new_cont New zone contents. Will be taken over (and later freed) by zone update.
* \param flags Flags for update.
*
* \return KNOT_E*
*/
int zone_update_from_contents(zone_update_t *update, zone_t *zone_without_contents,
zone_contents_t *new_cont, zone_update_flags_t flags);
/*!
* \brief Inits using extra changeset, increments SOA serial.
*
* This shall be used after from_differences, to start tracking changes that are against the loaded zonefile.
*
* \param update Zone update.
* \param conf Configuration.
*
* \return KNOT_E*
*/
int zone_update_start_extra(zone_update_t *update, conf_t *conf);
/*!
* \brief Returns node that would be in the zone after updating it.
*
* \note Returned node is either zone original or synthesized, do *not* free
* or modify. Returned node is allocated on local mempool.
*
* \param update Zone update.
* \param dname Dname to search for.
*
* \return Node after zone update.
*/
const zone_node_t *zone_update_get_node(zone_update_t *update,
const knot_dname_t *dname);
/*!
* \brief Returns the serial from the current apex.
*
* \param update Zone update.
*
* \return 0 if no apex was found, its serial otherwise.
*/
uint32_t zone_update_current_serial(zone_update_t *update);
/*! \brief Return true if NSEC3PARAM has been changed in this update. */
bool zone_update_changed_nsec3param(const zone_update_t *update);
/*!
* \brief Returns the SOA rdataset we're updating from.
*
* \param update Zone update.
*
* \return The original SOA rdataset.
*/
const knot_rdataset_t *zone_update_from(zone_update_t *update);
/*!
* \brief Returns the SOA rdataset we're updating to.
*
* \param update Zone update.
*
* \return NULL if no new SOA has been added, new SOA otherwise.
*
* \todo Refactor this function according to its use.
*/
const knot_rdataset_t *zone_update_to(zone_update_t *update);
/*!
* \brief Clear data allocated by given zone update structure.
*
* \param update Zone update to clear.
*/
void zone_update_clear(zone_update_t *update);
/*!
* \brief Adds an RRSet to the zone.
*
* \warning Do not edit the zone_update when any iterator is active. Any
* zone_update modifications will invalidate the trie iterators
* in the zone_update iterator(s).
*
* \param update Zone update.
* \param rrset RRSet to add.
*
* \return KNOT_E*
*/
int zone_update_add(zone_update_t *update, const knot_rrset_t *rrset);
/*!
* \brief Removes an RRSet from the zone.
*
* \warning Do not edit the zone_update when any iterator is active. Any
* zone_update modifications will invalidate the trie iterators
* in the zone_update iterator(s).
*
* \param update Zone update.
* \param rrset RRSet to remove.
*
* \return KNOT_E*
*/
int zone_update_remove(zone_update_t *update, const knot_rrset_t *rrset);
/*!
* \brief Removes a whole RRSet of specified type from the zone.
*
* \warning Do not edit the zone_update when any iterator is active. Any
* zone_update modifications will invalidate the trie iterators
* in the zone_update iterator(s).
*
* \param update Zone update.
* \param owner Node name to remove.
* \param type RRSet type to remove.
*
* \return KNOT_E*
*/
int zone_update_remove_rrset(zone_update_t *update, knot_dname_t *owner, uint16_t type);
/*!
* \brief Removes a whole node from the zone.
*
* \warning Do not edit the zone_update when any iterator is active. Any
* zone_update modifications will invalidate the trie iterators
* in the zone_update iterator(s).
*
* \param update Zone update.
* \param owner Node name to remove.
*
* \return KNOT_E*
*/
int zone_update_remove_node(zone_update_t *update, const knot_dname_t *owner);
/*!
* \brief Adds and removes RRsets to/from the zone according to the changeset.
*
* \param update Zone update.
* \param changes Changes to be made in zone.
*
* \return KNOT_E*
*/
int zone_update_apply_changeset(zone_update_t *update, const changeset_t *changes);
/*!
* \brief Applies the changeset in reverse, rsets from REM section are added and from ADD section removed.
*
* \param update Zone update.
* \param changes Changes to be un-done.
*
* \return KNOT_E*
*/
int zone_update_apply_changeset_reverse(zone_update_t *update, const changeset_t *changes);
/*!
* \brief Increment SOA serial (according to configured policy) in the update.
*
* \param update Update to be modified.
* \param conf Configuration.
*
* \return KNOT_E*
*/
int zone_update_increment_soa(zone_update_t *update, conf_t *conf);
/*!
* \brief Executes mandatory semantic checks on the zone contents.
*
* \param conf Configuration.
* \param update Update to be checked.
*
* \return KNOT_E*
*/
int zone_update_semcheck(conf_t *conf, zone_update_t *update);
/*!
* \brief If configured, verify ZONEMD and log the result.
*
* \param conf Configuration.
* \param update Zone update.
*
* \return KNOT_E*
*/
int zone_update_verify_digest(conf_t *conf, zone_update_t *update);
/*!
* \brief Commits all changes to the zone, signs it, saves changes to journal.
*
* \param conf Configuration.
* \param update Zone update.
*
* \return KNOT_E*
*/
int zone_update_commit(conf_t *conf, zone_update_t *update);
/*!
* \brief Returns bool whether there are any changes at all.
*
* \param update Zone update.
*/
bool zone_update_no_change(zone_update_t *update);
/*!
* \brief Return whether apex DNSKEY, CDNSKEY, or CDS is updated.
*/
bool zone_update_changes_dnskey(zone_update_t *update);
|
