2 * Copyright (C) 2011-2014 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.
24 #include <isc/buffer.h>
27 #include <isc/netaddr.h>
28 #include <isc/print.h>
29 #include <isc/stdlib.h>
30 #include <isc/string.h>
34 #include <dns/fixedname.h>
36 #include <dns/rdata.h>
37 #include <dns/rdataset.h>
38 #include <dns/rdatastruct.h>
39 #include <dns/result.h>
45 * Parallel radix trees for databases of response policy IP addresses
47 * The radix or Patricia trees are somewhat specialized to handle response
48 * policy addresses by representing the two test of IP IP addresses and name
49 * server IP addresses in a single tree.
51 * Each leaf indicates that an IP address is listed in the IP address or the
52 * name server IP address policy sub-zone (or both) of the corresponding
53 * response response zone. The policy data such as a CNAME or an A record
54 * is kept in the policy zone. After an IP address has been found in a radix
55 * tree, the node in the policy zone's database is found by converting
56 * the IP address to a domain name in a canonical form.
58 * The response policy zone canonical form of IPv6 addresses is one of:
59 * prefix.W.W.W.W.W.W.W.W
61 * prefix.WORDS.zz.WORDS
64 * prefix is the prefix length of the IPv6 address between 1 and 128
65 * W is a number between 0 and 65535
66 * WORDS is one or more numbers W separated with "."
67 * zz corresponds to :: in the standard IPv6 text representation
69 * The canonical form of IPv4 addresses is:
72 * prefix is the prefix length of the address between 1 and 32
73 * B is a number between 0 and 255
75 * IPv4 addresses are distinguished from IPv6 addresses by having
76 * 5 labels all of which are numbers, and a prefix between 1 and 32.
81 * Use a private definition of IPv6 addresses because s6_addr32 is not
82 * always defined and our IPv6 addresses are in non-standard byte order
84 typedef isc_uint32_t dns_rpz_cidr_word_t;
85 #define DNS_RPZ_CIDR_WORD_BITS ((int)sizeof(dns_rpz_cidr_word_t)*8)
86 #define DNS_RPZ_CIDR_KEY_BITS ((int)sizeof(dns_rpz_cidr_key_t)*8)
87 #define DNS_RPZ_CIDR_WORDS (128/DNS_RPZ_CIDR_WORD_BITS)
89 dns_rpz_cidr_word_t w[DNS_RPZ_CIDR_WORDS];
92 #define ADDR_V4MAPPED 0xffff
94 #define DNS_RPZ_WORD_MASK(b) \
95 ((b) == 0 ? (dns_rpz_cidr_word_t)(-1) \
96 : ((dns_rpz_cidr_word_t)(-1) \
97 << (DNS_RPZ_CIDR_WORD_BITS - (b))))
99 #define DNS_RPZ_IP_BIT(ip, bitno) \
100 (1 & ((ip)->w[(bitno)/DNS_RPZ_CIDR_WORD_BITS] >> \
101 (DNS_RPZ_CIDR_WORD_BITS - 1 - ((bitno) % DNS_RPZ_CIDR_WORD_BITS))))
103 typedef struct dns_rpz_cidr_node dns_rpz_cidr_node_t;
104 typedef isc_uint8_t dns_rpz_cidr_flags_t;
105 struct dns_rpz_cidr_node {
106 dns_rpz_cidr_node_t *parent;
107 dns_rpz_cidr_node_t *child[2];
108 dns_rpz_cidr_key_t ip;
109 dns_rpz_cidr_bits_t bits;
110 dns_rpz_cidr_flags_t flags;
111 #define DNS_RPZ_CIDR_FG_IP 0x01 /* has IP data or is parent of IP */
112 #define DNS_RPZ_CIDR_FG_IP_DATA 0x02 /* has IP data */
113 #define DNS_RPZ_CIDR_FG_NSIPv4 0x04 /* has or is parent of NSIPv4 data */
114 #define DNS_RPZ_CIDR_FG_NSIPv6 0x08 /* has or is parent of NSIPv6 data */
115 #define DNS_RPZ_CIDR_FG_NSIP_DATA 0x10 /* has NSIP data */
118 struct dns_rpz_cidr {
120 isc_boolean_t have_nsdname; /* zone has NSDNAME record */
121 dns_rpz_cidr_node_t *root;
122 dns_name_t ip_name; /* RPZ_IP_ZONE.origin. */
123 dns_name_t nsip_name; /* RPZ_NSIP_ZONE.origin. */
124 dns_name_t nsdname_name; /* RPZ_NSDNAME_ZONE.origin */
128 dns_rpz_type2str(dns_rpz_type_t type) {
130 case DNS_RPZ_TYPE_QNAME:
132 case DNS_RPZ_TYPE_IP:
134 case DNS_RPZ_TYPE_NSIP:
136 case DNS_RPZ_TYPE_NSDNAME:
138 case DNS_RPZ_TYPE_BAD:
141 FATAL_ERROR(__FILE__, __LINE__,
142 "impossible rpz type %d", type);
143 return ("impossible");
147 dns_rpz_str2policy(const char *str) {
149 return (DNS_RPZ_POLICY_ERROR);
150 if (!strcasecmp(str, "given"))
151 return (DNS_RPZ_POLICY_GIVEN);
152 if (!strcasecmp(str, "disabled"))
153 return (DNS_RPZ_POLICY_DISABLED);
154 if (!strcasecmp(str, "passthru"))
155 return (DNS_RPZ_POLICY_PASSTHRU);
156 if (!strcasecmp(str, "nxdomain"))
157 return (DNS_RPZ_POLICY_NXDOMAIN);
158 if (!strcasecmp(str, "nodata"))
159 return (DNS_RPZ_POLICY_NODATA);
160 if (!strcasecmp(str, "cname"))
161 return (DNS_RPZ_POLICY_CNAME);
165 if (!strcasecmp(str, "no-op"))
166 return (DNS_RPZ_POLICY_PASSTHRU);
167 return (DNS_RPZ_POLICY_ERROR);
171 dns_rpz_policy2str(dns_rpz_policy_t policy) {
175 case DNS_RPZ_POLICY_PASSTHRU:
178 case DNS_RPZ_POLICY_NXDOMAIN:
181 case DNS_RPZ_POLICY_NODATA:
184 case DNS_RPZ_POLICY_RECORD:
187 case DNS_RPZ_POLICY_CNAME:
188 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 * Start a new radix tree for a response policy zone.
272 dns_rpz_new_cidr(isc_mem_t *mctx, dns_name_t *origin,
273 dns_rpz_cidr_t **rbtdb_cidr)
276 dns_rpz_cidr_t *cidr;
278 REQUIRE(rbtdb_cidr != NULL && *rbtdb_cidr == NULL);
280 cidr = isc_mem_get(mctx, sizeof(*cidr));
282 return (ISC_R_NOMEMORY);
283 memset(cidr, 0, sizeof(*cidr));
286 dns_name_init(&cidr->ip_name, NULL);
287 result = dns_name_fromstring2(&cidr->ip_name, DNS_RPZ_IP_ZONE, origin,
288 DNS_NAME_DOWNCASE, mctx);
289 if (result != ISC_R_SUCCESS) {
290 isc_mem_put(mctx, cidr, sizeof(*cidr));
294 dns_name_init(&cidr->nsip_name, NULL);
295 result = dns_name_fromstring2(&cidr->nsip_name, DNS_RPZ_NSIP_ZONE,
296 origin, DNS_NAME_DOWNCASE, mctx);
297 if (result != ISC_R_SUCCESS) {
298 dns_name_free(&cidr->ip_name, mctx);
299 isc_mem_put(mctx, cidr, sizeof(*cidr));
303 dns_name_init(&cidr->nsdname_name, NULL);
304 result = dns_name_fromstring2(&cidr->nsdname_name, DNS_RPZ_NSDNAME_ZONE,
305 origin, DNS_NAME_DOWNCASE, mctx);
306 if (result != ISC_R_SUCCESS) {
307 dns_name_free(&cidr->nsip_name, mctx);
308 dns_name_free(&cidr->ip_name, mctx);
309 isc_mem_put(mctx, cidr, sizeof(*cidr));
314 return (ISC_R_SUCCESS);
318 * See if a policy zone has IP, NSIP, or NSDNAME rules or records.
321 dns_rpz_enabled_get(dns_rpz_cidr_t *cidr, dns_rpz_st_t *st) {
324 if (cidr->root != NULL &&
325 (cidr->root->flags & DNS_RPZ_CIDR_FG_IP) != 0)
326 st->state |= DNS_RPZ_HAVE_IP;
327 if (cidr->root != NULL &&
328 (cidr->root->flags & DNS_RPZ_CIDR_FG_NSIPv4) != 0)
329 st->state |= DNS_RPZ_HAVE_NSIPv4;
330 if (cidr->root != NULL &&
331 (cidr->root->flags & DNS_RPZ_CIDR_FG_NSIPv6) != 0)
332 st->state |= DNS_RPZ_HAVE_NSIPv6;
333 if (cidr->have_nsdname)
334 st->state |= DNS_RPZ_HAVE_NSDNAME;
337 static inline dns_rpz_cidr_flags_t
338 get_flags(const dns_rpz_cidr_key_t *ip, dns_rpz_cidr_bits_t prefix,
339 dns_rpz_type_t rpz_type)
341 if (rpz_type == DNS_RPZ_TYPE_NSIP) {
343 ip->w[0] == 0 && ip->w[1] == 0 &&
344 ip->w[2] == ADDR_V4MAPPED)
345 return (DNS_RPZ_CIDR_FG_NSIP_DATA |
346 DNS_RPZ_CIDR_FG_NSIPv4);
348 return (DNS_RPZ_CIDR_FG_NSIP_DATA |
349 DNS_RPZ_CIDR_FG_NSIPv6);
351 return (DNS_RPZ_CIDR_FG_IP | DNS_RPZ_CIDR_FG_IP_DATA);
356 * Mark a node as having IP or NSIP data and all of its parents
357 * as members of the IP or NSIP tree.
360 set_node_flags(dns_rpz_cidr_node_t *node, dns_rpz_type_t rpz_type) {
361 dns_rpz_cidr_flags_t flags;
363 flags = get_flags(&node->ip, node->bits, rpz_type);
364 node->flags |= flags;
365 flags &= ~(DNS_RPZ_CIDR_FG_NSIP_DATA | DNS_RPZ_CIDR_FG_IP_DATA);
370 node->flags |= flags;
375 * Make a radix tree node.
377 static dns_rpz_cidr_node_t *
378 new_node(dns_rpz_cidr_t *cidr, const dns_rpz_cidr_key_t *ip,
379 dns_rpz_cidr_bits_t bits, dns_rpz_cidr_flags_t flags)
381 dns_rpz_cidr_node_t *node;
384 node = isc_mem_get(cidr->mctx, sizeof(*node));
387 memset(node, 0, sizeof(*node));
389 node->flags = flags & ~(DNS_RPZ_CIDR_FG_IP_DATA |
390 DNS_RPZ_CIDR_FG_NSIP_DATA);
393 words = bits / DNS_RPZ_CIDR_WORD_BITS;
394 wlen = bits % DNS_RPZ_CIDR_WORD_BITS;
397 node->ip.w[i] = ip->w[i];
401 node->ip.w[i] = ip->w[i] & DNS_RPZ_WORD_MASK(wlen);
404 while (i < DNS_RPZ_CIDR_WORDS)
411 badname(int level, dns_name_t *name, const char *str1, const char *str2) {
412 char printname[DNS_NAME_FORMATSIZE];
415 * bin/tests/system/rpz/tests.sh looks for "invalid rpz".
417 if (level < DNS_RPZ_DEBUG_QUIET
418 && isc_log_wouldlog(dns_lctx, level)) {
419 dns_name_format(name, printname, sizeof(printname));
420 isc_log_write(dns_lctx, DNS_LOGCATEGORY_RPZ,
421 DNS_LOGMODULE_RBTDB, level,
422 "invalid rpz IP address \"%s\"%s%s",
423 printname, str1, str2);
428 * Convert an IP address from radix tree binary (host byte order) to
429 * to its canonical response policy domain name and its name in the
433 ip2name(dns_rpz_cidr_t *cidr, const dns_rpz_cidr_key_t *tgt_ip,
434 dns_rpz_cidr_bits_t tgt_prefix, dns_rpz_type_t type,
435 dns_name_t *canon_name, dns_name_t *search_name)
437 #ifndef INET6_ADDRSTRLEN
438 #define INET6_ADDRSTRLEN 46
440 int w[DNS_RPZ_CIDR_WORDS*2];
441 char str[1+8+1+INET6_ADDRSTRLEN+1];
448 if (tgt_prefix > 96 &&
451 tgt_ip->w[2] == ADDR_V4MAPPED) {
452 len = snprintf(str, sizeof(str), "%d.%d.%d.%d.%d",
455 (tgt_ip->w[3]>>8) & 0xff,
456 (tgt_ip->w[3]>>16) & 0xff,
457 (tgt_ip->w[3]>>24) & 0xff);
458 if (len == -1 || len > (int)sizeof(str))
459 return (ISC_R_FAILURE);
461 for (i = 0; i < DNS_RPZ_CIDR_WORDS; i++) {
462 w[i*2+1] = ((tgt_ip->w[DNS_RPZ_CIDR_WORDS-1-i] >> 16)
464 w[i*2] = tgt_ip->w[DNS_RPZ_CIDR_WORDS-1-i] & 0xffff;
467 len = snprintf(str, sizeof(str), "%d", tgt_prefix);
469 return (ISC_R_FAILURE);
471 while (i < DNS_RPZ_CIDR_WORDS * 2) {
472 if (w[i] != 0 || zeros
473 || i >= DNS_RPZ_CIDR_WORDS * 2 - 1
475 INSIST((size_t)len <= sizeof(str));
476 n = snprintf(&str[len], sizeof(str) - len,
479 return (ISC_R_FAILURE);
483 INSIST((size_t)len <= sizeof(str));
484 n = snprintf(&str[len], sizeof(str) - len,
487 return (ISC_R_FAILURE);
490 while (i < DNS_RPZ_CIDR_WORDS * 2 && w[i] == 0)
493 if (len >= (int)sizeof(str))
494 return (ISC_R_FAILURE);
498 if (canon_name != NULL) {
499 isc__buffer_init(&buffer, str, sizeof(str));
500 isc__buffer_add(&buffer, len);
501 result = dns_name_fromtext(canon_name, &buffer,
502 dns_rootname, 0, NULL);
503 if (result != ISC_R_SUCCESS)
506 if (search_name != NULL) {
507 isc__buffer_init(&buffer, str, sizeof(str));
508 isc__buffer_add(&buffer, len);
509 if (type == DNS_RPZ_TYPE_NSIP)
510 name = &cidr->nsip_name;
512 name = &cidr->ip_name;
513 result = dns_name_fromtext(search_name, &buffer, name, 0, NULL);
514 if (result != ISC_R_SUCCESS)
517 return (ISC_R_SUCCESS);
521 * Decide which kind of IP address response policy zone a name is in.
523 static dns_rpz_type_t
524 set_type(dns_rpz_cidr_t *cidr, dns_name_t *name) {
526 if (dns_name_issubdomain(name, &cidr->ip_name))
527 return (DNS_RPZ_TYPE_IP);
530 * Require `./configure --enable-rpz-nsip` and nsdname
531 * until consistency problems are resolved.
533 #ifdef ENABLE_RPZ_NSIP
534 if (dns_name_issubdomain(name, &cidr->nsip_name))
535 return (DNS_RPZ_TYPE_NSIP);
538 #ifdef ENABLE_RPZ_NSDNAME
539 if (dns_name_issubdomain(name, &cidr->nsdname_name))
540 return (DNS_RPZ_TYPE_NSDNAME);
543 return (DNS_RPZ_TYPE_QNAME);
547 * Convert an IP address from canonical response policy domain name form
548 * to radix tree binary (host byte order).
551 name2ipkey(dns_rpz_cidr_t *cidr, int level, dns_name_t *src_name,
552 dns_rpz_type_t type, dns_rpz_cidr_key_t *tgt_ip,
553 dns_rpz_cidr_bits_t *tgt_prefix)
556 dns_fixedname_t fname;
558 char ipstr[DNS_NAME_FORMATSIZE];
559 const char *prefix_str, *cp, *end;
562 dns_rpz_cidr_bits_t bits;
563 unsigned long prefix, l;
567 * Need at least enough labels for the shortest name,
568 * :: or 128.*.RPZ_x_ZONE.rpz.LOCALHOST.
570 ip_labels = dns_name_countlabels(src_name);
571 ip_labels -= dns_name_countlabels(&cidr->ip_name);
574 badname(level, src_name, "; too short", "");
575 return (ISC_R_FAILURE);
579 * Get text for the IP address
581 dns_fixedname_init(&fname);
582 ipname = dns_fixedname_name(&fname);
583 dns_name_split(src_name, dns_name_countlabels(&cidr->ip_name),
585 dns_name_format(ipname, ipstr, sizeof(ipstr));
586 end = &ipstr[strlen(ipstr)+1];
589 prefix = strtoul(prefix_str, &cp2, 10);
591 badname(level, src_name,
592 "; invalid leading prefix length", "");
593 return (ISC_R_FAILURE);
596 if (prefix < 1U || prefix > 128U) {
597 badname(level, src_name,
598 "; invalid prefix length of ", prefix_str);
599 return (ISC_R_FAILURE);
603 if (ip_labels == 4 && !strchr(cp, 'z')) {
605 * Convert an IPv4 address
606 * from the form "prefix.w.z.y.x"
609 badname(level, src_name,
610 "; invalid IPv4 prefix length of ", prefix_str);
611 return (ISC_R_FAILURE);
614 *tgt_prefix = (dns_rpz_cidr_bits_t)prefix;
617 tgt_ip->w[2] = ADDR_V4MAPPED;
619 for (i = 0; i < 32; i += 8) {
620 l = strtoul(cp, &cp2, 10);
621 if (l > 255U || (*cp2 != '.' && *cp2 != '\0')) {
624 badname(level, src_name,
625 "; invalid IPv4 octet ", cp);
626 return (ISC_R_FAILURE);
628 tgt_ip->w[3] |= l << i;
633 * Convert a text IPv6 address.
635 *tgt_prefix = (dns_rpz_cidr_bits_t)prefix;
637 ip_labels > 0 && i < DNS_RPZ_CIDR_WORDS * 2;
639 if (cp[0] == 'z' && cp[1] == 'z' &&
640 (cp[2] == '.' || cp[2] == '\0') &&
644 tgt_ip->w[3-i/2] = 0;
646 } while (ip_labels + i <= 8);
649 l = strtoul(cp, &cp2, 16);
651 (*cp2 != '.' && *cp2 != '\0')) {
654 badname(level, src_name,
655 "; invalid IPv6 word ", cp);
656 return (ISC_R_FAILURE);
659 tgt_ip->w[3-i/2] = l;
661 tgt_ip->w[3-i/2] |= l << 16;
668 badname(level, src_name, "", "");
669 return (ISC_R_FAILURE);
673 * Check for 1s after the prefix length.
675 bits = (dns_rpz_cidr_bits_t)prefix;
676 while (bits < DNS_RPZ_CIDR_KEY_BITS) {
677 dns_rpz_cidr_word_t aword;
679 i = bits % DNS_RPZ_CIDR_WORD_BITS;
680 aword = tgt_ip->w[bits / DNS_RPZ_CIDR_WORD_BITS];
681 if ((aword & ~DNS_RPZ_WORD_MASK(i)) != 0) {
682 badname(level, src_name,
683 "; too small prefix length of ", prefix_str);
684 return (ISC_R_FAILURE);
687 bits += DNS_RPZ_CIDR_WORD_BITS;
691 * Convert the address back to a canonical policy domain name
692 * to ensure that it is in canonical form.
694 result = ip2name(cidr, tgt_ip, (dns_rpz_cidr_bits_t) prefix,
696 if (result != ISC_R_SUCCESS || !dns_name_equal(src_name, ipname)) {
697 badname(level, src_name, "; not canonical", "");
698 return (ISC_R_FAILURE);
701 return (ISC_R_SUCCESS);
705 * Find first differing bit.
708 ffbit(dns_rpz_cidr_word_t w) {
711 bit = DNS_RPZ_CIDR_WORD_BITS-1;
712 if ((w & 0xffff0000) != 0) {
716 if ((w & 0xff00) != 0) {
720 if ((w & 0xf0) != 0) {
724 if ((w & 0xc) != 0) {
734 * Find the first differing bit in two keys.
737 diff_keys(const dns_rpz_cidr_key_t *key1, dns_rpz_cidr_bits_t bits1,
738 const dns_rpz_cidr_key_t *key2, dns_rpz_cidr_bits_t bits2)
740 dns_rpz_cidr_word_t delta;
741 dns_rpz_cidr_bits_t maxbit, bit;
744 maxbit = ISC_MIN(bits1, bits2);
747 * find the first differing words
751 i++, bit += DNS_RPZ_CIDR_WORD_BITS) {
752 delta = key1->w[i] ^ key2->w[i];
758 return (ISC_MIN(bit, maxbit));
762 * Search a radix tree for an IP address for ordinary lookup
763 * or for a CIDR block adding or deleting an entry
764 * The tree read (for simple search) or write lock must be held by the caller.
766 * Return ISC_R_SUCCESS, ISC_R_NOTFOUND, DNS_R_PARTIALMATCH, ISC_R_EXISTS,
770 search(dns_rpz_cidr_t *cidr, const dns_rpz_cidr_key_t *tgt_ip,
771 dns_rpz_cidr_bits_t tgt_prefix, dns_rpz_type_t type,
772 isc_boolean_t create,
773 dns_rpz_cidr_node_t **found) /* NULL or longest match node */
775 dns_rpz_cidr_node_t *cur, *parent, *child, *new_parent, *sibling;
776 int cur_num, child_num;
777 dns_rpz_cidr_bits_t dbit;
778 dns_rpz_cidr_flags_t flags, data_flag;
779 isc_result_t find_result;
781 flags = get_flags(tgt_ip, tgt_prefix, type);
782 data_flag = flags & (DNS_RPZ_CIDR_FG_IP_DATA |
783 DNS_RPZ_CIDR_FG_NSIP_DATA);
785 find_result = ISC_R_NOTFOUND;
794 * No child so we cannot go down. Fail or
795 * add the target as a child of the current parent.
798 return (find_result);
799 child = new_node(cidr, tgt_ip, tgt_prefix, 0);
801 return (ISC_R_NOMEMORY);
805 parent->child[cur_num] = child;
806 child->parent = parent;
807 set_node_flags(child, type);
810 return (ISC_R_SUCCESS);
814 * Pretend a node not in the correct tree does not exist
815 * if we are not adding to the tree,
816 * If we are adding, then continue down to eventually
817 * add a node and mark/put this node in the correct tree.
819 if ((cur->flags & flags) == 0 && !create)
820 return (find_result);
822 dbit = diff_keys(tgt_ip, tgt_prefix, &cur->ip, cur->bits);
824 * dbit <= tgt_prefix and dbit <= cur->bits always.
825 * We are finished searching if we matched all of the target.
827 if (dbit == tgt_prefix) {
828 if (tgt_prefix == cur->bits) {
830 * The current node matches the target exactly.
831 * It is the answer if it has data.
833 if ((cur->flags & data_flag) != 0) {
835 return (ISC_R_EXISTS);
838 return (ISC_R_SUCCESS);
841 * The node had no data but does now.
843 set_node_flags(cur, type);
846 return (ISC_R_SUCCESS);
848 return (find_result);
852 * We know tgt_prefix < cur_bits which means that
853 * the target is shorter than the current node.
854 * Add the target as the current node's parent.
857 return (find_result);
859 new_parent = new_node(cidr, tgt_ip, tgt_prefix,
861 if (new_parent == NULL)
862 return (ISC_R_NOMEMORY);
863 new_parent->parent = parent;
865 cidr->root = new_parent;
867 parent->child[cur_num] = new_parent;
868 child_num = DNS_RPZ_IP_BIT(&cur->ip, tgt_prefix+1);
869 new_parent->child[child_num] = cur;
870 cur->parent = new_parent;
871 set_node_flags(new_parent, type);
874 return (ISC_R_SUCCESS);
877 if (dbit == cur->bits) {
879 * We have a partial match by matching of all of the
880 * current node but only part of the target.
883 if ((cur->flags & data_flag) != 0) {
884 find_result = DNS_R_PARTIALMATCH;
890 cur_num = DNS_RPZ_IP_BIT(tgt_ip, dbit);
891 cur = cur->child[cur_num];
897 * dbit < tgt_prefix and dbit < cur->bits,
898 * so we failed to match both the target and the current node.
899 * Insert a fork of a parent above the current node and
900 * add the target as a sibling of the current node
903 return (find_result);
905 sibling = new_node(cidr, tgt_ip, tgt_prefix, 0);
907 return (ISC_R_NOMEMORY);
908 new_parent = new_node(cidr, tgt_ip, dbit, cur->flags);
909 if (new_parent == NULL) {
910 isc_mem_put(cidr->mctx, sibling, sizeof(*sibling));
911 return (ISC_R_NOMEMORY);
913 new_parent->parent = parent;
915 cidr->root = new_parent;
917 parent->child[cur_num] = new_parent;
918 child_num = DNS_RPZ_IP_BIT(tgt_ip, dbit);
919 new_parent->child[child_num] = sibling;
920 new_parent->child[1-child_num] = cur;
921 cur->parent = new_parent;
922 sibling->parent = new_parent;
923 set_node_flags(sibling, type);
926 return (ISC_R_SUCCESS);
931 * Add an IP address to the radix tree of a response policy database.
932 * The tree write lock must be held by the caller.
935 dns_rpz_cidr_addip(dns_rpz_cidr_t *cidr, dns_name_t *name) {
937 dns_rpz_cidr_key_t tgt_ip;
938 dns_rpz_cidr_bits_t tgt_prefix;
941 REQUIRE(cidr != NULL);
944 * No worries if the new name is not an IP address.
946 type = set_type(cidr, name);
948 case DNS_RPZ_TYPE_IP:
949 case DNS_RPZ_TYPE_NSIP:
951 case DNS_RPZ_TYPE_NSDNAME:
952 cidr->have_nsdname = ISC_TRUE;
954 case DNS_RPZ_TYPE_QNAME:
955 case DNS_RPZ_TYPE_BAD:
958 result = name2ipkey(cidr, DNS_RPZ_ERROR_LEVEL, name,
959 type, &tgt_ip, &tgt_prefix);
960 if (result != ISC_R_SUCCESS)
963 result = search(cidr, &tgt_ip, tgt_prefix, type, ISC_TRUE, NULL);
964 if (result == ISC_R_EXISTS &&
965 isc_log_wouldlog(dns_lctx, DNS_RPZ_ERROR_LEVEL))
967 char printname[DNS_NAME_FORMATSIZE];
970 * bin/tests/system/rpz/tests.sh looks for "rpz.*failed".
972 dns_name_format(name, printname, sizeof(printname));
973 isc_log_write(dns_lctx, DNS_LOGCATEGORY_RPZ,
974 DNS_LOGMODULE_RBTDB, DNS_RPZ_ERROR_LEVEL,
975 "rpz add failed; \"%s\" is a duplicate name",
981 * Delete an IP address from the radix tree of a response policy database.
982 * The tree write lock must be held by the caller.
985 dns_rpz_cidr_deleteip(dns_rpz_cidr_t *cidr, dns_name_t *name) {
987 dns_rpz_cidr_key_t tgt_ip;
988 dns_rpz_cidr_bits_t tgt_prefix;
990 dns_rpz_cidr_node_t *tgt = NULL, *parent, *child;
991 dns_rpz_cidr_flags_t flags, data_flag;
997 * Decide which kind of policy zone IP address it is, if either
998 * and then find its node.
1000 type = set_type(cidr, name);
1002 case DNS_RPZ_TYPE_IP:
1003 case DNS_RPZ_TYPE_NSIP:
1005 case DNS_RPZ_TYPE_NSDNAME:
1007 * We cannot easily count nsdnames because
1008 * internal rbt nodes get deleted.
1011 case DNS_RPZ_TYPE_QNAME:
1012 case DNS_RPZ_TYPE_BAD:
1017 * Do not get excited about the deletion of interior rbt nodes.
1019 result = name2ipkey(cidr, DNS_RPZ_DEBUG_QUIET, name,
1020 type, &tgt_ip, &tgt_prefix);
1021 if (result != ISC_R_SUCCESS)
1024 result = search(cidr, &tgt_ip, tgt_prefix, type, ISC_FALSE, &tgt);
1025 if (result != ISC_R_SUCCESS) {
1026 badname(DNS_RPZ_ERROR_LEVEL, name, "; missing rpz node", "");
1031 * Mark the node and its parents to reflect the deleted IP address.
1033 flags = get_flags(&tgt_ip, tgt_prefix, type);
1034 data_flag = flags & (DNS_RPZ_CIDR_FG_IP_DATA |
1035 DNS_RPZ_CIDR_FG_NSIP_DATA);
1036 tgt->flags &= ~data_flag;
1037 for (parent = tgt; parent != NULL; parent = parent->parent) {
1038 if ((parent->flags & data_flag) != 0 ||
1039 (parent->child[0] != NULL &&
1040 (parent->child[0]->flags & flags) != 0) ||
1041 (parent->child[1] != NULL &&
1042 (parent->child[1]->flags & flags) != 0))
1044 parent->flags &= ~flags;
1048 * We might need to delete 2 nodes.
1052 * The node is now useless if it has no data of its own
1053 * and 0 or 1 children. We are finished if it is not useless.
1055 if ((child = tgt->child[0]) != NULL) {
1056 if (tgt->child[1] != NULL)
1059 child = tgt->child[1];
1061 if ((tgt->flags & (DNS_RPZ_CIDR_FG_IP_DATA |
1062 DNS_RPZ_CIDR_FG_NSIP_DATA)) != 0)
1066 * Replace the pointer to this node in the parent with
1067 * the remaining child or NULL.
1069 parent = tgt->parent;
1070 if (parent == NULL) {
1073 parent->child[parent->child[1] == tgt] = child;
1076 * If the child exists fix up its parent pointer.
1079 child->parent = parent;
1080 isc_mem_put(cidr->mctx, tgt, sizeof(*tgt));
1083 } while (tgt != NULL);
1087 * Caller must hold tree lock.
1088 * Return ISC_R_NOTFOUND
1089 * or ISC_R_SUCCESS and the found entry's canonical and search names
1090 * and its prefix length
1093 dns_rpz_cidr_find(dns_rpz_cidr_t *cidr, const isc_netaddr_t *netaddr,
1094 dns_rpz_type_t type, dns_name_t *canon_name,
1095 dns_name_t *search_name, dns_rpz_cidr_bits_t *prefix)
1097 dns_rpz_cidr_key_t tgt_ip;
1098 isc_result_t result;
1099 dns_rpz_cidr_node_t *found;
1103 * Convert IP address to CIDR tree key.
1105 if (netaddr->family == AF_INET) {
1108 tgt_ip.w[2] = ADDR_V4MAPPED;
1109 tgt_ip.w[3] = ntohl(netaddr->type.in.s_addr);
1110 } else if (netaddr->family == AF_INET6) {
1111 dns_rpz_cidr_key_t src_ip6;
1114 * Given the int aligned struct in_addr member of netaddr->type
1115 * one could cast netaddr->type.in6 to dns_rpz_cidr_key_t *,
1116 * but there are objections.
1118 memmove(src_ip6.w, &netaddr->type.in6, sizeof(src_ip6.w));
1119 for (i = 0; i < 4; i++) {
1120 tgt_ip.w[i] = ntohl(src_ip6.w[i]);
1123 return (ISC_R_NOTFOUND);
1126 result = search(cidr, &tgt_ip, 128, type, ISC_FALSE, &found);
1127 if (result != ISC_R_SUCCESS && result != DNS_R_PARTIALMATCH)
1130 *prefix = found->bits;
1131 return (ip2name(cidr, &found->ip, found->bits, type,
1132 canon_name, search_name));
1136 * Translate CNAME rdata to a QNAME response policy action.
1139 dns_rpz_decode_cname(dns_rpz_zone_t *rpz, dns_rdataset_t *rdataset,
1140 dns_name_t *selfname)
1142 dns_rdata_t rdata = DNS_RDATA_INIT;
1143 dns_rdata_cname_t cname;
1144 isc_result_t result;
1146 result = dns_rdataset_first(rdataset);
1147 RUNTIME_CHECK(result == ISC_R_SUCCESS);
1148 dns_rdataset_current(rdataset, &rdata);
1149 result = dns_rdata_tostruct(&rdata, &cname, NULL);
1150 RUNTIME_CHECK(result == ISC_R_SUCCESS);
1151 dns_rdata_reset(&rdata);
1154 * CNAME . means NXDOMAIN
1156 if (dns_name_equal(&cname.cname, dns_rootname))
1157 return (DNS_RPZ_POLICY_NXDOMAIN);
1159 if (dns_name_iswildcard(&cname.cname)) {
1161 * CNAME *. means NODATA
1163 if (dns_name_countlabels(&cname.cname) == 2)
1164 return (DNS_RPZ_POLICY_NODATA);
1167 * A qname of www.evil.com and a policy of
1168 * *.evil.com CNAME *.garden.net
1170 * evil.com CNAME evil.com.garden.net
1172 if (dns_name_countlabels(&cname.cname) > 2)
1173 return (DNS_RPZ_POLICY_WILDCNAME);
1177 * CNAME PASSTHRU.origin means "do not rewrite.
1179 if (dns_name_equal(&cname.cname, &rpz->passthru))
1180 return (DNS_RPZ_POLICY_PASSTHRU);
1183 * 128.1.0.127.rpz-ip CNAME 128.1.0.0.127. is obsolete PASSTHRU
1185 if (selfname != NULL && dns_name_equal(&cname.cname, selfname))
1186 return (DNS_RPZ_POLICY_PASSTHRU);
1189 * Any other rdata gives a response consisting of the rdata.
1191 return (DNS_RPZ_POLICY_RECORD);