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

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

use strict;
use warnings;
use PVE::JSONSchema qw(get_standard_option);
use PVE::Cluster;
use PVE::Firewall;
use PVE::API2::Firewall::Rules;
use PVE::API2::Firewall::Aliases;

use Data::Dumper; # fixme: remove

use base qw(PVE::RESTHandler);

my $option_properties = {
    enable => {
	description => "Enable host firewall rules.",
	type => 'boolean',
	optional => 1,
    },
    macfilter => {
	description => "Enable/disable MAC address filter.",
	type => 'boolean',
	optional => 1,
    },
    dhcp => {
	description => "Enable DHCP.",
	type => 'boolean',
	optional => 1,
    },
    ndp => {
	description => "Enable NDP.",
	type => 'boolean',
	optional => 1,
    },
    policy_in => {
	description => "Input policy.",
	type => 'string',
	optional => 1,
	enum => ['ACCEPT', 'REJECT', 'DROP'],
    },
    policy_out => { 
	description => "Output policy.",
	type => 'string',
	optional => 1,
	enum => ['ACCEPT', 'REJECT', 'DROP'],
    },
    log_level_in =>  get_standard_option('pve-fw-loglevel', {
	description => "Log level for incoming traffic." }),
    log_level_out =>  get_standard_option('pve-fw-loglevel', {
	description => "Log level for outgoing traffic." }),

};

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) = @_;


	    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,
		},
	    },
	},
	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 $vmid = $param->{vmid};

	    my ($count, $lines) = PVE::Tools::dump_logfile("/var/log/pve-firewall.log", 
							   $param->{start}, $param->{limit},
							   "^$vmid ");
	    
	    $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',
		    },
		    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 $ipsets = {};
	    my $aliases = {};

	    foreach my $conf (($cluster_conf, $fw_conf)) {
		next if !$conf;
		if (!$param->{type} || $param->{type} eq 'ipset') {
		    foreach my $name (keys %{$conf->{ipset}}) {
			my $data = { 
			    type => 'ipset',
			    name => $name,
			    ref => "+$name",
			};
			if (my $comment = $conf->{ipset_comments}->{$name}) {
			    $data->{comment} = $comment;
			}
			$ipsets->{$name} = $data;
		    }
		}

		if (!$param->{type} || $param->{type} eq 'alias') {
		    foreach my $name (keys %{$conf->{aliases}}) {
			my $e = $conf->{aliases}->{$name};
			my $data = { 
			    type => 'alias',
			    name => $name,
			    ref => $name,
			};
			$data->{comment} = $e->{comment} if $e->{comment};
			$aliases->{$name} = $data;
		    }
		}
	    }

	    my $res = [];
	    foreach my $e (values %$ipsets) { push @$res, $e; };
	    foreach my $e (values %$aliases) { push @$res, $e; };
	    
	    return $res; 
	}});
}

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;
	5	use PVE::JSONSchema qw(get_standard_option);
	6	use PVE::Cluster;
	7	use PVE::Firewall;
464f933e	8	use PVE::API2::Firewall::Rules;
e76a9f53	9	use PVE::API2::Firewall::Aliases;
e7b35711 DM	10
	11	use Data::Dumper; # fixme: remove
	12
	13	use base qw(PVE::RESTHandler);
	14
2822f5c4 DM	15	my $option_properties = {
	16	enable => {
	17	description => "Enable host firewall rules.",
	18	type => 'boolean',
	19	optional => 1,
	20	},
44269d27 DM	21	macfilter => {
	22	description => "Enable/disable MAC address filter.",
	23	type => 'boolean',
	24	optional => 1,
	25	},
	26	dhcp => {
	27	description => "Enable DHCP.",
	28	type => 'boolean',
	29	optional => 1,
	30	},
a83abe93 WB	31	ndp => {
	32	description => "Enable NDP.",
	33	type => 'boolean',
	34	optional => 1,
	35	},
2822f5c4 DM	36	policy_in => {
	37	description => "Input policy.",
	38	type => 'string',
	39	optional => 1,
	40	enum => ['ACCEPT', 'REJECT', 'DROP'],
	41	},
	42	policy_out => {
	43	description => "Output policy.",
	44	type => 'string',
	45	optional => 1,
	46	enum => ['ACCEPT', 'REJECT', 'DROP'],
	47	},
44269d27 DM	48	log_level_in => get_standard_option('pve-fw-loglevel', {
	49	description => "Log level for incoming traffic." }),
	50	log_level_out => get_standard_option('pve-fw-loglevel', {
	51	description => "Log level for outgoing traffic." }),
	52
2822f5c4 DM	53	};
	54
	55	my $add_option_properties = sub {
	56	my ($properties) = @_;
	57
	58	foreach my $k (keys %$option_properties) {
	59	$properties->{$k} = $option_properties->{$k};
	60	}
	61
	62	return $properties;
	63	};
b6b8e6ad DM	64
	65	sub register_handlers {
	66	my ($class, $rule_env) = @_;
	67
	68	$class->register_method({
	69	name => 'index',
	70	path => '',
	71	method => 'GET',
	72	permissions => { user => 'all' },
	73	description => "Directory index.",
	74	parameters => {
	75	additionalProperties => 0,
	76	properties => {
	77	node => get_standard_option('pve-node'),
	78	vmid => get_standard_option('pve-vmid'),
	79	},
e7b35711	80	},
b6b8e6ad DM	81	returns => {
	82	type => 'array',
	83	items => {
	84	type => "object",
	85	properties => {},
2822f5c4	86	},
b6b8e6ad DM	87	links => [ { rel => 'child', href => "{name}" } ],
	88	},
	89	code => sub {
	90	my ($param) = @_;
e7b35711	91
b6b8e6ad DM	92	my $result = [
	93	{ name => 'rules' },
	94	{ name => 'aliases' },
947d6ea2 DM	95	{ name => 'ipset' },
947d6ea2 DM	96	{ name => 'refs' },
b6b8e6ad DM	97	{ name => 'options' },
b6b8e6ad DM	98	];
e7b35711	99
b6b8e6ad DM	100	return $result;
b6b8e6ad DM	101	}});
2822f5c4	102
b6b8e6ad DM	103
	104	$class->register_method({
	105	name => 'get_options',
	106	path => 'options',
	107	method => 'GET',
	108	description => "Get VM firewall options.",
	109	proxyto => 'node',
16c8f5d7 DM	110	permissions => {
	111	check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
	112	},
b6b8e6ad DM	113	parameters => {
	114	additionalProperties => 0,
	115	properties => {
	116	node => get_standard_option('pve-node'),
	117	vmid => get_standard_option('pve-vmid'),
2822f5c4 DM	118	},
2822f5c4 DM	119	},
b6b8e6ad	120	returns => {
2822f5c4	121	type => "object",
b6b8e6ad DM	122	#additionalProperties => 1,
	123	properties => $option_properties,
	124	},
	125	code => sub {
	126	my ($param) = @_;
	127
42ec8178 DM	128	my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
42ec8178 DM	129	my $vmfw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, $rule_env, $param->{vmid});
b6b8e6ad DM	130
	131	return PVE::Firewall::copy_opject_with_digest($vmfw_conf->{options});
	132	}});
	133
	134	$class->register_method({
	135	name => 'set_options',
	136	path => 'options',
	137	method => 'PUT',
	138	description => "Set Firewall options.",
	139	protected => 1,
	140	proxyto => 'node',
16c8f5d7 DM	141	permissions => {
	142	check => ['perm', '/vms/{vmid}', [ 'VM.Config.Network' ]],
	143	},
b6b8e6ad DM	144	parameters => {
	145	additionalProperties => 0,
	146	properties => &$add_option_properties({
	147	node => get_standard_option('pve-node'),
	148	vmid => get_standard_option('pve-vmid'),
	149	delete => {
	150	type => 'string', format => 'pve-configid-list',
	151	description => "A list of settings you want to delete.",
	152	optional => 1,
2822f5c4	153	},
b6b8e6ad DM	154	digest => get_standard_option('pve-config-digest'),
	155	}),
	156	},
	157	returns => { type => "null" },
	158	code => sub {
	159	my ($param) = @_;
	160
42ec8178 DM	161
	162	my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
	163	my $vmfw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, $rule_env, $param->{vmid});
b6b8e6ad DM	164
	165	my (undef, $digest) = PVE::Firewall::copy_opject_with_digest($vmfw_conf->{options});
	166	PVE::Tools::assert_if_modified($digest, $param->{digest});
	167
	168	if ($param->{delete}) {
	169	foreach my $opt (PVE::Tools::split_list($param->{delete})) {
	170	raise_param_exc({ delete => "no such option '$opt'" })
	171	if !$option_properties->{$opt};
	172	delete $vmfw_conf->{options}->{$opt};
2822f5c4 DM	173	}
2822f5c4 DM	174	}
2822f5c4	175
b6b8e6ad DM	176	if (defined($param->{enable})) {
	177	$param->{enable} = $param->{enable} ? 1 : 0;
	178	}
	179
	180	foreach my $k (keys %$option_properties) {
	181	next if !defined($param->{$k});
	182	$vmfw_conf->{options}->{$k} = $param->{$k};
	183	}
	184
	185	PVE::Firewall::save_vmfw_conf($param->{vmid}, $vmfw_conf);
	186
	187	return undef;
	188	}});
2822f5c4	189
b6b8e6ad DM	190	$class->register_method({
	191	name => 'log',
	192	path => 'log',
	193	method => 'GET',
	194	description => "Read firewall log",
	195	proxyto => 'node',
	196	permissions => {
	197	check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
	198	},
	199	protected => 1,
	200	parameters => {
	201	additionalProperties => 0,
	202	properties => {
	203	node => get_standard_option('pve-node'),
	204	vmid => get_standard_option('pve-vmid'),
	205	start => {
	206	type => 'integer',
	207	minimum => 0,
	208	optional => 1,
	209	},
	210	limit => {
	211	type => 'integer',
	212	minimum => 0,
	213	optional => 1,
	214	},
	215	},
	216	},
	217	returns => {
	218	type => 'array',
	219	items => {
	220	type => "object",
	221	properties => {
	222	n => {
	223	description=> "Line number",
	224	type=> 'integer',
	225	},
	226	t => {
	227	description=> "Line text",
	228	type => 'string',
	229	}
	230	}
	231	}
	232	},
	233	code => sub {
	234	my ($param) = @_;
e7b35711	235
b6b8e6ad DM	236	my $rpcenv = PVE::RPCEnvironment::get();
	237	my $user = $rpcenv->get_user();
	238	my $vmid = $param->{vmid};
	239
	240	my ($count, $lines) = PVE::Tools::dump_logfile("/var/log/pve-firewall.log",
	241	$param->{start}, $param->{limit},
	242	"^$vmid ");
	243
	244	$rpcenv->set_result_attrib('total', $count);
2822f5c4	245
b6b8e6ad DM	246	return $lines;
b6b8e6ad DM	247	}});
947d6ea2 DM	248
	249
	250	$class->register_method({
	251	name => 'refs',
	252	path => 'refs',
	253	method => 'GET',
	254	description => "Lists possible IPSet/Alias reference which are allowed in source/dest properties.",
16c8f5d7 DM	255	permissions => {
	256	check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
	257	},
947d6ea2 DM	258	parameters => {
	259	additionalProperties => 0,
	260	properties => {
	261	node => get_standard_option('pve-node'),
	262	vmid => get_standard_option('pve-vmid'),
f2c0865c DM	263	type => {
	264	description => "Only list references of specified type.",
	265	type => 'string',
	266	enum => ['alias', 'ipset'],
	267	optional => 1,
	268	},
947d6ea2 DM	269	},
	270	},
	271	returns => {
	272	type => 'array',
	273	items => {
	274	type => "object",
	275	properties => {
	276	type => {
	277	type => 'string',
	278	enum => ['alias', 'ipset'],
	279	},
	280	name => {
	281	type => 'string',
	282	},
	283	comment => {
	284	type => 'string',
	285	optional => 1,
	286	},
	287	},
	288	},
	289	},
	290	code => sub {
	291	my ($param) = @_;
	292
	293	my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
	294	my $fw_conf = PVE::Firewall::load_vmfw_conf($cluster_conf, $rule_env, $param->{vmid});
	295
	296	my $ipsets = {};
	297	my $aliases = {};
	298
	299	foreach my $conf (($cluster_conf, $fw_conf)) {
	300	next if !$conf;
f2c0865c DM	301	if (!$param->{type} \|\| $param->{type} eq 'ipset') {
	302	foreach my $name (keys %{$conf->{ipset}}) {
	303	my $data = {
	304	type => 'ipset',
	305	name => $name,
	306	ref => "+$name",
	307	};
	308	if (my $comment = $conf->{ipset_comments}->{$name}) {
	309	$data->{comment} = $comment;
	310	}
	311	$ipsets->{$name} = $data;
947d6ea2	312	}
947d6ea2 DM	313	}
947d6ea2 DM	314
f2c0865c DM	315	if (!$param->{type} \|\| $param->{type} eq 'alias') {
	316	foreach my $name (keys %{$conf->{aliases}}) {
	317	my $e = $conf->{aliases}->{$name};
	318	my $data = {
	319	type => 'alias',
	320	name => $name,
	321	ref => $name,
	322	};
	323	$data->{comment} = $e->{comment} if $e->{comment};
	324	$aliases->{$name} = $data;
	325	}
947d6ea2 DM	326	}
	327	}
	328
	329	my $res = [];
	330	foreach my $e (values %$ipsets) { push @$res, $e; };
	331	foreach my $e (values %$aliases) { push @$res, $e; };
	332
	333	return $res;
	334	}});
b6b8e6ad DM	335	}
	336
	337	package PVE::API2::Firewall::VM;
	338
	339	use strict;
	340	use warnings;
	341
	342	use base qw(PVE::API2::Firewall::VMBase);
	343
	344	__PACKAGE__->register_method ({
	345	subclass => "PVE::API2::Firewall::VMRules",
	346	path => 'rules',
	347	});
	348
	349	__PACKAGE__->register_method ({
	350	subclass => "PVE::API2::Firewall::VMAliases",
	351	path => 'aliases',
	352	});
	353
1210ae94 DM	354	__PACKAGE__->register_method ({
	355	subclass => "PVE::API2::Firewall::VMIPSetList",
	356	path => 'ipset',
	357	});
	358
b6b8e6ad DM	359	__PACKAGE__->register_handlers('vm');
	360
	361	package PVE::API2::Firewall::CT;
	362
	363	use strict;
	364	use warnings;
	365
	366	use base qw(PVE::API2::Firewall::VMBase);
	367
	368	__PACKAGE__->register_method ({
	369	subclass => "PVE::API2::Firewall::CTRules",
	370	path => 'rules',
	371	});
	372
	373	__PACKAGE__->register_method ({
	374	subclass => "PVE::API2::Firewall::CTAliases",
	375	path => 'aliases',
	376	});
	377
1210ae94 DM	378	__PACKAGE__->register_method ({
	379	subclass => "PVE::API2::Firewall::CTIPSetList",
	380	path => 'ipset',
	381	});
	382
b6b8e6ad	383	__PACKAGE__->register_handlers('vm');
e7b35711 DM	384
e7b35711 DM	385	1;