2 * services/authzone.h - authoritative zone that is locally hosted.
4 * Copyright (c) 2017, NLnet Labs. All rights reserved.
6 * This software is open source.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
15 * Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
19 * Neither the name of the NLNET LABS nor the names of its contributors may
20 * be used to endorse or promote products derived from this software without
21 * specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
29 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * This file contains the functions for an authority zone. This zone
40 * is queried by the iterator, just like a stub or forward zone, but then
41 * the data is locally held.
44 #ifndef SERVICES_AUTHZONE_H
45 #define SERVICES_AUTHZONE_H
46 #include "util/rbtree.h"
47 #include "util/locks.h"
48 #include "services/mesh.h"
49 struct ub_packed_rrset_key;
62 struct auth_nextprobe;
69 * Authoritative zones, shared.
72 /** lock on the authzone trees */
74 /** rbtree of struct auth_zone */
76 /** rbtree of struct auth_xfer */
78 /** do we have downstream enabled */
80 /** number of queries upstream */
82 /** number of queries downstream */
83 size_t num_query_down;
87 * Auth zone. Authoritative data, that is fetched from instead of sending
88 * packets to the internet.
91 /** rbtree node, key is name and class */
94 /** zone name, in uncompressed wireformat */
96 /** length of zone name */
98 /** number of labels in zone name */
100 /** the class of this zone, in host byteorder.
101 * uses 'dclass' to not conflict with c++ keyword class. */
104 /** lock on the data in the structure
105 * For the node, parent, name, namelen, namelabs, dclass, you
106 * need to also hold the zones_tree lock to change them (or to
107 * delete this zone) */
110 /** auth data for this zone
111 * rbtree of struct auth_data */
114 /** zonefile name (or NULL for no zonefile) */
116 /** fallback to the internet on failure or ttl-expiry of auth zone */
117 int fallback_enabled;
118 /** the zone has expired (enabled by the xfer worker), fallback
119 * happens if that option is enabled. */
121 /** zone is a slave zone (it has masters) */
123 /** for downstream: this zone answers queries towards the downstream
126 /** for upstream: this zone answers queries that unbound intends to
129 /** zone has been deleted */
131 /** deletelist pointer, unused normally except during delete */
132 struct auth_zone* delete_next;
136 * Auth data. One domain name, and the RRs to go with it.
139 /** rbtree node, key is name only */
143 /** length of name */
145 /** number of labels in name */
147 /** the data rrsets, with different types, linked list.
148 * if the list if NULL the node would be an empty non-terminal,
149 * but in this data structure such nodes that represent an empty
150 * non-terminal are not needed; they just don't exist.
152 struct auth_rrset* rrsets;
160 struct auth_rrset* next;
161 /** RR type in host byteorder */
163 /** RRset data item */
164 struct packed_rrset_data* data;
168 * Authoritative zone transfer structure.
169 * Create and destroy needs the auth_zones* biglock.
170 * The structure consists of different tasks. Each can be unowned (-1) or
171 * owner by a worker (worker-num). A worker can pick up a task and then do
172 * it. This means the events (timeouts, sockets) are for that worker.
174 * (move this to tasks).
175 * They don't have locks themselves, the worker (that owns it) uses it,
176 * also as part of callbacks, hence it has separate zonename pointers for
177 * lookup in the main zonetree. If the zone has no transfers, this
178 * structure is not created.
181 /** rbtree node, key is name and class */
184 /** lock on this structure, and on the workernum elements of the
185 * tasks. First hold the tree-lock in auth_zones, find the auth_xfer,
186 * lock this lock. Then a worker can reassign itself to fill up
188 * Once it has the task assigned to it, the worker can access the
189 * other elements of the task structure without a lock, because that
190 * is necessary for the eventloop and callbacks from that. */
191 lock_basic_type lock;
193 /** zone name, in uncompressed wireformat */
195 /** length of zone name */
197 /** number of labels in zone name */
199 /** the class of this zone, in host byteorder.
200 * uses 'dclass' to not conflict with c++ keyword class. */
203 /** task to wait for next-probe-timeout,
204 * once timeouted, see if a SOA probe is needed, or already
206 struct auth_nextprobe* task_nextprobe;
208 /** task for SOA probe. Check if the zone can be updated */
209 struct auth_probe* task_probe;
211 /** Task for transfer. Transferring and updating the zone. This
212 * includes trying (potentially) several upstream masters. Downloading
213 * and storing the zone */
214 struct auth_transfer* task_transfer;
216 /** a notify was received, but a zone transfer or probe was already
218 * However, the zone transfer could signal a newer serial number.
219 * The serial number of that notify is saved below. The transfer and
220 * probe tasks should check this once done to see if they need to
221 * restart the transfer task for the newer notify serial.
222 * Hold the lock to access this member (and the serial).
225 /** true if the notify_received has a serial number */
226 int notify_has_serial;
227 /** serial number of the notify */
228 uint32_t notify_serial;
229 /** the list of masters for checking notifies. This list is
230 * empty on start, and a copy of the list from the probe_task when
231 * it is done looking them up. */
232 struct auth_master* allow_notify_list;
234 /* protected by the lock on the structure, information about
235 * the loaded authority zone. */
236 /** is the zone currently considered expired? after expiry also older
237 * serial numbers are allowed (not just newer) */
239 /** do we have a zone (if 0, no zone data at all) */
242 /** current serial (from SOA), if we have no zone, 0 */
244 /** retry time (from SOA), time to wait with next_probe
245 * if no master responds */
247 /** refresh time (from SOA), time to wait with next_probe
248 * if everything is fine */
250 /** expiry time (from SOA), time until zone data is not considered
251 * valid any more, if no master responds within this time, either
252 * with the current zone or a new zone. */
255 /** zone lease start time (start+expiry is expiration time).
256 * this is renewed every SOA probe and transfer. On zone load
257 * from zonefile it is also set (with probe set soon to check) */
262 * The next probe task.
263 * This task consists of waiting for the probetimeout. It is a task because
264 * it needs an event in the eventtable. Once the timeout has passed, that
265 * worker can (potentially) become the auth_probe worker, or if another worker
266 * is already doing that, do nothing. Tasks becomes unowned.
267 * The probe worker, if it detects nothing has to be done picks up this task,
270 struct auth_nextprobe {
271 /* Worker pointer. NULL means unowned. */
272 struct worker* worker;
273 /* module env for this task */
274 struct module_env* env;
276 /** increasing backoff for failures */
278 /** Timeout for next probe (for SOA) */
280 /** timeout callback for next_probe or expiry(if that is sooner).
281 * it is on the worker's event_base */
282 struct comm_timer* timer;
287 * Send a SOA UDP query to see if the zone needs to be updated (or similar,
288 * potential, HTTP probe query) and check serial number.
289 * If yes, start the auth_transfer task. If no, make sure auth_nextprobe
290 * timeout wait task is running.
291 * Needs to be a task, because the UDP query needs an event entry.
292 * This task could also be started by eg. a NOTIFY being received, even though
293 * another worker is performing the nextprobe task (and that worker keeps
294 * waiting uninterrupted).
297 /* Worker pointer. NULL means unowned. */
298 struct worker* worker;
299 /* module env for this task */
300 struct module_env* env;
302 /** list of upstream masters for this zone, from config */
303 struct auth_master* masters;
305 /** for the hostname lookups, which master is current */
306 struct auth_master* lookup_target;
307 /** are we looking up A or AAAA, first A, then AAAA (if ip6 enabled) */
309 /** we only want to do lookups for making config work (for notify),
310 * don't proceed with UDP SOA probe queries */
312 /** we have seen a new lease this scan, because one of the masters
313 * replied with the current SOA serial version */
316 /** once notified, or the timeout has been reached. a scan starts. */
317 /** the scan specific target (notify source), or NULL if none */
318 struct auth_master* scan_specific;
319 /** scan tries all the upstream masters. the scan current target.
320 * or NULL if not working on sequential scan */
321 struct auth_master* scan_target;
322 /** if not NULL, the specific addr for the current master */
323 struct auth_addr* scan_addr;
325 /** dns id of packet in flight */
327 /** the SOA probe udp event.
328 * on the workers event base. */
329 struct comm_point* cp;
330 /** is the cp for ip6 or ip4 */
332 /** timeout for packets.
333 * on the workers event base. */
334 struct comm_timer* timer;
335 /** timeout in msec */
341 * Once done, make sure the nextprobe waiting task is running, whether done
342 * with failure or success. If failure, use shorter timeout for wait time.
344 struct auth_transfer {
345 /* Worker pointer. NULL means unowned. */
346 struct worker* worker;
347 /* module env for this task */
348 struct module_env* env;
350 /** xfer data that has been transferred, the data is applied
351 * once the transfer has completed correctly */
352 struct auth_chunk* chunks_first;
353 /** last element in chunks list (to append new data at the end) */
354 struct auth_chunk* chunks_last;
356 /** list of upstream masters for this zone, from config */
357 struct auth_master* masters;
359 /** for the hostname lookups, which master is current */
360 struct auth_master* lookup_target;
361 /** are we looking up A or AAAA, first A, then AAAA (if ip6 enabled) */
364 /** once notified, or the timeout has been reached. a scan starts. */
365 /** the scan specific target (notify source), or NULL if none */
366 struct auth_master* scan_specific;
367 /** scan tries all the upstream masters. the scan current target.
368 * or NULL if not working on sequential scan */
369 struct auth_master* scan_target;
370 /** what address we are scanning for the master, or NULL if the
371 * master is in IP format itself */
372 struct auth_addr* scan_addr;
373 /** the zone transfer in progress (or NULL if in scan). It is
374 * from this master */
375 struct auth_master* master;
377 /** failed ixfr transfer, retry with axfr (to the current master),
378 * the IXFR was 'REFUSED', 'SERVFAIL', 'NOTIMPL' or the contents of
379 * the IXFR did not apply cleanly (out of sync, delete of nonexistent
380 * data or add of duplicate data). Flag is cleared once the retry
381 * with axfr is done. */
383 /** we saw an ixfr-indicating timeout, count of them */
384 int ixfr_possible_timeout_count;
385 /** we are doing IXFR right now */
387 /** did we detect the current AXFR/IXFR serial number yet, 0 not yet,
388 * 1 we saw the first, 2 we saw the second, 3 must be last SOA in xfr*/
390 /** number of RRs scanned for AXFR/IXFR detection */
392 /** we are doing an IXFR but we detected an AXFR contents */
394 /** the serial number for the current AXFR/IXFR incoming reply,
395 * for IXFR, the outermost SOA records serial */
396 uint32_t incoming_xfr_serial;
398 /** dns id of AXFR query */
400 /** the transfer (TCP) to the master.
401 * on the workers event base. */
402 struct comm_point* cp;
403 /** timeout for the transfer.
404 * on the workers event base. */
405 struct comm_timer* timer;
408 /** list of addresses */
411 struct auth_addr* next;
413 struct sockaddr_storage addr;
418 /** auth zone master upstream, and the config settings for it */
420 /** next master in list */
421 struct auth_master* next;
422 /** master IP address (and port), or hostname, string */
424 /** for http, filename */
426 /** use HTTP for this master */
428 /** use IXFR for this master */
430 /** this is an allow notify member, the master can send notifies
431 * to us, but we don't send SOA probes, or zone transfer from it */
433 /** use ssl for channel */
435 /** the port number (for urls) */
437 /** if the host is a hostname, the list of resolved addrs, if any*/
438 struct auth_addr* list;
441 /** auth zone master zone transfer data chunk */
443 /** next chunk in list */
444 struct auth_chunk* next;
445 /** the data from this chunk, this is what was received.
446 * for an IXFR that means results from comm_net tcp actions,
447 * packets. also for an AXFR. For HTTP a zonefile chunk. */
449 /** length of allocated data */
454 * Create auth zones structure
456 struct auth_zones* auth_zones_create(void);
459 * Apply configuration to auth zones. Reads zonefiles.
460 * @param az: auth zones structure
461 * @param cfg: config to apply.
462 * @param setup: if true, also sets up values in the auth zones structure
463 * @return false on failure.
465 int auth_zones_apply_cfg(struct auth_zones* az, struct config_file* cfg,
468 /** initial pick up of worker timeouts, ties events to worker event loop
469 * @param az: auth zones structure
470 * @param env: worker env, of first worker that receives the events (if any)
473 void auth_xfer_pickup_initial(struct auth_zones* az, struct module_env* env);
476 * Cleanup auth zones. This removes all events from event bases.
477 * Stops the xfr tasks. But leaves zone data.
478 * @param az: auth zones structure.
480 void auth_zones_cleanup(struct auth_zones* az);
483 * Delete auth zones structure
485 void auth_zones_delete(struct auth_zones* az);
488 * Write auth zone data to file, in zonefile format.
490 int auth_zone_write_file(struct auth_zone* z, const char* fname);
493 * Use auth zones to lookup the answer to a query.
494 * The query is from the iterator. And the auth zones attempts to provide
495 * the answer instead of going to the internet.
497 * @param az: auth zones structure.
498 * @param qinfo: query info to lookup.
499 * @param region: region to use to allocate the reply in.
500 * @param msg: reply is stored here (if one).
501 * @param fallback: if true, fallback to making a query to the internet.
502 * @param dp_nm: name of delegation point to look for. This zone is used
503 * to answer the query.
504 * If the dp_nm is not found, fallback is set to true and false returned.
505 * @param dp_nmlen: length of dp_nm.
506 * @return 0: failure (an error of some sort, like servfail).
507 * if 0 and fallback is true, fallback to the internet.
508 * if 0 and fallback is false, like getting servfail.
509 * If true, an answer is available.
511 int auth_zones_lookup(struct auth_zones* az, struct query_info* qinfo,
512 struct regional* region, struct dns_msg** msg, int* fallback,
513 uint8_t* dp_nm, size_t dp_nmlen);
516 * Answer query from auth zone. Create authoritative answer.
517 * @param az: auth zones structure.
518 * @param env: the module environment.
519 * @param qinfo: query info (parsed).
520 * @param edns: edns info (parsed).
521 * @param buf: buffer with query ID and flags, also for reply.
522 * @param repinfo: reply information for a communication point.
523 * @param temp: temporary storage region.
524 * @return false if not answered
526 int auth_zones_answer(struct auth_zones* az, struct module_env* env,
527 struct query_info* qinfo, struct edns_data* edns,
528 struct comm_reply* repinfo, struct sldns_buffer* buf, struct regional* temp);
531 * Find the auth zone that is above the given qname.
532 * Return NULL when there is no auth_zone above the give name, otherwise
533 * returns the closest auth_zone above the qname that pertains to it.
534 * @param az: auth zones structure.
535 * @param name: query to look up for.
536 * @param name_len: length of name.
537 * @param dclass: class of zone to find.
538 * @return NULL or auth_zone that pertains to the query.
540 struct auth_zone* auth_zones_find_zone(struct auth_zones* az,
541 uint8_t* name, size_t name_len, uint16_t dclass);
543 /** find an auth zone by name (exact match by name or NULL returned) */
544 struct auth_zone* auth_zone_find(struct auth_zones* az, uint8_t* nm,
545 size_t nmlen, uint16_t dclass);
547 /** find an xfer zone by name (exact match by name or NULL returned) */
548 struct auth_xfer* auth_xfer_find(struct auth_zones* az, uint8_t* nm,
549 size_t nmlen, uint16_t dclass);
551 /** create an auth zone. returns wrlocked zone. caller must have wrlock
552 * on az. returns NULL on malloc failure */
553 struct auth_zone* auth_zone_create(struct auth_zones* az, uint8_t* nm,
554 size_t nmlen, uint16_t dclass);
556 /** set auth zone zonefile string. caller must have lock on zone */
557 int auth_zone_set_zonefile(struct auth_zone* z, char* zonefile);
559 /** set auth zone fallback. caller must have lock on zone.
560 * fallbackstr is "yes" or "no". false on parse failure. */
561 int auth_zone_set_fallback(struct auth_zone* z, char* fallbackstr);
563 /** see if the auth zone for the name can fallback
564 * @param az: auth zones
565 * @param nm: name of delegation point.
566 * @param nmlen: length of nm.
567 * @param dclass: class of zone to look for.
568 * @return true if fallback_enabled is true. false if not.
569 * if the zone does not exist, fallback is true (more lenient)
570 * also true if zone does not do upstream requests.
572 int auth_zones_can_fallback(struct auth_zones* az, uint8_t* nm, size_t nmlen,
575 /** process notify for auth zones.
576 * first checks the access list. Then processes the notify. This starts
577 * the probe sequence or it notes the serial number (if any)
578 * @param az: auth zones structure.
579 * @param env: module env of the worker that is handling the notify. it will
580 * pick up the task probe (or transfer), unless already in progress by
582 * @param nm: name of the zone. Uncompressed. from query.
583 * @param nmlen: length of name.
584 * @param dclass: class of zone.
585 * @param addr: source address of notify
586 * @param addrlen: length of addr.
587 * @param has_serial: if true, the notify has a serial attached.
588 * @param serial: the serial number, if has_serial is true.
589 * @param refused: is set to true on failure to note refused access.
590 * @return fail on failures (refused is false) and when access is
591 * denied (refused is true). True when processed.
593 int auth_zones_notify(struct auth_zones* az, struct module_env* env,
594 uint8_t* nm, size_t nmlen, uint16_t dclass,
595 struct sockaddr_storage* addr, socklen_t addrlen, int has_serial,
596 uint32_t serial, int* refused);
598 /** process notify packet and read serial number from SOA.
599 * returns 0 if no soa record in the notify */
600 int auth_zone_parse_notify_serial(struct sldns_buffer* pkt, uint32_t *serial);
602 /** for the zone and if not already going, starts the probe sequence.
603 * false if zone cannot be found. This is like a notify arrived and was
604 * accepted for that zone. */
605 int auth_zones_startprobesequence(struct auth_zones* az,
606 struct module_env* env, uint8_t* nm, size_t nmlen, uint16_t dclass);
608 /** read auth zone from zonefile. caller must lock zone. false on failure */
609 int auth_zone_read_zonefile(struct auth_zone* z, struct config_file* cfg);
611 /** find serial number of zone or false if none (no SOA record) */
612 int auth_zone_get_serial(struct auth_zone* z, uint32_t* serial);
614 /** compare auth_zones for sorted rbtree */
615 int auth_zone_cmp(const void* z1, const void* z2);
617 /** compare auth_data for sorted rbtree */
618 int auth_data_cmp(const void* z1, const void* z2);
620 /** compare auth_xfer for sorted rbtree */
621 int auth_xfer_cmp(const void* z1, const void* z2);
623 /** Create auth_xfer structure.
624 * Caller must have wrlock on az. Returns locked xfer zone.
625 * @param az: zones structure.
626 * @param z: zone with name and class
627 * @return xfer zone or NULL
629 struct auth_xfer* auth_xfer_create(struct auth_zones* az, struct auth_zone* z);
632 * Set masters in auth xfer structure from config.
633 * @param list: pointer to start of list. The malloced list is returned here.
634 * @param c: the config items to copy over.
635 * @param with_http: if true, http urls are also included, before the masters.
636 * @return false on failure.
638 int xfer_set_masters(struct auth_master** list, struct config_auth* c,
641 /** xfer nextprobe timeout callback, this is part of task_nextprobe */
642 void auth_xfer_timer(void* arg);
644 /** callback for commpoint udp replies to task_probe */
645 int auth_xfer_probe_udp_callback(struct comm_point* c, void* arg, int err,
646 struct comm_reply* repinfo);
647 /** callback for task_transfer tcp connections */
648 int auth_xfer_transfer_tcp_callback(struct comm_point* c, void* arg, int err,
649 struct comm_reply* repinfo);
650 /** callback for task_transfer http connections */
651 int auth_xfer_transfer_http_callback(struct comm_point* c, void* arg, int err,
652 struct comm_reply* repinfo);
653 /** xfer probe timeout callback, part of task_probe */
654 void auth_xfer_probe_timer_callback(void* arg);
655 /** xfer transfer timeout callback, part of task_transfer */
656 void auth_xfer_transfer_timer_callback(void* arg);
657 /** mesh callback for task_probe on lookup of host names */
658 void auth_xfer_probe_lookup_callback(void* arg, int rcode,
659 struct sldns_buffer* buf, enum sec_status sec, char* why_bogus,
660 int was_ratelimited);
661 /** mesh callback for task_transfer on lookup of host names */
662 void auth_xfer_transfer_lookup_callback(void* arg, int rcode,
663 struct sldns_buffer* buf, enum sec_status sec, char* why_bogus,
664 int was_ratelimited);
667 * Compares two 32-bit serial numbers as defined in RFC1982. Returns
668 * <0 if a < b, 0 if a == b, and >0 if a > b. The result is undefined
669 * if a != b but neither is greater or smaller (see RFC1982 section
672 int compare_serial(uint32_t a, uint32_t b);
674 #endif /* SERVICES_AUTHZONE_H */