bluebox 0.1.4

A fast DNS interceptor and cache for local networks
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Error types for the Bluebox DNS server.

use std::io;
use std::net::AddrParseError;

use thiserror::Error;

/// Main error type for Bluebox operations.
#[derive(Debug, Error)]
pub enum Error {
    #[error("configuration error")]
    Config(#[from] ConfigError),

    #[error("network error")]
    Network(#[from] NetworkError),

    #[error("DNS protocol error")]
    Protocol(#[from] hickory_proto::ProtoError),

    #[error("resolver error: {0}")]
    Resolver(String),

    #[error("I/O error")]
    Io(#[from] io::Error),

    #[error("metrics error")]
    Metrics(#[from] metrics_exporter_prometheus::BuildError),
}

/// Configuration-related errors.
#[derive(Debug, Error)]
pub enum ConfigError {
    #[error("failed to read config file")]
    ReadFile(#[source] io::Error),

    #[error("failed to parse config")]
    Parse(#[source] toml::de::Error),

    #[error("invalid upstream resolver address")]
    InvalidResolver(#[source] AddrParseError),

    #[error("validation failed")]
    Validation(#[from] ValidationError),
}

/// Validation errors for configuration values.
#[derive(Debug, Error)]
pub enum ValidationError {
    #[error("cache_ttl_seconds must be greater than 0")]
    ZeroCacheTtl,

    #[error("buffer_pool_size must be greater than 0")]
    ZeroBufferPoolSize,

    #[error("channel_capacity must be greater than 0")]
    ZeroChannelCapacity,

    #[error("arp_spoof.spoof_interval_secs must be greater than 0")]
    ZeroSpoofInterval,

    #[error("blocklist pattern cannot be empty")]
    EmptyBlocklistPattern,

    #[error("invalid wildcard pattern: {pattern:?}")]
    InvalidWildcardPattern { pattern: String },

    #[error("blocklist source name cannot be empty")]
    EmptyBlocklistSourceName,

    #[error("duplicate blocklist source name: {name:?}")]
    DuplicateBlocklistSourceName { name: String },

    #[error("blocklist source {name:?} has empty file path")]
    EmptyBlocklistSourcePath { name: String },

    #[error("blocklist source {name:?} has empty URL")]
    EmptyBlocklistSourceUrl { name: String },

    #[error(
        "blocklist source {name:?} has invalid URL (must start with http:// or https://): {url:?}"
    )]
    InvalidBlocklistSourceUrl { name: String, url: String },
}

/// Network-related errors.
#[derive(Debug, Error)]
pub enum NetworkError {
    #[error("no suitable network interface found")]
    NoInterface,

    #[error("failed to open datalink channel: {0}")]
    ChannelOpen(String),

    #[error("unsupported channel type")]
    UnsupportedChannel,

    #[error("failed to send packet: {0}")]
    SendFailed(String),

    #[error("packet construction failed: {0}")]
    PacketConstruction(String),
}

/// Result type alias using our Error.
pub type Result<T> = std::result::Result<T, Error>;