2 * Copyright (C) 2011, 2012 Internet Systems Consortium, Inc. ("ISC")
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14 * PERFORMANCE OF THIS SOFTWARE.
23 #include <isc/buffer.h>
26 #include <isc/netaddr.h>
27 #include <isc/print.h>
28 #include <isc/stdlib.h>
29 #include <isc/string.h>
33 #include <dns/fixedname.h>
35 #include <dns/rdata.h>
36 #include <dns/rdataset.h>
37 #include <dns/rdatastruct.h>
38 #include <dns/result.h>
44 * Parallel radix trees for databases of response policy IP addresses
46 * The radix or Patricia trees are somewhat specialized to handle response
47 * policy addresses by representing the two test of IP IP addresses and name
48 * server IP addresses in a single tree.
50 * Each leaf indicates that an IP address is listed in the IP address or the
51 * name server IP address policy sub-zone (or both) of the corresponding
52 * response response zone. The policy data such as a CNAME or an A record
53 * is kept in the policy zone. After an IP address has been found in a radix
54 * tree, the node in the policy zone's database is found by converting
55 * the IP address to a domain name in a canonical form.
57 * The response policy zone canonical form of IPv6 addresses is one of:
58 * prefix.W.W.W.W.W.W.W.W
60 * prefix.WORDS.zz.WORDS
63 * prefix is the prefix length of the IPv6 address between 1 and 128
64 * W is a number between 0 and 65535
65 * WORDS is one or more numbers W separated with "."
66 * zz corresponds to :: in the standard IPv6 text representation
68 * The canonical form of IPv4 addresses is:
71 * prefix is the prefix length of the address between 1 and 32
72 * B is a number between 0 and 255
74 * IPv4 addresses are distinguished from IPv6 addresses by having
75 * 5 labels all of which are numbers, and a prefix between 1 and 32.
80 * Use a private definition of IPv6 addresses because s6_addr32 is not
81 * always defined and our IPv6 addresses are in non-standard byte order
83 typedef isc_uint32_t dns_rpz_cidr_word_t;
84 #define DNS_RPZ_CIDR_WORD_BITS ((int)sizeof(dns_rpz_cidr_word_t)*8)
85 #define DNS_RPZ_CIDR_KEY_BITS ((int)sizeof(dns_rpz_cidr_key_t)*8)
86 #define DNS_RPZ_CIDR_WORDS (128/DNS_RPZ_CIDR_WORD_BITS)
88 dns_rpz_cidr_word_t w[DNS_RPZ_CIDR_WORDS];
91 #define ADDR_V4MAPPED 0xffff
93 #define DNS_RPZ_WORD_MASK(b) \
94 ((b) == 0 ? (dns_rpz_cidr_word_t)(-1) \
95 : ((dns_rpz_cidr_word_t)(-1) \
96 << (DNS_RPZ_CIDR_WORD_BITS - (b))))
98 #define DNS_RPZ_IP_BIT(ip, bitno) \
99 (1 & ((ip)->w[(bitno)/DNS_RPZ_CIDR_WORD_BITS] >> \
100 (DNS_RPZ_CIDR_WORD_BITS - 1 - ((bitno) % DNS_RPZ_CIDR_WORD_BITS))))
102 typedef struct dns_rpz_cidr_node dns_rpz_cidr_node_t;
103 typedef isc_uint8_t dns_rpz_cidr_flags_t;
104 struct dns_rpz_cidr_node {
105 dns_rpz_cidr_node_t *parent;
106 dns_rpz_cidr_node_t *child[2];
107 dns_rpz_cidr_key_t ip;
108 dns_rpz_cidr_bits_t bits;
109 dns_rpz_cidr_flags_t flags;
110 #define DNS_RPZ_CIDR_FG_IP 0x01 /* has IP data or is parent of IP */
111 #define DNS_RPZ_CIDR_FG_IP_DATA 0x02 /* has IP data */
112 #define DNS_RPZ_CIDR_FG_NSIPv4 0x04 /* has or is parent of NSIPv4 data */
113 #define DNS_RPZ_CIDR_FG_NSIPv6 0x08 /* has or is parent of NSIPv6 data */
114 #define DNS_RPZ_CIDR_FG_NSIP_DATA 0x10 /* has NSIP data */
117 struct dns_rpz_cidr {
119 isc_boolean_t have_nsdname; /* zone has NSDNAME record */
120 dns_rpz_cidr_node_t *root;
121 dns_name_t ip_name; /* RPZ_IP_ZONE.origin. */
122 dns_name_t nsip_name; /* RPZ_NSIP_ZONE.origin. */
123 dns_name_t nsdname_name; /* RPZ_NSDNAME_ZONE.origin */
126 static isc_boolean_t have_rpz_zones = ISC_FALSE;
129 dns_rpz_type2str(dns_rpz_type_t type) {
131 case DNS_RPZ_TYPE_QNAME:
133 case DNS_RPZ_TYPE_IP:
135 case DNS_RPZ_TYPE_NSIP:
137 case DNS_RPZ_TYPE_NSDNAME:
139 case DNS_RPZ_TYPE_BAD:
142 FATAL_ERROR(__FILE__, __LINE__,
143 "impossible rpz type %d", type);
144 return ("impossible");
148 dns_rpz_str2policy(const char *str) {
150 return (DNS_RPZ_POLICY_ERROR);
151 if (!strcasecmp(str, "given"))
152 return (DNS_RPZ_POLICY_GIVEN);
153 if (!strcasecmp(str, "disabled"))
154 return (DNS_RPZ_POLICY_DISABLED);
155 if (!strcasecmp(str, "passthru"))
156 return (DNS_RPZ_POLICY_PASSTHRU);
157 if (!strcasecmp(str, "nxdomain"))
158 return (DNS_RPZ_POLICY_NXDOMAIN);
159 if (!strcasecmp(str, "nodata"))
160 return (DNS_RPZ_POLICY_NODATA);
161 if (!strcasecmp(str, "cname"))
162 return (DNS_RPZ_POLICY_CNAME);
166 if (!strcasecmp(str, "no-op"))
167 return (DNS_RPZ_POLICY_PASSTHRU);
168 return (DNS_RPZ_POLICY_ERROR);
172 dns_rpz_policy2str(dns_rpz_policy_t policy) {
176 case DNS_RPZ_POLICY_PASSTHRU:
179 case DNS_RPZ_POLICY_NXDOMAIN:
182 case DNS_RPZ_POLICY_NODATA:
185 case DNS_RPZ_POLICY_RECORD:
188 case DNS_RPZ_POLICY_CNAME:
189 case DNS_RPZ_POLICY_WILDCNAME:
200 * Free the radix tree of a response policy database.
203 dns_rpz_cidr_free(dns_rpz_cidr_t **cidrp) {
204 dns_rpz_cidr_node_t *cur, *child, *parent;
205 dns_rpz_cidr_t *cidr;
207 REQUIRE(cidrp != NULL);
214 while (cur != NULL) {
216 child = cur->child[0];
221 child = cur->child[1];
227 /* Delete this leaf and go up. */
228 parent = cur->parent;
232 parent->child[parent->child[1] == cur] = NULL;
233 isc_mem_put(cidr->mctx, cur, sizeof(*cur));
237 dns_name_free(&cidr->ip_name, cidr->mctx);
238 dns_name_free(&cidr->nsip_name, cidr->mctx);
239 dns_name_free(&cidr->nsdname_name, cidr->mctx);
240 isc_mem_put(cidr->mctx, cidr, sizeof(*cidr));
245 * Forget a view's list of policy zones.
248 dns_rpz_view_destroy(dns_view_t *view) {
249 dns_rpz_zone_t *zone;
251 REQUIRE(view != NULL);
253 while (!ISC_LIST_EMPTY(view->rpz_zones)) {
254 zone = ISC_LIST_HEAD(view->rpz_zones);
255 ISC_LIST_UNLINK(view->rpz_zones, zone, link);
256 if (dns_name_dynamic(&zone->origin))
257 dns_name_free(&zone->origin, view->mctx);
258 if (dns_name_dynamic(&zone->passthru))
259 dns_name_free(&zone->passthru, view->mctx);
260 if (dns_name_dynamic(&zone->nsdname))
261 dns_name_free(&zone->nsdname, view->mctx);
262 if (dns_name_dynamic(&zone->cname))
263 dns_name_free(&zone->cname, view->mctx);
264 isc_mem_put(view->mctx, zone, sizeof(*zone));
269 * Note that we have at least one response policy zone.
270 * It would be better for something to tell the rbtdb code that the
271 * zone is in at least one view's list of policy zones.
274 dns_rpz_set_need(isc_boolean_t need) {
275 have_rpz_zones = need;
279 dns_rpz_needed(void) {
280 return (have_rpz_zones);
284 * Start a new radix tree for a response policy zone.
287 dns_rpz_new_cidr(isc_mem_t *mctx, dns_name_t *origin,
288 dns_rpz_cidr_t **rbtdb_cidr)
291 dns_rpz_cidr_t *cidr;
293 REQUIRE(rbtdb_cidr != NULL && *rbtdb_cidr == NULL);
296 * Only if there is at least one response policy zone.
299 return (ISC_R_SUCCESS);
301 cidr = isc_mem_get(mctx, sizeof(*cidr));
303 return (ISC_R_NOMEMORY);
304 memset(cidr, 0, sizeof(*cidr));
307 dns_name_init(&cidr->ip_name, NULL);
308 result = dns_name_fromstring2(&cidr->ip_name, DNS_RPZ_IP_ZONE, origin,
309 DNS_NAME_DOWNCASE, mctx);
310 if (result != ISC_R_SUCCESS) {
311 isc_mem_put(mctx, cidr, sizeof(*cidr));
315 dns_name_init(&cidr->nsip_name, NULL);
316 result = dns_name_fromstring2(&cidr->nsip_name, DNS_RPZ_NSIP_ZONE,
317 origin, DNS_NAME_DOWNCASE, mctx);
318 if (result != ISC_R_SUCCESS) {
319 dns_name_free(&cidr->ip_name, mctx);
320 isc_mem_put(mctx, cidr, sizeof(*cidr));
324 dns_name_init(&cidr->nsdname_name, NULL);
325 result = dns_name_fromstring2(&cidr->nsdname_name, DNS_RPZ_NSDNAME_ZONE,
326 origin, DNS_NAME_DOWNCASE, mctx);
327 if (result != ISC_R_SUCCESS) {
328 dns_name_free(&cidr->nsip_name, mctx);
329 dns_name_free(&cidr->ip_name, mctx);
330 isc_mem_put(mctx, cidr, sizeof(*cidr));
335 return (ISC_R_SUCCESS);
339 * See if a policy zone has IP, NSIP, or NSDNAME rules or records.
342 dns_rpz_enabled(dns_rpz_cidr_t *cidr, dns_rpz_st_t *st) {
345 if (cidr->root != NULL &&
346 (cidr->root->flags & DNS_RPZ_CIDR_FG_IP) != 0)
347 st->state |= DNS_RPZ_HAVE_IP;
348 if (cidr->root != NULL &&
349 (cidr->root->flags & DNS_RPZ_CIDR_FG_NSIPv4) != 0)
350 st->state |= DNS_RPZ_HAVE_NSIPv4;
351 if (cidr->root != NULL &&
352 (cidr->root->flags & DNS_RPZ_CIDR_FG_NSIPv6) != 0)
353 st->state |= DNS_RPZ_HAVE_NSIPv6;
354 if (cidr->have_nsdname)
355 st->state |= DNS_RPZ_HAVE_NSDNAME;
358 static inline dns_rpz_cidr_flags_t
359 get_flags(const dns_rpz_cidr_key_t *ip, dns_rpz_cidr_bits_t prefix,
360 dns_rpz_type_t rpz_type)
362 if (rpz_type == DNS_RPZ_TYPE_NSIP) {
364 ip->w[0] == 0 && ip->w[1] == 0 &&
365 ip->w[2] == ADDR_V4MAPPED)
366 return (DNS_RPZ_CIDR_FG_NSIP_DATA |
367 DNS_RPZ_CIDR_FG_NSIPv4);
369 return (DNS_RPZ_CIDR_FG_NSIP_DATA |
370 DNS_RPZ_CIDR_FG_NSIPv6);
372 return (DNS_RPZ_CIDR_FG_IP | DNS_RPZ_CIDR_FG_IP_DATA);
377 * Mark a node as having IP or NSIP data and all of its parents
378 * as members of the IP or NSIP tree.
381 set_node_flags(dns_rpz_cidr_node_t *node, dns_rpz_type_t rpz_type) {
382 dns_rpz_cidr_flags_t flags;
384 flags = get_flags(&node->ip, node->bits, rpz_type);
385 node->flags |= flags;
386 flags &= ~(DNS_RPZ_CIDR_FG_NSIP_DATA | DNS_RPZ_CIDR_FG_IP_DATA);
391 node->flags |= flags;
396 * Make a radix tree node.
398 static dns_rpz_cidr_node_t *
399 new_node(dns_rpz_cidr_t *cidr, const dns_rpz_cidr_key_t *ip,
400 dns_rpz_cidr_bits_t bits, dns_rpz_cidr_flags_t flags)
402 dns_rpz_cidr_node_t *node;
405 node = isc_mem_get(cidr->mctx, sizeof(*node));
408 memset(node, 0, sizeof(*node));
410 node->flags = flags & ~(DNS_RPZ_CIDR_FG_IP_DATA |
411 DNS_RPZ_CIDR_FG_NSIP_DATA);
414 words = bits / DNS_RPZ_CIDR_WORD_BITS;
415 wlen = bits % DNS_RPZ_CIDR_WORD_BITS;
418 node->ip.w[i] = ip->w[i];
422 node->ip.w[i] = ip->w[i] & DNS_RPZ_WORD_MASK(wlen);
425 while (i < DNS_RPZ_CIDR_WORDS)
432 badname(int level, dns_name_t *name, const char *str1, const char *str2) {
433 char printname[DNS_NAME_FORMATSIZE];
435 if (level < DNS_RPZ_DEBUG_QUIET
436 && isc_log_wouldlog(dns_lctx, level)) {
437 dns_name_format(name, printname, sizeof(printname));
438 isc_log_write(dns_lctx, DNS_LOGCATEGORY_RPZ,
439 DNS_LOGMODULE_RBTDB, level,
440 "invalid rpz IP address \"%s\"%s%s",
441 printname, str1, str2);
446 * Convert an IP address from radix tree binary (host byte order) to
447 * to its canonical response policy domain name and its name in the
451 ip2name(dns_rpz_cidr_t *cidr, const dns_rpz_cidr_key_t *tgt_ip,
452 dns_rpz_cidr_bits_t tgt_prefix, dns_rpz_type_t type,
453 dns_name_t *canon_name, dns_name_t *search_name)
455 #ifndef INET6_ADDRSTRLEN
456 #define INET6_ADDRSTRLEN 46
458 int w[DNS_RPZ_CIDR_WORDS*2];
459 char str[1+8+1+INET6_ADDRSTRLEN+1];
466 if (tgt_prefix > 96 &&
469 tgt_ip->w[2] == ADDR_V4MAPPED) {
470 len = snprintf(str, sizeof(str), "%d.%d.%d.%d.%d",
473 (tgt_ip->w[3]>>8) & 0xff,
474 (tgt_ip->w[3]>>16) & 0xff,
475 (tgt_ip->w[3]>>24) & 0xff);
476 if (len == -1 || len > (int)sizeof(str))
477 return (ISC_R_FAILURE);
479 for (i = 0; i < DNS_RPZ_CIDR_WORDS; i++) {
480 w[i*2+1] = ((tgt_ip->w[DNS_RPZ_CIDR_WORDS-1-i] >> 16)
482 w[i*2] = tgt_ip->w[DNS_RPZ_CIDR_WORDS-1-i] & 0xffff;
485 len = snprintf(str, sizeof(str), "%d", tgt_prefix);
487 return (ISC_R_FAILURE);
489 while (i < DNS_RPZ_CIDR_WORDS * 2) {
490 if (w[i] != 0 || zeros
491 || i >= DNS_RPZ_CIDR_WORDS * 2 - 1
493 INSIST((size_t)len <= sizeof(str));
494 n = snprintf(&str[len], sizeof(str) - len,
497 return (ISC_R_FAILURE);
501 INSIST((size_t)len <= sizeof(str));
502 n = snprintf(&str[len], sizeof(str) - len,
505 return (ISC_R_FAILURE);
508 while (i < DNS_RPZ_CIDR_WORDS * 2 && w[i] == 0)
511 if (len > (int)sizeof(str))
512 return (ISC_R_FAILURE);
516 if (canon_name != NULL) {
517 isc__buffer_init(&buffer, str, sizeof(str));
518 isc__buffer_add(&buffer, len);
519 result = dns_name_fromtext(canon_name, &buffer,
520 dns_rootname, 0, NULL);
521 if (result != ISC_R_SUCCESS)
524 if (search_name != NULL) {
525 isc__buffer_init(&buffer, str, sizeof(str));
526 isc__buffer_add(&buffer, len);
527 if (type == DNS_RPZ_TYPE_NSIP)
528 name = &cidr->nsip_name;
530 name = &cidr->ip_name;
531 result = dns_name_fromtext(search_name, &buffer, name, 0, NULL);
532 if (result != ISC_R_SUCCESS)
535 return (ISC_R_SUCCESS);
539 * Decide which kind of IP address response policy zone a name is in.
541 static dns_rpz_type_t
542 set_type(dns_rpz_cidr_t *cidr, dns_name_t *name) {
544 if (dns_name_issubdomain(name, &cidr->ip_name))
545 return (DNS_RPZ_TYPE_IP);
548 * Require `./configure --enable-rpz-nsip` and nsdname
549 * until consistency problems are resolved.
551 #ifdef ENABLE_RPZ_NSIP
552 if (dns_name_issubdomain(name, &cidr->nsip_name))
553 return (DNS_RPZ_TYPE_NSIP);
556 #ifdef ENABLE_RPZ_NSDNAME
557 if (dns_name_issubdomain(name, &cidr->nsdname_name))
558 return (DNS_RPZ_TYPE_NSDNAME);
561 return (DNS_RPZ_TYPE_QNAME);
565 * Convert an IP address from canonical response policy domain name form
566 * to radix tree binary (host byte order).
569 name2ipkey(dns_rpz_cidr_t *cidr, int level, dns_name_t *src_name,
570 dns_rpz_type_t type, dns_rpz_cidr_key_t *tgt_ip,
571 dns_rpz_cidr_bits_t *tgt_prefix)
574 dns_fixedname_t fname;
576 char ipstr[DNS_NAME_FORMATSIZE];
577 const char *prefix_str, *cp, *end;
580 dns_rpz_cidr_bits_t bits;
581 unsigned long prefix, l;
585 * Need at least enough labels for the shortest name,
586 * :: or 128.*.RPZ_x_ZONE.rpz.LOCALHOST.
588 ip_labels = dns_name_countlabels(src_name);
589 ip_labels -= dns_name_countlabels(&cidr->ip_name);
592 badname(level, src_name, "; too short", "");
593 return (ISC_R_FAILURE);
597 * Get text for the IP address
599 dns_fixedname_init(&fname);
600 ipname = dns_fixedname_name(&fname);
601 dns_name_split(src_name, dns_name_countlabels(&cidr->ip_name),
603 dns_name_format(ipname, ipstr, sizeof(ipstr));
604 end = &ipstr[strlen(ipstr)+1];
607 prefix = strtoul(prefix_str, &cp2, 10);
609 badname(level, src_name,
610 "; invalid leading prefix length", "");
611 return (ISC_R_FAILURE);
614 if (prefix < 1U || prefix > 128U) {
615 badname(level, src_name,
616 "; invalid prefix length of ", prefix_str);
617 return (ISC_R_FAILURE);
621 if (ip_labels == 4 && !strchr(cp, 'z')) {
623 * Convert an IPv4 address
624 * from the form "prefix.w.z.y.x"
627 badname(level, src_name,
628 "; invalid IPv4 prefix length of ", prefix_str);
629 return (ISC_R_FAILURE);
632 *tgt_prefix = (dns_rpz_cidr_bits_t)prefix;
635 tgt_ip->w[2] = ADDR_V4MAPPED;
637 for (i = 0; i < 32; i += 8) {
638 l = strtoul(cp, &cp2, 10);
639 if (l > 255U || (*cp2 != '.' && *cp2 != '\0')) {
642 badname(level, src_name,
643 "; invalid IPv4 octet ", cp);
644 return (ISC_R_FAILURE);
646 tgt_ip->w[3] |= l << i;
651 * Convert a text IPv6 address.
653 *tgt_prefix = (dns_rpz_cidr_bits_t)prefix;
655 ip_labels > 0 && i < DNS_RPZ_CIDR_WORDS * 2;
657 if (cp[0] == 'z' && cp[1] == 'z' &&
658 (cp[2] == '.' || cp[2] == '\0') &&
662 tgt_ip->w[3-i/2] = 0;
664 } while (ip_labels + i <= 8);
667 l = strtoul(cp, &cp2, 16);
669 (*cp2 != '.' && *cp2 != '\0')) {
672 badname(level, src_name,
673 "; invalid IPv6 word ", cp);
674 return (ISC_R_FAILURE);
677 tgt_ip->w[3-i/2] = l;
679 tgt_ip->w[3-i/2] |= l << 16;
686 badname(level, src_name, "", "");
687 return (ISC_R_FAILURE);
691 * Check for 1s after the prefix length.
693 bits = (dns_rpz_cidr_bits_t)prefix;
694 while (bits < DNS_RPZ_CIDR_KEY_BITS) {
695 dns_rpz_cidr_word_t aword;
697 i = bits % DNS_RPZ_CIDR_WORD_BITS;
698 aword = tgt_ip->w[bits / DNS_RPZ_CIDR_WORD_BITS];
699 if ((aword & ~DNS_RPZ_WORD_MASK(i)) != 0) {
700 badname(level, src_name,
701 "; too small prefix length of ", prefix_str);
702 return (ISC_R_FAILURE);
705 bits += DNS_RPZ_CIDR_WORD_BITS;
709 * Convert the address back to a canonical policy domain name
710 * to ensure that it is in canonical form.
712 result = ip2name(cidr, tgt_ip, (dns_rpz_cidr_bits_t) prefix,
714 if (result != ISC_R_SUCCESS || !dns_name_equal(src_name, ipname)) {
715 badname(level, src_name, "; not canonical", "");
716 return (ISC_R_FAILURE);
719 return (ISC_R_SUCCESS);
723 * Find first differing bit.
726 ffbit(dns_rpz_cidr_word_t w) {
729 bit = DNS_RPZ_CIDR_WORD_BITS-1;
730 if ((w & 0xffff0000) != 0) {
734 if ((w & 0xff00) != 0) {
738 if ((w & 0xf0) != 0) {
742 if ((w & 0xc) != 0) {
752 * Find the first differing bit in two keys.
755 diff_keys(const dns_rpz_cidr_key_t *key1, dns_rpz_cidr_bits_t bits1,
756 const dns_rpz_cidr_key_t *key2, dns_rpz_cidr_bits_t bits2)
758 dns_rpz_cidr_word_t delta;
759 dns_rpz_cidr_bits_t maxbit, bit;
762 maxbit = ISC_MIN(bits1, bits2);
765 * find the first differing words
769 i++, bit += DNS_RPZ_CIDR_WORD_BITS) {
770 delta = key1->w[i] ^ key2->w[i];
776 return (ISC_MIN(bit, maxbit));
780 * Search a radix tree for an IP address for ordinary lookup
781 * or for a CIDR block adding or deleting an entry
782 * The tree read (for simple search) or write lock must be held by the caller.
784 * Return ISC_R_SUCCESS, ISC_R_NOTFOUND, DNS_R_PARTIALMATCH, ISC_R_EXISTS,
788 search(dns_rpz_cidr_t *cidr, const dns_rpz_cidr_key_t *tgt_ip,
789 dns_rpz_cidr_bits_t tgt_prefix, dns_rpz_type_t type,
790 isc_boolean_t create,
791 dns_rpz_cidr_node_t **found) /* NULL or longest match node */
793 dns_rpz_cidr_node_t *cur, *parent, *child, *new_parent, *sibling;
794 int cur_num, child_num;
795 dns_rpz_cidr_bits_t dbit;
796 dns_rpz_cidr_flags_t flags, data_flag;
797 isc_result_t find_result;
799 flags = get_flags(tgt_ip, tgt_prefix, type);
800 data_flag = flags & (DNS_RPZ_CIDR_FG_IP_DATA |
801 DNS_RPZ_CIDR_FG_NSIP_DATA);
803 find_result = ISC_R_NOTFOUND;
812 * No child so we cannot go down. Fail or
813 * add the target as a child of the current parent.
816 return (find_result);
817 child = new_node(cidr, tgt_ip, tgt_prefix, 0);
819 return (ISC_R_NOMEMORY);
823 parent->child[cur_num] = child;
824 child->parent = parent;
825 set_node_flags(child, type);
828 return (ISC_R_SUCCESS);
832 * Pretend a node not in the correct tree does not exist
833 * if we are not adding to the tree,
834 * If we are adding, then continue down to eventually
835 * add a node and mark/put this node in the correct tree.
837 if ((cur->flags & flags) == 0 && !create)
838 return (find_result);
840 dbit = diff_keys(tgt_ip, tgt_prefix, &cur->ip, cur->bits);
842 * dbit <= tgt_prefix and dbit <= cur->bits always.
843 * We are finished searching if we matched all of the target.
845 if (dbit == tgt_prefix) {
846 if (tgt_prefix == cur->bits) {
848 * The current node matches the target exactly.
849 * It is the answer if it has data.
851 if ((cur->flags & data_flag) != 0) {
853 return (ISC_R_EXISTS);
856 return (ISC_R_SUCCESS);
859 * The node had no data but does now.
861 set_node_flags(cur, type);
864 return (ISC_R_SUCCESS);
866 return (find_result);
870 * We know tgt_prefix < cur_bits which means that
871 * the target is shorter than the current node.
872 * Add the target as the current node's parent.
875 return (find_result);
877 new_parent = new_node(cidr, tgt_ip, tgt_prefix,
879 if (new_parent == NULL)
880 return (ISC_R_NOMEMORY);
881 new_parent->parent = parent;
883 cidr->root = new_parent;
885 parent->child[cur_num] = new_parent;
886 child_num = DNS_RPZ_IP_BIT(&cur->ip, tgt_prefix+1);
887 new_parent->child[child_num] = cur;
888 cur->parent = new_parent;
889 set_node_flags(new_parent, type);
892 return (ISC_R_SUCCESS);
895 if (dbit == cur->bits) {
897 * We have a partial match by matching of all of the
898 * current node but only part of the target.
901 if ((cur->flags & data_flag) != 0) {
902 find_result = DNS_R_PARTIALMATCH;
908 cur_num = DNS_RPZ_IP_BIT(tgt_ip, dbit);
909 cur = cur->child[cur_num];
915 * dbit < tgt_prefix and dbit < cur->bits,
916 * so we failed to match both the target and the current node.
917 * Insert a fork of a parent above the current node and
918 * add the target as a sibling of the current node
921 return (find_result);
923 sibling = new_node(cidr, tgt_ip, tgt_prefix, 0);
925 return (ISC_R_NOMEMORY);
926 new_parent = new_node(cidr, tgt_ip, dbit, cur->flags);
927 if (new_parent == NULL) {
928 isc_mem_put(cidr->mctx, sibling, sizeof(*sibling));
929 return (ISC_R_NOMEMORY);
931 new_parent->parent = parent;
933 cidr->root = new_parent;
935 parent->child[cur_num] = new_parent;
936 child_num = DNS_RPZ_IP_BIT(tgt_ip, dbit);
937 new_parent->child[child_num] = sibling;
938 new_parent->child[1-child_num] = cur;
939 cur->parent = new_parent;
940 sibling->parent = new_parent;
941 set_node_flags(sibling, type);
944 return (ISC_R_SUCCESS);
949 * Add an IP address to the radix tree of a response policy database.
950 * The tree write lock must be held by the caller.
953 dns_rpz_cidr_addip(dns_rpz_cidr_t *cidr, dns_name_t *name) {
955 dns_rpz_cidr_key_t tgt_ip;
956 dns_rpz_cidr_bits_t tgt_prefix;
963 * No worries if the new name is not an IP address.
965 type = set_type(cidr, name);
967 case DNS_RPZ_TYPE_IP:
968 case DNS_RPZ_TYPE_NSIP:
970 case DNS_RPZ_TYPE_NSDNAME:
971 cidr->have_nsdname = ISC_TRUE;
973 case DNS_RPZ_TYPE_QNAME:
974 case DNS_RPZ_TYPE_BAD:
977 result = name2ipkey(cidr, DNS_RPZ_ERROR_LEVEL, name,
978 type, &tgt_ip, &tgt_prefix);
979 if (result != ISC_R_SUCCESS)
982 result = search(cidr, &tgt_ip, tgt_prefix, type, ISC_TRUE, NULL);
983 if (result == ISC_R_EXISTS &&
984 isc_log_wouldlog(dns_lctx, DNS_RPZ_ERROR_LEVEL))
986 char printname[DNS_NAME_FORMATSIZE];
988 dns_name_format(name, printname, sizeof(printname));
989 isc_log_write(dns_lctx, DNS_LOGCATEGORY_RPZ,
990 DNS_LOGMODULE_RBTDB, DNS_RPZ_ERROR_LEVEL,
991 "rpz add failed; \"%s\" is a duplicate name",
997 * Delete an IP address from the radix tree of a response policy database.
998 * The tree write lock must be held by the caller.
1001 dns_rpz_cidr_deleteip(dns_rpz_cidr_t *cidr, dns_name_t *name) {
1002 isc_result_t result;
1003 dns_rpz_cidr_key_t tgt_ip;
1004 dns_rpz_cidr_bits_t tgt_prefix;
1005 dns_rpz_type_t type;
1006 dns_rpz_cidr_node_t *tgt = NULL, *parent, *child;
1007 dns_rpz_cidr_flags_t flags, data_flag;
1013 * Decide which kind of policy zone IP address it is, if either
1014 * and then find its node.
1016 type = set_type(cidr, name);
1018 case DNS_RPZ_TYPE_IP:
1019 case DNS_RPZ_TYPE_NSIP:
1021 case DNS_RPZ_TYPE_NSDNAME:
1023 * We cannot easily count nsdnames because
1024 * internal rbt nodes get deleted.
1027 case DNS_RPZ_TYPE_QNAME:
1028 case DNS_RPZ_TYPE_BAD:
1033 * Do not get excited about the deletion of interior rbt nodes.
1035 result = name2ipkey(cidr, DNS_RPZ_DEBUG_QUIET, name,
1036 type, &tgt_ip, &tgt_prefix);
1037 if (result != ISC_R_SUCCESS)
1040 result = search(cidr, &tgt_ip, tgt_prefix, type, ISC_FALSE, &tgt);
1041 if (result != ISC_R_SUCCESS) {
1042 badname(DNS_RPZ_ERROR_LEVEL, name, "; missing rpz node", "");
1047 * Mark the node and its parents to reflect the deleted IP address.
1049 flags = get_flags(&tgt_ip, tgt_prefix, type);
1050 data_flag = flags & (DNS_RPZ_CIDR_FG_IP_DATA |
1051 DNS_RPZ_CIDR_FG_NSIP_DATA);
1052 tgt->flags &= ~data_flag;
1053 for (parent = tgt; parent != NULL; parent = parent->parent) {
1054 if ((parent->flags & data_flag) != 0 ||
1055 (parent->child[0] != NULL &&
1056 (parent->child[0]->flags & flags) != 0) ||
1057 (parent->child[1] != NULL &&
1058 (parent->child[1]->flags & flags) != 0))
1060 parent->flags &= ~flags;
1064 * We might need to delete 2 nodes.
1068 * The node is now useless if it has no data of its own
1069 * and 0 or 1 children. We are finished if it is not useless.
1071 if ((child = tgt->child[0]) != NULL) {
1072 if (tgt->child[1] != NULL)
1075 child = tgt->child[1];
1077 if ((tgt->flags & (DNS_RPZ_CIDR_FG_IP_DATA |
1078 DNS_RPZ_CIDR_FG_NSIP_DATA)) != 0)
1082 * Replace the pointer to this node in the parent with
1083 * the remaining child or NULL.
1085 parent = tgt->parent;
1086 if (parent == NULL) {
1089 parent->child[parent->child[1] == tgt] = child;
1092 * If the child exists fix up its parent pointer.
1095 child->parent = parent;
1096 isc_mem_put(cidr->mctx, tgt, sizeof(*tgt));
1099 } while (tgt != NULL);
1103 * Caller must hold tree lock.
1104 * Return ISC_R_NOTFOUND
1105 * or ISC_R_SUCCESS and the found entry's canonical and search names
1106 * and its prefix length
1109 dns_rpz_cidr_find(dns_rpz_cidr_t *cidr, const isc_netaddr_t *netaddr,
1110 dns_rpz_type_t type, dns_name_t *canon_name,
1111 dns_name_t *search_name, dns_rpz_cidr_bits_t *prefix)
1113 dns_rpz_cidr_key_t tgt_ip;
1114 isc_result_t result;
1115 dns_rpz_cidr_node_t *found;
1119 * Convert IP address to CIDR tree key.
1121 if (netaddr->family == AF_INET) {
1124 tgt_ip.w[2] = ADDR_V4MAPPED;
1125 tgt_ip.w[3] = ntohl(netaddr->type.in.s_addr);
1126 } else if (netaddr->family == AF_INET6) {
1127 dns_rpz_cidr_key_t src_ip6;
1130 * Given the int aligned struct in_addr member of netaddr->type
1131 * one could cast netaddr->type.in6 to dns_rpz_cidr_key_t *,
1132 * but there are objections.
1134 memcpy(src_ip6.w, &netaddr->type.in6, sizeof(src_ip6.w));
1135 for (i = 0; i < 4; i++) {
1136 tgt_ip.w[i] = ntohl(src_ip6.w[i]);
1139 return (ISC_R_NOTFOUND);
1142 result = search(cidr, &tgt_ip, 128, type, ISC_FALSE, &found);
1143 if (result != ISC_R_SUCCESS && result != DNS_R_PARTIALMATCH)
1146 *prefix = found->bits;
1147 return (ip2name(cidr, &found->ip, found->bits, type,
1148 canon_name, search_name));
1152 * Translate CNAME rdata to a QNAME response policy action.
1155 dns_rpz_decode_cname(dns_rpz_zone_t *rpz, dns_rdataset_t *rdataset,
1156 dns_name_t *selfname)
1158 dns_rdata_t rdata = DNS_RDATA_INIT;
1159 dns_rdata_cname_t cname;
1160 isc_result_t result;
1162 result = dns_rdataset_first(rdataset);
1163 RUNTIME_CHECK(result == ISC_R_SUCCESS);
1164 dns_rdataset_current(rdataset, &rdata);
1165 result = dns_rdata_tostruct(&rdata, &cname, NULL);
1166 RUNTIME_CHECK(result == ISC_R_SUCCESS);
1167 dns_rdata_reset(&rdata);
1170 * CNAME . means NXDOMAIN
1172 if (dns_name_equal(&cname.cname, dns_rootname))
1173 return (DNS_RPZ_POLICY_NXDOMAIN);
1175 if (dns_name_iswildcard(&cname.cname)) {
1177 * CNAME *. means NODATA
1179 if (dns_name_countlabels(&cname.cname) == 2)
1180 return (DNS_RPZ_POLICY_NODATA);
1183 * A qname of www.evil.com and a policy of
1184 * *.evil.com CNAME *.garden.net
1186 * evil.com CNAME evil.com.garden.net
1188 if (dns_name_countlabels(&cname.cname) > 2)
1189 return (DNS_RPZ_POLICY_WILDCNAME);
1193 * CNAME PASSTHRU.origin means "do not rewrite.
1195 if (dns_name_equal(&cname.cname, &rpz->passthru))
1196 return (DNS_RPZ_POLICY_PASSTHRU);
1199 * 128.1.0.127.rpz-ip CNAME 128.1.0.0.127. is obsolete PASSTHRU
1201 if (selfname != NULL && dns_name_equal(&cname.cname, selfname))
1202 return (DNS_RPZ_POLICY_PASSTHRU);
1205 * Any other rdata gives a response consisting of the rdata.
1207 return (DNS_RPZ_POLICY_RECORD);