]>
Commit | Line | Data |
---|---|---|
2c3a6c0a DM |
1 | package PVE::RPCEnvironment; |
2 | ||
3 | use strict; | |
4 | use warnings; | |
c104e4ab DM |
5 | |
6 | use PVE::RESTEnvironment; | |
7 | ||
37d45deb | 8 | use PVE::Exception qw(raise raise_perm_exc); |
2c3a6c0a DM |
9 | use PVE::SafeSyslog; |
10 | use PVE::Tools; | |
11 | use PVE::INotify; | |
12 | use PVE::Cluster; | |
13 | use PVE::ProcFSTools; | |
14 | use PVE::AccessControl; | |
15 | ||
c104e4ab | 16 | use base qw(PVE::RESTEnvironment); |
2c3a6c0a | 17 | |
c104e4ab | 18 | # FIXME: remove dependency to PVE::Storage; |
2c3a6c0a DM |
19 | |
20 | # ACL cache | |
21 | ||
4bc17477 DM |
22 | my $compile_acl_path = sub { |
23 | my ($self, $user, $path) = @_; | |
2c3a6c0a | 24 | |
2c3a6c0a DM |
25 | my $cfg = $self->{user_cfg}; |
26 | ||
27 | return undef if !$cfg->{roles}; | |
28 | ||
4bc17477 | 29 | die "internal error" if $user eq 'root@pam'; |
2c3a6c0a | 30 | |
4bc17477 DM |
31 | my $cache = $self->{aclcache}; |
32 | $cache->{$user} = {} if !$cache->{$user}; | |
33 | my $data = $cache->{$user}; | |
2c3a6c0a | 34 | |
4bc17477 | 35 | if (!$data->{poolroles}) { |
c104e4ab DM |
36 | $data->{poolroles} = {}; |
37 | ||
39c85db8 DM |
38 | foreach my $pool (keys %{$cfg->{pools}}) { |
39 | my $d = $cfg->{pools}->{$pool}; | |
40 | my @ra = PVE::AccessControl::roles($cfg, $user, "/pool/$pool"); # pool roles | |
4bc17477 DM |
41 | next if !scalar(@ra); |
42 | foreach my $vmid (keys %{$d->{vms}}) { | |
43 | for my $role (@ra) { | |
44 | $data->{poolroles}->{"/vms/$vmid"}->{$role} = 1; | |
2c3a6c0a DM |
45 | } |
46 | } | |
4bc17477 DM |
47 | foreach my $storeid (keys %{$d->{storage}}) { |
48 | for my $role (@ra) { | |
49 | $data->{poolroles}->{"/storage/$storeid"}->{$role} = 1; | |
50 | } | |
51 | } | |
52 | } | |
53 | } | |
54 | ||
55 | my @ra = PVE::AccessControl::roles($cfg, $user, $path); | |
56 | ||
57 | # apply roles inherited from pools | |
58 | # Note: assume we do not want to propagate those privs | |
59 | if ($data->{poolroles}->{$path}) { | |
60 | if (!($ra[0] && $ra[0] eq 'NoAccess')) { | |
8ade28e6 DM |
61 | if ($data->{poolroles}->{$path}->{NoAccess}) { |
62 | @ra = ('NoAccess'); | |
63 | } else { | |
64 | foreach my $role (keys %{$data->{poolroles}->{$path}}) { | |
65 | push @ra, $role; | |
66 | } | |
4bc17477 | 67 | } |
2c3a6c0a | 68 | } |
4bc17477 | 69 | } |
2c3a6c0a | 70 | |
4bc17477 | 71 | $data->{roles}->{$path} = [ @ra ]; |
c104e4ab | 72 | |
4bc17477 DM |
73 | my $privs = {}; |
74 | foreach my $role (@ra) { | |
75 | if (my $privset = $cfg->{roles}->{$role}) { | |
76 | foreach my $p (keys %$privset) { | |
77 | $privs->{$p} = 1; | |
78 | } | |
79 | } | |
2c3a6c0a | 80 | } |
4bc17477 | 81 | $data->{privs}->{$path} = $privs; |
2c3a6c0a | 82 | |
4bc17477 | 83 | return $privs; |
2c3a6c0a DM |
84 | }; |
85 | ||
4bc17477 DM |
86 | sub roles { |
87 | my ($self, $user, $path) = @_; | |
88 | ||
89 | if ($user eq 'root@pam') { # root can do anything | |
90 | return ('Administrator'); | |
c104e4ab | 91 | } |
4bc17477 DM |
92 | |
93 | $user = PVE::AccessControl::verify_username($user, 1); | |
94 | return () if !$user; | |
95 | ||
96 | my $cache = $self->{aclcache}; | |
97 | $cache->{$user} = {} if !$cache->{$user}; | |
98 | ||
99 | my $acl = $cache->{$user}; | |
100 | ||
101 | my $roles = $acl->{roles}->{$path}; | |
102 | return @$roles if $roles; | |
103 | ||
104 | &$compile_acl_path($self, $user, $path); | |
105 | $roles = $acl->{roles}->{$path} || []; | |
106 | return @$roles; | |
107 | } | |
108 | ||
2c3a6c0a DM |
109 | sub permissions { |
110 | my ($self, $user, $path) = @_; | |
111 | ||
4bc17477 DM |
112 | if ($user eq 'root@pam') { # root can do anything |
113 | my $cfg = $self->{user_cfg}; | |
114 | return $cfg->{roles}->{'Administrator'}; | |
c104e4ab | 115 | } |
4bc17477 | 116 | |
2c3a6c0a DM |
117 | $user = PVE::AccessControl::verify_username($user, 1); |
118 | return {} if !$user; | |
119 | ||
120 | my $cache = $self->{aclcache}; | |
4bc17477 | 121 | $cache->{$user} = {} if !$cache->{$user}; |
2c3a6c0a DM |
122 | |
123 | my $acl = $cache->{$user}; | |
124 | ||
4bc17477 DM |
125 | my $perm = $acl->{privs}->{$path}; |
126 | return $perm if $perm; | |
2c3a6c0a | 127 | |
4bc17477 | 128 | return &$compile_acl_path($self, $user, $path); |
2c3a6c0a DM |
129 | } |
130 | ||
131 | sub check { | |
37d45deb | 132 | my ($self, $user, $path, $privs, $noerr) = @_; |
2c3a6c0a DM |
133 | |
134 | my $perm = $self->permissions($user, $path); | |
135 | ||
136 | foreach my $priv (@$privs) { | |
37d45deb DM |
137 | PVE::AccessControl::verify_privname($priv); |
138 | if (!$perm->{$priv}) { | |
139 | return undef if $noerr; | |
c104e4ab | 140 | raise_perm_exc("$path, $priv"); |
37d45deb | 141 | } |
2c3a6c0a DM |
142 | }; |
143 | ||
144 | return 1; | |
145 | }; | |
146 | ||
37d45deb DM |
147 | sub check_any { |
148 | my ($self, $user, $path, $privs, $noerr) = @_; | |
149 | ||
150 | my $perm = $self->permissions($user, $path); | |
efce1d57 | 151 | |
37d45deb DM |
152 | my $found = 0; |
153 | foreach my $priv (@$privs) { | |
154 | PVE::AccessControl::verify_privname($priv); | |
155 | if ($perm->{$priv}) { | |
156 | $found = 1; | |
157 | last; | |
158 | } | |
159 | }; | |
160 | ||
161 | return 1 if $found; | |
162 | ||
163 | return undef if $noerr; | |
164 | ||
c104e4ab | 165 | raise_perm_exc("$path, " . join("|", @$privs)); |
37d45deb DM |
166 | }; |
167 | ||
c4a776a6 DM |
168 | sub check_full { |
169 | my ($self, $username, $path, $privs, $any, $noerr) = @_; | |
170 | if ($any) { | |
171 | return $self->check_any($username, $path, $privs, $noerr); | |
172 | } else { | |
173 | return $self->check($username, $path, $privs, $noerr); | |
174 | } | |
175 | } | |
176 | ||
7070c1ae DM |
177 | sub check_user_enabled { |
178 | my ($self, $user, $noerr) = @_; | |
c104e4ab | 179 | |
2c3a6c0a | 180 | my $cfg = $self->{user_cfg}; |
7070c1ae | 181 | return PVE::AccessControl::check_user_enabled($cfg, $user, $noerr); |
2c3a6c0a DM |
182 | } |
183 | ||
37d45deb DM |
184 | sub check_user_exist { |
185 | my ($self, $user, $noerr) = @_; | |
c104e4ab | 186 | |
37d45deb DM |
187 | my $cfg = $self->{user_cfg}; |
188 | return PVE::AccessControl::check_user_exist($cfg, $user, $noerr); | |
189 | } | |
190 | ||
a23cec1f DM |
191 | sub check_pool_exist { |
192 | my ($self, $pool, $noerr) = @_; | |
193 | ||
194 | my $cfg = $self->{user_cfg}; | |
195 | ||
196 | return 1 if $cfg->{pools}->{$pool}; | |
197 | ||
198 | return undef if $noerr; | |
199 | ||
c104e4ab | 200 | raise_perm_exc("pool '$pool' does not exist"); |
a23cec1f DM |
201 | } |
202 | ||
203 | sub check_vm_perm { | |
204 | my ($self, $user, $vmid, $pool, $privs, $any, $noerr) = @_; | |
205 | ||
206 | my $cfg = $self->{user_cfg}; | |
c104e4ab | 207 | |
a23cec1f DM |
208 | if ($pool) { |
209 | return if $self->check_full($user, "/pool/$pool", $privs, $any, 1); | |
210 | } | |
211 | return $self->check_full($user, "/vms/$vmid", $privs, $any, $noerr); | |
212 | }; | |
213 | ||
17ecec71 | 214 | sub check_volume_access { |
fef1bc17 DM |
215 | my ($self, $user, $storecfg, $vmid, $volid) = @_; |
216 | ||
217 | # test if we have read access to volid | |
218 | ||
3eac4e35 DM |
219 | my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1); |
220 | if ($sid) { | |
854f1dce | 221 | my ($vtype, undef, $ownervm) = PVE::Storage::parse_volname($storecfg, $volid); |
fef1bc17 | 222 | if ($vtype eq 'iso' || $vtype eq 'vztmpl') { |
c104e4ab | 223 | # we simply allow access |
e5ae5487 | 224 | } elsif (defined($ownervm) && defined($vmid) && ($ownervm == $vmid)) { |
c104e4ab | 225 | # we are owner - allow access |
e5ae5487 DM |
226 | } elsif ($vtype eq 'backup' && $ownervm) { |
227 | $self->check($user, "/storage/$sid", ['Datastore.AllocateSpace']); | |
228 | $self->check($user, "/vms/$ownervm", ['VM.Backup']); | |
229 | } else { | |
fef1bc17 DM |
230 | # allow if we are Datastore administrator |
231 | $self->check($user, "/storage/$sid", ['Datastore.Allocate']); | |
232 | } | |
233 | } else { | |
234 | die "Only root can pass arbitrary filesystem paths." | |
235 | if $user ne 'root@pam'; | |
fef1bc17 | 236 | } |
5f494227 DM |
237 | |
238 | return undef; | |
fef1bc17 DM |
239 | } |
240 | ||
37d45deb DM |
241 | sub is_group_member { |
242 | my ($self, $group, $user) = @_; | |
243 | ||
244 | my $cfg = $self->{user_cfg}; | |
245 | ||
246 | return 0 if !$cfg->{groups}->{$group}; | |
247 | ||
248 | return defined($cfg->{groups}->{$group}->{users}->{$user}); | |
249 | } | |
250 | ||
251 | sub filter_groups { | |
b9180ed2 | 252 | my ($self, $user, $privs, $any) = @_; |
37d45deb DM |
253 | |
254 | my $cfg = $self->{user_cfg}; | |
255 | ||
256 | my $groups = {}; | |
257 | foreach my $group (keys %{$cfg->{groups}}) { | |
b9180ed2 | 258 | my $path = "/access/groups/$group"; |
c4a776a6 DM |
259 | if ($self->check_full($user, $path, $privs, $any, 1)) { |
260 | $groups->{$group} = $cfg->{groups}->{$group}; | |
37d45deb DM |
261 | } |
262 | } | |
263 | ||
264 | return $groups; | |
265 | } | |
266 | ||
267 | sub group_member_join { | |
268 | my ($self, $grouplist) = @_; | |
269 | ||
270 | my $users = {}; | |
271 | ||
272 | my $cfg = $self->{user_cfg}; | |
273 | foreach my $group (@$grouplist) { | |
274 | my $data = $cfg->{groups}->{$group}; | |
275 | next if !$data; | |
276 | foreach my $user (keys %{$data->{users}}) { | |
277 | $users->{$user} = 1; | |
278 | } | |
279 | } | |
280 | ||
281 | return $users; | |
282 | } | |
283 | ||
e3a3a0d7 DM |
284 | sub check_perm_modify { |
285 | my ($self, $username, $path, $noerr) = @_; | |
286 | ||
287 | return $self->check($username, '/access', [ 'Permissions.Modify' ], $noerr) if !$path; | |
288 | ||
289 | my $testperms = [ 'Permissions.Modify' ]; | |
290 | if ($path =~ m|^/storage/.+$|) { | |
291 | push @$testperms, 'Datastore.Allocate'; | |
292 | } elsif ($path =~ m|^/vms/.+$|) { | |
293 | push @$testperms, 'VM.Allocate'; | |
7a7a517a DM |
294 | } elsif ($path =~ m|^/pool/.+$|) { |
295 | push @$testperms, 'Pool.Allocate'; | |
e3a3a0d7 DM |
296 | } |
297 | ||
298 | return $self->check_any($username, $path, $testperms, $noerr); | |
299 | } | |
300 | ||
f8cc5a5f DM |
301 | sub exec_api2_perm_check { |
302 | my ($self, $check, $username, $param, $noerr) = @_; | |
303 | ||
304 | # syslog("info", "CHECK " . join(', ', @$check)); | |
305 | ||
306 | my $ind = 0; | |
307 | my $test = $check->[$ind++]; | |
308 | die "no permission test specified" if !$test; | |
c104e4ab | 309 | |
f8cc5a5f DM |
310 | if ($test eq 'and') { |
311 | while (my $subcheck = $check->[$ind++]) { | |
c104e4ab | 312 | $self->exec_api2_perm_check($subcheck, $username, $param); |
f8cc5a5f DM |
313 | } |
314 | return 1; | |
315 | } elsif ($test eq 'or') { | |
316 | while (my $subcheck = $check->[$ind++]) { | |
c104e4ab | 317 | return 1 if $self->exec_api2_perm_check($subcheck, $username, $param, 1); |
f8cc5a5f DM |
318 | } |
319 | return 0 if $noerr; | |
320 | raise_perm_exc(); | |
321 | } elsif ($test eq 'perm') { | |
322 | my ($t, $tmplpath, $privs, %options) = @$check; | |
323 | my $any = $options{any}; | |
324 | die "missing parameters" if !($tmplpath && $privs); | |
c4a776a6 DM |
325 | my $require_param = $options{require_param}; |
326 | if ($require_param && !defined($param->{$require_param})) { | |
327 | return 0 if $noerr; | |
328 | raise_perm_exc(); | |
329 | } | |
f8cc5a5f | 330 | my $path = PVE::Tools::template_replace($tmplpath, $param); |
e3a3a0d7 | 331 | $path = PVE::AccessControl::normalize_path($path); |
c4a776a6 | 332 | return $self->check_full($username, $path, $privs, $any, $noerr); |
f8cc5a5f DM |
333 | } elsif ($test eq 'userid-group') { |
334 | my $userid = $param->{userid}; | |
335 | my ($t, $privs, %options) = @$check; | |
82b63965 DM |
336 | return 0 if !$options{groups_param} && !$self->check_user_exist($userid, $noerr); |
337 | if (!$self->check_any($username, "/access/groups", $privs, 1)) { | |
f8cc5a5f DM |
338 | my $groups = $self->filter_groups($username, $privs, 1); |
339 | if ($options{groups_param}) { | |
340 | my @group_param = PVE::Tools::split_list($param->{groups}); | |
82b63965 | 341 | raise_perm_exc("/access/groups, " . join("|", @$privs)) if !scalar(@group_param); |
f8cc5a5f DM |
342 | foreach my $pg (@group_param) { |
343 | raise_perm_exc("/access/groups/$pg, " . join("|", @$privs)) | |
344 | if !$groups->{$pg}; | |
345 | } | |
346 | } else { | |
347 | my $allowed_users = $self->group_member_join([keys %$groups]); | |
348 | if (!$allowed_users->{$userid}) { | |
349 | return 0 if $noerr; | |
350 | raise_perm_exc(); | |
351 | } | |
352 | } | |
353 | } | |
354 | return 1; | |
355 | } elsif ($test eq 'userid-param') { | |
09d27058 | 356 | my ($userid, undef, $realm) = PVE::AccessControl::verify_username($param->{userid}); |
f8cc5a5f DM |
357 | my ($t, $subtest) = @$check; |
358 | die "missing parameters" if !$subtest; | |
359 | if ($subtest eq 'self') { | |
a69bbe2e | 360 | return 0 if !$self->check_user_exist($userid, $noerr); |
1cf154b7 | 361 | return 1 if $username eq $userid; |
f8cc5a5f DM |
362 | return 0 if $noerr; |
363 | raise_perm_exc(); | |
82b63965 DM |
364 | } elsif ($subtest eq 'Realm.AllocateUser') { |
365 | my $path = "/access/realm/$realm"; | |
366 | return $self->check($username, $path, ['Realm.AllocateUser'], $noerr); | |
f8cc5a5f DM |
367 | } else { |
368 | die "unknown userid-param test"; | |
369 | } | |
82b63965 | 370 | } elsif ($test eq 'perm-modify') { |
e3a3a0d7 DM |
371 | my ($t, $tmplpath) = @$check; |
372 | my $path = PVE::Tools::template_replace($tmplpath, $param); | |
373 | $path = PVE::AccessControl::normalize_path($path); | |
374 | return $self->check_perm_modify($username, $path, $noerr); | |
375 | } else { | |
f8cc5a5f DM |
376 | die "unknown permission test"; |
377 | } | |
378 | }; | |
379 | ||
380 | sub check_api2_permissions { | |
381 | my ($self, $perm, $username, $param) = @_; | |
382 | ||
383 | return 1 if !$username && $perm->{user} eq 'world'; | |
384 | ||
385 | raise_perm_exc("user != null") if !$username; | |
386 | ||
387 | return 1 if $username eq 'root@pam'; | |
388 | ||
389 | raise_perm_exc('user != root@pam') if !$perm; | |
390 | ||
391 | return 1 if $perm->{user} && $perm->{user} eq 'all'; | |
392 | ||
c104e4ab | 393 | return $self->exec_api2_perm_check($perm->{check}, $username, $param) |
f8cc5a5f DM |
394 | if $perm->{check}; |
395 | ||
396 | raise_perm_exc(); | |
397 | } | |
398 | ||
c104e4ab DM |
399 | sub log_cluster_msg { |
400 | my ($self, $pri, $user, $msg) = @_; | |
2c3a6c0a | 401 | |
c104e4ab DM |
402 | PVE::Cluster::log_msg($pri, $user, $msg); |
403 | } | |
2c3a6c0a | 404 | |
c104e4ab DM |
405 | sub broadcast_tasklist { |
406 | my ($self, $tlist) = @_; | |
2c3a6c0a | 407 | |
c104e4ab DM |
408 | PVE::Cluster::broadcast_tasklist($tlist); |
409 | } | |
2c3a6c0a | 410 | |
c104e4ab DM |
411 | # initialize environment - must be called once at program startup |
412 | sub init { | |
413 | my ($class, $type, %params) = @_; | |
86c4f1e6 DM |
414 | |
415 | $class = ref($class) || $class; | |
5ae5900d | 416 | |
c104e4ab | 417 | my $self = $class->SUPER::init($type, %params); |
5ae5900d | 418 | |
c104e4ab DM |
419 | $self->{user_cfg} = {}; |
420 | $self->{aclcache} = {}; | |
421 | $self->{aclversion} = undef; | |
2c3a6c0a | 422 | |
c104e4ab DM |
423 | return $self; |
424 | }; | |
2c3a6c0a | 425 | |
2c3a6c0a DM |
426 | |
427 | # init_request - must be called before each RPC request | |
428 | sub init_request { | |
429 | my ($self, %params) = @_; | |
430 | ||
431 | PVE::Cluster::cfs_update(); | |
432 | ||
be6ea723 | 433 | $self->{result_attributes} = {}; |
272fe9ff | 434 | |
2c3a6c0a DM |
435 | my $userconfig; # we use this for regression tests |
436 | foreach my $p (keys %params) { | |
437 | if ($p eq 'userconfig') { | |
438 | $userconfig = $params{$p}; | |
439 | } else { | |
440 | die "unknown parameter '$p'"; | |
441 | } | |
442 | } | |
443 | ||
444 | eval { | |
445 | $self->{aclcache} = {}; | |
446 | if ($userconfig) { | |
447 | my $ucdata = PVE::Tools::file_get_contents($userconfig); | |
448 | my $cfg = PVE::AccessControl::parse_user_config($userconfig, $ucdata); | |
449 | $self->{user_cfg} = $cfg; | |
450 | } else { | |
c104e4ab DM |
451 | my $ucvers = PVE::Cluster::cfs_file_version('user.cfg'); |
452 | if (!$self->{aclcache} || !defined($self->{aclversion}) || | |
2c3a6c0a DM |
453 | !defined($ucvers) || ($ucvers ne $self->{aclversion})) { |
454 | $self->{aclversion} = $ucvers; | |
455 | my $cfg = PVE::Cluster::cfs_read_file('user.cfg'); | |
456 | $self->{user_cfg} = $cfg; | |
457 | } | |
458 | } | |
459 | }; | |
460 | if (my $err = $@) { | |
461 | $self->{user_cfg} = {}; | |
462 | die "Unable to load access control list: $err"; | |
463 | } | |
464 | } | |
465 | ||
c104e4ab | 466 | # hacks: to provide better backwards compatibiliy |
2c3a6c0a | 467 | |
c104e4ab DM |
468 | # old code uses PVE::RPCEnvironment::get(); |
469 | # new code should use PVE::RPCEnvironment->get(); | |
470 | sub get { | |
471 | return PVE::RESTEnvironment->get(); | |
2c3a6c0a DM |
472 | } |
473 | ||
c104e4ab DM |
474 | # old code uses PVE::RPCEnvironment::is_worker(); |
475 | # new code should use PVE::RPCEnvironment->is_worker(); | |
7b6dfe82 | 476 | sub is_worker { |
c104e4ab | 477 | return PVE::RESTEnvironment->is_worker(); |
2c3a6c0a DM |
478 | } |
479 | ||
480 | 1; |