Extracted from Perl API and migrated to Rust with type-safe implementations. Replaced string-based types with strongly-typed Rust counterparts including: - FirewallAction (Accept, Reject, Drop) - FirewallLogLevel - FirewallDirection (In, Out, Group) - FirewallAddressMatch for source/destination addresses - FirewallPortList for port specifications - FirewallIcmpType for ICMP type matching
Signed-off-by: Dietmar Maurer <[email protected]> --- proxmox-firewall-api-types/src/lib.rs | 3 + proxmox-firewall-api-types/src/rule.rs | 192 +++++++++++++++++++++++++ 2 files changed, 195 insertions(+) create mode 100644 proxmox-firewall-api-types/src/rule.rs diff --git a/proxmox-firewall-api-types/src/lib.rs b/proxmox-firewall-api-types/src/lib.rs index c6f00250..25e260c3 100644 --- a/proxmox-firewall-api-types/src/lib.rs +++ b/proxmox-firewall-api-types/src/lib.rs @@ -37,3 +37,6 @@ mod port; pub use port::{ FirewallPortList, FirewallPortListEntry, FIREWALL_DPORT_API_SCHEMA, FIREWALL_SPORT_API_SCHEMA, }; + +mod rule; +pub use rule::{FirewallRule, FirewallRuleType}; diff --git a/proxmox-firewall-api-types/src/rule.rs b/proxmox-firewall-api-types/src/rule.rs new file mode 100644 index 00000000..a2298609 --- /dev/null +++ b/proxmox-firewall-api-types/src/rule.rs @@ -0,0 +1,192 @@ +use serde::{Deserialize, Serialize}; + +#[cfg(feature = "enum-fallback")] +use proxmox_fixed_string::FixedString; +use proxmox_schema::{api, const_regex, ApiStringFormat}; + +use crate::{FirewallAddressMatch, FirewallIcmpType, FirewallPortList}; +use crate::{FIREWALL_DPORT_API_SCHEMA, FIREWALL_SPORT_API_SCHEMA}; +use super::FirewallLogLevel; + +const_regex! { + FIREWALL_RULE_IFACE_RE = r##"^[a-zA-Z][a-zA-Z0-9_]{1,20}([:\.]\d+)?$"##; + FIREWALL_SECURITY_GROUP_RE = r##"^[A-Za-z][A-Za-z0-9\-\_]+$"##; +} + +#[api( + properties: { + action: { + format: &ApiStringFormat::Pattern(&FIREWALL_SECURITY_GROUP_RE), + max_length: 20, + min_length: 2, + type: String, + }, + comment: { + optional: true, + type: String, + }, + dest: { + optional: true, + }, + digest: { + max_length: 64, + optional: true, + type: String, + }, + dport: { + optional: true, + schema: FIREWALL_DPORT_API_SCHEMA, + }, + enable: { + minimum: 0, + optional: true, + type: Integer, + }, + "icmp-type": { + optional: true, + }, + iface: { + format: &ApiStringFormat::Pattern(&FIREWALL_RULE_IFACE_RE), + max_length: 20, + min_length: 2, + optional: true, + type: String, + }, + log: { + optional: true, + }, + "macro": { + max_length: 128, + optional: true, + type: String, + }, + pos: { + minimum: 0, + optional: true, + type: Integer, + }, + proto: { + max_length: 64, // arbitrary limit, much longer than anything in /etc/protocols + optional: true, + type: String, + }, + source: { + optional: true, + }, + sport: { + optional: true, + schema: FIREWALL_SPORT_API_SCHEMA, + }, + type: { + type: FirewallRuleType, + }, + }, +)] +/// Firewall Rule. +#[derive(Debug, serde::Deserialize, serde::Serialize)] +pub struct FirewallRule { + /// Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. + pub action: String, + + /// Descriptive comment. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub comment: Option<String>, + + #[serde(default, skip_serializing_if = "Option::is_none")] + pub dest: Option<FirewallAddressMatch>, + + /// Prevent changes if current configuration file has a different digest. + /// This can be used to prevent concurrent modifications. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub digest: Option<String>, + + /// Restrict TCP/UDP destination port. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub dport: Option<FirewallPortList>, + + /// Flag to enable/disable a rule. + #[serde(deserialize_with = "proxmox_serde::perl::deserialize_u64")] + #[serde(default, skip_serializing_if = "Option::is_none")] + pub enable: Option<u64>, + + /// Specify icmp-type. Only valid if proto equals 'icmp' or + /// 'icmpv6'/'ipv6-icmp'. + #[serde(default, skip_serializing_if = "Option::is_none")] + #[serde(rename = "icmp-type")] + pub icmp_type: Option<FirewallIcmpType>, + + /// Network interface name. You have to use network configuration key names + /// for VMs and containers ('net\d+'). Host related rules can use arbitrary + /// strings. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub iface: Option<String>, + + #[serde(default, skip_serializing_if = "Option::is_none")] + pub log: Option<FirewallLogLevel>, + + /// Use predefined standard macro. + #[serde(default, skip_serializing_if = "Option::is_none")] + #[serde(rename = "macro")] + pub r#macro: Option<String>, + + /// Update rule at position <pos>. + #[serde(deserialize_with = "proxmox_serde::perl::deserialize_u64")] + #[serde(default, skip_serializing_if = "Option::is_none")] + pub pos: Option<u64>, + + /// IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, + /// as defined in '/etc/protocols'. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub proto: Option<String>, + + #[serde(default, skip_serializing_if = "Option::is_none")] + pub source: Option<FirewallAddressMatch>, + + /// Restrict TCP/UDP source port. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub sport: Option<FirewallPortList>, + + #[serde(rename = "type")] + pub ty: FirewallRuleType, +} + +#[api] +/// Rule type. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize, Serialize)] +pub enum FirewallRuleType { + #[serde(rename = "in")] + /// in. + In, + #[serde(rename = "out")] + /// out. + Out, + #[serde(rename = "forward")] + /// forward. + Forward, + #[serde(rename = "group")] + /// group. + Group, + /// Unknown variants for forward compatibility. + #[cfg(feature = "enum-fallback")] + #[serde(untagged)] + UnknownEnumValue(FixedString), +} + +serde_plain::derive_display_from_serialize!(FirewallRuleType); +serde_plain::derive_fromstr_from_deserialize!(FirewallRuleType); + +#[cfg(test)] +mod test { + use super::*; + + #[test] + fn test_regex_compilation_firewall_rule_iface_re() { + use regex::Regex; + let _: &Regex = &FIREWALL_RULE_IFACE_RE; + } + #[test] + fn test_regex_compilation_firewall_security_group_re() { + use regex::Regex; + let _: &Regex = &FIREWALL_SECURITY_GROUP_RE; + } +} -- 2.47.3
