harborshield 0.1.0

A Rust port of Whalewall, to automate management of firewall rules for Docker containers
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
mod external;
mod localhost;
pub mod nftables_convert;
mod rule;
#[cfg(test)]
mod tests;
pub mod validation;
mod verdict;

use crate::{Error, Result};
use bon::Builder;
pub use external::ExternalRules;
use ipnet::{IpNet, Ipv4Net, Ipv6Net};
pub use localhost::LocalRules;
pub use nftables_convert::{RuleContext, ToNftablesRule};
pub use rule::RuleConfig;
use serde::{Deserialize, Deserializer, Serialize};
use std::fmt;
use std::net::IpAddr;
use std::str::FromStr;
use validation::error::ValidationError;
pub use verdict::ConfigVerdict;

#[derive(Debug, Clone, Serialize, Builder)]
pub struct Config {
    #[serde(default)]
    #[builder(default)]
    pub mapped_ports: MappedPorts,
    #[serde(default)]
    #[builder(default)]
    pub output: Vec<RuleConfig>,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize, Builder)]
pub struct MappedPorts {
    #[serde(default)]
    #[builder(default)]
    pub localhost: LocalRules,
    #[serde(default)]
    #[builder(default)]
    pub external: ExternalRules,
}

fn default_true() -> bool {
    true
}

#[derive(Debug, Clone)]
pub enum AddrOrRange {
    Addr(IpAddr),
    Range(IpAddr, IpAddr),
    Net(IpNet),
}

impl Serialize for AddrOrRange {
    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_str(&self.to_string())
    }
}

impl<'de> Deserialize<'de> for AddrOrRange {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        s.parse().map_err(serde::de::Error::custom)
    }
}

impl fmt::Display for AddrOrRange {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            AddrOrRange::Addr(addr) => write!(f, "{}", addr),
            AddrOrRange::Range(start, end) => write!(f, "{}-{}", start, end),
            AddrOrRange::Net(net) => write!(f, "{}", net),
        }
    }
}

impl FromStr for AddrOrRange {
    type Err = Error;

    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        // Check for invalid "0.0.0.0/0" which causes nftables to fail
        if s == "0.0.0.0/0" {
            return Err(Error::invalid_ip(
                s,
                "0.0.0.0/0 is not supported by nftables. Use specific IP addresses or ranges instead",
            ));
        }

        if s.contains('/') {
            // CIDR notation
            if let Ok(net) = s.parse::<Ipv4Net>() {
                return Ok(AddrOrRange::Net(IpNet::V4(net)));
            }
            if let Ok(net) = s.parse::<Ipv6Net>() {
                return Ok(AddrOrRange::Net(IpNet::V6(net)));
            }
            return Err(Error::invalid_ip(s, "Invalid CIDR notation"));
        } else if s.contains('-') {
            // Range notation
            let parts: Vec<&str> = s.split('-').collect();
            if parts.len() != 2 {
                return Err(Error::invalid_ip(
                    s,
                    "Range must have exactly two parts separated by '-'",
                ));
            }

            let start = parts[0]
                .parse::<IpAddr>()
                .map_err(|_| Error::invalid_ip(parts[0], "Invalid IP address in range start"))?;
            let end = parts[1]
                .parse::<IpAddr>()
                .map_err(|_| Error::invalid_ip(parts[1], "Invalid IP address in range end"))?;

            return Ok(AddrOrRange::Range(start, end));
        }

        // Single address
        s.parse::<IpAddr>()
            .map(AddrOrRange::Addr)
            .map_err(|_| Error::invalid_ip(s, "Invalid IP address"))
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Protocol {
    #[serde(rename = "tcp")]
    Tcp,
    #[serde(rename = "udp")]
    Udp,
}

impl fmt::Display for Protocol {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Protocol::Tcp => write!(f, "tcp"),
            Protocol::Udp => write!(f, "udp"),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RulePorts {
    Single(u16),
    Range(u16, u16),
}

impl Serialize for RulePorts {
    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_str(&self.to_string())
    }
}

impl<'de> Deserialize<'de> for RulePorts {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        s.parse().map_err(serde::de::Error::custom)
    }
}

impl fmt::Display for RulePorts {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            RulePorts::Single(port) => write!(f, "{}", port),
            RulePorts::Range(start, end) => write!(f, "{}-{}", start, end),
        }
    }
}

impl FromStr for RulePorts {
    type Err = Error;

    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        if s.contains('-') {
            let parts: Vec<&str> = s.split('-').collect();
            if parts.len() != 2 {
                return Err(Error::config(format!("Invalid port range: {}", s)));
            }

            let start = parts[0]
                .parse::<u16>()
                .map_err(|_| Error::config(format!("Invalid port: {}", parts[0])))?;
            let end = parts[1]
                .parse::<u16>()
                .map_err(|_| Error::config(format!("Invalid port: {}", parts[1])))?;

            if start > end {
                return Err(Error::config(format!(
                    "Invalid port range: start {} > end {}",
                    start, end
                )));
            }

            Ok(RulePorts::Range(start, end))
        } else {
            let port = s
                .parse::<u16>()
                .map_err(|_| Error::config(format!("Invalid port: {}", s)))?;
            Ok(RulePorts::Single(port))
        }
    }
}

impl Config {
    pub fn new() -> Self {
        Self {
            mapped_ports: MappedPorts::default(),
            output: Vec::new(),
        }
    }

    pub fn with_mapped_ports(mut self, mapped_ports: MappedPorts) -> Self {
        self.mapped_ports = mapped_ports;
        self
    }

    pub fn with_output(mut self, output: Vec<RuleConfig>) -> Self {
        self.output = output;
        self
    }

    pub fn add_output_rule(mut self, rule: RuleConfig) -> Self {
        self.output.push(rule);
        self
    }

    pub fn validate(&self) -> Result<()> {
        // Validate output rules
        for (i, rule) in self.output.iter().enumerate() {
            Self::validate_rule(rule, i)?;
        }

        // Validate mapped ports
        Self::validate_mapped_ports(&self.mapped_ports)?;

        // Verdicts are already validated in their custom deserializers

        Ok(())
    }

    fn validate_rule(rule: &RuleConfig, index: usize) -> Result<()> {
        if rule.ips.is_empty()
            && rule.container.is_empty()
            && rule.src_ports.is_empty()
            && rule.dst_ports.is_empty()
        {
            return Err(Error::config(format!("Output rule #{} is empty", index)));
        }

        if !rule.ips.is_empty() && !rule.container.is_empty() {
            return Err(Error::config(format!(
                "Output rule #{}: 'ips' and 'container' are mutually exclusive",
                index
            )));
        }

        if rule.network.is_empty() && !rule.container.is_empty() {
            return Err(Error::config(format!(
                "Output rule #{}: 'network' must be set when 'container' is set",
                index
            )));
        }

        // Validate IP family consistency
        if !rule.ips.is_empty() {
            Self::validate_ip_family_consistency(&rule.ips, &format!("Output rule #{}", index))?;
        }

        if !rule.src_ports.is_empty() && rule.dst_ports.is_empty() {
            return Err(Error::config(format!(
                "Output rule #{}: 'dst_ports' must be set when 'src_ports' is set",
                index
            )));
        }

        if rule.dst_ports.is_empty() {
            return Err(Error::config(format!(
                "Output rule #{}: 'dst_ports' must be set when 'proto' is set",
                index
            )));
        }

        Self::validate_verdict(&rule.verdict)?;

        Ok(())
    }

    fn validate_verdict(verdict: &ConfigVerdict) -> Result<()> {
        if !verdict.chain.is_empty() && verdict.queue != 0 {
            return Err(Error::config(
                "'chain' and 'queue' are mutually exclusive".to_string(),
            ));
        }

        if verdict.queue == 0 && verdict.input_est_queue != 0 {
            return Err(Error::config(
                "'queue' must be set when 'input_est_queue' is set".to_string(),
            ));
        }

        if verdict.queue == 0 && verdict.output_est_queue != 0 {
            return Err(Error::config(
                "'queue' must be set when 'output_est_queue' is set".to_string(),
            ));
        }

        if verdict.input_est_queue == 0 && verdict.output_est_queue != 0 {
            return Err(Error::config(
                "'input_est_queue' must be set when 'output_est_queue' is set".to_string(),
            ));
        }

        if verdict.output_est_queue == 0 && verdict.input_est_queue != 0 {
            return Err(Error::config(
                "'output_est_queue' must be set when 'input_est_queue' is set".to_string(),
            ));
        }

        Ok(())
    }

    fn validate_mapped_ports(mapped_ports: &MappedPorts) -> Result<()> {
        // Validate external IPs consistency
        if !mapped_ports.external.ips.is_empty() {
            Self::validate_ip_family_consistency(
                &mapped_ports.external.ips,
                "External mapped ports",
            )?;
        }

        // Note: localhost should not have IPs field per the spec
        // This is enforced by not having an ips field in LocalRules struct

        Ok(())
    }

    fn validate_ip_family_consistency(ips: &[AddrOrRange], context: &str) -> Result<()> {
        if ips.is_empty() {
            return Ok(());
        }

        // Determine the family of the first IP
        let first_is_ipv4 = match &ips[0] {
            AddrOrRange::Addr(addr) => addr.is_ipv4(),
            AddrOrRange::Range(start, _) => start.is_ipv4(),
            AddrOrRange::Net(net) => match net {
                IpNet::V4(_) => true,
                IpNet::V6(_) => false,
            },
        };

        // Check that all subsequent IPs match the first family
        for ip in ips.iter().skip(1) {
            let is_ipv4 = match ip {
                AddrOrRange::Addr(addr) => addr.is_ipv4(),
                AddrOrRange::Range(start, _) => start.is_ipv4(),
                AddrOrRange::Net(net) => match net {
                    IpNet::V4(_) => true,
                    IpNet::V6(_) => false,
                },
            };

            if is_ipv4 != first_is_ipv4 {
                return Err(Error::config(format!(
                    "{}: Mixed IPv4 and IPv6 addresses are not supported. {} is {}, but {} is {}",
                    context,
                    ips[0],
                    if first_is_ipv4 { "IPv4" } else { "IPv6" },
                    ip,
                    if is_ipv4 { "IPv4" } else { "IPv6" }
                )));
            }
        }

        Ok(())
    }
}

// Custom Deserialize implementation with validation
impl<'de> Deserialize<'de> for Config {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        // First deserialize to a temporary structure
        #[derive(Deserialize)]
        struct TempConfig {
            #[serde(default)]
            mapped_ports: MappedPorts,
            #[serde(default)]
            output: Vec<RuleConfig>,
        }

        let temp = TempConfig::deserialize(deserializer)?;

        // Create the actual Config
        let config = Config {
            mapped_ports: temp.mapped_ports,
            output: temp.output,
        };

        // Basic structural validation - component types handle their own field validation
        config.validate().map_err(serde::de::Error::custom)?;

        Ok(config)
    }
}