rpz.h revision f97d56e757b9a293ffbaa915ca4d792ae84ba85a
f97d56e757b9a293ffbaa915ca4d792ae84ba85aTinderbox User * Copyright (C) 2011, 2012 Internet Systems Consortium, Inc. ("ISC")
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * Permission to use, copy, modify, and/or distribute this software for any
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * purpose with or without fee is hereby granted, provided that the above
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * copyright notice and this permission notice appear in all copies.
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * PERFORMANCE OF THIS SOFTWARE.
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt#define DNS_RPZ_NSDNAME_ZONE DNS_RPZ_PREFIX"nsdname"
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt#define DNS_RPZ_PASSTHRU_ZONE DNS_RPZ_PREFIX"passthru"
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrewstypedef enum {
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver * Require DNS_RPZ_POLICY_PASSTHRU < DNS_RPZ_POLICY_NXDOMAIN <
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver * DNS_RPZ_POLICY_NODATA < DNS_RPZ_POLICY_CNAME to choose among competing
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrewstypedef enum {
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver DNS_RPZ_POLICY_GIVEN = 0, /* 'given': what policy record says */
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt DNS_RPZ_POLICY_DISABLED = 1, /* log what would have happened */
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver DNS_RPZ_POLICY_PASSTHRU = 2, /* 'passthru': do not rewrite */
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver DNS_RPZ_POLICY_NXDOMAIN = 3, /* 'nxdomain': answer with NXDOMAIN */
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver DNS_RPZ_POLICY_NODATA = 4, /* 'nodata': answer with ANCOUNT=0 */
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver DNS_RPZ_POLICY_CNAME = 5, /* 'cname x': answer with x's rrsets */
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt#define DNS_RPZ_ZBIT(n) (((dns_rpz_zbits_t)1) << (dns_rpz_num_t)(n))
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * Mask of the specified and higher numbered policy zones
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * Avoid hassles with (1<<33) or (1<<65)
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt#define DNS_RPZ_ZMASK(n) ((dns_rpz_zbits_t)((((n) >= DNS_RPZ_MAX_ZONES-1) ? \
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * A single response policy zone.
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunttypedef struct dns_rpz_triggers dns_rpz_triggers_t;
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt dns_rpz_num_t num; /* ordinal in list of policy zones */
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt dns_name_t nsdname; /* DNS_RPZ_NSDNAME_ZONE.origin */
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt dns_name_t cname; /* override value for ..._CNAME */
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt dns_rpz_policy_t policy; /* DNS_RPZ_POLICY_GIVEN or override */
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * Radix tree node for response policy IP addresses
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunttypedef struct dns_rpz_cidr_node dns_rpz_cidr_node_t;
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * Response policy zones known to a view.
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * The set of records for a policy zone are in one of these states:
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * never loaded load_begun=0 have=0
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * during initial loading load_begun=1 have=0
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * and rbtdb->rpzsp == rbtdb->load_rpzsp
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * after good load load_begun=1 have!=0
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * after failed initial load load_begun=1 have=0
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * and rbtdb->load_rpzsp == NULL
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * reloading after failure load_begun=1 have=0
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * reloading after success
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * main rpzs load_begun=1 have!=0
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * load rpzs load_begun=1 have=0
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * One lock for short term read-only search that guarantees the
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * consistency of the pointers.
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * A second lock for maintenance that guarantees no other thread
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * is adding or deleting nodes.
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * context for finding the best policy
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrewstypedef struct {
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews unsigned int state;
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver# define DNS_RPZ_DONE_QNAME 0x0002 /* qname checked */
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver# define DNS_RPZ_DONE_QNAME_IP 0x0004 /* IP addresses of qname checked */
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver# define DNS_RPZ_DONE_NSDNAME 0x0008 /* NS name missed; checking addresses */
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * Best match so far.
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver * State for chasing IP addresses and NS names including recursion.
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews unsigned int label;
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * State of real query while recursing for NSIP or NSDNAME.
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * p_name: current policy owner name
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * r_name: recursing for this name to possible policy triggers
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt * f_name: saved found name from before recursion
afaa290bb6acc504e93a0adbf20b6dd6c64e6d63Vernon Schryver#define DNS_RPZ_MAX_TTL_DEFAULT DNS_RPZ_TTL_DEFAULT
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews * So various response policy zone messages can be turned up or down.
9fee08f655527a5dd849b171daeeee1dbbccca76Vernon Schryver#define DNS_RPZ_DEBUG_LEVEL3 ISC_LOG_DEBUG(3)
afaa290bb6acc504e93a0adbf20b6dd6c64e6d63Vernon Schryver#define DNS_RPZ_DEBUG_QUIET (DNS_RPZ_DEBUG_LEVEL3+1)
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Huntdns_rpz_decode_cname(dns_rpz_zone_t *rpz, dns_rdataset_t *rdataset,
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Huntdns_rpz_new_zones(dns_rpz_zones_t **rpzsp, isc_mem_t *mctx);
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Huntdns_rpz_attach_rpzs(dns_rpz_zones_t *source, dns_rpz_zones_t **target);
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt dns_rpz_zones_t **load_rpzsp, dns_rpz_num_t rpz_num);
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Huntdns_rpz_add(dns_rpz_zones_t *rpzs, dns_rpz_num_t rpz_num, dns_name_t *name);
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Huntdns_rpz_delete(dns_rpz_zones_t *rpzs, dns_rpz_num_t rpz_num, dns_name_t *name);
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Huntdns_rpz_find_ip(dns_rpz_zones_t *rpzs, dns_rpz_type_t rpz_type,
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Hunt dns_rpz_zbits_t zbits, const isc_netaddr_t *netaddr,
94315060c2b0d9deafabe72d6a0482405fd9d377Evan Huntdns_rpz_find_name(dns_rpz_zones_t *rpzs, dns_rpz_type_t rpz_type,
87708bde16713bc02ff2598f4a82f98c699a2f2dMark Andrews#endif /* DNS_RPZ_H */