]> git.proxmox.com Git - pve-firewall.git/blobdiff - src/PVE/Firewall.pm
correctly save security group rules
[pve-firewall.git] / src / PVE / Firewall.pm
index 9a8561e0cf2018a3b1a0ed0243149a6f1d2eec93..336aedbd72cacd417e7533257495eb3f9aa9dba5 100644 (file)
@@ -7,10 +7,10 @@ use Data::Dumper;
 use Digest::SHA;
 use PVE::INotify;
 use PVE::Exception qw(raise raise_param_exc);
-use PVE::JSONSchema qw(get_standard_option);
+use PVE::JSONSchema qw(register_standard_option get_standard_option);
 use PVE::Cluster;
 use PVE::ProcFSTools;
-use PVE::Tools;
+use PVE::Tools qw($IPV4RE);
 use File::Basename;
 use File::Path;
 use IO::File;
@@ -35,6 +35,37 @@ eval {
     $have_pve_manager = 1;
 };
 
+PVE::JSONSchema::register_format('IPv4orCIDR', \&pve_verify_ipv4_or_cidr);
+sub pve_verify_ipv4_or_cidr {
+    my ($cidr, $noerr) = @_;
+
+    if ($cidr =~ m!^(?:$IPV4RE)(/(\d+))?$!) {
+       return $cidr if Net::IP->new($cidr); 
+       return undef if $noerr;
+       die Net::IP::Error() . "\n";
+    }
+    return undef if $noerr;
+    die "value does not look like a valid IP address or CIDR network\n";
+}
+
+PVE::JSONSchema::register_standard_option('ipset-name', {
+    description => "IP set name.",
+    type => 'string',
+    pattern => '[A-Za-z][A-Za-z0-9\-\_]+',
+    minLength => 2,
+    maxLength => 20,                     
+});
+
+my $security_group_pattern = '[A-Za-z][A-Za-z0-9\-\_]+';
+
+PVE::JSONSchema::register_standard_option('pve-security-group-name', {
+    description => "Security Group name.",
+    type => 'string',
+    pattern => $security_group_pattern,
+    minLength => 2,
+    maxLength => 20,                             
+});
+
 my $feature_ipset_nomatch = 0;
 eval  {
     my (undef, undef, $release) = POSIX::uname();
@@ -673,7 +704,7 @@ sub get_etc_protocols {
 sub parse_address_list {
     my ($str) = @_;
 
-    return if $str !~ m/^(\+)(\S+)$/; # ipset ref
+    return if $str =~ m/^(\+)(\S+)$/; # ipset ref
 
     my $count = 0;
     my $iprange = 0;
@@ -694,6 +725,8 @@ sub parse_port_name_number_or_range {
 
     my $services = PVE::Firewall::get_etc_services();
     my $count = 0;
+    my $icmp_port = 0;
+
     foreach my $item (split(/,/, $str)) {
        $count++;
        if ($item =~ m/^(\d+):(\d+)$/) {
@@ -704,10 +737,16 @@ sub parse_port_name_number_or_range {
            my $port = $1;
            die "invalid port '$port'\n" if $port > 65535;
        } else {
-           die "invalid port '$item'\n" if !$services->{byname}->{$item}; 
+           if ($icmp_type_names->{$item}) {
+               $icmp_port = 1;
+           } else {
+               die "invalid port '$item'\n" if !$services->{byname}->{$item}; 
+           }
        }
     }
 
+    die "ICPM ports not allowed in port range\n" if $icmp_port && $count > 1;
+
     return $count;
 }
 
@@ -764,9 +803,12 @@ my $rule_properties = {
        enum => ['in', 'out', 'group'],
     },
     action => {
+       description => "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.",
        type => 'string',
        optional => 1,
-       enum => ['ACCEPT', 'DROP', 'REJECT'],
+       pattern => $security_group_pattern,
+       maxLength => 20,
+       minLength => 2,
     },
     macro => {
        type => 'string',
@@ -847,6 +889,57 @@ sub delete_rule_properties {
     return $rule;
 }
 
+my $apply_macro = sub {
+    my ($macro_name, $param, $verify) = @_;
+
+    my $macro_rules = $pve_fw_parsed_macros->{$macro_name};
+    die "unknown macro '$macro_name'\n" if !$macro_rules; # should not happen
+
+    my $rules = [];
+
+    foreach my $templ (@$macro_rules) {
+       my $rule = {};
+       my $param_used = {};
+       foreach my $k (keys %$templ) {
+           my $v = $templ->{$k};
+           if ($v eq 'PARAM') {
+               $v = $param->{$k};
+               $param_used->{$k} = 1;
+           } elsif ($v eq 'DEST') {
+               $v = $param->{dest};
+               $param_used->{dest} = 1;
+           } elsif ($v eq 'SOURCE') {
+               $v = $param->{source};
+               $param_used->{source} = 1;
+           }
+
+           if (!defined($v)) {
+               my $msg = "missing parameter '$k' in macro '$macro_name'";
+               raise_param_exc({ macro => $msg }) if $verify; 
+               die "$msg\n";
+           }
+           $rule->{$k} = $v;
+       }
+       foreach my $k (keys %$param) {
+           next if $k eq 'macro';
+           next if !defined($param->{$k});
+           next if $param_used->{$k};
+           if (defined($rule->{$k})) {
+               if ($rule->{$k} ne $param->{$k}) {
+                   my $msg = "parameter '$k' already define in macro (value = '$rule->{$k}')";
+                   raise_param_exc({ $k => $msg }) if $verify; 
+                   die "$msg\n";
+               }
+           } else {
+               $rule->{$k} = $param->{$k};
+           }
+       }
+       push @$rules, $rule;
+    }
+
+    return $rules;
+};
+
 sub verify_rule {
     my ($rule, $allow_groups) = @_;
 
@@ -862,7 +955,7 @@ sub verify_rule {
        raise_param_exc({ type => "security groups not allowed"}) 
            if !$allow_groups;
        raise_param_exc({ action => "invalid characters in security group name"}) 
-           if $rule->{action} !~ m/^[A-Za-z0-9_\-]+$/;
+           if $rule->{action} !~ m/^${security_group_pattern}$/;
     } else {
        raise_param_exc({ type => "unknown rule type '$type'"});
     }
@@ -895,6 +988,10 @@ sub verify_rule {
        raise_param_exc({ dest => $@ }) if $@;
     }
 
+    if ($rule->{macro}) {
+       &$apply_macro($rule->{macro}, $rule, 1);
+    }
+
     return $rule;
 }
 
@@ -1154,50 +1251,6 @@ sub ruleset_generate_cmdstr {
     return scalar(@cmd) ? join(' ', @cmd) : undef;
 }
 
-my $apply_macro = sub {
-    my ($macro_name, $param) = @_;
-
-    my $macro_rules = $pve_fw_parsed_macros->{$macro_name};
-    die "unknown macro '$macro_name'\n" if !$macro_rules; # should not happen
-
-    my $rules = [];
-
-    foreach my $templ (@$macro_rules) {
-       my $rule = {};
-       my $param_used = {};
-       foreach my $k (keys %$templ) {
-           my $v = $templ->{$k};
-           if ($v eq 'PARAM') {
-               $v = $param->{$k};
-               $param_used->{$k} = 1;
-           } elsif ($v eq 'DEST') {
-               $v = $param->{dest};
-               $param_used->{dest} = 1;
-           } elsif ($v eq 'SOURCE') {
-               $v = $param->{source};
-               $param_used->{source} = 1;
-           }
-
-           die "missing parameter '$k' in macro '$macro_name'\n" if !defined($v);
-           $rule->{$k} = $v;
-       }
-       foreach my $k (keys %$param) {
-           next if $k eq 'macro';
-           next if !defined($param->{$k});
-           next if $param_used->{$k};
-           if (defined($rule->{$k})) {
-               die "parameter '$k' already define in macro (value = '$rule->{$k}')\n"
-                   if $rule->{$k} ne $param->{$k};
-           } else {
-               $rule->{$k} = $param->{$k};
-           }
-       }
-       push @$rules, $rule;
-    }
-
-    return $rules;
-};
-
 sub ruleset_generate_rule {
     my ($ruleset, $chain, $rule, $actions, $goto, $cluster_conf) = @_;
 
@@ -1700,7 +1753,7 @@ sub parse_fw_rule {
        die "wrong number of rule elements\n" if scalar(@data) != 3;
        die "groups disabled\n" if !$allow_groups;
 
-       die "invalid characters in group name\n" if $action !~ m/^[A-Za-z0-9_\-]+$/;
+       die "invalid characters in group name\n" if $action !~ m/^${security_group_pattern}$/;
     } else {
        die "unknown rule type '$type'\n";
     }
@@ -1944,6 +1997,7 @@ sub parse_cluster_fw_rules {
        if ($line =~ m/^\[group\s+(\S+)\]\s*$/i) {
            $section = 'groups';
            $group = lc($1);
+           $res->{$section}->{$group} = [];
            next;
        }
 
@@ -1955,6 +2009,7 @@ sub parse_cluster_fw_rules {
        if ($line =~ m/^\[ipset\s+(\S+)\]\s*$/i) {
            $section = 'ipset';
            $group = lc($1);
+           $res->{$section}->{$group} = [];
            next;
        }
 
@@ -1986,29 +2041,26 @@ sub parse_cluster_fw_rules {
            }
            push @{$res->{$section}->{$group}}, $rule;
        } elsif ($section eq 'ipset') {
-           chomp $line;
-           $line =~ m/^(\!)?\s*((\d+)\.(\d+)\.(\d+)\.(\d+)(\/(\d+))?)/;
+           # we can add single line comments to the end of the rule
+           my $comment = decode('utf8', $1) if $line =~ s/#\s*(.*?)\s*$//;
+
+           $line =~ m/^(\!)?\s*(\S+)\s*$/;
            my $nomatch = $1;
-       my $ip = $2;
+           my $cidr = $2;
 
-           if(!$ip){
-               warn "$prefix: $line is not an valid ip address\n";
-               next;
-           }
-           if (!Net::IP->new($ip)) {
-               warn "$prefix: $line is not an valid ip address\n";
+           $cidr =~ s|/32$||;
+           
+           eval { pve_verify_ipv4_or_cidr($cidr); };
+           if (my $err = $@) {
+               warn "$prefix: $cidr - $err";
                next;
            }
 
-           if ($nomatch) {
-               if ($feature_ipset_nomatch) {
-                   push @{$res->{$section}->{$group}}, "$ip nomatch";
-               } else {
-                   warn "$prefix: ignore $line - nomatch not supported by kernel\n";
-               }
-           } else {
-               push @{$res->{$section}->{$group}}, $ip;
-           }
+           my $entry = { cidr => $cidr }; 
+           $entry->{nomatch} = 1 if $nomatch;
+           $entry->{comment} = $comment if $comment;
+           
+           push @{$res->{$section}->{$group}}, $entry;
        }
     }
 
@@ -2083,7 +2135,7 @@ my $format_rules = sub {
     my $raw = '';
 
     foreach my $rule (@$rules) {
-       if ($rule->{type} eq  'in' || $rule->{type} eq 'out') {
+       if ($rule->{type} eq  'in' || $rule->{type} eq 'out' || $rule->{type} eq 'group') {
            $raw .= '|' if defined($rule->{enable}) && !$rule->{enable};
            $raw .= uc($rule->{type});
            if ($rule->{macro}) {
@@ -2092,16 +2144,20 @@ my $format_rules = sub {
                $raw .= " " . $rule->{action};
            }
            $raw .= " " . ($rule->{iface} || '-') if $need_iface;
-           $raw .= " " . ($rule->{source} || '-');
-           $raw .= " " . ($rule->{dest} || '-');
-           $raw .= " " . ($rule->{proto} || '-');
-           $raw .= " " . ($rule->{dport} || '-');
-           $raw .= " " . ($rule->{sport} || '-');
+
+           if ($rule->{type} ne  'group')  {
+               $raw .= " " . ($rule->{source} || '-');
+               $raw .= " " . ($rule->{dest} || '-');
+               $raw .= " " . ($rule->{proto} || '-');
+               $raw .= " " . ($rule->{dport} || '-');
+               $raw .= " " . ($rule->{sport} || '-');
+           }
+
            $raw .= " # " . encode('utf8', $rule->{comment})
                if $rule->{comment} && $rule->{comment} !~ m/^\s*$/;
            $raw .= "\n";
        } else {
-           die "implement me '$rule->{type}'";
+           die "unknown rule type '$rule->{type}'";
        }
     }
 
@@ -2122,6 +2178,28 @@ my $format_options = sub {
     return $raw;
 };
 
+my $format_ipset = sub {
+    my ($options) = @_;
+
+    my $raw = '';
+
+    my $nethash = {};
+    foreach my $entry (@$options) {
+       $nethash->{$entry->{cidr}} = $entry;
+    }
+
+    foreach my $cidr (sort keys %$nethash) {
+       my $entry = $nethash->{$cidr};
+       my $line = $entry->{nomatch} ? '!' : '';
+       $line .= $entry->{cidr};
+       $line .= " # " . encode('utf8', $entry->{comment})
+           if $entry->{comment} && $entry->{comment} !~ m/^\s*$/;
+       $raw .= "$line\n";
+    }
+    return $raw;
+};
+
 sub save_vmfw_conf {
     my ($vmid, $vmfw_conf) = @_;
 
@@ -2221,8 +2299,25 @@ sub generate_ipset {
 
     push @{$ipset_ruleset->{$name}}, "create $name hash:net family inet hashsize $hashsize maxelem $hashsize";
 
-    foreach my $ip (@$options) {
-       push @{$ipset_ruleset->{$name}}, "add $name $ip";
+    # remove duplicates
+    my $nethash = {};
+    foreach my $entry (@$options) {
+       $nethash->{$entry->{cidr}} = $entry;
+    }
+
+    foreach my $cidr (sort keys %$nethash) {
+       my $entry = $nethash->{$cidr};
+
+       my $cmd = "add $name $cidr";
+       if ($entry->{nomatch}) {
+           if ($feature_ipset_nomatch) {
+               push @{$ipset_ruleset->{$name}}, "$cmd nomatch";
+           } else {
+               warn "ignore !$cidr - nomatch not supported by kernel\n";
+           }
+       } else {
+           push @{$ipset_ruleset->{$name}}, $cmd;
+       }
     }
 }
 
@@ -2304,7 +2399,12 @@ sub save_clusterfw_conf {
     my $options = $cluster_conf->{options};
     $raw .= &$format_options($options) if scalar(keys %$options);
 
-    # fixme: save ipset
+    foreach my $ipset (sort keys %{$cluster_conf->{ipset}}) {
+       $raw .= "[IPSET $ipset]\n\n";
+       my $options = $cluster_conf->{ipset}->{$ipset};
+       $raw .= &$format_ipset($options);
+       $raw .= "\n";
+    }
 
     my $rules = $cluster_conf->{rules};
     if (scalar(@$rules)) {
@@ -2583,6 +2683,13 @@ sub get_ipset_cmdlist {
     my $active_chains = ipset_get_chains();
     my $statushash = get_ruleset_status($ruleset, $active_chains, \&ipset_chain_digest, $verbose);
 
+    # remove stale _swap chains 
+    foreach my $chain (keys %$active_chains) {
+       if ($chain =~ m/^PVEFW-\S+_swap$/) {
+           $cmdlist .= "destroy $chain\n";
+       }
+    }
+
     foreach my $chain (sort keys %$ruleset) {
        my $stat = $statushash->{$chain};
        die "internal error" if !$stat;