dfw 1.3.0

Docker firewall framework, in Rust
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
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

// Copyright Pit Kleyersburg <pitkley@googlemail.com>
// SPDX-License-Identifier: MIT OR Apache-2.0
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified or distributed
// except according to those terms.

use crate::{errors::*, nftables::DFW_MARK, types::RuleVerdict};
use derive_builder::Builder;
use failure::bail;

#[derive(Debug, Clone, Builder)]
#[builder(derive(Debug), pattern = "mutable", build_fn(skip))]
#[allow(dead_code)]
pub(crate) struct Rule {
    #[builder(setter(into))]
    pub in_interface: String,
    #[builder(setter(into))]
    pub out_interface: String,
    #[builder(setter(into))]
    pub source_address: String,
    #[builder(setter(into))]
    pub destination_address: String,
    #[builder(setter(into))]
    pub source_address_v6: String,
    #[builder(setter(into))]
    pub destination_address_v6: String,
    #[builder(setter(into))]
    pub protocol: String,
    #[builder(setter(into))]
    pub source_port: String,
    #[builder(setter(into))]
    pub destination_port: String,
    #[builder(setter(into))]
    pub matches: String,
    #[builder(setter(into))]
    pub comment: String,
    #[builder(setter(into))]
    pub verdict: RuleVerdict,
    #[builder(setter(into))]
    pub dnat: String,
}

impl RuleBuilder {
    pub(crate) fn build(&self) -> Result<String> {
        let mut args: Vec<String> = Vec::new();

        // Handle protocol matches
        if self.source_port.is_some() || self.destination_port.is_some() {
            args.push(self.protocol.clone().unwrap_or_else(|| "tcp".to_owned()));
            if let Some(source_port) = &self.source_port {
                args.push("sport".to_owned());
                args.push(source_port.to_owned());
            }
            if let Some(destination_port) = &self.destination_port {
                args.push("dport".to_owned());
                args.push(destination_port.to_owned());
            }
        }

        // Handle `ip` matches
        if let Some(source_address) = &self.source_address {
            args.push("ip".to_owned());
            args.push("saddr".to_owned());
            args.push(source_address.to_owned());
        }
        if let Some(destination_address) = &self.destination_address {
            args.push("ip".to_owned());
            args.push("daddr".to_owned());
            args.push(destination_address.to_owned());
        }

        // Handle `ip6` matches
        if let Some(source_address) = &self.source_address_v6 {
            args.push("ip6".to_owned());
            args.push("saddr".to_owned());
            args.push(source_address.to_owned());
        }
        if let Some(destination_address) = &self.destination_address_v6 {
            args.push("ip6".to_owned());
            args.push("daddr".to_owned());
            args.push(destination_address.to_owned());
        }

        // Handle interface-matches
        if self.in_interface.is_some() || self.out_interface.is_some() {
            args.push("meta".to_owned());
            if let Some(in_interface) = &self.in_interface {
                args.push("iifname".to_owned());
                args.push(in_interface.to_owned());
            }
            if let Some(out_interface) = &self.out_interface {
                args.push("oifname".to_owned());
                args.push(out_interface.to_owned());
            }
        }

        // Bail if none of the above was initialized
        if args.is_empty() {
            bail!("one of `{source,destination}_{port,address{,_v6}}`, `{in,out}_interface` must be initialized");
        }

        // Unconditionally set mark
        args.push("meta".to_owned());
        args.push("mark".to_owned());
        args.push("set".to_owned());
        args.push(DFW_MARK.to_owned());

        if let Some(matches) = &self.matches {
            args.push(matches.to_owned());
        }

        if let Some(verdict) = &self.verdict {
            args.push(verdict.to_string());
        } else if let Some(dnat) = &self.dnat {
            args.push("dnat".to_owned());
            args.push(dnat.to_owned());
        }

        if let Some(comment) = &self.comment {
            args.push(format!(r#"comment "{}""#, comment));
        }

        Ok(args.join(" "))
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn builder_should_fail() {
        let rule = RuleBuilder::default();
        assert!(rule.build().is_err());
    }

    #[test]
    fn builder_should_succeed() {
        let mut rule = RuleBuilder::default();
        rule.source_port("1");
        assert!(rule.build().is_ok());
    }
}