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

// 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.

//! The types in this module make up the structure of the iptables backend-specific configurations.
//!
//! # Example
//!
//! ```
//! # use dfw::iptables::Iptables;
//! # use dfw::types::*;
//! # use toml;
//! # toml::from_str::<DFW<Iptables>>(r#"
//! [backend_defaults.initialization.v4]
//! filter = [
//!     "-P INPUT DROP",
//!     "-F INPUT",
//! ]
//! [backend_defaults.initialization.v6]
//! nat = [
//!     "-P PREROUTING DROP",
//! ]
//! # "#).unwrap();
//! ```

use serde::Deserialize;
use std::collections::HashMap;

/// The defaults/configuration for the iptables backend.
#[derive(Deserialize, Debug, Clone, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct Defaults {
    /// The optional initialization section.
    ///
    /// # Example
    ///
    /// ```
    /// # use dfw::iptables::types::*;
    /// # use toml;
    /// # toml::from_str::<Defaults>(r#"
    /// [initialization.v4]
    /// filter = [
    ///     "-P INPUT DROP",
    ///     "-F INPUT",
    /// ]
    /// # "#).unwrap();
    ///
    /// # toml::from_str::<Defaults>(r#"
    /// [initialization.v6]
    /// nat = [
    ///     "-P PREROUTING DROP",
    /// ]
    /// # "#).unwrap();
    /// ```
    pub initialization: Option<Initialization>,
}

/// The initialization section allows you to add custom rules to any table in both iptables and
/// ip6tables.
///
/// # Example
///
/// ```
/// # use dfw::iptables::types::*;
/// # use toml;
/// # toml::from_str::<Defaults>(r#"
/// [initialization.v4]
/// filter = [
///     "-P INPUT DROP",
///     "-F INPUT",
/// ]
///
/// [initialization.v6]
/// nat = [
///     "-P PREROUTING DROP",
/// ]
/// # "#).unwrap();
/// ```
#[derive(Deserialize, Debug, Clone, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct Initialization {
    /// Initialization rules for iptables (IPv4). Expects a map where the key is a specific table
    /// and the value is a list of rules.
    ///
    /// # Example
    ///
    /// ```
    /// # use dfw::iptables::types::*;
    /// # use toml;
    /// # toml::from_str::<Defaults>(r#"
    /// [initialization.v4]
    /// filter = [
    ///     "-P INPUT DROP",
    ///     "-F INPUT",
    /// ]
    /// # "#).unwrap();
    /// ```
    pub v4: Option<HashMap<String, Vec<String>>>,

    /// Initialization rules for ip6tables (IPv6). Expects a map where the key is a specific table
    /// and the value is a list of rules.
    ///
    /// # Example
    ///
    /// ```
    /// # use dfw::iptables::types::*;
    /// # use toml;
    /// # toml::from_str::<Defaults>(r#"
    /// [initialization.v6]
    /// nat = [
    ///     "-P PREROUTING DROP",
    /// ]
    /// # "#).unwrap();
    /// ```
    pub v6: Option<HashMap<String, Vec<String>>>,
}