]>
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,
133 my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
135 my ($list, $digest) = PVE
::Firewall
::copy_list_with_digest
($rules);
137 die "no rule at position $param->{pos}\n" if $param->{pos} >= scalar(@$list);
139 my $rule = $list->[$param->{pos}];
140 $rule->{pos} = $param->{pos};
146 sub register_create_rule
{
149 my $properties = $class->additional_parameters();
151 my $create_rule_properties = PVE
::Firewall
::add_rule_properties
($properties);
152 $create_rule_properties->{action
}->{optional
} = 0;
153 $create_rule_properties->{type
}->{optional
} = 0;
155 my $rule_env = $class->rule_env();
157 $class->register_method({
158 name
=> 'create_rule',
161 description
=> "Create new rule.",
163 permissions
=> PVE
::Firewall
::rules_modify_permissions
($rule_env),
165 additionalProperties
=> 0,
166 properties
=> $create_rule_properties,
168 proxyto
=> $rule_env eq 'host' ?
'node' : undef,
169 returns
=> { type
=> "null" },
173 my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
177 PVE
::Firewall
::copy_rule_data
($rule, $param);
178 PVE
::Firewall
::verify_rule
($rule, $cluster_conf, $fw_conf, $class->rule_env());
180 $rule->{enable
} = 0 if !defined($param->{enable
});
182 unshift @$rules, $rule;
184 $class->save_rules($param, $fw_conf, $rules);
190 sub register_update_rule
{
193 my $properties = $class->additional_parameters();
195 $properties->{pos} = $api_properties->{pos};
197 my $rule_env = $class->rule_env();
199 $properties->{moveto
} = {
200 description
=> "Move rule to new position <moveto>. Other arguments are ignored.",
206 $properties->{delete} = {
207 type
=> 'string', format
=> 'pve-configid-list',
208 description
=> "A list of settings you want to delete.",
212 my $update_rule_properties = PVE
::Firewall
::add_rule_properties
($properties);
214 $class->register_method({
215 name
=> 'update_rule',
218 description
=> "Modify rule data.",
220 permissions
=> PVE
::Firewall
::rules_modify_permissions
($rule_env),
222 additionalProperties
=> 0,
223 properties
=> $update_rule_properties,
225 proxyto
=> $rule_env eq 'host' ?
'node' : undef,
226 returns
=> { type
=> "null" },
230 my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
232 my (undef, $digest) = PVE
::Firewall
::copy_list_with_digest
($rules);
233 PVE
::Tools
::assert_if_modified
($digest, $param->{digest
});
235 die "no rule at position $param->{pos}\n" if $param->{pos} >= scalar(@$rules);
237 my $rule = $rules->[$param->{pos}];
239 my $moveto = $param->{moveto
};
240 if (defined($moveto) && $moveto != $param->{pos}) {
242 for (my $i = 0; $i < scalar(@$rules); $i++) {
243 next if $i == $param->{pos};
245 push @$newrules, $rule;
247 push @$newrules, $rules->[$i];
249 push @$newrules, $rule if $moveto >= scalar(@$rules);
252 PVE
::Firewall
::copy_rule_data
($rule, $param);
254 PVE
::Firewall
::delete_rule_properties
($rule, $param->{'delete'}) if $param->{'delete'};
256 PVE
::Firewall
::verify_rule
($rule, $cluster_conf, $fw_conf, $class->rule_env());
259 $class->save_rules($param, $fw_conf, $rules);
265 sub register_delete_rule
{
268 my $properties = $class->additional_parameters();
270 $properties->{pos} = $api_properties->{pos};
272 $properties->{digest
} = get_standard_option
('pve-config-digest');
274 my $rule_env = $class->rule_env();
276 $class->register_method({
277 name
=> 'delete_rule',
280 description
=> "Delete rule.",
282 permissions
=> PVE
::Firewall
::rules_modify_permissions
($rule_env),
284 additionalProperties
=> 0,
285 properties
=> $properties,
287 proxyto
=> $rule_env eq 'host' ?
'node' : undef,
288 returns
=> { type
=> "null" },
292 my ($cluster_conf, $fw_conf, $rules) = $class->load_config($param);
294 my (undef, $digest) = PVE
::Firewall
::copy_list_with_digest
($rules);
295 PVE
::Tools
::assert_if_modified
($digest, $param->{digest
});
297 die "no rule at position $param->{pos}\n" if $param->{pos} >= scalar(@$rules);
299 splice(@$rules, $param->{pos}, 1);
301 $class->save_rules($param, $fw_conf, $rules);
307 sub register_handlers
{
310 $class->register_get_rules();
311 $class->register_get_rule();
312 $class->register_create_rule();
313 $class->register_update_rule();
314 $class->register_delete_rule();
317 package PVE
::API2
::Firewall
::GroupRules
;
321 use PVE
::JSONSchema
qw(get_standard_option);
323 use base
qw(PVE::API2::Firewall::RulesBase);
325 __PACKAGE__-
>additional_parameters({ group
=> get_standard_option
('pve-security-group-name') });
329 my ($class, $param) = @_;
335 my ($class, $param) = @_;
337 my $fw_conf = PVE
::Firewall
::load_clusterfw_conf
();
338 my $rules = $fw_conf->{groups
}->{$param->{group
}};
339 die "no such security group '$param->{group}'\n" if !defined($rules);
341 return (undef, $fw_conf, $rules);
345 my ($class, $param, $fw_conf, $rules) = @_;
347 if (!defined($rules)) {
348 delete $fw_conf->{groups
}->{$param->{group
}};
350 $fw_conf->{groups
}->{$param->{group
}} = $rules;
353 PVE
::Firewall
::save_clusterfw_conf
($fw_conf);
356 __PACKAGE__-
>register_method({
357 name
=> 'delete_security_group',
360 description
=> "Delete security group.",
363 additionalProperties
=> 0,
365 group
=> get_standard_option
('pve-security-group-name'),
368 returns
=> { type
=> 'null' },
372 my (undef, $cluster_conf, $rules) = __PACKAGE__-
>load_config($param);
374 die "Security group '$param->{group}' is not empty\n"
377 __PACKAGE__-
>save_rules($param, $cluster_conf, undef);
382 __PACKAGE__-
>register_handlers();
384 package PVE
::API2
::Firewall
::ClusterRules
;
389 use base
qw(PVE::API2::Firewall::RulesBase);
392 my ($class, $param) = @_;
398 my ($class, $param) = @_;
400 my $fw_conf = PVE
::Firewall
::load_clusterfw_conf
();
401 my $rules = $fw_conf->{rules
};
403 return (undef, $fw_conf, $rules);
407 my ($class, $param, $fw_conf, $rules) = @_;
409 $fw_conf->{rules
} = $rules;
410 PVE
::Firewall
::save_clusterfw_conf
($fw_conf);
413 __PACKAGE__-
>register_handlers();
415 package PVE
::API2
::Firewall
::HostRules
;
419 use PVE
::JSONSchema
qw(get_standard_option);
421 use base
qw(PVE::API2::Firewall::RulesBase);
423 __PACKAGE__-
>additional_parameters({ node
=> get_standard_option
('pve-node')});
426 my ($class, $param) = @_;
432 my ($class, $param) = @_;
434 my $cluster_conf = PVE
::Firewall
::load_clusterfw_conf
();
435 my $fw_conf = PVE
::Firewall
::load_hostfw_conf
($cluster_conf);
436 my $rules = $fw_conf->{rules
};
438 return ($cluster_conf, $fw_conf, $rules);
442 my ($class, $param, $fw_conf, $rules) = @_;
444 $fw_conf->{rules
} = $rules;
445 PVE
::Firewall
::save_hostfw_conf
($fw_conf);
448 __PACKAGE__-
>register_handlers();
450 package PVE
::API2
::Firewall
::VMRules
;
454 use PVE
::JSONSchema
qw(get_standard_option);
456 use base
qw(PVE::API2::Firewall::RulesBase);
458 __PACKAGE__-
>additional_parameters({
459 node
=> get_standard_option
('pve-node'),
460 vmid
=> get_standard_option
('pve-vmid'),
464 my ($class, $param) = @_;
470 my ($class, $param) = @_;
472 my $cluster_conf = PVE
::Firewall
::load_clusterfw_conf
();
473 my $fw_conf = PVE
::Firewall
::load_vmfw_conf
($cluster_conf, 'vm', $param->{vmid
});
474 my $rules = $fw_conf->{rules
};
476 return ($cluster_conf, $fw_conf, $rules);
480 my ($class, $param, $fw_conf, $rules) = @_;
482 $fw_conf->{rules
} = $rules;
483 PVE
::Firewall
::save_vmfw_conf
($param->{vmid
}, $fw_conf);
486 __PACKAGE__-
>register_handlers();
488 package PVE
::API2
::Firewall
::CTRules
;
492 use PVE
::JSONSchema
qw(get_standard_option);
494 use base
qw(PVE::API2::Firewall::RulesBase);
496 __PACKAGE__-
>additional_parameters({
497 node
=> get_standard_option
('pve-node'),
498 vmid
=> get_standard_option
('pve-vmid'),
502 my ($class, $param) = @_;
508 my ($class, $param) = @_;
510 my $cluster_conf = PVE
::Firewall
::load_clusterfw_conf
();
511 my $fw_conf = PVE
::Firewall
::load_vmfw_conf
($cluster_conf, 'ct', $param->{vmid
});
512 my $rules = $fw_conf->{rules
};
514 return ($cluster_conf, $fw_conf, $rules);
518 my ($class, $param, $fw_conf, $rules) = @_;
520 $fw_conf->{rules
} = $rules;
521 PVE
::Firewall
::save_vmfw_conf
($param->{vmid
}, $fw_conf);
524 __PACKAGE__-
>register_handlers();