all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Dietmar Maurer <dietmar@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [RFC proxmox 14/22] firewall-api-types: add firewall address types
Date: Mon, 16 Feb 2026 11:43:52 +0100	[thread overview]
Message-ID: <20260216104401.3959270-15-dietmar@proxmox.com> (raw)
In-Reply-To: <20260216104401.3959270-1-dietmar@proxmox.com>

This adds new types for representing firewall address matches:

- FirewallAddressMatch: enum for IP lists, ipset references, or alias
  references
- FirewallAddressList: validated list of address entries with consistent
  address family
- FirewallAddressEntry: enum for CIDR or IP range entries

The implementation includes:
- Proper encapsulation with constructor and accessor methods
- Address family validation in FirewallAddressList::new()
- FromStr implementations for parsing address specifications
- Integration with existing FirewallIpsetReference and
  FirewallAliasReference types

Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
---
 proxmox-firewall-api-types/Cargo.toml     |   1 +
 proxmox-firewall-api-types/src/address.rs | 225 ++++++++++++++++++++++
 proxmox-firewall-api-types/src/lib.rs     |   3 +
 3 files changed, 229 insertions(+)
 create mode 100644 proxmox-firewall-api-types/src/address.rs

diff --git a/proxmox-firewall-api-types/Cargo.toml b/proxmox-firewall-api-types/Cargo.toml
index 97b477b8..8b77b522 100644
--- a/proxmox-firewall-api-types/Cargo.toml
+++ b/proxmox-firewall-api-types/Cargo.toml
@@ -22,3 +22,4 @@ serde_plain = { workspace = true }
 proxmox-schema = { workspace = true, features = ["api-macro"] }
 proxmox-serde = { workspace = true, features = ["perl"] }
 proxmox-fixed-string = { workspace = true, optional = true }
+proxmox-network-types = { workspace = true, features = [ "api-types" ] }
diff --git a/proxmox-firewall-api-types/src/address.rs b/proxmox-firewall-api-types/src/address.rs
new file mode 100644
index 00000000..46166352
--- /dev/null
+++ b/proxmox-firewall-api-types/src/address.rs
@@ -0,0 +1,225 @@
+use std::fmt;
+use std::str::FromStr;
+
+use super::{FirewallAliasReference, FirewallIpsetReference};
+
+use anyhow::{bail, Error};
+use proxmox_network_types::ip_address::{Cidr, Family, IpRange};
+use proxmox_schema::{ApiStringFormat, ApiType, Schema, StringSchema};
+
+/// A match for source or destination address.
+#[derive(Clone, Debug, PartialEq)]
+pub enum FirewallAddressMatch {
+    /// IP address list match.
+    Ip(FirewallAddressList),
+    /// IP set match.
+    Ipset(FirewallIpsetReference),
+    /// Alias match.
+    Alias(FirewallAliasReference),
+}
+
+impl ApiType for FirewallAddressMatch {
+    const API_SCHEMA: Schema = StringSchema::new(
+        r#"Restrict source or destination packet address.
+    This can refer to a single IP address,
+    an IP set ('+ipsetname') or an IP alias definition. You can also specify
+    an address range like '20.34.101.207-201.3.9.99', or a list of IP
+    addresses and networks (entries are separated by comma). Please do not
+    mix IPv4 and IPv6 addresses inside such lists."#,
+    )
+    .format(&ApiStringFormat::VerifyFn(verify_firewall_address_match))
+    .max_length(512)
+    .schema();
+}
+
+fn verify_firewall_address_match(s: &str) -> Result<(), Error> {
+    FirewallAddressMatch::from_str(s).map(|_| ())
+}
+
+serde_plain::derive_deserialize_from_fromstr!(FirewallAddressMatch, "valid firewall address match");
+serde_plain::derive_serialize_from_display!(FirewallAddressMatch);
+
+/// A firewall address entry (CIDR or Range).
+#[derive(Clone, Debug, PartialEq)]
+pub enum FirewallAddressEntry {
+    /// CIDR notation.
+    Cidr(Cidr),
+    /// IP range.
+    Range(IpRange),
+}
+
+impl FirewallAddressEntry {
+    /// Get the address family of the entry.
+    pub fn family(&self) -> Family {
+        match self {
+            Self::Cidr(cidr) => cidr.family(),
+            Self::Range(range) => range.family(),
+        }
+    }
+}
+
+impl fmt::Display for FirewallAddressEntry {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match self {
+            Self::Cidr(ip) => ip.fmt(f),
+            Self::Range(range) => range.fmt(f),
+        }
+    }
+}
+
+impl FromStr for FirewallAddressEntry {
+    type Err = Error;
+
+    fn from_str(s: &str) -> Result<Self, Error> {
+        if let Ok(cidr) = s.parse() {
+            return Ok(FirewallAddressEntry::Cidr(cidr));
+        }
+
+        if let Ok(range) = s.parse() {
+            return Ok(FirewallAddressEntry::Range(range));
+        }
+
+        bail!("Invalid IP entry: {s}");
+    }
+}
+
+/// A list of firewall address entries.
+#[derive(Clone, Debug, PartialEq)]
+pub struct FirewallAddressList {
+    // guaranteed to have the same family
+    entries: Vec<FirewallAddressEntry>,
+    family: Family,
+}
+
+impl FirewallAddressList {
+    /// Creates a new address list from a vector of entries.
+    ///
+    /// Validates that all entries have the same address family.
+    pub fn new(entries: Vec<FirewallAddressEntry>) -> Result<Self, Error> {
+        if entries.is_empty() {
+            bail!("empty address list");
+        }
+
+        let family = entries[0].family();
+
+        for entry in &entries[1..] {
+            if entry.family() != family {
+                bail!("address list entries must have the same address family");
+            }
+        }
+
+        Ok(Self { entries, family })
+    }
+
+    /// Returns the entries of the address list.
+    pub fn entries(&self) -> &[FirewallAddressEntry] {
+        &self.entries
+    }
+
+    /// Returns the address family of the address list.
+    pub fn family(&self) -> Family {
+        self.family
+    }
+}
+
+impl fmt::Display for FirewallAddressMatch {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match self {
+            Self::Ip(list) => {
+                for (i, entry) in list.entries.iter().enumerate() {
+                    if i > 0 {
+                        write!(f, ",")?;
+                    }
+                    entry.fmt(f)?;
+                }
+                Ok(())
+            }
+            Self::Ipset(reference) => reference.fmt(f),
+            Self::Alias(reference) => reference.fmt(f),
+        }
+    }
+}
+
+impl FromStr for FirewallAddressMatch {
+    type Err = Error;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let s = s.trim();
+
+        if s.is_empty() {
+            bail!("empty firewall address specification");
+        }
+
+        if s.starts_with('+') {
+            return Ok(FirewallAddressMatch::Ipset(
+                s.parse::<FirewallIpsetReference>()?,
+            ));
+        }
+
+        if let Ok(alias_ref) = s.parse::<FirewallAliasReference>() {
+            return Ok(FirewallAddressMatch::Alias(alias_ref));
+        }
+
+        let mut entries = Vec::new();
+
+        for element in s.split(',') {
+            let entry: FirewallAddressEntry = element.parse()?;
+            entries.push(entry);
+        }
+
+        Ok(Self::Ip(FirewallAddressList::new(entries)?))
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_parse_ip_addr_match() {
+        for input in [
+            "10.0.0.0/8",
+            "10.0.0.0/8,192.168.0.0-192.168.255.255,172.16.0.1",
+            "dc/test",
+            "+guest/proxmox",
+        ] {
+            input
+                .parse::<FirewallAddressMatch>()
+                .expect("valid ip match");
+        }
+
+        for input in [
+            "10.0.0.0/",
+            "10.0.0.0/8,192.168.256.0-192.168.255.255,172.16.0.1",
+            "dc/test!invalid",
+            "+guest/",
+            "",
+        ] {
+            input
+                .parse::<FirewallAddressMatch>()
+                .expect_err("invalid ip match");
+        }
+    }
+
+    #[test]
+    fn test_firewall_address_list_mixed_families() {
+        let entries = vec![
+            "10.0.0.1/32".parse().unwrap(),
+            "fe80::1/128".parse().unwrap(),
+        ];
+
+        assert!(FirewallAddressList::new(entries).is_err());
+    }
+
+    #[test]
+    fn test_firewall_address_list_valid() {
+        let entries = vec![
+            "10.0.0.1/32".parse().unwrap(),
+            "192.168.1.1/32".parse().unwrap(),
+        ];
+
+        let list = FirewallAddressList::new(entries).expect("valid list");
+        assert_eq!(list.family(), Family::V4);
+        assert_eq!(list.entries().len(), 2);
+    }
+}
diff --git a/proxmox-firewall-api-types/src/lib.rs b/proxmox-firewall-api-types/src/lib.rs
index 8fae5042..c6f00250 100644
--- a/proxmox-firewall-api-types/src/lib.rs
+++ b/proxmox-firewall-api-types/src/lib.rs
@@ -1,3 +1,6 @@
+mod address;
+pub use address::{FirewallAddressEntry, FirewallAddressList, FirewallAddressMatch};
+
 mod alias;
 pub use alias::{FirewallAliasReference, FirewallAliasScope};
 
-- 
2.47.3




  parent reply	other threads:[~2026-02-16 10:44 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-16 10:43 [RFC proxmox 00/22] New crate for firewall api types Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 01/22] firewall-api-types: add new " Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 02/22] firewall-api-types: add README.md Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 03/22] firewall-api-types: add firewall policy types Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 04/22] firewall-api-types: add logging types Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 05/22] firewall-api-types: add FirewallClusterOptions Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 06/22] firewall-api-types: add FirewallGuestOptions Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 07/22] firewall-api-types: add FirewallConntrackHelper enum Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 08/22] firewall-api-types: add FirewallNodeOptions struct Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 09/22] firewall-api-types: add FirewallRef type Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 10/22] firewall-api-types: add FirewallPortList types Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 11/22] firewall-api-types: add FirewallIcmpType Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 12/22] firewall-api-types: add FirewallIpsetReference type Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 13/22] firewall-api-types: add FirewallAliasReference type Dietmar Maurer
2026-02-16 10:43 ` Dietmar Maurer [this message]
2026-02-16 10:43 ` [RFC proxmox 15/22] firewall-api-types: add FirewallRule type Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 16/22] firewall-api-types: use ConfigDigest from proxmox-config-digest crate Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 17/22] firewall-api-types: use COMMENT_SCHEMA from proxmox-schema crate Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 18/22] firewall-api-types: add FirewallRuleUpdater type Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 19/22] firewall-api-types: refactor FirewallRule and add FirewallRuleListEntry Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 20/22] firewall-api-types: add DeletableFirewallRuleProperty enum Dietmar Maurer
2026-02-16 10:43 ` [RFC proxmox 21/22] firewall-api-types: add FirewallAliasEntry API type Dietmar Maurer
2026-02-16 10:44 ` [RFC proxmox 22/22] firewall-api-types: add FirewallIpsetListEntry and FirewallIpsetEntry api types Dietmar Maurer
2026-02-17  6:17 ` [RFC proxmox 00/22] New crate for firewall " Hannes Laimer
2026-02-17  6:39   ` Dietmar Maurer
2026-02-17  8:17     ` Hannes Laimer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260216104401.3959270-15-dietmar@proxmox.com \
    --to=dietmar@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal