]>
git.proxmox.com Git - pve-firewall.git/blob - src/PVE/API2/Firewall/Rules.pm
1 package PVE
::API2
::Firewall
::RulesBase
;
5 use PVE
::JSONSchema
qw(get_standard_option);
6 use PVE
::Exception
qw(raise raise_param_exc);
10 use base
qw(PVE::RESTHandler);
12 my $api_properties = {
14 description
=> "Rule position.",
21 my ($class, $param) = @_;
23 die "implement this in subclass";
25 #return ($cluster_conf, $fw_conf, $rules);
29 my ($class, $param, $fw_conf, $rules) = @_;
31 die "implement this in subclass";
34 my $additional_param_hash = {};
37 my ($class, $param) = @_;
39 die "implement this in subclass";
42 sub additional_parameters
{
43 my ($class, $new_value) = @_;
45 if (defined($new_value)) {
46 $additional_param_hash->{$class} = $new_value;
51 my $org = $additional_param_hash->{$class} || {};
52 foreach my $p (keys %$org) { $copy->{$p} = $org->{$p}; }
56 sub register_get_rules
{
59 my $properties = $class->additional_parameters();
61 my $rule_env = $class->rule_env();
63 $class->register_method({
67 description
=> "List rules.",
68 permissions
=> PVE
::Firewall
::rules_audit_permissions
($rule_env),
70 additionalProperties
=> 0,
71 properties
=> $properties,
73 proxyto
=> $rule_env eq 'host' ?
'node' : undef,
84 links
=> [ { rel
=> 'child', href
=> "{pos}" } ],
89 my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
91 my ($list, $digest) = PVE
::Firewall
::copy_list_with_digest
($rules);
94 foreach my $rule (@$list) {
95 $rule->{pos} = $ind++;
102 sub register_get_rule
{
105 my $properties = $class->additional_parameters();
107 $properties->{pos} = $api_properties->{pos};
109 my $rule_env = $class->rule_env();
111 $class->register_method({
115 description
=> "Get single rule data.",
116 permissions
=> PVE
::Firewall
::rules_audit_permissions
($rule_env),
118 additionalProperties
=> 0,
119 properties
=> $properties,
121 proxyto
=> $rule_env eq 'host' ?
'node' : undef,
179 my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
181 my ($list, $digest) = PVE
::Firewall
::copy_list_with_digest
($rules);
183 die "no rule at position $param->{pos}\n" if $param->{pos} >= scalar(@$list);
185 my $rule = $list->[$param->{pos}];
186 $rule->{pos} = $param->{pos};
192 sub register_create_rule
{
195 my $properties = $class->additional_parameters();
197 my $create_rule_properties = PVE
::Firewall
::add_rule_properties
($properties);
198 $create_rule_properties->{action
}->{optional
} = 0;
199 $create_rule_properties->{type
}->{optional
} = 0;
201 my $rule_env = $class->rule_env();
203 $class->register_method({
204 name
=> 'create_rule',
207 description
=> "Create new rule.",
209 permissions
=> PVE
::Firewall
::rules_modify_permissions
($rule_env),
211 additionalProperties
=> 0,
212 properties
=> $create_rule_properties,
214 proxyto
=> $rule_env eq 'host' ?
'node' : undef,
215 returns
=> { type
=> "null" },
219 my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
223 PVE
::Firewall
::copy_rule_data
($rule, $param);
224 PVE
::Firewall
::verify_rule
($rule, $cluster_conf, $fw_conf, $class->rule_env());
226 $rule->{enable
} = 0 if !defined($param->{enable
});
228 unshift @$rules, $rule;
230 $class->save_rules($param, $fw_conf, $rules);
236 sub register_update_rule
{
239 my $properties = $class->additional_parameters();
241 $properties->{pos} = $api_properties->{pos};
243 my $rule_env = $class->rule_env();
245 $properties->{moveto
} = {
246 description
=> "Move rule to new position <moveto>. Other arguments are ignored.",
252 $properties->{delete} = {
253 type
=> 'string', format
=> 'pve-configid-list',
254 description
=> "A list of settings you want to delete.",
258 my $update_rule_properties = PVE
::Firewall
::add_rule_properties
($properties);
260 $class->register_method({
261 name
=> 'update_rule',
264 description
=> "Modify rule data.",
266 permissions
=> PVE
::Firewall
::rules_modify_permissions
($rule_env),
268 additionalProperties
=> 0,
269 properties
=> $update_rule_properties,
271 proxyto
=> $rule_env eq 'host' ?
'node' : undef,
272 returns
=> { type
=> "null" },
276 my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
278 my (undef, $digest) = PVE
::Firewall
::copy_list_with_digest
($rules);
279 PVE
::Tools
::assert_if_modified
($digest, $param->{digest
});
281 die "no rule at position $param->{pos}\n" if $param->{pos} >= scalar(@$rules);
283 my $rule = $rules->[$param->{pos}];
285 my $moveto = $param->{moveto
};
286 if (defined($moveto) && $moveto != $param->{pos}) {
288 for (my $i = 0; $i < scalar(@$rules); $i++) {
289 next if $i == $param->{pos};
291 push @$newrules, $rule;
293 push @$newrules, $rules->[$i];
295 push @$newrules, $rule if $moveto >= scalar(@$rules);
298 PVE
::Firewall
::copy_rule_data
($rule, $param);
300 PVE
::Firewall
::delete_rule_properties
($rule, $param->{'delete'}) if $param->{'delete'};
302 PVE
::Firewall
::verify_rule
($rule, $cluster_conf, $fw_conf, $class->rule_env());
305 $class->save_rules($param, $fw_conf, $rules);
311 sub register_delete_rule
{
314 my $properties = $class->additional_parameters();
316 $properties->{pos} = $api_properties->{pos};
318 $properties->{digest
} = get_standard_option
('pve-config-digest');
320 my $rule_env = $class->rule_env();
322 $class->register_method({
323 name
=> 'delete_rule',
326 description
=> "Delete rule.",
328 permissions
=> PVE
::Firewall
::rules_modify_permissions
($rule_env),
330 additionalProperties
=> 0,
331 properties
=> $properties,
333 proxyto
=> $rule_env eq 'host' ?
'node' : undef,
334 returns
=> { type
=> "null" },
338 my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
340 my (undef, $digest) = PVE
::Firewall
::copy_list_with_digest
($rules);
341 PVE
::Tools
::assert_if_modified
($digest, $param->{digest
});
343 die "no rule at position $param->{pos}\n" if $param->{pos} >= scalar(@$rules);
345 splice(@$rules, $param->{pos}, 1);
347 $class->save_rules($param, $fw_conf, $rules);
353 sub register_handlers
{
356 $class->register_get_rules();
357 $class->register_get_rule();
358 $class->register_create_rule();
359 $class->register_update_rule();
360 $class->register_delete_rule();
363 package PVE
::API2
::Firewall
::GroupRules
;
367 use PVE
::JSONSchema
qw(get_standard_option);
369 use base
qw(PVE::API2::Firewall::RulesBase);
371 __PACKAGE__-
>additional_parameters({ group
=> get_standard_option
('pve-security-group-name') });
375 my ($class, $param) = @_;
381 my ($class, $param) = @_;
383 my $fw_conf = PVE
::Firewall
::load_clusterfw_conf
();
384 my $rules = $fw_conf->{groups
}->{$param->{group
}};
385 die "no such security group '$param->{group}'\n" if !defined($rules);
387 return (undef, $fw_conf, $rules);
391 my ($class, $param, $fw_conf, $rules) = @_;
393 if (!defined($rules)) {
394 delete $fw_conf->{groups
}->{$param->{group
}};
396 $fw_conf->{groups
}->{$param->{group
}} = $rules;
399 PVE
::Firewall
::save_clusterfw_conf
($fw_conf);
402 __PACKAGE__-
>register_method({
403 name
=> 'delete_security_group',
406 description
=> "Delete security group.",
409 check
=> ['perm', '/', [ 'Sys.Modify' ]],
412 additionalProperties
=> 0,
414 group
=> get_standard_option
('pve-security-group-name'),
417 returns
=> { type
=> 'null' },
421 my (undef, $cluster_conf, $rules) = __PACKAGE__-
>load_config($param);
423 die "Security group '$param->{group}' is not empty\n"
426 __PACKAGE__-
>save_rules($param, $cluster_conf, undef);
431 __PACKAGE__-
>register_handlers();
433 package PVE
::API2
::Firewall
::ClusterRules
;
438 use base
qw(PVE::API2::Firewall::RulesBase);
441 my ($class, $param) = @_;
447 my ($class, $param) = @_;
449 my $fw_conf = PVE
::Firewall
::load_clusterfw_conf
();
450 my $rules = $fw_conf->{rules
};
452 return (undef, $fw_conf, $rules);
456 my ($class, $param, $fw_conf, $rules) = @_;
458 $fw_conf->{rules
} = $rules;
459 PVE
::Firewall
::save_clusterfw_conf
($fw_conf);
462 __PACKAGE__-
>register_handlers();
464 package PVE
::API2
::Firewall
::HostRules
;
468 use PVE
::JSONSchema
qw(get_standard_option);
470 use base
qw(PVE::API2::Firewall::RulesBase);
472 __PACKAGE__-
>additional_parameters({ node
=> get_standard_option
('pve-node')});
475 my ($class, $param) = @_;
481 my ($class, $param) = @_;
483 my $cluster_conf = PVE
::Firewall
::load_clusterfw_conf
();
484 my $fw_conf = PVE
::Firewall
::load_hostfw_conf
($cluster_conf);
485 my $rules = $fw_conf->{rules
};
487 return ($cluster_conf, $fw_conf, $rules);
491 my ($class, $param, $fw_conf, $rules) = @_;
493 $fw_conf->{rules
} = $rules;
494 PVE
::Firewall
::save_hostfw_conf
($fw_conf);
497 __PACKAGE__-
>register_handlers();
499 package PVE
::API2
::Firewall
::VMRules
;
503 use PVE
::JSONSchema
qw(get_standard_option);
505 use base
qw(PVE::API2::Firewall::RulesBase);
507 __PACKAGE__-
>additional_parameters({
508 node
=> get_standard_option
('pve-node'),
509 vmid
=> get_standard_option
('pve-vmid'),
513 my ($class, $param) = @_;
519 my ($class, $param) = @_;
521 my $cluster_conf = PVE
::Firewall
::load_clusterfw_conf
();
522 my $fw_conf = PVE
::Firewall
::load_vmfw_conf
($cluster_conf, 'vm', $param->{vmid
});
523 my $rules = $fw_conf->{rules
};
525 return ($cluster_conf, $fw_conf, $rules);
529 my ($class, $param, $fw_conf, $rules) = @_;
531 $fw_conf->{rules
} = $rules;
532 PVE
::Firewall
::save_vmfw_conf
($param->{vmid
}, $fw_conf);
535 __PACKAGE__-
>register_handlers();
537 package PVE
::API2
::Firewall
::CTRules
;
541 use PVE
::JSONSchema
qw(get_standard_option);
543 use base
qw(PVE::API2::Firewall::RulesBase);
545 __PACKAGE__-
>additional_parameters({
546 node
=> get_standard_option
('pve-node'),
547 vmid
=> get_standard_option
('pve-vmid'),
551 my ($class, $param) = @_;
557 my ($class, $param) = @_;
559 my $cluster_conf = PVE
::Firewall
::load_clusterfw_conf
();
560 my $fw_conf = PVE
::Firewall
::load_vmfw_conf
($cluster_conf, 'ct', $param->{vmid
});
561 my $rules = $fw_conf->{rules
};
563 return ($cluster_conf, $fw_conf, $rules);
567 my ($class, $param, $fw_conf, $rules) = @_;
569 $fw_conf->{rules
} = $rules;
570 PVE
::Firewall
::save_vmfw_conf
($param->{vmid
}, $fw_conf);
573 __PACKAGE__-
>register_handlers();