bump version to 5.1-1
[pve-access-control.git] / PVE / AccessControl.pm
1 package PVE::AccessControl;
2
3 use strict;
4 use warnings;
5 use Encode;
6 use Crypt::OpenSSL::Random;
7 use Crypt::OpenSSL::RSA;
8 use Net::SSLeay;
9 use Net::IP;
10 use MIME::Base64;
11 use Digest::SHA;
12
13 use PVE::OTP;
14 use PVE::Ticket;
15 use PVE::Tools qw(run_command lock_file file_get_contents split_list safe_print);
16 use PVE::Cluster qw(cfs_register_file cfs_read_file cfs_write_file cfs_lock_file);
17 use PVE::JSONSchema qw(register_standard_option get_standard_option);
18
19 use PVE::Auth::Plugin;
20 use PVE::Auth::AD;
21 use PVE::Auth::LDAP;
22 use PVE::Auth::PVE;
23 use PVE::Auth::PAM;
24
25 # load and initialize all plugins
26
27 PVE::Auth::AD->register();
28 PVE::Auth::LDAP->register();
29 PVE::Auth::PVE->register();
30 PVE::Auth::PAM->register();
31 PVE::Auth::Plugin->init();
32
33 # $authdir must be writable by root only!
34 my $confdir = "/etc/pve";
35 my $authdir = "$confdir/priv";
36 my $authprivkeyfn = "$authdir/authkey.key";
37 my $authpubkeyfn = "$confdir/authkey.pub";
38 my $pve_www_key_fn = "$confdir/pve-www.key";
39
40 my $ticket_lifetime = 3600*2; # 2 hours
41
42 Crypt::OpenSSL::RSA->import_random_seed();
43
44 cfs_register_file('user.cfg',
45                   \&parse_user_config,
46                   \&write_user_config);
47
48 sub verify_username {
49     PVE::Auth::Plugin::verify_username(@_);
50 }
51
52 sub pve_verify_realm {
53     PVE::Auth::Plugin::pve_verify_realm(@_);
54 }
55
56 sub lock_user_config {
57     my ($code, $errmsg) = @_;
58
59     cfs_lock_file("user.cfg", undef, $code);
60     if (my $err = $@) {
61         $errmsg ? die "$errmsg: $err" : die $err;
62     }
63 }
64
65 my $pve_auth_pub_key;
66 sub get_pubkey {
67
68     return $pve_auth_pub_key if $pve_auth_pub_key;
69
70     my $input = PVE::Tools::file_get_contents($authpubkeyfn);
71
72     $pve_auth_pub_key = Crypt::OpenSSL::RSA->new_public_key($input);
73
74     return $pve_auth_pub_key;
75 }
76
77 my $csrf_prevention_secret;
78 my $get_csrfr_secret = sub {
79     if (!$csrf_prevention_secret) {
80         my $input = PVE::Tools::file_get_contents($pve_www_key_fn);
81         $csrf_prevention_secret = Digest::SHA::sha1_base64($input);
82     }
83     return $csrf_prevention_secret;
84 };
85
86 sub assemble_csrf_prevention_token {
87     my ($username) = @_;
88
89     my $secret =  &$get_csrfr_secret();
90
91     return PVE::Ticket::assemble_csrf_prevention_token ($secret, $username);
92 }
93
94 sub verify_csrf_prevention_token {
95     my ($username, $token, $noerr) = @_;
96
97     my $secret =  &$get_csrfr_secret();
98
99     return PVE::Ticket::verify_csrf_prevention_token(
100         $secret, $username, $token, -300, $ticket_lifetime, $noerr);
101 }
102
103 my $pve_auth_priv_key;
104 sub get_privkey {
105
106     return $pve_auth_priv_key if $pve_auth_priv_key;
107
108     my $input = PVE::Tools::file_get_contents($authprivkeyfn);
109
110     $pve_auth_priv_key = Crypt::OpenSSL::RSA->new_private_key($input);
111
112     return $pve_auth_priv_key;
113 }
114
115 sub assemble_ticket {
116     my ($username) = @_;
117
118     my $rsa_priv = get_privkey();
119
120     return PVE::Ticket::assemble_rsa_ticket($rsa_priv, 'PVE', $username);
121 }
122
123 sub verify_ticket {
124     my ($ticket, $noerr) = @_;
125
126     my $rsa_pub = get_pubkey();
127
128     my ($username, $age) = PVE::Ticket::verify_rsa_ticket(
129         $rsa_pub, 'PVE', $ticket, undef, -300, $ticket_lifetime, $noerr);
130
131     return undef if $noerr && !defined($username);
132
133     return undef if !PVE::Auth::Plugin::verify_username($username, $noerr);
134
135     return wantarray ? ($username, $age) : $username;
136 }
137
138 # VNC tickets
139 # - they do not contain the username in plain text
140 # - they are restricted to a specific resource path (example: '/vms/100')
141 sub assemble_vnc_ticket {
142     my ($username, $path) = @_;
143
144     my $rsa_priv = get_privkey();
145
146     $path = normalize_path($path);
147
148     my $secret_data = "$username:$path";
149
150     return PVE::Ticket::assemble_rsa_ticket(
151         $rsa_priv, 'PVEVNC', undef, $secret_data);
152 }
153
154 sub verify_vnc_ticket {
155     my ($ticket, $username, $path, $noerr) = @_;
156
157     my $rsa_pub = get_pubkey();
158
159     my $secret_data = "$username:$path";
160
161     return PVE::Ticket::verify_rsa_ticket(
162         $rsa_pub, 'PVEVNC', $ticket, $secret_data, -20, 40, $noerr);
163 }
164
165 sub assemble_spice_ticket {
166     my ($username, $vmid, $node) = @_;
167
168     my $secret = &$get_csrfr_secret();
169
170     return PVE::Ticket::assemble_spice_ticket(
171         $secret, $username, $vmid, $node);
172 }
173
174 sub verify_spice_connect_url {
175     my ($connect_str) = @_;
176
177     my $secret = &$get_csrfr_secret();
178
179     return PVE::Ticket::verify_spice_connect_url($secret, $connect_str);
180 }
181
182 sub read_x509_subject_spice {
183     my ($filename) = @_;
184
185     # read x509 subject
186     my $bio = Net::SSLeay::BIO_new_file($filename, 'r');
187     die "Could not open $filename using OpenSSL\n"
188         if !$bio;
189
190     my $x509 = Net::SSLeay::PEM_read_bio_X509($bio);
191     Net::SSLeay::BIO_free($bio);
192
193     die "Could not parse X509 certificate in $filename\n"
194         if !$x509;
195
196     my $nameobj = Net::SSLeay::X509_get_subject_name($x509);
197     my $subject = Net::SSLeay::X509_NAME_oneline($nameobj);
198     Net::SSLeay::X509_free($x509);
199
200     # remote-viewer wants comma as seperator (not '/')
201     $subject =~ s!^/!!;
202     $subject =~ s!/(\w+=)!,$1!g;
203
204     return $subject;
205 }
206
207 # helper to generate SPICE remote-viewer configuration
208 sub remote_viewer_config {
209     my ($authuser, $vmid, $node, $proxy, $title, $port) = @_;
210
211     if (!$proxy) {
212         my $host = `hostname -f` || PVE::INotify::nodename();
213         chomp $host;
214         $proxy = $host;
215     }
216
217     my ($ticket, $proxyticket) = assemble_spice_ticket($authuser, $vmid, $node);
218
219     my $filename = "/etc/pve/local/pve-ssl.pem";
220     my $subject = read_x509_subject_spice($filename);
221
222     my $cacert = PVE::Tools::file_get_contents("/etc/pve/pve-root-ca.pem", 8192);
223     $cacert =~ s/\n/\\n/g;
224
225     $proxy = "[$proxy]" if Net::IP::ip_is_ipv6($proxy);
226     my $config = {
227         'secure-attention' => "Ctrl+Alt+Ins",
228         'toggle-fullscreen' => "Shift+F11",
229         'release-cursor' => "Ctrl+Alt+R",
230         type => 'spice',
231         title => $title,
232         host => $proxyticket, # this breaks tls hostname verification, so we need to use 'host-subject'
233         proxy => "http://$proxy:3128",
234         'tls-port' => $port,
235         'host-subject' => $subject,
236         ca => $cacert,
237         password => $ticket,
238         'delete-this-file' => 1,
239     };
240
241     return ($ticket, $proxyticket, $config);
242 }
243
244 sub check_user_exist {
245     my ($usercfg, $username, $noerr) = @_;
246
247     $username = PVE::Auth::Plugin::verify_username($username, $noerr);
248     return undef if !$username;
249
250     return $usercfg->{users}->{$username} if $usercfg && $usercfg->{users}->{$username};
251
252     die "no such user ('$username')\n" if !$noerr;
253
254     return undef;
255 }
256
257 sub check_user_enabled {
258     my ($usercfg, $username, $noerr) = @_;
259
260     my $data = check_user_exist($usercfg, $username, $noerr);
261     return undef if !$data;
262
263     return 1 if $data->{enable};
264
265     die "user '$username' is disabled\n" if !$noerr;
266
267     return undef;
268 }
269
270 sub verify_one_time_pw {
271     my ($usercfg, $username, $tfa_cfg, $otp) = @_;
272
273     my $type = $tfa_cfg->{type};
274
275     die "missing one time password for two-factor authentication '$type'\n" if !$otp;
276
277     # fixme: proxy support?
278     my $proxy;
279
280     if ($type eq 'yubico') {
281         my $keys = $usercfg->{users}->{$username}->{keys};
282         PVE::OTP::yubico_verify_otp($otp, $keys, $tfa_cfg->{url},
283                                     $tfa_cfg->{id}, $tfa_cfg->{key}, $proxy);
284     } elsif ($type eq 'oath') {
285         my $keys = $usercfg->{users}->{$username}->{keys};
286         PVE::OTP::oath_verify_otp($otp, $keys, $tfa_cfg->{step}, $tfa_cfg->{digits});
287     } else {
288         die "unknown tfa type '$type'\n";
289     }
290 }
291
292 # password should be utf8 encoded
293 # Note: some plugins delay/sleep if auth fails
294 sub authenticate_user {
295     my ($username, $password, $otp) = @_;
296
297     die "no username specified\n" if !$username;
298
299     my ($ruid, $realm);
300
301     ($username, $ruid, $realm) = PVE::Auth::Plugin::verify_username($username);
302
303     my $usercfg = cfs_read_file('user.cfg');
304
305     check_user_enabled($usercfg, $username);
306
307     my $ctime = time();
308     my $expire = $usercfg->{users}->{$username}->{expire};
309
310     die "account expired\n" if $expire && ($expire < $ctime);
311
312     my $domain_cfg = cfs_read_file('domains.cfg');
313
314     my $cfg = $domain_cfg->{ids}->{$realm};
315     die "auth domain '$realm' does not exists\n" if !$cfg;
316     my $plugin = PVE::Auth::Plugin->lookup($cfg->{type});
317     $plugin->authenticate_user($cfg, $realm, $ruid, $password);
318
319     if ($cfg->{tfa}) {
320         my $tfa_cfg = PVE::Auth::Plugin::parse_tfa_config($cfg->{tfa});
321         verify_one_time_pw($usercfg, $username, $tfa_cfg, $otp);
322     }
323
324     return $username;
325 }
326
327 sub domain_set_password {
328     my ($realm, $username, $password) = @_;
329
330     die "no auth domain specified" if !$realm;
331
332     my $domain_cfg = cfs_read_file('domains.cfg');
333
334     my $cfg = $domain_cfg->{ids}->{$realm};
335     die "auth domain '$realm' does not exist\n" if !$cfg;
336     my $plugin = PVE::Auth::Plugin->lookup($cfg->{type});
337     $plugin->store_password($cfg, $realm, $username, $password);
338 }
339
340 sub add_user_group {
341     my ($username, $usercfg, $group) = @_;
342
343     $usercfg->{users}->{$username}->{groups}->{$group} = 1;
344     $usercfg->{groups}->{$group}->{users}->{$username} = 1;
345 }
346
347 sub delete_user_group {
348     my ($username, $usercfg) = @_;
349
350     foreach my $group (keys %{$usercfg->{groups}}) {
351
352         delete ($usercfg->{groups}->{$group}->{users}->{$username})
353             if $usercfg->{groups}->{$group}->{users}->{$username};
354     }
355 }
356
357 sub delete_user_acl {
358     my ($username, $usercfg) = @_;
359
360     foreach my $acl (keys %{$usercfg->{acl}}) {
361
362         delete ($usercfg->{acl}->{$acl}->{users}->{$username})
363             if $usercfg->{acl}->{$acl}->{users}->{$username};
364     }
365 }
366
367 sub delete_group_acl {
368     my ($group, $usercfg) = @_;
369
370     foreach my $acl (keys %{$usercfg->{acl}}) {
371
372         delete ($usercfg->{acl}->{$acl}->{groups}->{$group})
373             if $usercfg->{acl}->{$acl}->{groups}->{$group};
374     }
375 }
376
377 sub delete_pool_acl {
378     my ($pool, $usercfg) = @_;
379
380     my $path = "/pool/$pool";
381
382     delete ($usercfg->{acl}->{$path})
383 }
384
385 # we automatically create some predefined roles by splitting privs
386 # into 3 groups (per category)
387 # root: only root is allowed to do that
388 # admin: an administrator can to that
389 # user: a normal user/customer can to that
390 my $privgroups = {
391     VM => {
392         root => [],
393         admin => [
394             'VM.Config.Disk',
395             'VM.Config.CPU',
396             'VM.Config.Memory',
397             'VM.Config.Network',
398             'VM.Config.HWType',
399             'VM.Config.Options', # covers all other things
400             'VM.Allocate',
401             'VM.Clone',
402             'VM.Migrate',
403             'VM.Monitor',
404             'VM.Snapshot',
405             'VM.Snapshot.Rollback',
406         ],
407         user => [
408             'VM.Config.CDROM', # change CDROM media
409             'VM.Console',
410             'VM.Backup',
411             'VM.PowerMgmt',
412         ],
413         audit => [
414             'VM.Audit',
415         ],
416     },
417     Sys => {
418         root => [
419             'Sys.PowerMgmt',
420             'Sys.Modify', # edit/change node settings
421         ],
422         admin => [
423             'Permissions.Modify',
424             'Sys.Console',
425             'Sys.Syslog',
426         ],
427         user => [],
428         audit => [
429             'Sys.Audit',
430         ],
431     },
432     Datastore => {
433         root => [],
434         admin => [
435             'Datastore.Allocate',
436             'Datastore.AllocateTemplate',
437         ],
438         user => [
439             'Datastore.AllocateSpace',
440         ],
441         audit => [
442             'Datastore.Audit',
443         ],
444     },
445     User => {
446         root => [
447             'Realm.Allocate',
448         ],
449         admin => [
450             'User.Modify',
451             'Group.Allocate', # edit/change group settings
452             'Realm.AllocateUser',
453         ],
454         user => [],
455         audit => [],
456     },
457     Pool => {
458         root => [],
459         admin => [
460             'Pool.Allocate', # create/delete pools
461         ],
462         user => [],
463         audit => [],
464     },
465 };
466
467 my $valid_privs = {};
468
469 my $special_roles = {
470     'NoAccess' => {}, # no privileges
471     'Administrator' => $valid_privs, # all privileges
472 };
473
474 sub create_roles {
475
476     foreach my $cat (keys %$privgroups) {
477         my $cd = $privgroups->{$cat};
478         foreach my $p (@{$cd->{root}}, @{$cd->{admin}},
479                        @{$cd->{user}}, @{$cd->{audit}}) {
480             $valid_privs->{$p} = 1;
481         }
482         foreach my $p (@{$cd->{admin}}, @{$cd->{user}}, @{$cd->{audit}}) {
483
484             $special_roles->{"PVE${cat}Admin"}->{$p} = 1;
485             $special_roles->{"PVEAdmin"}->{$p} = 1;
486         }
487         if (scalar(@{$cd->{user}})) {
488             foreach my $p (@{$cd->{user}}, @{$cd->{audit}}) {
489                 $special_roles->{"PVE${cat}User"}->{$p} = 1;
490             }
491         }
492         foreach my $p (@{$cd->{audit}}) {
493             $special_roles->{"PVEAuditor"}->{$p} = 1;
494         }
495     }
496
497     $special_roles->{"PVETemplateUser"} = { 'VM.Clone' => 1, 'VM.Audit' => 1 };
498 };
499
500 create_roles();
501
502 sub role_is_special {
503     my ($role) = @_;
504     return (exists $special_roles->{$role}) ? 1 : 0;
505 }
506
507 sub add_role_privs {
508     my ($role, $usercfg, $privs) = @_;
509
510     return if !$privs;
511
512     die "role '$role' does not exist\n" if !$usercfg->{roles}->{$role};
513
514     foreach my $priv (split_list($privs)) {
515         if (defined ($valid_privs->{$priv})) {
516             $usercfg->{roles}->{$role}->{$priv} = 1;
517         } else {
518             die "invalid privilege '$priv'\n";
519         }
520     }
521 }
522
523 sub normalize_path {
524     my $path = shift;
525
526     $path =~ s|/+|/|g;
527
528     $path =~ s|/$||;
529
530     $path = '/' if !$path;
531
532     $path = "/$path" if $path !~ m|^/|;
533
534     return undef if $path !~ m|^[[:alnum:]\.\-\_\/]+$|;
535
536     return $path;
537 }
538
539 PVE::JSONSchema::register_format('pve-groupid', \&verify_groupname);
540 sub verify_groupname {
541     my ($groupname, $noerr) = @_;
542
543     if ($groupname !~ m/^[A-Za-z0-9\.\-_]+$/) {
544
545         die "group name '$groupname' contains invalid characters\n" if !$noerr;
546
547         return undef;
548     }
549
550     return $groupname;
551 }
552
553 PVE::JSONSchema::register_format('pve-roleid', \&verify_rolename);
554 sub verify_rolename {
555     my ($rolename, $noerr) = @_;
556
557     if ($rolename !~ m/^[A-Za-z0-9\.\-_]+$/) {
558
559         die "role name '$rolename' contains invalid characters\n" if !$noerr;
560
561         return undef;
562     }
563
564     return $rolename;
565 }
566
567 PVE::JSONSchema::register_format('pve-poolid', \&verify_poolname);
568 sub verify_poolname {
569     my ($poolname, $noerr) = @_;
570
571     if ($poolname !~ m/^[A-Za-z0-9\.\-_]+$/) {
572
573         die "pool name '$poolname' contains invalid characters\n" if !$noerr;
574
575         return undef;
576     }
577
578     return $poolname;
579 }
580
581 PVE::JSONSchema::register_format('pve-priv', \&verify_privname);
582 sub verify_privname {
583     my ($priv, $noerr) = @_;
584
585     if (!$valid_privs->{$priv}) {
586         die "invalid privilege '$priv'\n" if !$noerr;
587
588         return undef;
589     }
590
591     return $priv;
592 }
593
594 sub userconfig_force_defaults {
595     my ($cfg) = @_;
596
597     foreach my $r (keys %$special_roles) {
598         $cfg->{roles}->{$r} = $special_roles->{$r};
599     }
600
601     # add root user if not exists
602     if (!$cfg->{users}->{'root@pam'}) {
603         $cfg->{users}->{'root@pam'}->{enable} = 1;
604     }
605 }
606
607 sub parse_user_config {
608     my ($filename, $raw) = @_;
609
610     my $cfg = {};
611
612     userconfig_force_defaults($cfg);
613
614     $raw = '' if !defined($raw);
615     while ($raw =~ /^\s*(.+?)\s*$/gm) {
616         my $line = $1;
617         my @data;
618
619         foreach my $d (split (/:/, $line)) {
620             $d =~ s/^\s+//;
621             $d =~ s/\s+$//;
622             push @data, $d
623         }
624
625         my $et = shift @data;
626
627         if ($et eq 'user') {
628             my ($user, $enable, $expire, $firstname, $lastname, $email, $comment, $keys) = @data;
629
630             my (undef, undef, $realm) = PVE::Auth::Plugin::verify_username($user, 1);
631             if (!$realm) {
632                 warn "user config - ignore user '$user' - invalid user name\n";
633                 next;
634             }
635
636             $enable = $enable ? 1 : 0;
637
638             $expire = 0 if !$expire;
639
640             if ($expire !~ m/^\d+$/) {
641                 warn "user config - ignore user '$user' - (illegal characters in expire '$expire')\n";
642                 next;
643             }
644             $expire = int($expire);
645
646             #if (!verify_groupname ($group, 1)) {
647             #    warn "user config - ignore user '$user' - invalid characters in group name\n";
648             #    next;
649             #}
650
651             $cfg->{users}->{$user} = {
652                 enable => $enable,
653                 # group => $group,
654             };
655             $cfg->{users}->{$user}->{firstname} = PVE::Tools::decode_text($firstname) if $firstname;
656             $cfg->{users}->{$user}->{lastname} = PVE::Tools::decode_text($lastname) if $lastname;
657             $cfg->{users}->{$user}->{email} = $email;
658             $cfg->{users}->{$user}->{comment} = PVE::Tools::decode_text($comment) if $comment;
659             $cfg->{users}->{$user}->{expire} = $expire;
660             # keys: allowed yubico key ids or oath secrets (base32 encoded)
661             $cfg->{users}->{$user}->{keys} = $keys if $keys;
662
663             #$cfg->{users}->{$user}->{groups}->{$group} = 1;
664             #$cfg->{groups}->{$group}->{$user} = 1;
665
666         } elsif ($et eq 'group') {
667             my ($group, $userlist, $comment) = @data;
668
669             if (!verify_groupname($group, 1)) {
670                 warn "user config - ignore group '$group' - invalid characters in group name\n";
671                 next;
672             }
673
674             # make sure to add the group (even if there are no members)
675             $cfg->{groups}->{$group} = { users => {} } if !$cfg->{groups}->{$group};
676
677             $cfg->{groups}->{$group}->{comment} = PVE::Tools::decode_text($comment) if $comment;
678
679             foreach my $user (split_list($userlist)) {
680
681                 if (!PVE::Auth::Plugin::verify_username($user, 1)) {
682                     warn "user config - ignore invalid group member '$user'\n";
683                     next;
684                 }
685
686                 if ($cfg->{users}->{$user}) { # user exists
687                     $cfg->{users}->{$user}->{groups}->{$group} = 1;
688                     $cfg->{groups}->{$group}->{users}->{$user} = 1;
689                 } else {
690                     warn "user config - ignore invalid group member '$user'\n";
691                 }
692             }
693
694         } elsif ($et eq 'role') {
695             my ($role, $privlist) = @data;
696
697             if (!verify_rolename($role, 1)) {
698                 warn "user config - ignore role '$role' - invalid characters in role name\n";
699                 next;
700             }
701
702             # make sure to add the role (even if there are no privileges)
703             $cfg->{roles}->{$role} = {} if !$cfg->{roles}->{$role};
704
705             foreach my $priv (split_list($privlist)) {
706                 if (defined ($valid_privs->{$priv})) {
707                     $cfg->{roles}->{$role}->{$priv} = 1;
708                 } else {
709                     warn "user config - ignore invalid priviledge '$priv'\n";
710                 }
711             }
712
713         } elsif ($et eq 'acl') {
714             my ($propagate, $pathtxt, $uglist, $rolelist) = @data;
715
716             if (my $path = normalize_path($pathtxt)) {
717                 foreach my $role (split_list($rolelist)) {
718
719                     if (!verify_rolename($role, 1)) {
720                         warn "user config - ignore invalid role name '$role' in acl\n";
721                         next;
722                     }
723
724                     foreach my $ug (split_list($uglist)) {
725                         if ($ug =~ m/^@(\S+)$/) {
726                             my $group = $1;
727                             if ($cfg->{groups}->{$group}) { # group exists
728                                 $cfg->{acl}->{$path}->{groups}->{$group}->{$role} = $propagate;
729                             } else {
730                                 warn "user config - ignore invalid acl group '$group'\n";
731                             }
732                         } elsif (PVE::Auth::Plugin::verify_username($ug, 1)) {
733                             if ($cfg->{users}->{$ug}) { # user exists
734                                 $cfg->{acl}->{$path}->{users}->{$ug}->{$role} = $propagate;
735                             } else {
736                                 warn "user config - ignore invalid acl member '$ug'\n";
737                             }
738                         } else {
739                             warn "user config - invalid user/group '$ug' in acl\n";
740                         }
741                     }
742                 }
743             } else {
744                 warn "user config - ignore invalid path in acl '$pathtxt'\n";
745             }
746         } elsif ($et eq 'pool') {
747             my ($pool, $comment, $vmlist, $storelist) = @data;
748
749             if (!verify_poolname($pool, 1)) {
750                 warn "user config - ignore pool '$pool' - invalid characters in pool name\n";
751                 next;
752             }
753
754             # make sure to add the pool (even if there are no members)
755             $cfg->{pools}->{$pool} = { vms => {}, storage => {} } if !$cfg->{pools}->{$pool};
756
757             $cfg->{pools}->{$pool}->{comment} = PVE::Tools::decode_text($comment) if $comment;
758
759             foreach my $vmid (split_list($vmlist)) {
760                 if ($vmid !~ m/^\d+$/) {
761                     warn "user config - ignore invalid vmid '$vmid' in pool '$pool'\n";
762                     next;
763                 }
764                 $vmid = int($vmid);
765
766                 if ($cfg->{vms}->{$vmid}) {
767                     warn "user config - ignore duplicate vmid '$vmid' in pool '$pool'\n";
768                     next;
769                 }
770
771                 $cfg->{pools}->{$pool}->{vms}->{$vmid} = 1;
772
773                 # record vmid ==> pool relation
774                 $cfg->{vms}->{$vmid} = $pool;
775             }
776
777             foreach my $storeid (split_list($storelist)) {
778                 if ($storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
779                     warn "user config - ignore invalid storage '$storeid' in pool '$pool'\n";
780                     next;
781                 }
782                 $cfg->{pools}->{$pool}->{storage}->{$storeid} = 1;
783             }
784         } else {
785             warn "user config - ignore config line: $line\n";
786         }
787     }
788
789     userconfig_force_defaults($cfg);
790
791     return $cfg;
792 }
793
794 sub write_user_config {
795     my ($filename, $cfg) = @_;
796
797     my $data = '';
798
799     foreach my $user (keys %{$cfg->{users}}) {
800         my $d = $cfg->{users}->{$user};
801         my $firstname = $d->{firstname} ? PVE::Tools::encode_text($d->{firstname}) : '';
802         my $lastname = $d->{lastname} ? PVE::Tools::encode_text($d->{lastname}) : '';
803         my $email = $d->{email} || '';
804         my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : '';
805         my $expire = int($d->{expire} || 0);
806         my $enable = $d->{enable} ? 1 : 0;
807         my $keys = $d->{keys} ? $d->{keys} : '';
808         $data .= "user:$user:$enable:$expire:$firstname:$lastname:$email:$comment:$keys:\n";
809     }
810
811     $data .= "\n";
812
813     foreach my $group (keys %{$cfg->{groups}}) {
814         my $d = $cfg->{groups}->{$group};
815         my $list = join (',', keys %{$d->{users}});
816         my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : '';
817         $data .= "group:$group:$list:$comment:\n";
818     }
819
820     $data .= "\n";
821
822     foreach my $pool (keys %{$cfg->{pools}}) {
823         my $d = $cfg->{pools}->{$pool};
824         my $vmlist = join (',', keys %{$d->{vms}});
825         my $storelist = join (',', keys %{$d->{storage}});
826         my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : '';
827         $data .= "pool:$pool:$comment:$vmlist:$storelist:\n";
828     }
829
830     $data .= "\n";
831
832     foreach my $role (keys %{$cfg->{roles}}) {
833         next if $special_roles->{$role};
834
835         my $d = $cfg->{roles}->{$role};
836         my $list = join (',', keys %$d);
837         $data .= "role:$role:$list:\n";
838     }
839
840     $data .= "\n";
841
842     foreach my $path (sort keys %{$cfg->{acl}}) {
843         my $d = $cfg->{acl}->{$path};
844
845         my $ra = {};
846
847         foreach my $group (keys %{$d->{groups}}) {
848             my $l0 = '';
849             my $l1 = '';
850             foreach my $role (sort keys %{$d->{groups}->{$group}}) {
851                 my $propagate = $d->{groups}->{$group}->{$role};
852                 if ($propagate) {
853                     $l1 .= ',' if $l1;
854                     $l1 .= $role;
855                 } else {
856                     $l0 .= ',' if $l0;
857                     $l0 .= $role;
858                 }
859             }
860             $ra->{0}->{$l0}->{"\@$group"} = 1 if $l0;
861             $ra->{1}->{$l1}->{"\@$group"} = 1 if $l1;
862         }
863
864         foreach my $user (keys %{$d->{users}}) {
865             # no need to save, because root is always 'Administrator'
866             next if $user eq 'root@pam';
867
868             my $l0 = '';
869             my $l1 = '';
870             foreach my $role (sort keys %{$d->{users}->{$user}}) {
871                 my $propagate = $d->{users}->{$user}->{$role};
872                 if ($propagate) {
873                     $l1 .= ',' if $l1;
874                     $l1 .= $role;
875                 } else {
876                     $l0 .= ',' if $l0;
877                     $l0 .= $role;
878                 }
879             }
880             $ra->{0}->{$l0}->{$user} = 1 if $l0;
881             $ra->{1}->{$l1}->{$user} = 1 if $l1;
882         }
883
884         foreach my $rolelist (sort keys %{$ra->{0}}) {
885             my $uglist = join (',', keys %{$ra->{0}->{$rolelist}});
886             $data .= "acl:0:$path:$uglist:$rolelist:\n";
887         }
888         foreach my $rolelist (sort keys %{$ra->{1}}) {
889             my $uglist = join (',', keys %{$ra->{1}->{$rolelist}});
890             $data .= "acl:1:$path:$uglist:$rolelist:\n";
891         }
892     }
893
894     return $data;
895 }
896
897 sub roles {
898     my ($cfg, $user, $path) = @_;
899
900     # NOTE: we do not consider pools here.
901     # You need to use $rpcenv->roles() instead if you want that.
902
903     return 'Administrator' if $user eq 'root@pam'; # root can do anything
904
905     my $perm = {};
906
907     foreach my $p (sort keys %{$cfg->{acl}}) {
908         my $final = ($path eq $p);
909
910         next if !(($p eq '/') || $final || ($path =~ m|^$p/|));
911
912         my $acl = $cfg->{acl}->{$p};
913
914         #print "CHECKACL $path $p\n";
915         #print "ACL $path = " . Dumper ($acl);
916
917         if (my $ri = $acl->{users}->{$user}) {
918             my $new;
919             foreach my $role (keys %$ri) {
920                 my $propagate = $ri->{$role};
921                 if ($final || $propagate) {
922                     #print "APPLY ROLE $p $user $role\n";
923                     $new = {} if !$new;
924                     $new->{$role} = 1;
925                 }
926             }
927             if ($new) {
928                 $perm = $new; # overwrite previous settings
929                 next; # user privs always override group privs
930             }
931         }
932
933         my $new;
934         foreach my $g (keys %{$acl->{groups}}) {
935             next if !$cfg->{groups}->{$g}->{users}->{$user};
936             if (my $ri = $acl->{groups}->{$g}) {
937                 foreach my $role (keys %$ri) {
938                     my $propagate = $ri->{$role};
939                     if ($final || $propagate) {
940                         #print "APPLY ROLE $p \@$g $role\n";
941                         $new = {} if !$new;
942                         $new->{$role} = 1;
943                     }
944                 }
945             }
946         }
947         if ($new) {
948             $perm = $new; # overwrite previous settings
949             next;
950         }
951     }
952
953     return ('NoAccess') if defined ($perm->{NoAccess});
954     #return () if defined ($perm->{NoAccess});
955
956     #print "permission $user $path = " . Dumper ($perm);
957
958     my @ra = keys %$perm;
959
960     #print "roles $user $path = " . join (',', @ra) . "\n";
961
962     return @ra;
963 }
964
965 sub permission {
966     my ($cfg, $user, $path) = @_;
967
968     $user = PVE::Auth::Plugin::verify_username($user, 1);
969     return {} if !$user;
970
971     my @ra = roles($cfg, $user, $path);
972
973     my $privs = {};
974
975     foreach my $role (@ra) {
976         if (my $privset = $cfg->{roles}->{$role}) {
977             foreach my $p (keys %$privset) {
978                 $privs->{$p} = 1;
979             }
980         }
981     }
982
983     #print "priviledges $user $path = " . Dumper ($privs);
984
985     return $privs;
986 }
987
988 sub check_permissions {
989     my ($username, $path, $privlist) = @_;
990
991     $path = normalize_path($path);
992     my $usercfg = cfs_read_file('user.cfg');
993     my $perm = permission($usercfg, $username, $path);
994
995     foreach my $priv (split_list($privlist)) {
996         return undef if !$perm->{$priv};
997     };
998
999     return 1;
1000 }
1001
1002 sub remove_vm_access {
1003     my ($vmid) = @_;
1004     my $delVMaccessFn = sub {
1005         my $usercfg = cfs_read_file("user.cfg");
1006         my $modified;
1007
1008         if (my $acl = $usercfg->{acl}->{"/vms/$vmid"}) {
1009             delete $usercfg->{acl}->{"/vms/$vmid"};
1010             $modified = 1;
1011         }
1012         if (my $pool = $usercfg->{vms}->{$vmid}) {
1013             if (my $data = $usercfg->{pools}->{$pool}) {
1014                 delete $data->{vms}->{$vmid};
1015                 delete $usercfg->{vms}->{$vmid};
1016                 $modified = 1;
1017             }
1018         }
1019         cfs_write_file("user.cfg", $usercfg) if $modified;
1020     };
1021
1022     lock_user_config($delVMaccessFn, "access permissions cleanup for VM $vmid failed");
1023 }
1024
1025 sub remove_storage_access {
1026     my ($storeid) = @_;
1027
1028     my $deleteStorageAccessFn = sub {
1029         my $usercfg = cfs_read_file("user.cfg");
1030         my $modified;
1031
1032         if (my $storage = $usercfg->{acl}->{"/storage/$storeid"}) {
1033             delete $usercfg->{acl}->{"/storage/$storeid"};
1034             $modified = 1;
1035         }
1036         foreach my $pool (keys %{$usercfg->{pools}}) {
1037             delete $usercfg->{pools}->{$pool}->{storage}->{$storeid};
1038             $modified = 1;
1039         }
1040         cfs_write_file("user.cfg", $usercfg) if $modified;
1041     };
1042
1043     lock_user_config($deleteStorageAccessFn,
1044                      "access permissions cleanup for storage $storeid failed");
1045 }
1046
1047 sub add_vm_to_pool {
1048     my ($vmid, $pool) = @_;
1049
1050     my $addVMtoPoolFn = sub {
1051         my $usercfg = cfs_read_file("user.cfg");
1052         if (my $data = $usercfg->{pools}->{$pool}) {
1053             $data->{vms}->{$vmid} = 1;
1054             $usercfg->{vms}->{$vmid} = $pool;
1055             cfs_write_file("user.cfg", $usercfg);
1056         }
1057     };
1058
1059     lock_user_config($addVMtoPoolFn, "can't add VM $vmid to pool '$pool'");
1060 }
1061
1062 sub remove_vm_from_pool {
1063     my ($vmid) = @_;
1064
1065     my $delVMfromPoolFn = sub {
1066         my $usercfg = cfs_read_file("user.cfg");
1067         if (my $pool = $usercfg->{vms}->{$vmid}) {
1068             if (my $data = $usercfg->{pools}->{$pool}) {
1069                 delete $data->{vms}->{$vmid};
1070                 delete $usercfg->{vms}->{$vmid};
1071                 cfs_write_file("user.cfg", $usercfg);
1072             }
1073         }
1074     };
1075
1076     lock_user_config($delVMfromPoolFn, "pool cleanup for VM $vmid failed");
1077 }
1078
1079 # bash completion helpers
1080
1081 register_standard_option('userid-completed',
1082     get_standard_option('userid', { completion => \&complete_username}),
1083 );
1084
1085 sub complete_username {
1086
1087     my $user_cfg = cfs_read_file('user.cfg');
1088
1089     return [ keys %{$user_cfg->{users}} ];
1090 }
1091
1092 sub complete_group {
1093
1094     my $user_cfg = cfs_read_file('user.cfg');
1095
1096     return [ keys %{$user_cfg->{groups}} ];
1097 }
1098
1099 sub complete_realm {
1100
1101     my $domain_cfg = cfs_read_file('domains.cfg');
1102
1103     return [ keys %{$domain_cfg->{ids}} ];
1104 }
1105
1106 1;