]>
git.proxmox.com Git - pve-firewall.git/blob - src/PVE/API2/Firewall/Aliases.pm
1 package PVE
::API2
::Firewall
::AliasesBase
;
5 use PVE
::Exception
qw(raise raise_param_exc);
6 use PVE
::JSONSchema
qw(get_standard_option);
10 use base
qw(PVE::RESTHandler);
12 my $api_properties = {
14 description
=> "Network/IP specification in CIDR format.",
15 type
=> 'string', format
=> 'IPv4orCIDR',
17 name
=> get_standard_option
('pve-fw-alias'),
18 rename => get_standard_option
('pve-fw-alias', {
19 description
=> "Rename an existing alias.",
29 my ($class, $param) = @_;
31 die "implement this in subclass";
33 #return ($fw_conf, $rules);
37 my ($class, $param, $fw_conf, $aliases) = @_;
39 die "implement this in subclass";
42 my $additional_param_hash = {};
44 sub additional_parameters
{
45 my ($class, $new_value) = @_;
47 if (defined($new_value)) {
48 $additional_param_hash->{$class} = $new_value;
53 my $org = $additional_param_hash->{$class} || {};
54 foreach my $p (keys %$org) { $copy->{$p} = $org->{$p}; }
58 my $aliases_to_list = sub {
62 foreach my $k (sort keys %$aliases) {
63 push @$list, $aliases->{$k};
68 sub register_get_aliases
{
71 my $properties = $class->additional_parameters();
73 $class->register_method({
74 name
=> 'get_aliases',
77 description
=> "List aliases",
79 additionalProperties
=> 0,
80 properties
=> $properties,
87 name
=> { type
=> 'string' },
88 cidr
=> { type
=> 'string' },
93 digest
=> get_standard_option
('pve-config-digest', { optional
=> 0} ),
96 links
=> [ { rel
=> 'child', href
=> "{name}" } ],
101 my ($fw_conf, $aliases) = $class->load_config($param);
103 my $list = &$aliases_to_list($aliases);
105 return PVE
::Firewall
::copy_list_with_digest
($list);
109 sub register_create_alias
{
112 my $properties = $class->additional_parameters();
114 $properties->{name
} = $api_properties->{name
};
115 $properties->{cidr
} = $api_properties->{cidr
};
116 $properties->{comment
} = $api_properties->{comment
};
118 $class->register_method({
119 name
=> 'create_alias',
122 description
=> "Create IP or Network Alias.",
125 additionalProperties
=> 0,
126 properties
=> $properties,
128 returns
=> { type
=> "null" },
132 my ($fw_conf, $aliases) = $class->load_config($param);
134 my $name = lc($param->{name
});
136 raise_param_exc
({ name
=> "alias '$param->{name}' already exists" })
137 if defined($aliases->{$name});
139 my $data = { name
=> $param->{name
}, cidr
=> $param->{cidr
} };
140 $data->{comment
} = $param->{comment
} if $param->{comment
};
142 $aliases->{$name} = $data;
144 $class->save_aliases($param, $fw_conf, $aliases);
150 sub register_read_alias
{
153 my $properties = $class->additional_parameters();
155 $properties->{name
} = $api_properties->{name
};
157 $class->register_method({
158 name
=> 'read_alias',
161 description
=> "Read alias.",
163 additionalProperties
=> 0,
164 properties
=> $properties,
166 returns
=> { type
=> "object" },
170 my ($fw_conf, $aliases) = $class->load_config($param);
172 my $name = lc($param->{name
});
174 raise_param_exc
({ name
=> "no such alias" })
175 if !defined($aliases->{$name});
177 return $aliases->{$name};
181 sub register_update_alias
{
184 my $properties = $class->additional_parameters();
186 $properties->{name
} = $api_properties->{name
};
187 $properties->{rename} = $api_properties->{rename};
188 $properties->{cidr
} = $api_properties->{cidr
};
189 $properties->{comment
} = $api_properties->{comment
};
190 $properties->{digest
} = get_standard_option
('pve-config-digest');
192 $class->register_method({
193 name
=> 'update_alias',
196 description
=> "Update IP or Network alias.",
199 additionalProperties
=> 0,
200 properties
=> $properties,
202 returns
=> { type
=> "null" },
206 my ($fw_conf, $aliases) = $class->load_config($param);
208 my $list = &$aliases_to_list($aliases);
210 my (undef, $digest) = PVE
::Firewall
::copy_list_with_digest
($list);
212 PVE
::Tools
::assert_if_modified
($digest, $param->{digest
});
214 my $name = lc($param->{name
});
216 raise_param_exc
({ name
=> "no such alias" }) if !$aliases->{$name};
218 my $data = { name
=> $param->{name
}, cidr
=> $param->{cidr
} };
219 $data->{comment
} = $param->{comment
} if $param->{comment
};
221 $aliases->{$name} = $data;
223 my $rename = lc($param->{rename});
225 if ($rename && ($name ne $rename)) {
226 raise_param_exc
({ name
=> "alias '$param->{rename}' already exists" })
227 if defined($aliases->{$rename});
228 $aliases->{$name}->{name
} = $param->{rename};
229 $aliases->{$rename} = $aliases->{$name};
230 delete $aliases->{$name};
233 $class->save_aliases($param, $fw_conf, $aliases);
239 sub register_delete_alias
{
242 my $properties = $class->additional_parameters();
244 $properties->{name
} = $api_properties->{name
};
245 $properties->{cidr
} = $api_properties->{cidr
};
246 $properties->{digest
} = get_standard_option
('pve-config-digest');
248 $class->register_method({
249 name
=> 'remove_alias',
252 description
=> "Remove IP or Network alias.",
255 additionalProperties
=> 0,
256 properties
=> $properties,
258 returns
=> { type
=> "null" },
262 my ($fw_conf, $aliases) = $class->load_config($param);
264 my $list = &$aliases_to_list($aliases);
265 my (undef, $digest) = PVE
::Firewall
::copy_list_with_digest
($list);
266 PVE
::Tools
::assert_if_modified
($digest, $param->{digest
});
268 my $name = lc($param->{name
});
269 delete $aliases->{$name};
271 $class->save_aliases($param, $fw_conf, $aliases);
277 sub register_handlers
{
280 $class->register_get_aliases();
281 $class->register_create_alias();
282 $class->register_read_alias();
283 $class->register_update_alias();
284 $class->register_delete_alias();
287 package PVE
::API2
::Firewall
::ClusterAliases
;
292 use base
qw(PVE::API2::Firewall::AliasesBase);
295 my ($class, $param) = @_;
297 my $fw_conf = PVE
::Firewall
::load_clusterfw_conf
();
298 my $aliases = $fw_conf->{aliases
};
300 return ($fw_conf, $aliases);
304 my ($class, $param, $fw_conf, $aliases) = @_;
306 $fw_conf->{aliases
} = $aliases;
307 PVE
::Firewall
::save_clusterfw_conf
($fw_conf);
310 __PACKAGE__-
>register_handlers();