1 package PVE
::RPCEnvironment
;
6 use PVE
::AccessControl
;
8 use PVE
::Exception
qw(raise raise_perm_exc);
11 use PVE
::RESTEnvironment
;
15 use base
qw(PVE::RESTEnvironment);
19 my $compile_acl_path = sub {
20 my ($self, $user, $path) = @_;
22 my $cfg = $self->{user_cfg
};
24 return undef if !$cfg->{roles
};
26 die "internal error" if $user eq 'root@pam';
28 my $cache = $self->{aclcache
};
29 $cache->{$user} = {} if !$cache->{$user};
30 my $data = $cache->{$user};
32 my ($username, undef) = PVE
::AccessControl
::split_tokenid
($user, 1);
33 die "internal error" if $username && $username ne 'root@pam' && !defined($cache->{$username});
35 if (!$data->{poolroles
}) {
36 $data->{poolroles
} = {};
38 foreach my $pool (keys %{$cfg->{pools
}}) {
39 my $d = $cfg->{pools
}->{$pool};
40 my $pool_roles = PVE
::AccessControl
::roles
($cfg, $user, "/pool/$pool"); # pool roles
41 next if !scalar(keys %$pool_roles);
42 foreach my $vmid (keys %{$d->{vms
}}) {
43 for my $role (keys %$pool_roles) {
44 $data->{poolroles
}->{"/vms/$vmid"}->{$role} = 1;
47 foreach my $storeid (keys %{$d->{storage
}}) {
48 for my $role (keys %$pool_roles) {
49 $data->{poolroles
}->{"/storage/$storeid"}->{$role} = 1;
55 my $roles = PVE
::AccessControl
::roles
($cfg, $user, $path);
57 # apply roles inherited from pools
58 # Note: assume we do not want to propagate those privs
59 if ($data->{poolroles
}->{$path}) {
60 if (!defined($roles->{NoAccess
})) {
61 if ($data->{poolroles
}->{$path}->{NoAccess
}) {
62 $roles = { 'NoAccess' => 0 };
64 foreach my $role (keys %{$data->{poolroles
}->{$path}}) {
65 $roles->{$role} = 0 if !defined($roles->{$role});
71 $data->{roles
}->{$path} = $roles;
74 foreach my $role (keys %$roles) {
75 if (my $privset = $cfg->{roles
}->{$role}) {
76 foreach my $p (keys %$privset) {
77 $privs->{$p} = $roles->{$role};
82 if ($username && $username ne 'root@pam') {
83 # intersect user and token permissions
84 my $user_privs = $cache->{$username}->{privs
}->{$path};
85 my $filtered_privs = [ grep { $user_privs->{$_} } keys %$privs ];
86 $privs = { map { $_ => $user_privs->{$_} && $privs->{$_} } @$filtered_privs };
89 $data->{privs
}->{$path} = $privs;
95 my ($self, $user, $path) = @_;
97 if ($user eq 'root@pam') { # root can do anything
98 my $cfg = $self->{user_cfg
};
99 return { map { $_ => 1 } keys %{$cfg->{roles
}->{'Administrator'}} };
102 if (PVE
::AccessControl
::pve_verify_tokenid
($user, 1)) {
103 my ($username, $token) = PVE
::AccessControl
::split_tokenid
($user);
104 my $cfg = $self->{user_cfg
};
105 my $token_info = $cfg->{users
}->{$username}->{tokens
}->{$token};
107 return {} if !$token_info;
109 # ensure cache for user is populated
110 my $user_perms = $self->permissions($username, $path);
112 # return user privs for non-privsep tokens
113 return $user_perms if !$token_info->{privsep
};
115 $user = PVE
::AccessControl
::verify_username
($user, 1);
119 my $cache = $self->{aclcache
};
120 $cache->{$user} = {} if !$cache->{$user};
122 my $acl = $cache->{$user};
124 my $perm = $acl->{privs
}->{$path};
125 return $perm if $perm;
127 return &$compile_acl_path($self, $user, $path);
130 sub compute_api_permission
{
131 my ($self, $authuser) = @_;
133 my $usercfg = $self->{user_cfg
};
137 vms
=> qr/VM\.|Permissions\.Modify/,
138 access
=> qr/(User|Group)\.|Permissions\.Modify/,
139 storage
=> qr/Datastore\.|Permissions\.Modify/,
140 nodes
=> qr/Sys\.|Permissions\.Modify/,
141 sdn
=> qr/SDN\.|Permissions\.Modify/,
142 dc
=> qr/Sys\.Audit|SDN\./,
144 map { $res->{$_} = {} } keys %$priv_re_map;
146 my $required_paths = ['/', '/nodes', '/access/groups', '/vms', '/storage', '/sdn'];
148 my $checked_paths = {};
149 foreach my $path (@$required_paths, keys %{$usercfg->{acl
}}) {
150 next if $checked_paths->{$path};
151 $checked_paths->{$path} = 1;
153 my $path_perm = $self->permissions($authuser, $path);
155 my $toplevel = ($path =~ /^\/(\w
+)/) ?
$1 : 'dc';
156 if ($toplevel eq 'pool') {
157 foreach my $priv (keys %$path_perm) {
158 if ($priv =~ m/^VM\./) {
159 $res->{vms
}->{$priv} = 1;
160 } elsif ($priv =~ m/^Datastore\./) {
161 $res->{storage
}->{$priv} = 1;
162 } elsif ($priv eq 'Permissions.Modify') {
163 $res->{storage
}->{$priv} = 1;
164 $res->{vms
}->{$priv} = 1;
168 my $priv_regex = $priv_re_map->{$toplevel} // next;
169 foreach my $priv (keys %$path_perm) {
170 next if $priv !~ m/^($priv_regex)/;
171 $res->{$toplevel}->{$priv} = 1;
179 sub get_effective_permissions
{
180 my ($self, $user) = @_;
182 # default / top level paths
186 '/access/groups' => 1,
194 my $cfg = $self->{user_cfg
};
196 # paths explicitly listed in ACLs
197 foreach my $acl_path (keys %{$cfg->{acl
}}) {
198 $paths->{$acl_path} = 1;
201 # paths referenced by pool definitions
202 foreach my $pool (keys %{$cfg->{pools
}}) {
203 my $d = $cfg->{pools
}->{$pool};
204 foreach my $vmid (keys %{$d->{vms
}}) {
205 $paths->{"/vms/$vmid"} = 1;
207 foreach my $storeid (keys %{$d->{storage
}}) {
208 $paths->{"/storage/$storeid"} = 1;
213 foreach my $path (keys %$paths) {
214 my $path_perms = $self->permissions($user, $path);
215 # filter paths where user has NO permissions
216 $perms->{$path} = $path_perms if %$path_perms;
222 my ($self, $user, $path, $privs, $noerr) = @_;
224 my $perm = $self->permissions($user, $path);
226 foreach my $priv (@$privs) {
227 PVE
::AccessControl
::verify_privname
($priv);
228 if (!defined($perm->{$priv})) {
229 return undef if $noerr;
230 raise_perm_exc
("$path, $priv");
238 my ($self, $user, $path, $privs, $noerr) = @_;
240 my $perm = $self->permissions($user, $path);
243 foreach my $priv (@$privs) {
244 PVE
::AccessControl
::verify_privname
($priv);
245 if (defined($perm->{$priv})) {
253 return undef if $noerr;
255 raise_perm_exc
("$path, " . join("|", @$privs));
259 my ($self, $username, $path, $privs, $any, $noerr) = @_;
261 return $self->check_any($username, $path, $privs, $noerr);
263 return $self->check($username, $path, $privs, $noerr);
267 sub check_user_enabled
{
268 my ($self, $user, $noerr) = @_;
270 my $cfg = $self->{user_cfg
};
271 return PVE
::AccessControl
::check_user_enabled
($cfg, $user, $noerr);
274 sub check_user_exist
{
275 my ($self, $user, $noerr) = @_;
277 my $cfg = $self->{user_cfg
};
278 return PVE
::AccessControl
::check_user_exist
($cfg, $user, $noerr);
281 sub check_pool_exist
{
282 my ($self, $pool, $noerr) = @_;
284 my $cfg = $self->{user_cfg
};
286 return 1 if $cfg->{pools
}->{$pool};
288 return undef if $noerr;
290 raise_perm_exc
("pool '$pool' does not exist");
294 my ($self, $user, $vmid, $pool, $privs, $any, $noerr) = @_;
296 my $cfg = $self->{user_cfg
};
299 return if $self->check_full($user, "/pool/$pool", $privs, $any, 1);
301 return $self->check_full($user, "/vms/$vmid", $privs, $any, $noerr);
304 sub is_group_member
{
305 my ($self, $group, $user) = @_;
307 my $cfg = $self->{user_cfg
};
309 return 0 if !$cfg->{groups
}->{$group};
311 return defined($cfg->{groups
}->{$group}->{users
}->{$user});
315 my ($self, $user, $privs, $any) = @_;
317 my $cfg = $self->{user_cfg
};
320 foreach my $group (keys %{$cfg->{groups
}}) {
321 my $path = "/access/groups/$group";
322 if ($self->check_full($user, $path, $privs, $any, 1)) {
323 $groups->{$group} = $cfg->{groups
}->{$group};
330 sub group_member_join
{
331 my ($self, $grouplist) = @_;
335 my $cfg = $self->{user_cfg
};
336 foreach my $group (@$grouplist) {
337 my $data = $cfg->{groups
}->{$group};
339 foreach my $user (keys %{$data->{users
}}) {
347 sub check_perm_modify
{
348 my ($self, $username, $path, $noerr) = @_;
350 return $self->check($username, '/access', [ 'Permissions.Modify' ], $noerr) if !$path;
352 my $testperms = [ 'Permissions.Modify' ];
353 if ($path =~ m
|^/storage/.+$|) {
354 push @$testperms, 'Datastore.Allocate';
355 } elsif ($path =~ m
|^/vms/.+$|) {
356 push @$testperms, 'VM.Allocate';
357 } elsif ($path =~ m
|^/pool/.+$|) {
358 push @$testperms, 'Pool.Allocate';
361 return $self->check_any($username, $path, $testperms, $noerr);
364 sub exec_api2_perm_check
{
365 my ($self, $check, $username, $param, $noerr) = @_;
367 # syslog("info", "CHECK " . join(', ', @$check));
370 my $test = $check->[$ind++];
371 die "no permission test specified" if !$test;
373 if ($test eq 'and') {
374 while (my $subcheck = $check->[$ind++]) {
375 $self->exec_api2_perm_check($subcheck, $username, $param);
378 } elsif ($test eq 'or') {
379 while (my $subcheck = $check->[$ind++]) {
380 return 1 if $self->exec_api2_perm_check($subcheck, $username, $param, 1);
384 } elsif ($test eq 'perm') {
385 my ($t, $tmplpath, $privs, %options) = @$check;
386 my $any = $options{any
};
387 die "missing parameters" if !($tmplpath && $privs);
388 my $require_param = $options{require_param
};
389 if ($require_param && !defined($param->{$require_param})) {
393 my $path = PVE
::Tools
::template_replace
($tmplpath, $param);
394 $path = PVE
::AccessControl
::normalize_path
($path);
395 return $self->check_full($username, $path, $privs, $any, $noerr);
396 } elsif ($test eq 'userid-group') {
397 my $userid = $param->{userid
};
398 my ($t, $privs, %options) = @$check;
399 return 0 if !$options{groups_param
} && !$self->check_user_exist($userid, $noerr);
400 if (!$self->check_any($username, "/access/groups", $privs, 1)) {
401 my $groups = $self->filter_groups($username, $privs, 1);
402 if ($options{groups_param
}) {
403 my @group_param = PVE
::Tools
::split_list
($param->{groups
});
404 raise_perm_exc
("/access/groups, " . join("|", @$privs)) if !scalar(@group_param);
405 foreach my $pg (@group_param) {
406 raise_perm_exc
("/access/groups/$pg, " . join("|", @$privs))
410 my $allowed_users = $self->group_member_join([keys %$groups]);
411 if (!$allowed_users->{$userid}) {
418 } elsif ($test eq 'userid-param') {
419 my ($userid, undef, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
420 my ($t, $subtest) = @$check;
421 die "missing parameters" if !$subtest;
422 if ($subtest eq 'self') {
423 return 0 if !$self->check_user_exist($userid, $noerr);
424 return 1 if $username eq $userid;
427 } elsif ($subtest eq 'Realm.AllocateUser') {
428 my $path = "/access/realm/$realm";
429 return $self->check($username, $path, ['Realm.AllocateUser'], $noerr);
431 die "unknown userid-param test";
433 } elsif ($test eq 'perm-modify') {
434 my ($t, $tmplpath) = @$check;
435 my $path = PVE
::Tools
::template_replace
($tmplpath, $param);
436 $path = PVE
::AccessControl
::normalize_path
($path);
437 return $self->check_perm_modify($username, $path, $noerr);
439 die "unknown permission test";
443 sub check_api2_permissions
{
444 my ($self, $perm, $username, $param) = @_;
446 return 1 if !$username && $perm->{user
} && $perm->{user
} eq 'world';
448 raise_perm_exc
("user != null") if !$username;
450 return 1 if $username eq 'root@pam';
452 raise_perm_exc
('user != root@pam') if !$perm;
454 return 1 if $perm->{user
} && $perm->{user
} eq 'all';
456 return $self->exec_api2_perm_check($perm->{check
}, $username, $param)
462 sub log_cluster_msg
{
463 my ($self, $pri, $user, $msg) = @_;
465 PVE
::Cluster
::log_msg
($pri, $user, $msg);
468 sub broadcast_tasklist
{
469 my ($self, $tlist) = @_;
471 PVE
::Cluster
::broadcast_tasklist
($tlist);
474 # initialize environment - must be called once at program startup
476 my ($class, $type, %params) = @_;
478 $class = ref($class) || $class;
480 my $self = $class->SUPER::init
($type, %params);
482 $self->{user_cfg
} = {};
483 $self->{aclcache
} = {};
484 $self->{aclversion
} = undef;
490 # init_request - must be called before each RPC request
492 my ($self, %params) = @_;
494 PVE
::Cluster
::cfs_update
();
496 $self->{result_attributes
} = {};
498 my $userconfig; # we use this for regression tests
499 foreach my $p (keys %params) {
500 if ($p eq 'userconfig') {
501 $userconfig = $params{$p};
503 die "unknown parameter '$p'";
508 $self->{aclcache
} = {};
510 my $ucdata = PVE
::Tools
::file_get_contents
($userconfig);
511 my $cfg = PVE
::AccessControl
::parse_user_config
($userconfig, $ucdata);
512 $self->{user_cfg
} = $cfg;
514 my $ucvers = PVE
::Cluster
::cfs_file_version
('user.cfg');
515 if (!$self->{aclcache
} || !defined($self->{aclversion
}) ||
516 !defined($ucvers) || ($ucvers ne $self->{aclversion
})) {
517 $self->{aclversion
} = $ucvers;
518 my $cfg = PVE
::Cluster
::cfs_read_file
('user.cfg');
519 $self->{user_cfg
} = $cfg;
524 $self->{user_cfg
} = {};
525 die "Unable to load access control list: $err";
529 # hacks: to provide better backwards compatibiliy
531 # old code uses PVE::RPCEnvironment::get();
532 # new code should use PVE::RPCEnvironment->get();
534 return PVE
::RESTEnvironment-
>get();
537 # old code uses PVE::RPCEnvironment::is_worker();
538 # new code should use PVE::RPCEnvironment->is_worker();
540 return PVE
::RESTEnvironment-
>is_worker();