[pve-firewall.git] / src / PVE / API2 / Firewall / VM.pm

package PVE::API2::Firewall::VMBase;

use strict;
use warnings;

use PVE::Exception qw(raise_param_exc);
use PVE::JSONSchema qw(get_standard_option);
use PVE::Cluster;
use PVE::Firewall;
use PVE::API2::Firewall::Rules;
use PVE::API2::Firewall::Aliases;


use base qw(PVE::RESTHandler);

my $option_properties = $PVE::Firewall::vm_option_properties;

my $add_option_properties = sub {
    my ($properties) = @_;

    foreach my $k (keys %$option_properties) {
	$properties->{$k} = $option_properties->{$k};
    }

    return $properties;
};

sub register_handlers {
    my ($class, $rule_env) = @_;

    $class->register_method({
	name => 'index',
	path => '',
	method => 'GET',
	permissions => { user => 'all' },
	description => "Directory index.",
	parameters => {
	    additionalProperties => 0,
	    properties => {
		node => get_standard_option('pve-node'),
		vmid => get_standard_option('pve-vmid'),
	    },
	},
	returns => {
	    type => 'array',
	    items => {
		type => "object",
		properties => {},
	    },
	    links => [ { rel => 'child', href => "{name}" } ],
	},
	code => sub {
	    my ($param) = @_;

	    my $result = [
		{ name => 'rules' },
		{ name => 'aliases' },
		{ name => 'ipset' },
		{ name => 'refs' },
		{ name => 'options' },
		];

	    return $result;
	}});


    $class->register_method({
	name => 'get_options',
	path => 'options',
	method => 'GET',
	description => "Get VM firewall options.",
	proxyto => 'node',
	permissions => {
	    check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
	},
	parameters => {
	    additionalProperties => 0,
	    properties => {
		node => get_standard_option('pve-node'),
		vmid => get_standard_option('pve-vmid'),
	    },
	},
	returns => {
	    type => "object",
	    #additionalProperties => 1,
	    properties => $option_properties,
	},
	code => sub {
	    my ($param) = @_;

	    my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
	    my $vmfw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, $rule_env, $param->{vmid});

	    return PVE::Firewall::copy_opject_with_digest($vmfw_conf->{options});
	}});

    $class->register_method({
	name => 'set_options',
	path => 'options',
	method => 'PUT',
	description => "Set Firewall options.",
	protected => 1,
	proxyto => 'node',
	permissions => {
	    check => ['perm', '/vms/{vmid}', [ 'VM.Config.Network' ]],
	},
	parameters => {
	    additionalProperties => 0,
	    properties => &$add_option_properties({
		node => get_standard_option('pve-node'),
		vmid => get_standard_option('pve-vmid'),
		delete => {
		    type => 'string', format => 'pve-configid-list',
		    description => "A list of settings you want to delete.",
		    optional => 1,
		},
		digest => get_standard_option('pve-config-digest'),
	    }),
	},
	returns => { type => "null" },
	code => sub {
	    my ($param) = @_;

	    PVE::Firewall::lock_vmfw_conf($param->{vmid}, 10, sub {
		my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
		my $vmfw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, $rule_env, $param->{vmid});

		my (undef, $digest) = PVE::Firewall::copy_opject_with_digest($vmfw_conf->{options});
		PVE::Tools::assert_if_modified($digest, $param->{digest});

		if ($param->{delete}) {
		    foreach my $opt (PVE::Tools::split_list($param->{delete})) {
			raise_param_exc({ delete => "no such option '$opt'" })
			    if !$option_properties->{$opt};
			delete $vmfw_conf->{options}->{$opt};
		    }
		}

		if (defined($param->{enable})) {
		    $param->{enable} = $param->{enable} ? 1 : 0;
		}

		foreach my $k (keys %$option_properties) {
		    next if !defined($param->{$k});
		    $vmfw_conf->{options}->{$k} = $param->{$k};
		}

		PVE::Firewall::save_vmfw_conf($param->{vmid}, $vmfw_conf);
	    });

	    return undef;
	}});

    $class->register_method({
	name => 'log',
	path => 'log',
	method => 'GET',
	description => "Read firewall log",
	proxyto => 'node',
	permissions => {
	    check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
	},
	protected => 1,
	parameters => {
	    additionalProperties => 0,
	    properties => {
		node => get_standard_option('pve-node'),
		vmid => get_standard_option('pve-vmid'),
		start => {
		    type => 'integer',
		    minimum => 0,
		    optional => 1,
		},
		limit => {
		    type => 'integer',
		    minimum => 0,
		    optional => 1,
		},
		since => {
		    type => 'integer',
		    minimum => 0,
		    description => "Display log since this UNIX epoch.",
		    optional => 1,
		},
		until => {
		    type => 'integer',
		    minimum => 0,
		    description => "Display log until this UNIX epoch.",
		    optional => 1,
		},
	    },
	},
	returns => {
	    type => 'array',
	    items => {
		type => "object",
		properties => {
		    n => {
			description=>  "Line number",
			type=> 'integer',
		    },
		    t => {
			description=>  "Line text",
			type => 'string',
		    }
		}
	    }
	},
	code => sub {
	    my ($param) = @_;

	    my $rpcenv = PVE::RPCEnvironment::get();
	    my $user = $rpcenv->get_user();
	    my $filename = "/var/log/pve-firewall.log";
	    my $vmid = $param->{'vmid'};

	    my $callback = sub {
		my ($line) = @_;
		my $reg = "^$vmid ";
		return $line =~ m/$reg/;
	    };

	    my ($count, $lines) = PVE::Firewall::Helpers::dump_fw_logfile(
		$filename, $param, $callback);

	    $rpcenv->set_result_attrib('total', $count);

	    return $lines;
	}});


    $class->register_method({
	name => 'refs',
	path => 'refs',
	method => 'GET',
	description => "Lists possible IPSet/Alias reference which are allowed in source/dest properties.",
	permissions => {
	    check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
	},
	parameters => {
	    additionalProperties => 0,
	    properties => {
		node => get_standard_option('pve-node'),
		vmid => get_standard_option('pve-vmid'),
		type => {
		    description => "Only list references of specified type.",
		    type => 'string',
		    enum => ['alias', 'ipset'],
		    optional => 1,
		},
	    },
	},
	returns => {
	    type => 'array',
	    items => {
		type => "object",
		properties => {
		    type => {
			type => 'string',
			enum => ['alias', 'ipset'],
		    },
		    name => {
			type => 'string',
		    },
		    ref => {
			type => 'string',
		    },
		    scope => {
			type => 'string',
		    },
		    comment => {
			type => 'string',
			optional => 1,
		    },
		},
	    },
	},
	code => sub {
	    my ($param) = @_;

	    my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
	    my $fw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, $rule_env, $param->{vmid});

	    my $dc_refs = PVE::Firewall::Helpers::collect_refs($cluster_conf, $param->{type}, 'dc');
	    my $vm_refs = PVE::Firewall::Helpers::collect_refs($fw_conf, $param->{type}, 'guest');

	    return [@$dc_refs, @$vm_refs];
	}});
}

package PVE::API2::Firewall::VM;

use strict;
use warnings;

use base qw(PVE::API2::Firewall::VMBase);

__PACKAGE__->register_method ({
    subclass => "PVE::API2::Firewall::VMRules",
    path => 'rules',
});

__PACKAGE__->register_method ({
    subclass => "PVE::API2::Firewall::VMAliases",
    path => 'aliases',
});

__PACKAGE__->register_method ({
    subclass => "PVE::API2::Firewall::VMIPSetList",
    path => 'ipset',
});

__PACKAGE__->register_handlers('vm');

package PVE::API2::Firewall::CT;

use strict;
use warnings;

use base qw(PVE::API2::Firewall::VMBase);

__PACKAGE__->register_method ({
    subclass => "PVE::API2::Firewall::CTRules",
    path => 'rules',
});

__PACKAGE__->register_method ({
    subclass => "PVE::API2::Firewall::CTAliases",
    path => 'aliases',
});

__PACKAGE__->register_method ({
    subclass => "PVE::API2::Firewall::CTIPSetList",
    path => 'ipset',
});

__PACKAGE__->register_handlers('vm');

1;
Commit	Line	Data
b6b8e6ad	1	package PVE::API2::Firewall::VMBase;
e7b35711 DM	2
	3	use strict;
	4	use warnings;
f6163c2e TL	5
f6163c2e TL	6	use PVE::Exception qw(raise_param_exc);
e7b35711 DM	7	use PVE::JSONSchema qw(get_standard_option);
	8	use PVE::Cluster;
	9	use PVE::Firewall;
464f933e	10	use PVE::API2::Firewall::Rules;
e76a9f53	11	use PVE::API2::Firewall::Aliases;
e7b35711	12
e7b35711 DM	13
	14	use base qw(PVE::RESTHandler);
	15
e313afe0	16	my $option_properties = $PVE::Firewall::vm_option_properties;
2822f5c4 DM	17
	18	my $add_option_properties = sub {
	19	my ($properties) = @_;
	20
	21	foreach my $k (keys %$option_properties) {
	22	$properties->{$k} = $option_properties->{$k};
	23	}
75a12a9d	24
2822f5c4 DM	25	return $properties;
2822f5c4 DM	26	};
b6b8e6ad DM	27
	28	sub register_handlers {
	29	my ($class, $rule_env) = @_;
	30
	31	$class->register_method({
	32	name => 'index',
	33	path => '',
	34	method => 'GET',
	35	permissions => { user => 'all' },
	36	description => "Directory index.",
	37	parameters => {
	38	additionalProperties => 0,
	39	properties => {
	40	node => get_standard_option('pve-node'),
	41	vmid => get_standard_option('pve-vmid'),
	42	},
e7b35711	43	},
b6b8e6ad DM	44	returns => {
	45	type => 'array',
	46	items => {
	47	type => "object",
	48	properties => {},
2822f5c4	49	},
b6b8e6ad DM	50	links => [ { rel => 'child', href => "{name}" } ],
	51	},
	52	code => sub {
	53	my ($param) = @_;
e7b35711	54
b6b8e6ad DM	55	my $result = [
	56	{ name => 'rules' },
	57	{ name => 'aliases' },
947d6ea2 DM	58	{ name => 'ipset' },
947d6ea2 DM	59	{ name => 'refs' },
b6b8e6ad DM	60	{ name => 'options' },
b6b8e6ad DM	61	];
e7b35711	62
b6b8e6ad DM	63	return $result;
b6b8e6ad DM	64	}});
2822f5c4	65
b6b8e6ad DM	66
	67	$class->register_method({
	68	name => 'get_options',
	69	path => 'options',
	70	method => 'GET',
	71	description => "Get VM firewall options.",
	72	proxyto => 'node',
16c8f5d7 DM	73	permissions => {
	74	check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
	75	},
b6b8e6ad DM	76	parameters => {
	77	additionalProperties => 0,
	78	properties => {
	79	node => get_standard_option('pve-node'),
	80	vmid => get_standard_option('pve-vmid'),
2822f5c4 DM	81	},
2822f5c4 DM	82	},
b6b8e6ad	83	returns => {
2822f5c4	84	type => "object",
b6b8e6ad DM	85	#additionalProperties => 1,
	86	properties => $option_properties,
	87	},
	88	code => sub {
	89	my ($param) = @_;
	90
42ec8178 DM	91	my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
42ec8178 DM	92	my $vmfw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, $rule_env, $param->{vmid});
b6b8e6ad DM	93
	94	return PVE::Firewall::copy_opject_with_digest($vmfw_conf->{options});
	95	}});
	96
	97	$class->register_method({
	98	name => 'set_options',
	99	path => 'options',
	100	method => 'PUT',
	101	description => "Set Firewall options.",
	102	protected => 1,
	103	proxyto => 'node',
16c8f5d7 DM	104	permissions => {
	105	check => ['perm', '/vms/{vmid}', [ 'VM.Config.Network' ]],
	106	},
b6b8e6ad DM	107	parameters => {
	108	additionalProperties => 0,
	109	properties => &$add_option_properties({
	110	node => get_standard_option('pve-node'),
	111	vmid => get_standard_option('pve-vmid'),
	112	delete => {
	113	type => 'string', format => 'pve-configid-list',
	114	description => "A list of settings you want to delete.",
	115	optional => 1,
2822f5c4	116	},
b6b8e6ad DM	117	digest => get_standard_option('pve-config-digest'),
	118	}),
	119	},
	120	returns => { type => "null" },
	121	code => sub {
	122	my ($param) = @_;
	123
a38849e6 FG	124	PVE::Firewall::lock_vmfw_conf($param->{vmid}, 10, sub {
	125	my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
	126	my $vmfw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, $rule_env, $param->{vmid});
	127
	128	my (undef, $digest) = PVE::Firewall::copy_opject_with_digest($vmfw_conf->{options});
	129	PVE::Tools::assert_if_modified($digest, $param->{digest});
	130
	131	if ($param->{delete}) {
	132	foreach my $opt (PVE::Tools::split_list($param->{delete})) {
	133	raise_param_exc({ delete => "no such option '$opt'" })
	134	if !$option_properties->{$opt};
	135	delete $vmfw_conf->{options}->{$opt};
	136	}
2822f5c4	137	}
2822f5c4	138
a38849e6 FG	139	if (defined($param->{enable})) {
	140	$param->{enable} = $param->{enable} ? 1 : 0;
	141	}
b6b8e6ad	142
a38849e6 FG	143	foreach my $k (keys %$option_properties) {
	144	next if !defined($param->{$k});
	145	$vmfw_conf->{options}->{$k} = $param->{$k};
	146	}
b6b8e6ad	147
a38849e6 FG	148	PVE::Firewall::save_vmfw_conf($param->{vmid}, $vmfw_conf);
a38849e6 FG	149	});
75a12a9d	150
b6b8e6ad DM	151	return undef;
b6b8e6ad DM	152	}});
2822f5c4	153
b6b8e6ad	154	$class->register_method({
75a12a9d TL	155	name => 'log',
75a12a9d TL	156	path => 'log',
b6b8e6ad DM	157	method => 'GET',
	158	description => "Read firewall log",
	159	proxyto => 'node',
	160	permissions => {
	161	check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
	162	},
	163	protected => 1,
	164	parameters => {
	165	additionalProperties => 0,
	166	properties => {
	167	node => get_standard_option('pve-node'),
	168	vmid => get_standard_option('pve-vmid'),
	169	start => {
	170	type => 'integer',
	171	minimum => 0,
	172	optional => 1,
	173	},
	174	limit => {
	175	type => 'integer',
	176	minimum => 0,
	177	optional => 1,
	178	},
8bd9b3e4 CE	179	since => {
	180	type => 'integer',
	181	minimum => 0,
	182	description => "Display log since this UNIX epoch.",
	183	optional => 1,
	184	},
	185	until => {
	186	type => 'integer',
	187	minimum => 0,
	188	description => "Display log until this UNIX epoch.",
	189	optional => 1,
	190	},
b6b8e6ad DM	191	},
	192	},
	193	returns => {
	194	type => 'array',
75a12a9d	195	items => {
b6b8e6ad DM	196	type => "object",
	197	properties => {
	198	n => {
	199	description=> "Line number",
	200	type=> 'integer',
	201	},
	202	t => {
	203	description=> "Line text",
	204	type => 'string',
	205	}
	206	}
	207	}
	208	},
	209	code => sub {
	210	my ($param) = @_;
e7b35711	211
b6b8e6ad DM	212	my $rpcenv = PVE::RPCEnvironment::get();
b6b8e6ad DM	213	my $user = $rpcenv->get_user();
8bd9b3e4 CE	214	my $filename = "/var/log/pve-firewall.log";
	215	my $vmid = $param->{'vmid'};
	216
	217	my $callback = sub {
	218	my ($line) = @_;
	219	my $reg = "^$vmid ";
	220	return $line =~ m/$reg/;
	221	};
b6b8e6ad	222
8bd9b3e4 CE	223	my ($count, $lines) = PVE::Firewall::Helpers::dump_fw_logfile(
8bd9b3e4 CE	224	$filename, $param, $callback);
75a12a9d	225
b6b8e6ad	226	$rpcenv->set_result_attrib('total', $count);
75a12a9d TL	227
75a12a9d TL	228	return $lines;
b6b8e6ad	229	}});
947d6ea2 DM	230
	231
	232	$class->register_method({
	233	name => 'refs',
	234	path => 'refs',
	235	method => 'GET',
	236	description => "Lists possible IPSet/Alias reference which are allowed in source/dest properties.",
16c8f5d7 DM	237	permissions => {
	238	check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
	239	},
947d6ea2 DM	240	parameters => {
	241	additionalProperties => 0,
	242	properties => {
	243	node => get_standard_option('pve-node'),
	244	vmid => get_standard_option('pve-vmid'),
f2c0865c DM	245	type => {
	246	description => "Only list references of specified type.",
	247	type => 'string',
	248	enum => ['alias', 'ipset'],
	249	optional => 1,
	250	},
947d6ea2 DM	251	},
	252	},
	253	returns => {
	254	type => 'array',
	255	items => {
	256	type => "object",
75a12a9d	257	properties => {
947d6ea2 DM	258	type => {
	259	type => 'string',
	260	enum => ['alias', 'ipset'],
	261	},
	262	name => {
	263	type => 'string',
	264	},
b06a8c2d LN	265	ref => {
	266	type => 'string',
	267	},
	268	scope => {
	269	type => 'string',
	270	},
75a12a9d	271	comment => {
947d6ea2 DM	272	type => 'string',
	273	optional => 1,
	274	},
	275	},
	276	},
	277	},
	278	code => sub {
	279	my ($param) = @_;
75a12a9d	280
947d6ea2 DM	281	my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
	282	my $fw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, $rule_env, $param->{vmid});
	283
b06a8c2d LN	284	my $dc_refs = PVE::Firewall::Helpers::collect_refs($cluster_conf, $param->{type}, 'dc');
b06a8c2d LN	285	my $vm_refs = PVE::Firewall::Helpers::collect_refs($fw_conf, $param->{type}, 'guest');
75a12a9d	286
b06a8c2d	287	return [@$dc_refs, @$vm_refs];
947d6ea2	288	}});
b6b8e6ad DM	289	}
	290
	291	package PVE::API2::Firewall::VM;
	292
	293	use strict;
	294	use warnings;
	295
	296	use base qw(PVE::API2::Firewall::VMBase);
	297
	298	__PACKAGE__->register_method ({
75a12a9d	299	subclass => "PVE::API2::Firewall::VMRules",
b6b8e6ad DM	300	path => 'rules',
	301	});
	302
	303	__PACKAGE__->register_method ({
75a12a9d	304	subclass => "PVE::API2::Firewall::VMAliases",
b6b8e6ad DM	305	path => 'aliases',
	306	});
	307
1210ae94	308	__PACKAGE__->register_method ({
75a12a9d	309	subclass => "PVE::API2::Firewall::VMIPSetList",
1210ae94 DM	310	path => 'ipset',
	311	});
	312
b6b8e6ad DM	313	__PACKAGE__->register_handlers('vm');
	314
	315	package PVE::API2::Firewall::CT;
	316
	317	use strict;
	318	use warnings;
	319
	320	use base qw(PVE::API2::Firewall::VMBase);
	321
	322	__PACKAGE__->register_method ({
75a12a9d	323	subclass => "PVE::API2::Firewall::CTRules",
b6b8e6ad DM	324	path => 'rules',
	325	});
	326
	327	__PACKAGE__->register_method ({
75a12a9d	328	subclass => "PVE::API2::Firewall::CTAliases",
b6b8e6ad DM	329	path => 'aliases',
	330	});
	331
1210ae94	332	__PACKAGE__->register_method ({
75a12a9d	333	subclass => "PVE::API2::Firewall::CTIPSetList",
1210ae94 DM	334	path => 'ipset',
	335	});
	336
b6b8e6ad	337	__PACKAGE__->register_handlers('vm');
e7b35711 DM	338
e7b35711 DM	339	1;