support comments on ipset sections

[pve-firewall.git] / src / PVE / API2 / Firewall / IPSet.pm

diff --git a/src/PVE/API2/Firewall/IPSet.pm b/src/PVE/API2/Firewall/IPSet.pm
index 646a01825bba55fa94dfbdb80226e8a469f92a99..0e73dd4abf83fae1cd1f90749bf24444af5dd06c 100644 (file)
--- a/src/PVE/API2/Firewall/IPSet.pm
+++ b/src/PVE/API2/Firewall/IPSet.pm
@@ -14,10 +14,7 @@ my $api_properties = {
        description => "Network/IP specification in CIDR format.",
        type => 'string', format => 'IPv4orCIDR',
     },
-    name => {
-       description => "IP set name.",
-       type => 'string',
-    },
+    name => get_standard_option('ipset-name'),
     comment => {
        type => 'string',
        optional => 1,
@@ -89,7 +86,8 @@ sub register_get_ipset {
                    nomatch => {
                        type => 'boolean',
                        optional => 1,
-                   },                  
+                   },
+                   digest => get_standard_option('pve-config-digest', { optional => 0} ),      
                },
            },
            links => [ { rel => 'child', href => "{cidr}" } ],
@@ -99,7 +97,18 @@ sub register_get_ipset {
 
            my ($fw_conf, $ipset) = $class->load_config($param);
 
-           return $ipset;
+           my $digest = $fw_conf->{digest};
+
+           my $res = [];
+           foreach my $entry (@$ipset) {
+               my $data = {digest => $digest};
+               foreach my $k (qw(cidr comment nomatch)) {
+                   $data->{$k} = $entry->{$k} if $entry->{$k};
+               }
+               push @$res, $data;
+           }
+
+           return $res;
        }});
 }
 
@@ -112,7 +121,7 @@ sub register_create_ip {
     $properties->{cidr} = $api_properties->{cidr};
     $properties->{nomatch} = $api_properties->{nomatch};
     $properties->{comment} = $api_properties->{comment};
-    
+
     $class->register_method({
        name => 'create_ip',
        path => '',
@@ -171,9 +180,13 @@ sub register_read_ip {
            my ($param) = @_;
 
            my ($fw_conf, $ipset) = $class->load_config($param);
+           my $digest = $fw_conf->{digest};
 
            foreach my $entry (@$ipset) {
-               return $entry if $entry->{cidr} eq $param->{cidr};
+               if ($entry->{cidr} eq $param->{cidr}) {
+                   $entry->{digest} = $digest;
+                   return $entry;
+               }
            }
 
            raise_param_exc({ cidr => "no such IP/Network" });
@@ -189,7 +202,8 @@ sub register_update_ip {
     $properties->{cidr} = $api_properties->{cidr};
     $properties->{nomatch} = $api_properties->{nomatch};
     $properties->{comment} = $api_properties->{comment};
-    
+    $properties->{digest} = get_standard_option('pve-config-digest');
+
     $class->register_method({
        name => 'update_ip',
        path => '{cidr}',
@@ -206,6 +220,8 @@ sub register_update_ip {
 
            my ($fw_conf, $ipset) = $class->load_config($param);
 
+           PVE::Tools::assert_if_modified($fw_conf->{digest}, $param->{digest});
+
            foreach my $entry (@$ipset) {
                if($entry->{cidr} eq $param->{cidr}) {
                    $entry->{nomatch} = $param->{nomatch};
@@ -226,7 +242,8 @@ sub register_delete_ip {
 
     $properties->{name} = $api_properties->{name};
     $properties->{cidr} = $api_properties->{cidr};
-    
+    $properties->{digest} = get_standard_option('pve-config-digest');
+
     $class->register_method({
        name => 'remove_ip',
        path => '{cidr}',
@@ -243,6 +260,8 @@ sub register_delete_ip {
 
            my ($fw_conf, $ipset) = $class->load_config($param);
 
+           PVE::Tools::assert_if_modified($fw_conf->{digest}, $param->{digest});
+
            my $new = [];
    
            foreach my $entry (@$ipset) {
@@ -295,8 +314,9 @@ package PVE::API2::Firewall::BaseIPSetList;
 
 use strict;
 use warnings;
-use PVE::Firewall;
+use PVE::JSONSchema qw(get_standard_option);
 use PVE::Exception qw(raise_param_exc);
+use PVE::Firewall;
 
 use base qw(PVE::RESTHandler);
 
@@ -316,10 +336,12 @@ sub register_index {
            items => {
                type => "object",
                properties => { 
-                   name => {
-                       description => "IPSet name.",
+                   name => get_standard_option('ipset-name'),
+                   digest => get_standard_option('pve-config-digest', { optional => 0} ),
+                   comment => { 
                        type => 'string',
-                   },
+                       optional => 1,
+                   }
                },
            },
            links => [ { rel => 'child', href => "{name}" } ],
@@ -329,9 +351,19 @@ sub register_index {
            
            my $fw_conf = $class->load_config();
 
+           my $digest = $fw_conf->{digest};
+
            my $res = [];
            foreach my $name (keys %{$fw_conf->{ipset}}) {
-               push @$res, { name => $name, count => scalar(@{$fw_conf->{ipset}->{$name}}) };
+               my $data = { 
+                   name => $name,
+                   digest => $digest,
+                   count => scalar(@{$fw_conf->{ipset}->{$name}}) 
+               };
+               if (my $comment = $fw_conf->{ipset_comments}->{$name}) {
+                   $data->{comment} = $comment;
+               }
+               push @$res, $data;
            }
 
            return $res;
@@ -350,11 +382,16 @@ sub register_create {
        parameters => {
            additionalProperties => 0,
            properties => { 
-               name => {
-                   # fixme: verify format
-                   description => "IP set name.",
+               name => get_standard_option('ipset-name'),
+               comment => {
                    type => 'string',
+                   optional => 1,
                },
+               rename => get_standard_option('ipset-name', {
+                   description => "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.",
+                   optional => 1,
+               }),
+               digest => get_standard_option('pve-config-digest'),
            }
        },
        returns => { type => 'null' },
@@ -363,12 +400,31 @@ sub register_create {
            
            my $fw_conf = $class->load_config();
 
-           foreach my $name (keys %{$fw_conf->{ipset}}) {
-               raise_param_exc({ name => "IPSet '$name' already exists" }) 
-                   if $name eq $param->{name};
+           my $digest = $fw_conf->{digest};
+
+           PVE::Tools::assert_if_modified($digest, $param->{digest});
+
+           if (!$param->{rename}) {
+               foreach my $name (keys %{$fw_conf->{ipset}}) {
+                   raise_param_exc({ name => "IPSet '$name' already exists" }) 
+                       if $name eq $param->{name};
+               }
+           }
+
+           if ($param->{rename}) {
+               raise_param_exc({ name => "IPSet '$param->{rename}' does not exists" }) 
+                   if !$fw_conf->{ipset}->{$param->{rename}};
+               my $data = delete $fw_conf->{ipset}->{$param->{rename}};
+               $fw_conf->{ipset}->{$param->{name}} = $data;
+               if (my $comment = delete $fw_conf->{ipset_comments}->{$param->{rename}}) {
+                   $fw_conf->{ipset_comments}->{$param->{name}} = $comment;
+               }
+               $fw_conf->{ipset_comments}->{$param->{name}} = $param->{comment} if defined($param->{comment});
+           } else {
+               $fw_conf->{ipset}->{$param->{name}} = [];
+               $fw_conf->{ipset_comments}->{$param->{name}} = $param->{comment} if defined($param->{comment});
            }
 
-           $fw_conf->{ipset}->{$param->{name}} = [];
            $class->save_config($fw_conf);
 
            return undef;
@@ -387,12 +443,9 @@ sub register_delete {
        parameters => {
            additionalProperties => 0,
            properties => { 
-               name => {
-                   # fixme: verify format
-                   description => "IP set name.",
-                   type => 'string',
-               },
-           }
+               name => get_standard_option('ipset-name'),
+               digest => get_standard_option('pve-config-digest'),
+           },
        },
        returns => { type => 'null' },
        code => sub {
@@ -400,9 +453,11 @@ sub register_delete {
            
            my $fw_conf = $class->load_config();
 
+           PVE::Tools::assert_if_modified($fw_conf->{digest}, $param->{digest});
+
            return undef if !$fw_conf->{ipset}->{$param->{name}};
 
-           die "IPSet '$param->{name}' is not empty" 
+           die "IPSet '$param->{name}' is not empty\n" 
                if scalar(@{$fw_conf->{ipset}->{$param->{name}}});
 
            delete $fw_conf->{ipset}->{$param->{name}};