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
232
233
234
235

use std::net::IpAddr;

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

// ---------------------------------------------------------------------------
// Ipv4Builder  –  entry point via Firewall::ipv4()
// ---------------------------------------------------------------------------

pub struct Ipv4Builder<'a> {
    fw: &'a Firewall,
    ip: IpAddr,
}

impl<'a> Ipv4Builder<'a> {
    pub(crate) fn new(fw: &'a Firewall, ip: IpAddr) -> Self {
        Ipv4Builder { fw, ip }
    }

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

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

    pub fn delete(self) -> Ipv4DeleteBuilder {
        Ipv4DeleteBuilder { ip: self.ip }
    }

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

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

pub struct Ipv4ActionBuilder {
    ip: IpAddr,
    action: Action,
}

impl Ipv4ActionBuilder {
    pub fn tcp(self) -> Ipv4Finalizer {
        Ipv4Finalizer {
            action: self.action,
            ip: self.ip,
            protocol: Protocol::Tcp,
        }
    }

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

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

pub struct Ipv4Finalizer {
    ip: IpAddr,
    action: Action,
    protocol: Protocol,
}

impl Ipv4Finalizer {
    pub fn apply(&self) -> Result<(), UfwError> {
        let ip_str = self.ip.to_string();
        let action_str = match self.action {
            Action::Allow => "allow",
            Action::Deny => "deny",
        };
        match self.protocol {
            Protocol::Both => {
                CommandRunner::run("sudo", &["ufw", action_str, "from", &ip_str])?;
            }
            Protocol::Tcp | Protocol::Udp => {
                let proto_str = match self.protocol {
                    Protocol::Tcp => "tcp",
                    Protocol::Udp => "udp",
                    _ => unreachable!(),
                };
                CommandRunner::run(
                    "sudo",
                    &["ufw", action_str, "from", &ip_str, "proto", proto_str],
                )?;
            }
        }
        Ok(())
    }
}

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

pub struct Ipv4DeleteBuilder {
    ip: IpAddr,
}

impl Ipv4DeleteBuilder {
    pub fn tcp(self) -> Ipv4DeleteFinalizer {
        Ipv4DeleteFinalizer {
            ip: self.ip,
            protocol: Protocol::Tcp,
        }
    }

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

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

pub struct Ipv4DeleteFinalizer {
    ip: IpAddr,
    protocol: Protocol,
}

impl Ipv4DeleteFinalizer {
    pub fn apply(&self) -> Result<bool, UfwError> {
        let ip_str = self.ip.to_string();
        let outcomes: Vec<Result<_, _>> = match self.protocol {
            Protocol::Both => {
                vec![
                    // Generic (no protocol)
                    CommandRunner::delete("sudo", &["ufw", "delete", "allow", "from", &ip_str]),
                    CommandRunner::delete("sudo", &["ufw", "delete", "deny", "from", &ip_str]),
                    // Protocol-specific TCP
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "allow", "from", &ip_str, "proto", "tcp"],
                    ),
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "deny", "from", &ip_str, "proto", "tcp"],
                    ),
                    // Protocol-specific UDP
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "allow", "from", &ip_str, "proto", "udp"],
                    ),
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "deny", "from", &ip_str, "proto", "udp"],
                    ),
                ]
            }
            Protocol::Tcp => {
                vec![
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "allow", "from", &ip_str, "proto", "tcp"],
                    ),
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "deny", "from", &ip_str, "proto", "tcp"],
                    ),
                ]
            }
            Protocol::Udp => {
                vec![
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "allow", "from", &ip_str, "proto", "udp"],
                    ),
                    CommandRunner::delete(
                        "sudo",
                        &["ufw", "delete", "deny", "from", &ip_str, "proto", "udp"],
                    ),
                ]
            }
        };
        combine_delete_outcomes(outcomes)
    }
}

// ---------------------------------------------------------------------------
// Ipv4Status  –  read-only status check
// ---------------------------------------------------------------------------

pub struct Ipv4Status<'a> {
    fw: &'a Firewall,
    ip: IpAddr,
}

impl<'a> Ipv4Status<'a> {
    pub fn tcp(&self) -> Result<RuleStatus, UfwError> {
        let rules = self.fw.ips()?;
        Ok(find_ip_status(&rules, self.ip, Protocol::Tcp))
    }

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

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