2 * util/edns.h - handle base EDNS options.
4 * Copyright (c) 2018, 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 functions for base EDNS options.
45 #include "util/storage/dnstree.h"
53 * Structure containing all EDNS tags.
56 /** Tree of EDNS client tags to use in upstream queries, per address
57 * prefix. Contains nodes of type edns_tag_addr. */
58 rbtree_type client_tags;
59 /** EDNS opcode to use for client tags */
60 uint16_t client_tag_opcode;
61 /** region to allocate tree nodes in */
62 struct regional* region;
66 * EDNS tag. Node of rbtree, containing tag and prefix.
68 struct edns_tag_addr {
69 /** node in address tree, used for tree lookups. Need to be the first
70 * member of this struct. */
71 struct addr_tree_node node;
72 /** tag data, in host byte ordering */
77 * Create structure to hold EDNS tags
78 * @return: newly created edns_tags, NULL on alloc failure.
80 struct edns_tags* edns_tags_create(void);
82 /** Delete EDNS tags structure
83 * @param edns_tags: struct to delete
85 void edns_tags_delete(struct edns_tags* edns_tags);
88 * Add configured EDNS tags
89 * @param edns_tags: edns tags to apply config to
90 * @param config: struct containing EDNS tags configuration
93 int edns_tags_apply_cfg(struct edns_tags* edns_tags,
94 struct config_file* config);
97 * Find tag for address.
98 * @param tree: tree containing EDNS tags per address prefix.
99 * @param addr: address to use for tree lookup
100 * @param addrlen: length of address
101 * @return: matching tree node, NULL otherwise
103 struct edns_tag_addr*
104 edns_tag_addr_lookup(rbtree_type* tree, struct sockaddr_storage* addr,
108 * Apply common EDNS options.
110 * @param edns_out: initialised edns information with outbound edns.
111 * @param edns_in: initialised edns information with received edns.
112 * @param cfg: configuration.
113 * @param c: comm channel.
114 * @param region: the region to allocate the edns options in.
116 int apply_edns_options(struct edns_data* edns_out, struct edns_data* edns_in,
117 struct config_file* cfg, struct comm_point* c, struct regional* region);