use strict;
use warnings;
use PVE::JSONSchema qw(get_standard_option);
+use PVE::Exception qw(raise raise_param_exc);
use PVE::Firewall;
use base qw(PVE::RESTHandler);
my $api_properties = {
- group => {
- description => "Security group name.",
- type => 'string',
- maxLength => 20, # fixme: what length?
- },
pos => {
description => "Rule position.",
type => 'integer',
die "implement this in subclass";
- #return ($fw_conf, $rules);
+ #return ($cluster_conf, $fw_conf, $rules);
}
sub save_rules {
die "implement this in subclass";
}
-my $need_group_param_hash = {};
+my $additional_param_hash = {};
-sub need_group_param {
+sub rule_env {
+ my ($class, $param) = @_;
+
+ die "implement this in subclass";
+}
+
+sub additional_parameters {
my ($class, $new_value) = @_;
- $need_group_param_hash->{$class} = $new_value if defined($new_value);
+ if (defined($new_value)) {
+ $additional_param_hash->{$class} = $new_value;
+ }
- return $need_group_param_hash->{$class};
+ # return a copy
+ my $copy = {};
+ my $org = $additional_param_hash->{$class} || {};
+ foreach my $p (keys %$org) { $copy->{$p} = $org->{$p}; }
+ return $copy;
}
sub register_get_rules {
my ($class) = @_;
- my $properties = {};
-
- if ($class->need_group_param()) {
- $properties->{group} = $api_properties->{group};
- }
+ my $properties = $class->additional_parameters();
$class->register_method({
name => 'get_rules',
additionalProperties => 0,
properties => $properties,
},
+ proxyto => $class->rule_env() eq 'host' ? 'node' : undef,
returns => {
type => 'array',
items => {
code => sub {
my ($param) = @_;
- my ($fw_conf, $rules) = $class->load_config($param);
-
- my $digest = $fw_conf->{digest};
+ my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
- my $res = [];
+ my ($list, $digest) = PVE::Firewall::copy_list_with_digest($rules);
my $ind = 0;
- foreach my $rule (@$rules) {
- push @$res, PVE::Firewall::cleanup_fw_rule($rule, $digest, $ind++);
+ foreach my $rule (@$list) {
+ $rule->{pos} = $ind++;
}
- return $res;
+ return $list;
}});
}
sub register_get_rule {
my ($class) = @_;
- my $properties = {};
+ my $properties = $class->additional_parameters();
$properties->{pos} = $api_properties->{pos};
- if ($class->need_group_param()) {
- $properties->{group} = $api_properties->{group};
- }
-
$class->register_method({
name => 'get_rule',
path => '{pos}',
additionalProperties => 0,
properties => $properties,
},
+ proxyto => $class->rule_env() eq 'host' ? 'node' : undef,
returns => {
type => "object",
properties => {
code => sub {
my ($param) = @_;
- my ($fw_conf, $rules) = $class->load_config($param);
+ my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
- my $digest = $fw_conf->{digest};
- # fixme: check digest
+ my ($list, $digest) = PVE::Firewall::copy_list_with_digest($rules);
- die "no rule at position $param->{pos}\n" if $param->{pos} >= scalar(@$rules);
+ die "no rule at position $param->{pos}\n" if $param->{pos} >= scalar(@$list);
- my $rule = $rules->[$param->{pos}];
-
- return PVE::Firewall::cleanup_fw_rule($rule, $digest, $param->{pos});
+ my $rule = $list->[$param->{pos}];
+ $rule->{pos} = $param->{pos};
+
+ return $rule;
}});
}
sub register_create_rule {
my ($class) = @_;
- my $properties = {};
-
- if ($class->need_group_param()) {
- $properties->{group} = $api_properties->{group};
- }
+ my $properties = $class->additional_parameters();
my $create_rule_properties = PVE::Firewall::add_rule_properties($properties);
-
+ $create_rule_properties->{action}->{optional} = 0;
+ $create_rule_properties->{type}->{optional} = 0;
+
$class->register_method({
name => 'create_rule',
path => '',
additionalProperties => 0,
properties => $create_rule_properties,
},
+ proxyto => $class->rule_env() eq 'host' ? 'node' : undef,
returns => { type => "null" },
code => sub {
my ($param) = @_;
- my ($fw_conf, $rules) = $class->load_config($param);
+ my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
- my $digest = $fw_conf->{digest};
-
- my $rule = { type => 'out', action => 'ACCEPT', enable => 0};
+ my $rule = {};
PVE::Firewall::copy_rule_data($rule, $param);
+ PVE::Firewall::verify_rule($rule, $cluster_conf, $fw_conf, $class->rule_env());
+
+ $rule->{enable} = 0 if !defined($param->{enable});
unshift @$rules, $rule;
sub register_update_rule {
my ($class) = @_;
- my $properties = {};
+ my $properties = $class->additional_parameters();
$properties->{pos} = $api_properties->{pos};
- if ($class->need_group_param()) {
- $properties->{group} = $api_properties->{group};
- }
-
$properties->{moveto} = {
description => "Move rule to new position <moveto>. Other arguments are ignored.",
type => 'integer',
optional => 1,
};
+ $properties->{delete} = {
+ type => 'string', format => 'pve-configid-list',
+ description => "A list of settings you want to delete.",
+ optional => 1,
+ };
+
my $update_rule_properties = PVE::Firewall::add_rule_properties($properties);
$class->register_method({
additionalProperties => 0,
properties => $update_rule_properties,
},
+ proxyto => $class->rule_env() eq 'host' ? 'node' : undef,
returns => { type => "null" },
code => sub {
my ($param) = @_;
- my ($fw_conf, $rules) = $class->load_config($param);
+ my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
+
+ my (undef, $digest) = PVE::Firewall::copy_list_with_digest($rules);
+ PVE::Tools::assert_if_modified($digest, $param->{digest});
- my $digest = $fw_conf->{digest};
- # fixme: check digest
-
die "no rule at position $param->{pos}\n" if $param->{pos} >= scalar(@$rules);
my $rule = $rules->[$param->{pos}];
$rules = $newrules;
} else {
PVE::Firewall::copy_rule_data($rule, $param);
+
+ PVE::Firewall::delete_rule_properties($rule, $param->{'delete'}) if $param->{'delete'};
+
+ PVE::Firewall::verify_rule($rule, $cluster_conf, $fw_conf, $class->rule_env());
}
$class->save_rules($param, $fw_conf, $rules);
sub register_delete_rule {
my ($class) = @_;
- my $properties = {};
+ my $properties = $class->additional_parameters();
$properties->{pos} = $api_properties->{pos};
-
- if ($class->need_group_param()) {
- $properties->{group} = $api_properties->{group};
- }
+ $properties->{digest} = get_standard_option('pve-config-digest');
+
$class->register_method({
name => 'delete_rule',
path => '{pos}',
additionalProperties => 0,
properties => $properties,
},
+ proxyto => $class->rule_env() eq 'host' ? 'node' : undef,
returns => { type => "null" },
code => sub {
my ($param) = @_;
- my ($fw_conf, $rules) = $class->load_config($param);
+ my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
- my $digest = $fw_conf->{digest};
- # fixme: check digest
+ my (undef, $digest) = PVE::Firewall::copy_list_with_digest($rules);
+ PVE::Tools::assert_if_modified($digest, $param->{digest});
die "no rule at position $param->{pos}\n" if $param->{pos} >= scalar(@$rules);
use strict;
use warnings;
+use PVE::JSONSchema qw(get_standard_option);
use base qw(PVE::API2::Firewall::RulesBase);
-__PACKAGE__->need_group_param(1);
+__PACKAGE__->additional_parameters({ group => get_standard_option('pve-security-group-name') });
+
+
+sub rule_env {
+ my ($class, $param) = @_;
+
+ return 'group';
+}
sub load_config {
my ($class, $param) = @_;
my $rules = $fw_conf->{groups}->{$param->{group}};
die "no such security group '$param->{group}'\n" if !defined($rules);
- return ($fw_conf, $rules);
+ return (undef, $fw_conf, $rules);
}
sub save_rules {
my ($class, $param, $fw_conf, $rules) = @_;
- $fw_conf->{groups}->{$param->{group}} = $rules;
+ if (!defined($rules)) {
+ delete $fw_conf->{groups}->{$param->{group}};
+ } else {
+ $fw_conf->{groups}->{$param->{group}} = $rules;
+ }
+
PVE::Firewall::save_clusterfw_conf($fw_conf);
}
-__PACKAGE__->register_handlers('groups');
+__PACKAGE__->register_method({
+ name => 'delete_security_group',
+ path => '',
+ method => 'DELETE',
+ description => "Delete security group.",
+ protected => 1,
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ group => get_standard_option('pve-security-group-name'),
+ },
+ },
+ returns => { type => 'null' },
+ code => sub {
+ my ($param) = @_;
+
+ my (undef, $cluster_conf, $rules) = __PACKAGE__->load_config($param);
+
+ die "Security group '$param->{group}' is not empty\n"
+ if scalar(@$rules);
+
+ __PACKAGE__->save_rules($param, $cluster_conf, undef);
+
+ return undef;
+ }});
+
+__PACKAGE__->register_handlers();
package PVE::API2::Firewall::ClusterRules;
use base qw(PVE::API2::Firewall::RulesBase);
+sub rule_env {
+ my ($class, $param) = @_;
+
+ return 'cluster';
+}
+
sub load_config {
my ($class, $param) = @_;
my $fw_conf = PVE::Firewall::load_clusterfw_conf();
my $rules = $fw_conf->{rules};
- return ($fw_conf, $rules);
+ return (undef, $fw_conf, $rules);
}
sub save_rules {
PVE::Firewall::save_clusterfw_conf($fw_conf);
}
-__PACKAGE__->register_handlers('cluster');
+__PACKAGE__->register_handlers();
+
+package PVE::API2::Firewall::HostRules;
+
+use strict;
+use warnings;
+use PVE::JSONSchema qw(get_standard_option);
+
+use base qw(PVE::API2::Firewall::RulesBase);
+
+__PACKAGE__->additional_parameters({ node => get_standard_option('pve-node')});
+
+sub rule_env {
+ my ($class, $param) = @_;
+
+ return 'host';
+}
+
+sub load_config {
+ my ($class, $param) = @_;
+
+ my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
+ my $fw_conf = PVE::Firewall::load_hostfw_conf($cluster_conf);
+ my $rules = $fw_conf->{rules};
+
+ return ($cluster_conf, $fw_conf, $rules);
+}
+
+sub save_rules {
+ my ($class, $param, $fw_conf, $rules) = @_;
+
+ $fw_conf->{rules} = $rules;
+ PVE::Firewall::save_hostfw_conf($fw_conf);
+}
+
+__PACKAGE__->register_handlers();
+
+package PVE::API2::Firewall::VMRules;
+
+use strict;
+use warnings;
+use PVE::JSONSchema qw(get_standard_option);
+
+use base qw(PVE::API2::Firewall::RulesBase);
+
+__PACKAGE__->additional_parameters({
+ node => get_standard_option('pve-node'),
+ vmid => get_standard_option('pve-vmid'),
+});
+
+sub rule_env {
+ my ($class, $param) = @_;
+
+ return 'vm';
+}
+
+sub load_config {
+ my ($class, $param) = @_;
+
+ my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
+ my $fw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, 'vm', $param->{vmid});
+ my $rules = $fw_conf->{rules};
+
+ return ($cluster_conf, $fw_conf, $rules);
+}
+
+sub save_rules {
+ my ($class, $param, $fw_conf, $rules) = @_;
+
+ $fw_conf->{rules} = $rules;
+ PVE::Firewall::save_vmfw_conf($param->{vmid}, $fw_conf);
+}
+
+__PACKAGE__->register_handlers();
+
+package PVE::API2::Firewall::CTRules;
+
+use strict;
+use warnings;
+use PVE::JSONSchema qw(get_standard_option);
+
+use base qw(PVE::API2::Firewall::RulesBase);
+
+__PACKAGE__->additional_parameters({
+ node => get_standard_option('pve-node'),
+ vmid => get_standard_option('pve-vmid'),
+});
+
+sub rule_env {
+ my ($class, $param) = @_;
+
+ return 'ct';
+}
+
+sub load_config {
+ my ($class, $param) = @_;
+
+ my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
+ my $fw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, 'ct', $param->{vmid});
+ my $rules = $fw_conf->{rules};
+
+ return ($cluster_conf, $fw_conf, $rules);
+}
+
+sub save_rules {
+ my ($class, $param, $fw_conf, $rules) = @_;
+
+ $fw_conf->{rules} = $rules;
+ PVE::Firewall::save_vmfw_conf($param->{vmid}, $fw_conf);
+}
+
+__PACKAGE__->register_handlers();
1;
projects / pve-firewall.git / blobdiff