ufwctl 0.1.0

Linux-only Rust library for managing UFW firewall rules
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
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

use crate::Firewall;
use crate::command::{CommandRunner, combine_delete_outcomes};
use crate::enums::{Action, Protocol, RuleStatus};
use crate::error::UfwError;
use crate::parser::find_port_status;

// ---------------------------------------------------------------------------
// PortBuilder  –  entry point via Firewall::port()
// ---------------------------------------------------------------------------

pub struct PortBuilder<'a> {
    fw: &'a Firewall,
    port: u16,
}

impl<'a> PortBuilder<'a> {
    pub(crate) fn new(fw: &'a Firewall, port: u16) -> Self {
        PortBuilder { fw, port }
    }

    pub fn allow(self) -> PortActionBuilder {
        PortActionBuilder {
            port: self.port,
            action: Action::Allow,
        }
    }

    pub fn deny(self) -> PortActionBuilder {
        PortActionBuilder {
            port: self.port,
            action: Action::Deny,
        }
    }

    pub fn delete(self) -> PortDeleteBuilder {
        PortDeleteBuilder { port: self.port }
    }

    pub fn status(self) -> PortStatus<'a> {
        PortStatus {
            fw: self.fw,
            port: self.port,
        }
    }
}

// ---------------------------------------------------------------------------
// PortActionBuilder  –  allow / deny → apply() -> Result<(), UfwError>
// ---------------------------------------------------------------------------

pub struct PortActionBuilder {
    port: u16,
    action: Action,
}

impl PortActionBuilder {
    pub fn tcp(self) -> PortFinalizer {
        PortFinalizer {
            action: self.action,
            port: self.port,
            protocol: Protocol::Tcp,
        }
    }

    pub fn udp(self) -> PortFinalizer {
        PortFinalizer {
            action: self.action,
            port: self.port,
            protocol: Protocol::Udp,
        }
    }

    pub fn both(self) -> PortFinalizer {
        PortFinalizer {
            action: self.action,
            port: self.port,
            protocol: Protocol::Both,
        }
    }
}

pub struct PortFinalizer {
    port: u16,
    action: Action,
    protocol: Protocol,
}

impl PortFinalizer {
    pub fn apply(&self) -> Result<(), UfwError> {
        let protocols: &[&str] = match self.protocol {
            Protocol::Tcp => &["tcp"],
            Protocol::Udp => &["udp"],
            Protocol::Both => &["tcp", "udp"],
        };

        let action_str = match self.action {
            Action::Allow => "allow",
            Action::Deny => "deny",
        };

        for proto in protocols {
            let rule = format!("{}/{}", self.port, proto);
            CommandRunner::run("sudo", &["ufw", action_str, &rule])?;
        }
        Ok(())
    }
}

// ---------------------------------------------------------------------------
// PortDeleteBuilder  –  delete → apply() -> Result<bool, UfwError>
// ---------------------------------------------------------------------------

pub struct PortDeleteBuilder {
    port: u16,
}

impl PortDeleteBuilder {
    pub fn tcp(self) -> PortDeleteFinalizer {
        PortDeleteFinalizer {
            port: self.port,
            protocol: Protocol::Tcp,
        }
    }

    pub fn udp(self) -> PortDeleteFinalizer {
        PortDeleteFinalizer {
            port: self.port,
            protocol: Protocol::Udp,
        }
    }

    pub fn both(self) -> PortDeleteFinalizer {
        PortDeleteFinalizer {
            port: self.port,
            protocol: Protocol::Both,
        }
    }
}

pub struct PortDeleteFinalizer {
    port: u16,
    protocol: Protocol,
}

impl PortDeleteFinalizer {
    pub fn apply(&self) -> Result<bool, UfwError> {
        let outcomes: Vec<Result<_, _>> = match self.protocol {
            Protocol::Tcp => {
                vec![
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "allow", &format!("{}/tcp", self.port)],
                    ),
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "deny", &format!("{}/tcp", self.port)],
                    ),
                ]
            }
            Protocol::Udp => {
                vec![
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "allow", &format!("{}/udp", self.port)],
                    ),
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "deny", &format!("{}/udp", self.port)],
                    ),
                ]
            }
            Protocol::Both => {
                vec![
                    // Bare port forms for rules created as `ufw allow 22` / `ufw deny 22`
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "allow", &self.port.to_string()],
                    ),
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "deny", &self.port.to_string()],
                    ),
                    // Protocol-specific forms
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "allow", &format!("{}/tcp", self.port)],
                    ),
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "deny", &format!("{}/tcp", self.port)],
                    ),
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "allow", &format!("{}/udp", self.port)],
                    ),
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "deny", &format!("{}/udp", self.port)],
                    ),
                ]
            }
        };
        combine_delete_outcomes(outcomes)
    }
}

// ---------------------------------------------------------------------------
// PortStatus  –  read-only status check
// ---------------------------------------------------------------------------

pub struct PortStatus<'a> {
    fw: &'a Firewall,
    port: u16,
}

impl<'a> PortStatus<'a> {
    pub fn tcp(&self) -> Result<RuleStatus, UfwError> {
        let rules = self.fw.ports()?;
        Ok(find_port_status(&rules, self.port, Protocol::Tcp))
    }

    pub fn udp(&self) -> Result<RuleStatus, UfwError> {
        let rules = self.fw.ports()?;
        Ok(find_port_status(&rules, self.port, Protocol::Udp))
    }

    pub fn both(&self) -> Result<RuleStatus, UfwError> {
        let rules = self.fw.ports()?;
        Ok(find_port_status(&rules, self.port, Protocol::Both))
    }
}