Struct BlocklistConfig

pub struct BlocklistConfig {
    pub wildcard_match: bool,
    pub min_wildcard_depth: u8,
    pub lists: Vec<String>,
    pub sinkhole_ipv4: Option<Ipv4Addr>,
    pub sinkhole_ipv6: Option<Ipv6Addr>,
    pub ttl: u32,
    pub block_message: Option<String>,
    pub consult_action: BlocklistConsultAction,
}

Available on crate feature blocklist only.

Configuration for file based zones

Fields

wildcard_match: bool

Support wildcards? Defaults to true. If set to true, block list entries containing asterisks will be expanded to match queries.

min_wildcard_depth: u8

Minimum wildcard depth. Defaults to 2. Any wildcard entries without at least this many static elements will not be expanded (e.g., *.com has a depth of 1; *.example.com has a depth of two.) This is meant as a safeguard against an errant block list entry, such as * or *.com that might block many more hosts than intended.

lists: Vec<String>

Block lists to load. These should be specified as relative (to the server zone directory) paths in the config file.

sinkhole_ipv4: Option<Ipv4Addr>

IPv4 sinkhole IP. This is the IP that is returned when a blocklist entry is matched for an A query. If unspecified, an implementation-provided default will be used.

sinkhole_ipv6: Option<Ipv6Addr>

IPv6 sinkhole IP. This is the IP that is returned when a blocklist entry is matched for a AAAA query. If unspecified, an implementation-provided default will be used.

ttl: u32

Block TTL. This is the length of time a block response should be stored in the requesting resolvers cache, in seconds. Defaults to 86,400 seconds.

block_message: Option<String>

Block message to return to the user. This is an optional message that, if configured, will be returned as a TXT record in the additionals section when a blocklist entry is matched for a query.

consult_action: BlocklistConsultAction

The consult action controls how the blocklist handles queries where another authority has already provided an answer. By default, it ignores any such queries (“Disabled”,) however it can be configured to log blocklist matches for those queries (“Log”,) or can be configured to overwrite the previous responses (“Enforce”.)

Trait Implementations

impl Clone for BlocklistConfig

fn clone(&self) -> BlocklistConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BlocklistConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BlocklistConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BlocklistConfig

where BlocklistConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BlocklistConfig

fn eq(&self, other: &BlocklistConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BlocklistConfig

impl StructuralPartialEq for BlocklistConfig