]>
git.proxmox.com Git - pve-access-control.git/blob - RPCEnvironment.pm
95d3029886183e488bd8bdbf76213f888eb8d83e
1 package PVE
::RPCEnvironment
;
6 use PVE
::RESTEnvironment
;
8 use PVE
::Exception
qw(raise raise_perm_exc);
14 use PVE
::AccessControl
;
16 use base
qw(PVE::RESTEnvironment);
20 my $compile_acl_path = sub {
21 my ($self, $user, $path) = @_;
23 my $cfg = $self->{user_cfg
};
25 return undef if !$cfg->{roles
};
27 die "internal error" if $user eq 'root@pam';
29 my $cache = $self->{aclcache
};
30 $cache->{$user} = {} if !$cache->{$user};
31 my $data = $cache->{$user};
33 if (!$data->{poolroles
}) {
34 $data->{poolroles
} = {};
36 foreach my $pool (keys %{$cfg->{pools
}}) {
37 my $d = $cfg->{pools
}->{$pool};
38 my @ra = PVE
::AccessControl
::roles
($cfg, $user, "/pool/$pool"); # pool roles
40 foreach my $vmid (keys %{$d->{vms
}}) {
42 $data->{poolroles
}->{"/vms/$vmid"}->{$role} = 1;
45 foreach my $storeid (keys %{$d->{storage
}}) {
47 $data->{poolroles
}->{"/storage/$storeid"}->{$role} = 1;
53 my @ra = PVE
::AccessControl
::roles
($cfg, $user, $path);
55 # apply roles inherited from pools
56 # Note: assume we do not want to propagate those privs
57 if ($data->{poolroles
}->{$path}) {
58 if (!($ra[0] && $ra[0] eq 'NoAccess')) {
59 if ($data->{poolroles
}->{$path}->{NoAccess
}) {
62 foreach my $role (keys %{$data->{poolroles
}->{$path}}) {
69 $data->{roles
}->{$path} = [ @ra ];
72 foreach my $role (@ra) {
73 if (my $privset = $cfg->{roles
}->{$role}) {
74 foreach my $p (keys %$privset) {
79 $data->{privs
}->{$path} = $privs;
85 my ($self, $user, $path) = @_;
87 if ($user eq 'root@pam') { # root can do anything
88 return ('Administrator');
91 $user = PVE
::AccessControl
::verify_username
($user, 1);
94 my $cache = $self->{aclcache
};
95 $cache->{$user} = {} if !$cache->{$user};
97 my $acl = $cache->{$user};
99 my $roles = $acl->{roles
}->{$path};
100 return @$roles if $roles;
102 &$compile_acl_path($self, $user, $path);
103 $roles = $acl->{roles
}->{$path} || [];
108 my ($self, $user, $path) = @_;
110 if ($user eq 'root@pam') { # root can do anything
111 my $cfg = $self->{user_cfg
};
112 return $cfg->{roles
}->{'Administrator'};
115 $user = PVE
::AccessControl
::verify_username
($user, 1);
118 my $cache = $self->{aclcache
};
119 $cache->{$user} = {} if !$cache->{$user};
121 my $acl = $cache->{$user};
123 my $perm = $acl->{privs
}->{$path};
124 return $perm if $perm;
126 return &$compile_acl_path($self, $user, $path);
130 my ($self, $user, $path, $privs, $noerr) = @_;
132 my $perm = $self->permissions($user, $path);
134 foreach my $priv (@$privs) {
135 PVE
::AccessControl
::verify_privname
($priv);
136 if (!$perm->{$priv}) {
137 return undef if $noerr;
138 raise_perm_exc
("$path, $priv");
146 my ($self, $user, $path, $privs, $noerr) = @_;
148 my $perm = $self->permissions($user, $path);
151 foreach my $priv (@$privs) {
152 PVE
::AccessControl
::verify_privname
($priv);
153 if ($perm->{$priv}) {
161 return undef if $noerr;
163 raise_perm_exc
("$path, " . join("|", @$privs));
167 my ($self, $username, $path, $privs, $any, $noerr) = @_;
169 return $self->check_any($username, $path, $privs, $noerr);
171 return $self->check($username, $path, $privs, $noerr);
175 sub check_user_enabled
{
176 my ($self, $user, $noerr) = @_;
178 my $cfg = $self->{user_cfg
};
179 return PVE
::AccessControl
::check_user_enabled
($cfg, $user, $noerr);
182 sub check_user_exist
{
183 my ($self, $user, $noerr) = @_;
185 my $cfg = $self->{user_cfg
};
186 return PVE
::AccessControl
::check_user_exist
($cfg, $user, $noerr);
189 sub check_pool_exist
{
190 my ($self, $pool, $noerr) = @_;
192 my $cfg = $self->{user_cfg
};
194 return 1 if $cfg->{pools
}->{$pool};
196 return undef if $noerr;
198 raise_perm_exc
("pool '$pool' does not exist");
202 my ($self, $user, $vmid, $pool, $privs, $any, $noerr) = @_;
204 my $cfg = $self->{user_cfg
};
207 return if $self->check_full($user, "/pool/$pool", $privs, $any, 1);
209 return $self->check_full($user, "/vms/$vmid", $privs, $any, $noerr);
212 sub is_group_member
{
213 my ($self, $group, $user) = @_;
215 my $cfg = $self->{user_cfg
};
217 return 0 if !$cfg->{groups
}->{$group};
219 return defined($cfg->{groups
}->{$group}->{users
}->{$user});
223 my ($self, $user, $privs, $any) = @_;
225 my $cfg = $self->{user_cfg
};
228 foreach my $group (keys %{$cfg->{groups
}}) {
229 my $path = "/access/groups/$group";
230 if ($self->check_full($user, $path, $privs, $any, 1)) {
231 $groups->{$group} = $cfg->{groups
}->{$group};
238 sub group_member_join
{
239 my ($self, $grouplist) = @_;
243 my $cfg = $self->{user_cfg
};
244 foreach my $group (@$grouplist) {
245 my $data = $cfg->{groups
}->{$group};
247 foreach my $user (keys %{$data->{users
}}) {
255 sub check_perm_modify
{
256 my ($self, $username, $path, $noerr) = @_;
258 return $self->check($username, '/access', [ 'Permissions.Modify' ], $noerr) if !$path;
260 my $testperms = [ 'Permissions.Modify' ];
261 if ($path =~ m
|^/storage/.+$|) {
262 push @$testperms, 'Datastore.Allocate';
263 } elsif ($path =~ m
|^/vms/.+$|) {
264 push @$testperms, 'VM.Allocate';
265 } elsif ($path =~ m
|^/pool/.+$|) {
266 push @$testperms, 'Pool.Allocate';
269 return $self->check_any($username, $path, $testperms, $noerr);
272 sub exec_api2_perm_check
{
273 my ($self, $check, $username, $param, $noerr) = @_;
275 # syslog("info", "CHECK " . join(', ', @$check));
278 my $test = $check->[$ind++];
279 die "no permission test specified" if !$test;
281 if ($test eq 'and') {
282 while (my $subcheck = $check->[$ind++]) {
283 $self->exec_api2_perm_check($subcheck, $username, $param);
286 } elsif ($test eq 'or') {
287 while (my $subcheck = $check->[$ind++]) {
288 return 1 if $self->exec_api2_perm_check($subcheck, $username, $param, 1);
292 } elsif ($test eq 'perm') {
293 my ($t, $tmplpath, $privs, %options) = @$check;
294 my $any = $options{any
};
295 die "missing parameters" if !($tmplpath && $privs);
296 my $require_param = $options{require_param
};
297 if ($require_param && !defined($param->{$require_param})) {
301 my $path = PVE
::Tools
::template_replace
($tmplpath, $param);
302 $path = PVE
::AccessControl
::normalize_path
($path);
303 return $self->check_full($username, $path, $privs, $any, $noerr);
304 } elsif ($test eq 'userid-group') {
305 my $userid = $param->{userid
};
306 my ($t, $privs, %options) = @$check;
307 return 0 if !$options{groups_param
} && !$self->check_user_exist($userid, $noerr);
308 if (!$self->check_any($username, "/access/groups", $privs, 1)) {
309 my $groups = $self->filter_groups($username, $privs, 1);
310 if ($options{groups_param
}) {
311 my @group_param = PVE
::Tools
::split_list
($param->{groups
});
312 raise_perm_exc
("/access/groups, " . join("|", @$privs)) if !scalar(@group_param);
313 foreach my $pg (@group_param) {
314 raise_perm_exc
("/access/groups/$pg, " . join("|", @$privs))
318 my $allowed_users = $self->group_member_join([keys %$groups]);
319 if (!$allowed_users->{$userid}) {
326 } elsif ($test eq 'userid-param') {
327 my ($userid, undef, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
328 my ($t, $subtest) = @$check;
329 die "missing parameters" if !$subtest;
330 if ($subtest eq 'self') {
331 return 0 if !$self->check_user_exist($userid, $noerr);
332 return 1 if $username eq $userid;
335 } elsif ($subtest eq 'Realm.AllocateUser') {
336 my $path = "/access/realm/$realm";
337 return $self->check($username, $path, ['Realm.AllocateUser'], $noerr);
339 die "unknown userid-param test";
341 } elsif ($test eq 'perm-modify') {
342 my ($t, $tmplpath) = @$check;
343 my $path = PVE
::Tools
::template_replace
($tmplpath, $param);
344 $path = PVE
::AccessControl
::normalize_path
($path);
345 return $self->check_perm_modify($username, $path, $noerr);
347 die "unknown permission test";
351 sub check_api2_permissions
{
352 my ($self, $perm, $username, $param) = @_;
354 return 1 if !$username && $perm->{user
} && $perm->{user
} eq 'world';
356 raise_perm_exc
("user != null") if !$username;
358 return 1 if $username eq 'root@pam';
360 raise_perm_exc
('user != root@pam') if !$perm;
362 return 1 if $perm->{user
} && $perm->{user
} eq 'all';
364 return $self->exec_api2_perm_check($perm->{check
}, $username, $param)
370 sub log_cluster_msg
{
371 my ($self, $pri, $user, $msg) = @_;
373 PVE
::Cluster
::log_msg
($pri, $user, $msg);
376 sub broadcast_tasklist
{
377 my ($self, $tlist) = @_;
379 PVE
::Cluster
::broadcast_tasklist
($tlist);
382 # initialize environment - must be called once at program startup
384 my ($class, $type, %params) = @_;
386 $class = ref($class) || $class;
388 my $self = $class->SUPER::init
($type, %params);
390 $self->{user_cfg
} = {};
391 $self->{aclcache
} = {};
392 $self->{aclversion
} = undef;
398 # init_request - must be called before each RPC request
400 my ($self, %params) = @_;
402 PVE
::Cluster
::cfs_update
();
404 $self->{result_attributes
} = {};
406 my $userconfig; # we use this for regression tests
407 foreach my $p (keys %params) {
408 if ($p eq 'userconfig') {
409 $userconfig = $params{$p};
411 die "unknown parameter '$p'";
416 $self->{aclcache
} = {};
418 my $ucdata = PVE
::Tools
::file_get_contents
($userconfig);
419 my $cfg = PVE
::AccessControl
::parse_user_config
($userconfig, $ucdata);
420 $self->{user_cfg
} = $cfg;
422 my $ucvers = PVE
::Cluster
::cfs_file_version
('user.cfg');
423 if (!$self->{aclcache
} || !defined($self->{aclversion
}) ||
424 !defined($ucvers) || ($ucvers ne $self->{aclversion
})) {
425 $self->{aclversion
} = $ucvers;
426 my $cfg = PVE
::Cluster
::cfs_read_file
('user.cfg');
427 $self->{user_cfg
} = $cfg;
432 $self->{user_cfg
} = {};
433 die "Unable to load access control list: $err";
437 # hacks: to provide better backwards compatibiliy
439 # old code uses PVE::RPCEnvironment::get();
440 # new code should use PVE::RPCEnvironment->get();
442 return PVE
::RESTEnvironment-
>get();
445 # old code uses PVE::RPCEnvironment::is_worker();
446 # new code should use PVE::RPCEnvironment->is_worker();
448 return PVE
::RESTEnvironment-
>is_worker();