From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 5ED591FF136 for ; Mon, 04 May 2026 18:15:19 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 0A6CF7DB2; Mon, 4 May 2026 18:12:40 +0200 (CEST) From: Stefan Hanreich To: pve-devel@lists.proxmox.com Subject: [PATCH pve-network v4 26/47] api2: add prefix list module Date: Mon, 4 May 2026 18:03:23 +0200 Message-ID: <20260504160350.395470-27-s.hanreich@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260504160350.395470-1-s.hanreich@proxmox.com> References: <20260504160350.395470-1-s.hanreich@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1777910534461 X-SPAM-LEVEL: Spam detection results: 1 AWL -1.988 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment KAM_MAILER 2 Automated Mailer Tag Left in Email POISEN_SPAM_PILL 0.1 Meta: its spam POISEN_SPAM_PILL_1 0.1 random spam to be learned in bayes POISEN_SPAM_PILL_3 0.1 random spam to be learned in bayes SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLACK 3 Contains an URL listed in the URIBL blacklist [sdn.pm] Message-ID-Hash: HRRC3RL7EYPLHHQVSOPE3YQIGJVG4G7J X-Message-ID-Hash: HRRC3RL7EYPLHHQVSOPE3YQIGJVG4G7J X-MailFrom: s.hanreich@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Contains the CRUD functionality for prefix lists: GET /prefix-lists - lists all prefix lists GET /prefix-lists/ - get prefix list POST /prefix-lists - create a new prefix list PUT /prefix-lists/ - update prefix list DELETE /prefix-lists/ - delete prefix list The API methods also check for dangling references of prefix lists to prevent accidentally deleting a prefix list that is utilized by a route map. Signed-off-by: Stefan Hanreich --- src/PVE/API2/Network/SDN.pm | 7 + src/PVE/API2/Network/SDN/Makefile | 1 + src/PVE/API2/Network/SDN/PrefixLists.pm | 259 ++++++++++++++++++++++++ src/PVE/Network/SDN/PrefixLists.pm | 21 ++ 4 files changed, 288 insertions(+) create mode 100644 src/PVE/API2/Network/SDN/PrefixLists.pm diff --git a/src/PVE/API2/Network/SDN.pm b/src/PVE/API2/Network/SDN.pm index cc5ac25..778a29b 100644 --- a/src/PVE/API2/Network/SDN.pm +++ b/src/PVE/API2/Network/SDN.pm @@ -22,6 +22,7 @@ use PVE::API2::Network::SDN::Zones; use PVE::API2::Network::SDN::Ipams; use PVE::API2::Network::SDN::Dns; use PVE::API2::Network::SDN::Fabrics; +use PVE::API2::Network::SDN::PrefixLists; use base qw(PVE::RESTHandler); @@ -55,6 +56,11 @@ __PACKAGE__->register_method({ path => 'fabrics', }); +__PACKAGE__->register_method({ + subclass => "PVE::API2::Network::SDN::PrefixLists", + path => 'prefix-lists', +}); + __PACKAGE__->register_method({ name => 'index', path => '', @@ -87,6 +93,7 @@ __PACKAGE__->register_method({ { id => 'ipams' }, { id => 'dns' }, { id => 'fabrics' }, + { id => 'prefix-lists' }, ]; return $res; diff --git a/src/PVE/API2/Network/SDN/Makefile b/src/PVE/API2/Network/SDN/Makefile index 08371d2..7a89311 100644 --- a/src/PVE/API2/Network/SDN/Makefile +++ b/src/PVE/API2/Network/SDN/Makefile @@ -7,6 +7,7 @@ SOURCES=Vnets.pm\ Ips.pm\ Fabrics.pm\ RouteMaps.pm\ + PrefixLists.pm PERL5DIR=${DESTDIR}/usr/share/perl5 diff --git a/src/PVE/API2/Network/SDN/PrefixLists.pm b/src/PVE/API2/Network/SDN/PrefixLists.pm new file mode 100644 index 0000000..bc8e118 --- /dev/null +++ b/src/PVE/API2/Network/SDN/PrefixLists.pm @@ -0,0 +1,259 @@ +package PVE::API2::Network::SDN::PrefixLists; + +use strict; +use warnings; + +use PVE::Exception qw(raise_param_exc); +use PVE::JSONSchema qw(get_standard_option); +use PVE::Network::SDN::PrefixLists; +use PVE::Tools qw(extract_param); + +use PVE::RESTHandler; +use base qw(PVE::RESTHandler); + +__PACKAGE__->register_method({ + name => 'list_prefix_lists', + path => '', + method => 'GET', + permissions => { + description => + "Only returns prefix list entries where you have 'Sys.Audit' or 'Sys.Modify' permissions.", + user => 'all', + }, + description => "List Prefix Lists", + parameters => { + properties => { + running => { + type => 'boolean', + optional => 1, + description => "Display running config.", + }, + pending => { + type => 'boolean', + optional => 1, + description => "Display pending config.", + }, + }, + }, + returns => { + type => 'array', + items => { + type => "object", + properties => {}, + }, + links => [{ rel => 'child', href => "{id}" }], + }, + code => sub { + my ($param) = @_; + + my $pending = extract_param($param, 'pending'); + my $running = extract_param($param, 'running'); + + my $digest; + my $prefix_lists; + + if ($pending) { + my $current_config = PVE::Network::SDN::PrefixLists::config(); + my $running_config = PVE::Network::SDN::PrefixLists::config(1); + + my $pending_prefix_lists = PVE::Network::SDN::pending_config( + { 'prefix-lists' => { ids => $running_config->list() } }, + { ids => $current_config->list() }, + 'prefix-lists', + ); + + $digest = $current_config->digest(); + $prefix_lists = $pending_prefix_lists->{ids}; + } elsif ($running) { + $prefix_lists = PVE::Network::SDN::PrefixLists::config(1)->list(); + } else { + my $current_config = PVE::Network::SDN::PrefixLists::config(); + + $digest = $current_config->digest(); + $prefix_lists = $current_config->list(); + } + + my $rpcenv = PVE::RPCEnvironment::get(); + my $authuser = $rpcenv->get_user(); + my $prefix_list_privs = ['SDN.Audit']; + + my @res; + for my $prefix_list_id (sort keys $prefix_lists->%*) { + next + if !$rpcenv->check_any( + $authuser, + "/prefix-lists/$prefix_list_id", + $prefix_list_privs, + 1, + ); + $prefix_lists->{$prefix_list_id}->{digest} = $digest if $digest; + push @res, $prefix_lists->{$prefix_list_id}; + } + + return \@res; + }, +}); + +__PACKAGE__->register_method({ + name => 'get_prefix_list_entry', + path => '{id}', + method => 'GET', + permissions => { + check => ['perm', '/sdn/prefix-lists/{id}', ['SDN.Audit']], + }, + description => "Get Prefix List", + parameters => { + properties => { + id => get_standard_option('pve-sdn-prefix-list-id'), + }, + }, + returns => { + type => "object", + properties => {}, + }, + code => sub { + my ($param) = @_; + + my $prefix_list_id = extract_param($param, 'id'); + my $prefix_list_entry = PVE::Network::SDN::PrefixLists::config()->get($prefix_list_id); + + raise_param_exc({ 'id' => "$prefix_list_id doesn't exist" }) + if !$prefix_list_entry; + + return $prefix_list_entry; + }, +}); + +__PACKAGE__->register_method({ + name => 'create_prefix_list_entry', + path => '', + method => 'POST', + protected => 1, + permissions => { + check => ['perm', '/sdn/prefix-lists', ['SDN.Allocate']], + }, + description => "Create Prefix List", + parameters => { + properties => { + digest => get_standard_option('pve-config-digest'), + 'lock-token' => get_standard_option('pve-sdn-lock-token'), + PVE::Network::SDN::PrefixLists::prefix_list_properties(0)->%*, + }, + }, + returns => { + type => "null", + }, + code => sub { + my ($param) = @_; + + my $lock_token = extract_param($param, 'lock-token'); + + PVE::Network::SDN::lock_sdn_config( + sub { + my $config = PVE::Network::SDN::PrefixLists::config(); + + my $digest = extract_param($param, 'digest'); + PVE::Tools::assert_if_modified($config->digest(), $digest) if $digest; + + $config->create($param); + PVE::Network::SDN::PrefixLists::write_config($config); + }, + "creating prefix list failed", + $lock_token, + ); + + return; + }, +}); + +__PACKAGE__->register_method({ + name => 'update_prefix_list_entry', + path => '{id}', + method => 'PUT', + protected => 1, + permissions => { + check => ['perm', '/sdn/prefix-lists/{id}', ['SDN.Allocate']], + }, + description => "Update Prefix List", + parameters => { + properties => { + digest => get_standard_option('pve-config-digest'), + 'lock-token' => get_standard_option('pve-sdn-lock-token'), + PVE::Network::SDN::PrefixLists::prefix_list_properties(1)->%*, + }, + }, + returns => { + type => "null", + }, + code => sub { + my ($param) = @_; + + my $lock_token = extract_param($param, 'lock-token'); + + PVE::Network::SDN::lock_sdn_config( + sub { + my $config = PVE::Network::SDN::PrefixLists::config(); + + my $digest = extract_param($param, 'digest'); + PVE::Tools::assert_if_modified($config->digest(), $digest) if $digest; + + my $prefix_list_id = extract_param($param, 'id'); + my $delete = extract_param($param, 'delete'); + + $config->update($prefix_list_id, $param, $delete); + PVE::Network::SDN::PrefixLists::write_config($config); + }, + "updating prefix list failed", + $lock_token, + ); + + return; + }, +}); + +__PACKAGE__->register_method({ + name => 'delete_prefix_list_entry', + path => '{id}', + method => 'DELETE', + protected => 1, + permissions => { + check => ['perm', '/sdn/prefix-lists/{id}', ['SDN.Allocate']], + }, + description => "Delete Prefix List", + parameters => { + properties => { + digest => get_standard_option('pve-config-digest'), + 'lock-token' => get_standard_option('pve-sdn-lock-token'), + id => get_standard_option('pve-sdn-prefix-list-id'), + }, + }, + returns => { + type => "null", + }, + code => sub { + my ($param) = @_; + + my $lock_token = extract_param($param, 'lock-token'); + + PVE::Network::SDN::lock_sdn_config( + sub { + my $config = PVE::Network::SDN::PrefixLists::config(); + + my $digest = extract_param($param, 'digest'); + PVE::Tools::assert_if_modified($config->digest(), $digest) if $digest; + + my $prefix_list_id = extract_param($param, 'id'); + PVE::Network::SDN::PrefixLists::check_references($prefix_list_id); + + $config->delete($prefix_list_id); + PVE::Network::SDN::PrefixLists::write_config($config); + }, + "deleting prefix list failed", + $lock_token, + ); + + return; + }, +}); + +1; diff --git a/src/PVE/Network/SDN/PrefixLists.pm b/src/PVE/Network/SDN/PrefixLists.pm index ced2ebf..4cd7fdb 100644 --- a/src/PVE/Network/SDN/PrefixLists.pm +++ b/src/PVE/Network/SDN/PrefixLists.pm @@ -7,6 +7,7 @@ use PVE::Cluster qw(cfs_register_file cfs_read_file cfs_lock_file cfs_write_file use PVE::JSONSchema qw(get_standard_option); use PVE::INotify; use PVE::Network::SDN; +use PVE::Network::SDN::RouteMaps; use PVE::RS::SDN::PrefixLists; PVE::JSONSchema::register_format( @@ -73,6 +74,26 @@ sub write_config { cfs_write_file("sdn/prefix-lists.cfg", $config->to_raw(), 1); } +sub check_references { + my ($prefix_list_id) = @_; + + my $route_map_entries = PVE::Network::SDN::RouteMaps::config()->list(); + for my $route_map_entry (values $route_map_entries->%*) { + for my $match_action_property_string ($route_map_entry->{match}->@*) { + my $match_action = PVE::JSONSchema::parse_property_string( + $PVE::Network::SDN::RouteMaps::ROUTE_MAP_MATCH_FORMAT, + $match_action_property_string, + ); + + next if $match_action->{key} !~ m/^(.*)-prefix-list$/; + + die + "prefix list $prefix_list_id is still referenced by route map entry $route_map_entry->{'route-map-id'} #$route_map_entry->{'order'}" + if $match_action->{value} eq $prefix_list_id; + } + } +} + sub prefix_list_properties { my ($update) = @_; -- 2.47.3