2 * daemon/acl_list.h - client access control storage for the server.
4 * Copyright (c) 2007, 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 helps the server keep out queries from outside sources, that
40 * should not be answered.
43 #include "daemon/acl_list.h"
44 #include "util/regional.h"
46 #include "util/config_file.h"
47 #include "util/net_help.h"
48 #include "services/localzone.h"
49 #include "sldns/str2wire.h"
54 struct acl_list* acl = (struct acl_list*)calloc(1,
55 sizeof(struct acl_list));
58 acl->region = regional_create();
67 acl_list_delete(struct acl_list* acl)
71 regional_destroy(acl->region);
75 /** insert new address into acl_list structure */
76 static struct acl_addr*
77 acl_list_insert(struct acl_list* acl, struct sockaddr_storage* addr,
78 socklen_t addrlen, int net, enum acl_access control,
79 int complain_duplicates)
81 struct acl_addr* node = regional_alloc_zero(acl->region,
82 sizeof(struct acl_addr));
85 node->control = control;
86 if(!addr_tree_insert(&acl->tree, &node->node, addr, addrlen, net)) {
87 if(complain_duplicates)
88 verbose(VERB_QUERY, "duplicate acl address ignored.");
93 /** apply acl_list string */
95 acl_list_str_cfg(struct acl_list* acl, const char* str, const char* s2,
96 int complain_duplicates)
98 struct sockaddr_storage addr;
101 enum acl_access control;
102 if(strcmp(s2, "allow") == 0)
104 else if(strcmp(s2, "deny") == 0)
106 else if(strcmp(s2, "refuse") == 0)
107 control = acl_refuse;
108 else if(strcmp(s2, "deny_non_local") == 0)
109 control = acl_deny_non_local;
110 else if(strcmp(s2, "refuse_non_local") == 0)
111 control = acl_refuse_non_local;
112 else if(strcmp(s2, "allow_snoop") == 0)
113 control = acl_allow_snoop;
114 else if(strcmp(s2, "allow_setrd") == 0)
115 control = acl_allow_setrd;
117 log_err("access control type %s unknown", str);
120 if(!netblockstrtoaddr(str, UNBOUND_DNS_PORT, &addr, &addrlen, &net)) {
121 log_err("cannot parse access control: %s %s", str, s2);
124 if(!acl_list_insert(acl, &addr, addrlen, net, control,
125 complain_duplicates)) {
126 log_err("out of memory");
132 /** find or create node (NULL on parse or error) */
133 static struct acl_addr*
134 acl_find_or_create(struct acl_list* acl, const char* str)
136 struct acl_addr* node;
137 struct sockaddr_storage addr;
140 if(!netblockstrtoaddr(str, UNBOUND_DNS_PORT, &addr, &addrlen, &net)) {
141 log_err("cannot parse netblock: %s", str);
144 /* find or create node */
145 if(!(node=(struct acl_addr*)addr_tree_find(&acl->tree, &addr,
147 /* create node, type 'allow' since otherwise tags are
148 * pointless, can override with specific access-control: cfg */
149 if(!(node=(struct acl_addr*)acl_list_insert(acl, &addr,
150 addrlen, net, acl_allow, 1))) {
151 log_err("out of memory");
158 /** apply acl_tag string */
160 acl_list_tags_cfg(struct acl_list* acl, const char* str, uint8_t* bitmap,
163 struct acl_addr* node;
164 if(!(node=acl_find_or_create(acl, str)))
166 node->taglen = bitmaplen;
167 node->taglist = regional_alloc_init(acl->region, bitmap, bitmaplen);
169 log_err("out of memory");
175 /** apply acl_view string */
177 acl_list_view_cfg(struct acl_list* acl, const char* str, const char* str2,
180 struct acl_addr* node;
181 if(!(node=acl_find_or_create(acl, str)))
183 node->view = views_find_view(vs, str2, 0 /* get read lock*/);
185 log_err("no view with name: %s", str2);
188 lock_rw_unlock(&node->view->lock);
192 /** apply acl_tag_action string */
194 acl_list_tag_action_cfg(struct acl_list* acl, struct config_file* cfg,
195 const char* str, const char* tag, const char* action)
197 struct acl_addr* node;
199 enum localzone_type t;
200 if(!(node=acl_find_or_create(acl, str)))
202 /* allocate array if not yet */
203 if(!node->tag_actions) {
204 node->tag_actions = (uint8_t*)regional_alloc_zero(acl->region,
205 sizeof(*node->tag_actions)*cfg->num_tags);
206 if(!node->tag_actions) {
207 log_err("out of memory");
210 node->tag_actions_size = (size_t)cfg->num_tags;
213 if((tagid=find_tag_id(cfg, tag)) == -1) {
214 log_err("cannot parse tag (define-tag it): %s %s", str, tag);
217 if((size_t)tagid >= node->tag_actions_size) {
218 log_err("tagid too large for array %s %s", str, tag);
221 if(!local_zone_str2type(action, &t)) {
222 log_err("cannot parse access control action type: %s %s %s",
226 node->tag_actions[tagid] = (uint8_t)t;
230 /** check wire data parse */
232 check_data(const char* data, const struct config_strlist* head)
235 uint8_t rr[LDNS_RR_BUF_SIZE];
236 size_t len = sizeof(rr);
238 /* '.' is sufficient for validation, and it makes the call to
239 * sldns_wirerr_get_type() simpler below. */
240 snprintf(buf, sizeof(buf), "%s %s", ".", data);
241 res = sldns_str2wire_rr_buf(buf, rr, &len, NULL, 3600, NULL, 0,
244 /* Reject it if we would end up having CNAME and other data (including
245 * another CNAME) for the same tag. */
246 if(res == 0 && head) {
247 const char* err_data = NULL;
249 if(sldns_wirerr_get_type(rr, len, 1) == LDNS_RR_TYPE_CNAME) {
250 /* adding CNAME while other data already exists. */
253 snprintf(buf, sizeof(buf), "%s %s", ".", head->str);
255 res = sldns_str2wire_rr_buf(buf, rr, &len, NULL, 3600,
258 /* This should be impossible here as head->str
259 * has been validated, but we check it just in
263 if(sldns_wirerr_get_type(rr, len, 1) ==
264 LDNS_RR_TYPE_CNAME) /* already have CNAME */
265 err_data = head->str;
268 log_err("redirect tag data '%s' must not coexist with "
269 "other data.", err_data);
275 log_err("rr data [char %d] parse error %s",
276 (int)LDNS_WIREPARSE_OFFSET(res)-2,
277 sldns_get_errorstr_parse(res));
281 /** apply acl_tag_data string */
283 acl_list_tag_data_cfg(struct acl_list* acl, struct config_file* cfg,
284 const char* str, const char* tag, const char* data)
286 struct acl_addr* node;
289 if(!(node=acl_find_or_create(acl, str)))
291 /* allocate array if not yet */
292 if(!node->tag_datas) {
293 node->tag_datas = (struct config_strlist**)regional_alloc_zero(
294 acl->region, sizeof(*node->tag_datas)*cfg->num_tags);
295 if(!node->tag_datas) {
296 log_err("out of memory");
299 node->tag_datas_size = (size_t)cfg->num_tags;
302 if((tagid=find_tag_id(cfg, tag)) == -1) {
303 log_err("cannot parse tag (define-tag it): %s %s", str, tag);
306 if((size_t)tagid >= node->tag_datas_size) {
307 log_err("tagid too large for array %s %s", str, tag);
312 if(!check_data(data, node->tag_datas[tagid])) {
313 log_err("cannot parse access-control-tag data: %s %s '%s'",
318 dupdata = regional_strdup(acl->region, data);
320 log_err("out of memory");
323 if(!cfg_region_strlist_insert(acl->region,
324 &(node->tag_datas[tagid]), dupdata)) {
325 log_err("out of memory");
331 /** read acl_list config */
333 read_acl_list(struct acl_list* acl, struct config_file* cfg)
335 struct config_str2list* p;
336 for(p = cfg->acls; p; p = p->next) {
337 log_assert(p->str && p->str2);
338 if(!acl_list_str_cfg(acl, p->str, p->str2, 1))
344 /** read acl tags config */
346 read_acl_tags(struct acl_list* acl, struct config_file* cfg)
348 struct config_strbytelist* np, *p = cfg->acl_tags;
349 cfg->acl_tags = NULL;
351 log_assert(p->str && p->str2);
352 if(!acl_list_tags_cfg(acl, p->str, p->str2, p->str2len)) {
353 config_del_strbytelist(p);
356 /* free the items as we go to free up memory */
366 /** read acl view config */
368 read_acl_view(struct acl_list* acl, struct config_file* cfg, struct views* v)
370 struct config_str2list* np, *p = cfg->acl_view;
371 cfg->acl_view = NULL;
373 log_assert(p->str && p->str2);
374 if(!acl_list_view_cfg(acl, p->str, p->str2, v)) {
377 /* free the items as we go to free up memory */
387 /** read acl tag actions config */
389 read_acl_tag_actions(struct acl_list* acl, struct config_file* cfg)
391 struct config_str3list* p, *np;
392 p = cfg->acl_tag_actions;
393 cfg->acl_tag_actions = NULL;
395 log_assert(p->str && p->str2 && p->str3);
396 if(!acl_list_tag_action_cfg(acl, cfg, p->str, p->str2,
398 config_deltrplstrlist(p);
401 /* free the items as we go to free up memory */
412 /** read acl tag datas config */
414 read_acl_tag_datas(struct acl_list* acl, struct config_file* cfg)
416 struct config_str3list* p, *np;
417 p = cfg->acl_tag_datas;
418 cfg->acl_tag_datas = NULL;
420 log_assert(p->str && p->str2 && p->str3);
421 if(!acl_list_tag_data_cfg(acl, cfg, p->str, p->str2, p->str3)) {
422 config_deltrplstrlist(p);
425 /* free the items as we go to free up memory */
437 acl_list_apply_cfg(struct acl_list* acl, struct config_file* cfg,
440 regional_free_all(acl->region);
441 addr_tree_init(&acl->tree);
442 if(!read_acl_list(acl, cfg))
444 if(!read_acl_view(acl, cfg, v))
446 if(!read_acl_tags(acl, cfg))
448 if(!read_acl_tag_actions(acl, cfg))
450 if(!read_acl_tag_datas(acl, cfg))
452 /* insert defaults, with '0' to ignore them if they are duplicates */
453 if(!acl_list_str_cfg(acl, "0.0.0.0/0", "refuse", 0))
455 if(!acl_list_str_cfg(acl, "127.0.0.0/8", "allow", 0))
458 if(!acl_list_str_cfg(acl, "::0/0", "refuse", 0))
460 if(!acl_list_str_cfg(acl, "::1", "allow", 0))
462 if(!acl_list_str_cfg(acl, "::ffff:127.0.0.1", "allow", 0))
465 addr_tree_init_parents(&acl->tree);
470 acl_get_control(struct acl_addr* acl)
472 if(acl) return acl->control;
477 acl_addr_lookup(struct acl_list* acl, struct sockaddr_storage* addr,
480 return (struct acl_addr*)addr_tree_lookup(&acl->tree,
485 acl_list_get_mem(struct acl_list* acl)
488 return sizeof(*acl) + regional_get_mem(acl->region);