86c15fdf1b4d16b0b2c6b39c856796ef425621a4
[pve-access-control.git] / PVE / AccessControl.pm
1 package PVE::AccessControl;
2
3 use strict;
4 use Encode;
5 use Crypt::OpenSSL::Random;
6 use Crypt::OpenSSL::RSA;
7 use MIME::Base64;
8 use Digest::SHA;
9 use Authen::PAM qw(:constants);
10 use Net::LDAP;
11 use PVE::Tools qw(run_command lock_file file_get_contents split_list safe_print);
12 use PVE::Cluster qw(cfs_register_file cfs_read_file cfs_write_file cfs_lock_file);
13 use PVE::JSONSchema;
14 use Encode;
15
16 use Data::Dumper; # fixme: remove
17
18 # $authdir must be writable by root only!
19 my $confdir = "/etc/pve";
20 my $authdir = "$confdir/priv";
21 my $authprivkeyfn = "$authdir/authkey.key";
22 my $authpubkeyfn = "$confdir/authkey.pub";
23 my $shadowconfigfile = "priv/shadow.cfg";
24 my $domainconfigfile = "domains.cfg";
25 my $pve_www_key_fn = "$confdir/pve-www.key";
26
27 my $ticket_lifetime = 3600*2; # 2 hours
28
29 Crypt::OpenSSL::RSA->import_random_seed();
30
31 cfs_register_file('user.cfg', 
32                   \&parse_user_config,  
33                   \&write_user_config);
34
35 cfs_register_file($shadowconfigfile, 
36                   \&parse_shadow_passwd, 
37                   \&write_shadow_config);
38
39 cfs_register_file($domainconfigfile, 
40                   \&parse_domains,
41                   \&write_domains);
42
43
44 sub lock_user_config {
45     my ($code, $errmsg) = @_;
46
47     cfs_lock_file("user.cfg", undef, $code);
48     my $err = $@;
49     if ($err) {
50         $errmsg ? die "$errmsg: $err" : die $err;
51     }
52 }
53
54 sub lock_domain_config {
55     my ($code, $errmsg) = @_;
56
57     cfs_lock_file($domainconfigfile, undef, $code);
58     my $err = $@;
59     if ($err) {
60         $errmsg ? die "$errmsg: $err" : die $err;
61     }
62 }
63
64 sub lock_shadow_config {
65     my ($code, $errmsg) = @_;
66
67     cfs_lock_file($shadowconfigfile, undef, $code);
68     my $err = $@;
69     if ($err) {
70         $errmsg ? die "$errmsg: $err" : die $err;
71     }
72 }
73
74 my $pve_auth_pub_key;
75 sub get_pubkey {    
76
77     return $pve_auth_pub_key if $pve_auth_pub_key;
78
79     my $input = PVE::Tools::file_get_contents($authpubkeyfn); 
80
81     $pve_auth_pub_key = Crypt::OpenSSL::RSA->new_public_key($input);
82
83     return $pve_auth_pub_key;
84 }
85
86 my $csrf_prevention_secret;
87 my $get_csrfr_secret = sub {
88     if (!$csrf_prevention_secret) {
89         my $input = PVE::Tools::file_get_contents($pve_www_key_fn); 
90         $csrf_prevention_secret = Digest::SHA::sha1_base64($input);
91     }
92     return $csrf_prevention_secret;
93 };
94
95 sub assemble_csrf_prevention_token {
96     my ($username) = @_;
97
98     my $timestamp = sprintf("%08X", time());
99
100     my $digest = Digest::SHA::sha1_base64("$timestamp:$username", &$get_csrfr_secret());
101
102     return "$timestamp:$digest"; 
103 }
104
105 sub verify_csrf_prevention_token {
106     my ($username, $token, $noerr) = @_;
107
108     if ($token =~ m/^([A-Z0-9]{8}):(\S+)$/) {
109         my $sig = $2;
110         my $timestamp = $1;
111         my $ttime = hex($timestamp);
112
113         my $digest = Digest::SHA::sha1_base64("$timestamp:$username", &$get_csrfr_secret());
114
115         my $age = time() - $ttime;
116         return if ($digest eq $sig) && ($age > -300) && ($age < $ticket_lifetime);
117     }
118
119     die "Permission denied - invalid csrf token\n" if !$noerr;
120
121     return undef;
122 }
123
124 my $pve_auth_priv_key;
125 sub get_privkey {
126
127     return $pve_auth_priv_key if $pve_auth_priv_key;
128
129     my $input = PVE::Tools::file_get_contents($authprivkeyfn); 
130
131     $pve_auth_priv_key = Crypt::OpenSSL::RSA->new_private_key($input);
132
133     return $pve_auth_priv_key;
134 }
135
136 sub assemble_ticket {
137     my ($username) = @_;
138
139     my $rsa_priv = get_privkey();
140
141     my $timestamp = sprintf("%08X", time());
142
143     my $plain = "PVE:$username:$timestamp";
144
145     my $ticket = $plain . "::" . encode_base64($rsa_priv->sign($plain), '');
146
147     return $ticket;
148 }
149
150 sub verify_ticket {
151     my ($ticket, $noerr) = @_;
152
153     if ($ticket && $ticket =~ m/^(PVE:\S+)::([^:\s]+)$/) {
154         my $plain = $1;
155         my $sig = $2;
156
157         my $rsa_pub = get_pubkey();
158         if ($rsa_pub->verify($plain, decode_base64($sig))) {
159             if ($plain =~ m/^PVE:(([A-Za-z0-9\.\-_]+)(\@([A-Za-z0-9\.\-_]+))?):([A-Z0-9]{8})$/) {
160                 my $username = $1;
161                 my $timestamp = $5;
162                 my $ttime = hex($timestamp);
163
164                 my $age = time() - $ttime;
165
166                 if (($age > -300) && ($age < $ticket_lifetime)) {
167                     return wantarray ? ($username, $age) : $username;
168                 }
169             }
170         }
171     }
172
173     die "permission denied - invalid ticket\n" if !$noerr;
174
175     return undef;
176 }
177
178 # VNC tickets
179 # - they do not contain the username in plain text
180 # - they are restricted to a specific resource path (example: '/vms/100')
181 sub assemble_vnc_ticket {
182     my ($username, $path) = @_;
183
184     my $rsa_priv = get_privkey();
185
186     my $timestamp = sprintf("%08X", time());
187
188     my $plain = "PVEVNC:$timestamp";
189
190     $path = normalize_path($path);
191
192     my $full = "$plain:$username:$path";
193
194     my $ticket = $plain . "::" . encode_base64($rsa_priv->sign($full), '');
195
196     return $ticket;
197 }
198
199 sub verify_vnc_ticket {
200     my ($ticket, $username, $path, $noerr) = @_;
201
202     if ($ticket && $ticket =~ m/^(PVEVNC:\S+)::([^:\s]+)$/) {
203         my $plain = $1;
204         my $sig = $2;
205         my $full = "$plain:$username:$path";
206
207         my $rsa_pub = get_pubkey();
208         # Note: sign only match if $username and  $path is correct
209         if ($rsa_pub->verify($full, decode_base64($sig))) {
210             if ($plain =~ m/^PVEVNC:([A-Z0-9]{8})$/) {
211                 my $ttime = hex($1);
212
213                 my $age = time() - $ttime;
214
215                 if (($age > -20) && ($age < 40)) {
216                     return 1;
217                 }
218             }
219         }
220     }
221
222     die "permission denied - invalid vnc ticket\n" if !$noerr;
223
224     return undef;
225 }
226
227
228 sub authenticate_user_shadow {
229     my ($userid, $password) = @_;
230
231     die "no password\n" if !$password;
232
233     my $shadow_cfg = cfs_read_file($shadowconfigfile);
234     
235     if ($shadow_cfg->{users}->{$userid}) {
236         my $encpw = crypt($password, $shadow_cfg->{users}->{$userid}->{shadow});
237         die "invalid credentials\n" if ($encpw ne $shadow_cfg->{users}->{$userid}->{shadow});
238     } else {
239         die "no password set\n";
240     }
241 }
242
243 sub authenticate_user_pam {
244     my ($userid, $password) = @_;
245
246     # user (www-data) need to be able to read /etc/passwd /etc/shadow
247
248     die "no password\n" if !$password;
249
250     my $pamh = new Authen::PAM ('common-auth', $userid, sub {
251         my @res;
252         while(@_) {
253             my $msg_type = shift;
254             my $msg = shift;
255             push @res, (0, $password);
256         }
257         push @res, 0;
258         return @res;
259     });
260
261     if (!ref ($pamh)) {
262         my $err = $pamh->pam_strerror($pamh);
263         die "error during PAM init: $err";
264     }
265
266     my $res;
267
268     if (($res = $pamh->pam_authenticate(0)) != PAM_SUCCESS) {
269         my $err = $pamh->pam_strerror($res);
270         die "$err\n";
271     }
272
273     if (($res = $pamh->pam_acct_mgmt (0)) != PAM_SUCCESS) {
274         my $err = $pamh->pam_strerror($res);
275         die "$err\n";
276     }
277
278     $pamh = 0; # call destructor
279 }
280
281 sub authenticate_user_ad {
282
283     my ($entry, $server, $userid, $password) = @_;
284
285     my $default_port = $entry->{secure} ? 636: 389;
286     my $port = $entry->{port} ? $entry->{port} : $default_port;
287     my $scheme = $entry->{secure} ? 'ldaps' : 'ldap';
288     my $conn_string = "$scheme://${server}:$port";
289     
290     my $ldap = Net::LDAP->new($server) || die "$@\n";
291
292     $userid = "$userid\@$entry->{domain}" 
293         if $userid !~ m/@/ && $entry->{domain};
294
295     my $res = $ldap->bind($userid, password => $password);
296
297     my $code = $res->code();
298     my $err = $res->error;
299
300     $ldap->unbind();
301
302     die "$err\n" if ($code);
303 }
304
305 sub authenticate_user_ldap {
306
307     my ($entry, $server, $userid, $password) = @_;
308
309     my $default_port = $entry->{secure} ? 636: 389;
310     my $port = $entry->{port} ? $entry->{port} : $default_port;
311     my $scheme = $entry->{secure} ? 'ldaps' : 'ldap';
312     my $conn_string = "$scheme://${server}:$port";
313
314     my $ldap = Net::LDAP->new($conn_string, verify => 'none') || die "$@\n";
315     my $search = $entry->{user_attr} . "=" . $userid;
316     my $result = $ldap->search( base    => "$entry->{base_dn}",
317                                 scope   => "sub",
318                                 filter  => "$search",
319                                 attrs   => ['dn']
320                                 );
321     die "no entries returned\n" if !$result->entries;
322     my @entries = $result->entries;
323     my $res = $ldap->bind($entries[0]->dn, password => $password);
324
325     my $code = $res->code();
326     my $err = $res->error;
327
328     $ldap->unbind();
329
330     die "$err\n" if ($code);
331 }
332
333 sub authenticate_user_domain {
334     my ($realm, $userid, $password) = @_;
335  
336     my $domain_cfg = cfs_read_file($domainconfigfile);
337
338     die "no auth domain specified" if !$realm;
339
340     if ($realm eq 'pam') {
341         authenticate_user_pam($userid, $password);
342         return;
343     } 
344
345     eval {
346         if ($realm eq 'pve') {
347             authenticate_user_shadow($userid, $password);
348         } else { 
349
350             my $cfg = $domain_cfg->{$realm};
351             die "auth domain '$realm' does not exists\n" if !$cfg;
352     
353             if ($cfg->{type} eq 'ad') {
354                 eval { authenticate_user_ad($cfg, $cfg->{server1}, $userid, $password); };
355                 my $err = $@;
356                 return if !$err;
357                 die $err if !$cfg->{server2};
358                 authenticate_user_ad($cfg, $cfg->{server2}, $userid, $password); 
359             } elsif ($cfg->{type} eq 'ldap') {
360                 eval { authenticate_user_ldap($cfg, $cfg->{server1}, $userid, $password); };
361                 my $err = $@;
362                 return if !$err;
363                 die $err if !$cfg->{server2};
364                 authenticate_user_ldap($cfg, $cfg->{server2}, $userid, $password); 
365             } else {
366                 die "unknown auth type '$cfg->{type}'\n";
367             }
368         }
369     };
370     if (my $err = $@) {
371         sleep(2); # timeout after failed auth
372         die $err;
373     }
374 }
375
376 sub check_user_exist {
377     my ($usercfg, $username, $noerr) = @_;
378
379     $username = verify_username($username, $noerr);
380     return undef if !$username;
381  
382     return $usercfg->{users}->{$username} if $usercfg && $usercfg->{users}->{$username};
383
384     die "no such user ('$username')\n" if !$noerr;
385  
386     return undef;
387 }
388
389 sub check_user_enabled {
390     my ($usercfg, $username, $noerr) = @_;
391
392     my $data = check_user_exist($usercfg, $username, $noerr);
393     return undef if !$data;
394
395     return 1 if $data->{enable};
396
397     return 1 if $username eq 'root@pam'; # root is always enabled
398
399     die "user '$username' is disabled\n" if !$noerr;
400  
401     return undef;
402 }
403
404 # password should be utf8 encoded
405 sub authenticate_user {
406     my ($username, $password) = @_;
407
408     die "no username specified\n" if !$username;
409  
410     my ($userid, $realm);
411
412     ($username, $userid, $realm) = verify_username($username);
413
414     my $usercfg = cfs_read_file('user.cfg');
415
416     eval { check_user_enabled($usercfg, $username); };
417     if (my $err = $@) {
418         sleep(2);
419         die $err;
420     }
421
422     my $ctime = time();
423     my $expire = $usercfg->{users}->{$username}->{expire};
424
425     if ($expire && ($expire < $ctime)) {
426         sleep(2);
427         die "account expired\n"
428     }
429
430     authenticate_user_domain($realm, $userid, $password);
431
432     return $username;
433 }
434
435 sub delete_shadow_password {
436     my ($userid) = @_;
437  
438     lock_shadow_config(sub {
439         my $shadow_cfg = cfs_read_file($shadowconfigfile);
440         delete ($shadow_cfg->{users}->{$userid})
441             if $shadow_cfg->{users}->{$userid};
442         cfs_write_file($shadowconfigfile, $shadow_cfg);
443     });
444 }
445
446 sub store_shadow_password {
447     my ($userid, $password) = @_;
448   
449     lock_shadow_config(sub {
450         my $shadow_cfg = cfs_read_file($shadowconfigfile);
451         $shadow_cfg->{users}->{$userid}->{shadow} = encrypt_pw($password);
452         cfs_write_file($shadowconfigfile, $shadow_cfg);
453     });
454 }
455
456 sub encrypt_pw {
457     my ($pw) = @_;
458
459     my $time = substr (Digest::SHA::sha1_base64 (time), 0, 8);
460     return crypt (encode("utf8", $pw), "\$5\$$time\$");
461 }
462
463 sub store_pam_password {
464     my ($userid, $password) = @_;
465
466     my $cmd = ['/usr/sbin/usermod'];
467
468     my $epw = encrypt_pw($password);
469     push @$cmd, '-p', $epw;
470
471     push @$cmd, $userid;
472
473     run_command($cmd);
474 }
475
476 sub domain_set_password {
477     my ($realm, $userid, $password) = @_;
478
479     die "no auth domain specified" if !$realm;
480
481     if ($realm eq 'pam') {
482         store_pam_password($userid, $password);
483     } elsif ($realm eq 'pve') {
484         store_shadow_password($userid, $password);
485     } else {
486         die "can't set password on auth domain '$realm'\n";
487     }
488 }
489
490 sub add_user_group {
491
492     my ($username, $usercfg, $group) = @_;
493     $usercfg->{users}->{$username}->{groups}->{$group} = 1;
494     $usercfg->{groups}->{$group}->{users}->{$username} = 1;
495 }
496
497 sub delete_user_group {
498
499     my ($username, $usercfg) = @_;
500     
501     foreach my $group (keys %{$usercfg->{groups}}) {
502
503         delete ($usercfg->{groups}->{$group}->{users}->{$username}) 
504             if $usercfg->{groups}->{$group}->{users}->{$username};
505     }
506 }
507
508 sub delete_user_acl {
509
510     my ($username, $usercfg) = @_;
511
512     foreach my $acl (keys %{$usercfg->{acl}}) {
513
514         delete ($usercfg->{acl}->{$acl}->{users}->{$username}) 
515             if $usercfg->{acl}->{$acl}->{users}->{$username};
516     }
517 }
518
519 sub delete_group_acl {
520
521     my ($group, $usercfg) = @_;
522
523     foreach my $acl (keys %{$usercfg->{acl}}) {
524
525         delete ($usercfg->{acl}->{$acl}->{groups}->{$group}) 
526             if $usercfg->{acl}->{$acl}->{groups}->{$group};
527     }
528 }
529
530 sub delete_pool_acl {
531
532     my ($pool, $usercfg) = @_;
533
534     my $path = "/pool/$pool";
535
536     foreach my $aclpath (keys %{$usercfg->{acl}}) {
537         delete ($usercfg->{acl}->{$aclpath})
538             if $usercfg->{acl}->{$aclpath} eq 'path';
539     }
540 }
541
542 # we automatically create some predefined roles by splitting privs
543 # into 3 groups (per category)
544 # root: only root is allowed to do that
545 # admin: an administrator can to that
546 # user: a normak user/customer can to that
547 my $privgroups = {
548     VM => {
549         root => [],
550         admin => [           
551             'VM.Modify', 
552             'VM.Allocate', 
553             'VM.Migrate',
554         ],
555         user => [
556             'VM.Console', 
557             'VM.PowerMgmt',
558         ],
559         audit => [ 
560             'VM.Audit',
561         ],
562     },
563     Sys => {
564         root => [
565             'Sys.PowerMgmt',     
566             'Sys.Modify', # edit/change node settings
567         ],
568         admin => [
569             'Permissions.Modify',
570             'Sys.Console',    
571             'Sys.Syslog',
572         ],
573         user => [],
574         audit => [
575             'Sys.Audit',
576         ],
577     },
578     Datastore => {
579         root => [],
580         admin => [
581             'Datastore.Allocate',
582         ],
583         user => [
584             'Datastore.AllocateSpace',
585         ],
586         audit => [
587             'Datastore.Audit',
588         ],
589     },
590     User => {
591         root => [
592             'Realm.Allocate',
593         ],
594         admin => [
595             'User.Modify',
596             'Group.Allocate', # edit/change group settings
597             'Realm.AllocateUser', 
598         ],
599         user => [],
600         audit => [],
601     },
602     Pool => {
603         root => [],
604         admin => [
605             'Pool.Allocate', # create/delete pools
606         ],
607         user => [],
608         audit => [],
609     },
610 };
611
612 my $valid_privs = {};
613
614 my $special_roles = {
615     'NoAccess' => {}, # no priviledges
616     'Administrator' => $valid_privs, # all priviledges
617 };
618
619 sub create_roles {
620
621     foreach my $cat (keys %$privgroups) {
622         my $cd = $privgroups->{$cat};
623         foreach my $p (@{$cd->{root}}, @{$cd->{admin}}, 
624                        @{$cd->{user}}, @{$cd->{audit}}) {
625             $valid_privs->{$p} = 1;
626         }
627         foreach my $p (@{$cd->{admin}}, @{$cd->{user}}, @{$cd->{audit}}) {
628
629             $special_roles->{"PVE${cat}Admin"}->{$p} = 1;
630             $special_roles->{"PVEAdmin"}->{$p} = 1;
631         }
632         if (scalar(@{$cd->{user}})) {
633             foreach my $p (@{$cd->{user}}, @{$cd->{audit}}) {
634                 $special_roles->{"PVE${cat}User"}->{$p} = 1;
635             }
636         }
637         foreach my $p (@{$cd->{audit}}) {
638             $special_roles->{"PVEAuditor"}->{$p} = 1;
639         }
640     }
641 };
642
643 create_roles();
644
645 my $valid_attributes = {
646     ad => {
647         server1 => '[\w\d]+(.[\w\d]+)*',
648         server2 => '[\w\d]+(.[\w\d]+)*',
649         domain => '\S+',
650         port => '\d+',
651         secure => '',
652         comment => '.*',
653     },
654     ldap => {
655         server1 => '[\w\d]+(.[\w\d]+)*',
656         server2 => '[\w\d]+(.[\w\d]+)*',
657         base_dn => '\w+=[\w\s]+(,\s*\w+=[\w\s]+)*',
658         user_attr => '\S{2,}',
659         secure => '',
660         port => '\d+',
661         comment => '.*',
662     }
663 };
664
665 sub add_role_privs {
666     my ($role, $usercfg, $privs) = @_;
667
668     return if !$privs;
669
670     die "role '$role' does not exist\n" if !$usercfg->{roles}->{$role};
671
672     foreach my $priv (split_list($privs)) {
673         if (defined ($valid_privs->{$priv})) {
674             $usercfg->{roles}->{$role}->{$priv} = 1;
675         } else {
676             die "invalid priviledge '$priv'\n";
677         } 
678     }   
679 }
680
681 sub normalize_path {
682     my $path = shift;
683
684     $path =~ s|/+|/|g;
685
686     $path =~ s|/$||;
687
688     $path = '/' if !$path;
689
690     $path = "/$path" if $path !~ m|^/|;
691
692     return undef if $path !~ m|^[[:alnum:]\-\_\/]+$|;
693
694     return $path;
695
696
697 my $realm_regex = qr/[A-Za-z][A-Za-z0-9\.\-_]+/;
698
699 sub pve_verify_realm {
700     my ($realm, $noerr) = @_;
701  
702     if ($realm !~ m/^${realm_regex}$/) {
703         return undef if $noerr;
704         die "value does not look like a valid realm\n"; 
705     }
706     return $realm;
707 }
708
709 PVE::JSONSchema::register_format('pve-userid', \&verify_username);
710 sub verify_username {
711     my ($username, $noerr) = @_;
712
713     $username = '' if !$username;
714     my $len = length($username);
715     if ($len < 3) {
716         die "user name '$username' is too short\n" if !$noerr;
717         return undef;
718     }
719     if ($len > 64) {
720         die "user name '$username' is too long ($len > 64)\n" if !$noerr;
721         return undef;
722     }
723
724     # we only allow a limited set of characters (colon is not allowed,
725     # because we store usernames in colon separated lists)!
726     if ($username =~ m/^([^\s:]+)\@(${realm_regex})$/) {
727         return wantarray ? ($username, $1, $2) : $username;
728     }
729
730     die "value '$username' does not look like a valid user name\n" if !$noerr;
731
732     return undef;
733 }
734 PVE::JSONSchema::register_standard_option('userid', {
735     description => "User ID",
736     type => 'string', format => 'pve-userid',
737     maxLength => 64,
738 });
739
740 PVE::JSONSchema::register_standard_option('realm', {
741     description => "Authentication domain ID",
742     type => 'string', format => 'pve-configid',
743     maxLength => 32,
744 });
745
746 PVE::JSONSchema::register_format('pve-groupid', \&verify_groupname);
747 sub verify_groupname {
748     my ($groupname, $noerr) = @_;
749
750     if ($groupname !~ m/^[A-Za-z0-9\.\-_]+$/) {
751
752         die "group name '$groupname' contains invalid characters\n" if !$noerr;
753
754         return undef;
755     }
756     
757     return $groupname;
758 }
759
760 PVE::JSONSchema::register_format('pve-roleid', \&verify_rolename);
761 sub verify_rolename {
762     my ($rolename, $noerr) = @_;
763
764     if ($rolename !~ m/^[A-Za-z0-9\.\-_]+$/) {
765
766         die "role name '$rolename' contains invalid characters\n" if !$noerr;
767
768         return undef;
769     }
770     
771     return $rolename;
772 }
773
774 PVE::JSONSchema::register_format('pve-poolid', \&verify_groupname);
775 sub verify_poolname {
776     my ($poolname, $noerr) = @_;
777
778     if ($poolname !~ m/^[A-Za-z0-9\.\-_]+$/) {
779
780         die "pool name '$poolname' contains invalid characters\n" if !$noerr;
781
782         return undef;
783     }
784     
785     return $poolname;
786 }
787
788 PVE::JSONSchema::register_format('pve-priv', \&verify_privname);
789 sub verify_privname {
790     my ($priv, $noerr) = @_;
791
792     if (!$valid_privs->{$priv}) {
793         die "invalid priviledge '$priv'\n" if !$noerr;
794
795         return undef;
796     }
797     
798     return $priv;
799 }
800
801 sub userconfig_force_defaults {
802     my ($cfg) = @_;
803
804     foreach my $r (keys %$special_roles) {
805         $cfg->{roles}->{$r} = $special_roles->{$r};
806     }
807
808     # fixme: remove 'root' group (not required)?
809
810     # add root user 
811     $cfg->{users}->{'root@pam'}->{enable} = 1;
812 }
813
814 sub parse_user_config {
815     my ($filename, $raw) = @_;
816
817     my $cfg = {};
818
819     userconfig_force_defaults($cfg);
820
821     while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
822         my $line = $1;
823
824         next if $line =~ m/^\s*$/; # skip empty lines
825
826         my @data;
827
828         foreach my $d (split (/:/, $line)) {
829             $d =~ s/^\s+//; 
830             $d =~ s/\s+$//;
831             push @data, $d
832         }
833
834         my $et = shift @data;
835
836         if ($et eq 'user') {
837             my ($user, $enable, $expire, $firstname, $lastname, $email, $comment) = @data;
838
839             my (undef, undef, $realm) = verify_username($user, 1);
840             if (!$realm) {
841                 warn "user config - ignore user '$user' - invalid user name\n";
842                 next;
843             }
844
845             $enable = $enable ? 1 : 0;
846
847             $expire = 0 if !$expire;
848
849             if ($expire !~ m/^\d+$/) {
850                 warn "user config - ignore user '$user' - (illegal characters in expire '$expire')\n";
851                 next;
852             }
853             $expire = int($expire);
854
855             #if (!verify_groupname ($group, 1)) {
856             #    warn "user config - ignore user '$user' - invalid characters in group name\n";
857             #    next;
858             #}
859
860             $cfg->{users}->{$user} = {
861                 enable => $enable,
862                 # group => $group,
863             };
864             $cfg->{users}->{$user}->{firstname} = PVE::Tools::decode_text($firstname) if $firstname;
865             $cfg->{users}->{$user}->{lastname} = PVE::Tools::decode_text($lastname) if $lastname;
866             $cfg->{users}->{$user}->{email} = $email;
867             $cfg->{users}->{$user}->{comment} = PVE::Tools::decode_text($comment) if $comment;
868             $cfg->{users}->{$user}->{expire} = $expire;
869
870             #$cfg->{users}->{$user}->{groups}->{$group} = 1;
871             #$cfg->{groups}->{$group}->{$user} = 1;
872
873         } elsif ($et eq 'group') {
874             my ($group, $userlist, $comment) = @data;
875
876             if (!verify_groupname($group, 1)) {
877                 warn "user config - ignore group '$group' - invalid characters in group name\n";
878                 next;
879             }
880
881             # make sure to add the group (even if there are no members)
882             $cfg->{groups}->{$group} = { users => {} } if !$cfg->{groups}->{$group};
883
884             $cfg->{groups}->{$group}->{comment} = PVE::Tools::decode_text($comment) if $comment;
885
886             foreach my $user (split_list($userlist)) {
887
888                 if (!verify_username($user, 1)) {
889                     warn "user config - ignore invalid group member '$user'\n";
890                     next;
891                 }
892
893                 if ($cfg->{users}->{$user}) { # user exists 
894                     $cfg->{users}->{$user}->{groups}->{$group} = 1;
895                     $cfg->{groups}->{$group}->{users}->{$user} = 1;
896                 } else {
897                     warn "user config - ignore invalid group member '$user'\n";
898                 }
899             }
900
901         } elsif ($et eq 'role') {
902             my ($role, $privlist) = @data;
903                 
904             if (!verify_rolename($role, 1)) {
905                 warn "user config - ignore role '$role' - invalid characters in role name\n";
906                 next;
907             }
908
909             # make sure to add the role (even if there are no privileges)
910             $cfg->{roles}->{$role} = {} if !$cfg->{roles}->{$role};
911
912             foreach my $priv (split_list($privlist)) {
913                 if (defined ($valid_privs->{$priv})) {
914                     $cfg->{roles}->{$role}->{$priv} = 1;
915                 } else {
916                     warn "user config - ignore invalid priviledge '$priv'\n";
917                 } 
918             }
919             
920         } elsif ($et eq 'acl') {
921             my ($propagate, $pathtxt, $uglist, $rolelist) = @data;
922
923             if (my $path = normalize_path($pathtxt)) {
924                 foreach my $role (split_list($rolelist)) {
925                         
926                     if (!verify_rolename($role, 1)) {
927                         warn "user config - ignore invalid role name '$role' in acl\n";
928                         next;
929                     }
930
931                     foreach my $ug (split_list($uglist)) {
932                         if ($ug =~ m/^@(\w+)$/) {
933                             my $group = $1;
934                             if ($cfg->{groups}->{$group}) { # group exists 
935                                 $cfg->{acl}->{$path}->{groups}->{$group}->{$role} = $propagate;
936                             } else {
937                                 warn "user config - ignore invalid acl group '$group'\n";
938                             }
939                         } elsif (verify_username($ug, 1)) {
940                             if ($cfg->{users}->{$ug}) { # user exists 
941                                 $cfg->{acl}->{$path}->{users}->{$ug}->{$role} = $propagate;
942                             } else {
943                                 warn "user config - ignore invalid acl member '$ug'\n";
944                             }
945                         } else {
946                             warn "user config - invalid user/group '$ug' in acl\n";
947                         }
948                     }
949                 }
950             } else {
951                 warn "user config - ignore invalid path in acl '$pathtxt'\n";
952             }
953         } elsif ($et eq 'pool') {
954             my ($pool, $comment, $vmlist, $storelist) = @data;
955
956             if (!verify_poolname($pool, 1)) {
957                 warn "user config - ignore pool '$pool' - invalid characters in pool name\n";
958                 next;
959             }
960
961             # make sure to add the pool (even if there are no members)
962             $cfg->{pools}->{$pool} = { vms => {}, storage => {} } if !$cfg->{pools}->{$pool};
963
964             $cfg->{pools}->{$pool}->{comment} = PVE::Tools::decode_text($comment) if $comment;
965
966             foreach my $vmid (split_list($vmlist)) {
967                 if ($vmid !~ m/^\d+$/) {
968                     warn "user config - ignore invalid vmid '$vmid' in pool '$pool'\n";
969                     next;
970                 }
971                 $vmid = int($vmid);
972
973                 if ($cfg->{vms}->{$vmid}) {
974                     warn "user config - ignore duplicate vmid '$vmid' in pool '$pool'\n";
975                     next;
976                 }
977
978                 $cfg->{pools}->{$pool}->{vms}->{$vmid} = 1;
979                     
980                 # record vmid ==> pool relation
981                 $cfg->{vms}->{$vmid} = $pool;
982             }
983
984             foreach my $storeid (split_list($storelist)) {
985                 if ($storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
986                     warn "user config - ignore invalid storage '$storeid' in pool '$pool'\n";
987                     next;
988                 }
989                 $cfg->{pools}->{$pool}->{storage}->{$storeid} = 1;
990             }
991         } else {
992             warn "user config - ignore config line: $line\n";
993         }
994     }
995
996     userconfig_force_defaults($cfg);
997
998     return $cfg;
999 }
1000
1001 sub parse_shadow_passwd {
1002     my ($filename, $raw) = @_;
1003
1004     my $shadow = {};
1005
1006     while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
1007         my $line = $1;
1008
1009         next if $line =~ m/^\s*$/; # skip empty lines
1010
1011         if ($line !~ m/^\S+:\S+:$/) {
1012             warn "pve shadow password: ignore invalid line $.\n";
1013             next;
1014         }
1015
1016         my ($userid, $crypt_pass) = split (/:/, $line);
1017         $shadow->{users}->{$userid}->{shadow} = $crypt_pass;
1018     }
1019
1020     return $shadow;
1021 }
1022
1023 sub write_domains {
1024     my ($filename, $cfg) = @_;
1025
1026     my $data = '';
1027
1028     my $wrote_default;
1029
1030     foreach my $realm (sort keys %$cfg) {
1031         my $entry = $cfg->{$realm};
1032         my $type = lc($entry->{type});
1033
1034         next if !$type;
1035
1036         next if ($type eq 'pam') || ($type eq 'pve');
1037
1038         my $formats = $valid_attributes->{$type};
1039         next if !$formats;
1040
1041         $data .= "$type: $realm\n";
1042
1043         foreach my $k (sort keys %$entry) {
1044             next if $k eq 'type';
1045             my $v = $entry->{$k};
1046             if ($k eq 'default') {
1047                     $data .= "\t$k\n" if $v && !$wrote_default;
1048                     $wrote_default = 1;
1049             } elsif (defined($formats->{$k})) {
1050                 if (!$formats->{$k}) {
1051                     $data .= "\t$k\n" if $v;
1052                 } elsif ($v =~ m/^$formats->{$k}$/) {
1053                     $v = PVE::Tools::encode_text($v) if $k eq 'comment';
1054                     $data .= "\t$k $v\n";
1055                 } else {
1056                     die "invalid value '$v' for attribute '$k'\n";
1057                 }
1058             } else {
1059                 die "invalid attribute '$k' - not supported\n";
1060             }
1061         }
1062
1063         $data .= "\n";
1064     }
1065
1066     return $data;
1067 }
1068
1069 sub parse_domains {
1070     my ($filename, $raw) = @_;
1071
1072     my $cfg = {};
1073
1074     my $default;
1075
1076     while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
1077         my $line = $1;
1078  
1079         next if $line =~ m/^\#/; # skip comment lines
1080         next if $line =~ m/^\s*$/; # skip empty lines
1081
1082         if ($line =~ m/^(\S+):\s*(\S+)\s*$/) {
1083             my $realm = $2;
1084             my $type = lc($1);
1085
1086             my $ignore = 0;
1087             my $entry;
1088
1089             my $formats = $valid_attributes->{$type};
1090             if (!$formats) {
1091                 $ignore = 1;
1092                 warn "ignoring domain '$realm' - (unsupported authentication type '$type')\n";
1093             } elsif (!pve_verify_realm($realm, 1)) {
1094                 $ignore = 1;
1095                 warn "ignoring domain '$realm' - (illegal characters)\n";
1096             } else {
1097                 $entry = { type => $type };
1098             }
1099
1100             while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
1101                 $line = $1;
1102
1103                 next if $line =~ m/^\#/; #skip comment lines
1104                 last if $line =~ m/^\s*$/;
1105                     
1106                 next if $ignore; # skip
1107
1108                 if ($line =~ m/^\s+(default)\s*$/) {
1109                     $default = $realm if !$default;
1110                 } elsif ($line =~ m/^\s+(\S+)(\s+(.*\S))?\s*$/) {
1111                     my ($k, $v) = (lc($1), $3);
1112                     if (defined($formats->{$k})) {
1113                         if (!$formats->{$k} && !defined($v)) {
1114                                 $entry->{$k} = 1;                           
1115                         } elsif ($formats->{$k} && $v =~ m/^$formats->{$k}$/) {
1116                             if (!defined($entry->{$k})) {
1117                                 $v = PVE::Tools::decode_text($v) if $k eq 'comment';
1118                                 $entry->{$k} = $v;
1119                             } else {
1120                                 warn "ignoring duplicate attribute '$k $v'\n";
1121                             }
1122                         } else {
1123                             warn "ignoring value '$v' for attribute '$k' - invalid format\n";
1124                         }
1125                     } else {
1126                         warn "ignoring attribute '$k' - not supported\n";
1127                     }
1128                 } else {
1129                     warn "ignore config line: $line\n";
1130                 }
1131             }
1132
1133             if ($entry->{server2} && !$entry->{server1}) {
1134                 $entry->{server1} = $entry->{server2};
1135                 delete $entry->{server2};
1136             }
1137
1138             if ($ignore) {
1139                 # do nothing
1140             } elsif (!$entry->{server1}) {
1141                 warn "ignoring domain '$realm' - missing server attribute\n";
1142             } elsif (($entry->{type} eq "ldap") && !$entry->{user_attr}) {
1143                 warn "ignoring domain '$realm' - missing user attribute\n";
1144             } elsif (($entry->{type} eq "ldap") && !$entry->{base_dn}) {
1145                 warn "ignoring domain '$realm' - missing base_dn attribute\n";
1146             } elsif (($entry->{type} eq "ad") && !$entry->{domain}) {
1147                 warn "ignoring domain '$realm' - missing domain attribute\n";
1148             } else {
1149                 $cfg->{$realm} = $entry;
1150             }
1151      
1152         } else {
1153             warn "ignore config line: $line\n";
1154         }
1155     }
1156
1157     $cfg->{$default}->{default} = 1 if $default;
1158
1159     # add default domains
1160
1161     $cfg->{pve} = {
1162         type => 'builtin',
1163         comment => "Proxmox VE authentication server", 
1164     };
1165
1166     $cfg->{pam} = {
1167         type => 'builtin',
1168         comment => "Linux PAM standard authentication", 
1169     };
1170         
1171     return $cfg;
1172 }
1173
1174 sub write_shadow_config {
1175     my ($filename, $cfg) = @_;
1176
1177     my $data = '';
1178     foreach my $userid (keys %{$cfg->{users}}) {
1179         my $crypt_pass = $cfg->{users}->{$userid}->{shadow};
1180         $data .= "$userid:$crypt_pass:\n";
1181     }
1182
1183     return $data
1184 }
1185
1186 sub write_user_config {
1187     my ($filename, $cfg) = @_;
1188
1189     my $data = '';
1190
1191     foreach my $user (keys %{$cfg->{users}}) {
1192         my $d = $cfg->{users}->{$user};
1193         my $firstname = $d->{firstname} ? PVE::Tools::encode_text($d->{firstname}) : '';
1194         my $lastname = $d->{lastname} ? PVE::Tools::encode_text($d->{lastname}) : '';
1195         my $email = $d->{email} || '';
1196         my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : '';
1197         my $expire = int($d->{expire} || 0);
1198         my $enable = $d->{enable} ? 1 : 0;
1199         $data .= "user:$user:$enable:$expire:$firstname:$lastname:$email:$comment:\n";
1200     }
1201
1202     $data .= "\n";
1203
1204     foreach my $group (keys %{$cfg->{groups}}) {
1205         my $d = $cfg->{groups}->{$group};
1206         my $list = join (',', keys %{$d->{users}});
1207         my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : '';      
1208         $data .= "group:$group:$list:$comment:\n";
1209     }
1210
1211     $data .= "\n";
1212
1213     foreach my $pool (keys %{$cfg->{pools}}) {
1214         my $d = $cfg->{pools}->{$pool};
1215         my $vmlist = join (',', keys %{$d->{vms}});
1216         my $storelist = join (',', keys %{$d->{storage}});
1217         my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : '';      
1218         $data .= "pool:$pool:$comment:$vmlist:$storelist:\n";
1219     }
1220
1221     $data .= "\n";
1222
1223     foreach my $role (keys %{$cfg->{roles}}) {
1224         next if $special_roles->{$role};
1225
1226         my $d = $cfg->{roles}->{$role};
1227         my $list = join (',', keys %$d);
1228         $data .= "role:$role:$list:\n";
1229     }
1230
1231     $data .= "\n";
1232
1233     foreach my $path (sort keys %{$cfg->{acl}}) {
1234         my $d = $cfg->{acl}->{$path};
1235
1236         my $ra = {};
1237
1238         foreach my $group (keys %{$d->{groups}}) {
1239             my $l0 = '';
1240             my $l1 = '';
1241             foreach my $role (sort keys %{$d->{groups}->{$group}}) {
1242                 my $propagate = $d->{groups}->{$group}->{$role};
1243                 if ($propagate) {
1244                     $l1 .= ',' if $l1;
1245                     $l1 .= $role;
1246                 } else {
1247                     $l0 .= ',' if $l0;
1248                     $l0 .= $role;
1249                 }
1250             }
1251             $ra->{0}->{$l0}->{"\@$group"} = 1 if $l0;
1252             $ra->{1}->{$l1}->{"\@$group"} = 1 if $l1;
1253         }
1254
1255         foreach my $user (keys %{$d->{users}}) {
1256             # no need to save, because root is always 'Administartor'
1257             next if $user eq 'root@pam'; 
1258
1259             my $l0 = '';
1260             my $l1 = '';
1261             foreach my $role (sort keys %{$d->{users}->{$user}}) {
1262                 my $propagate = $d->{users}->{$user}->{$role};
1263                 if ($propagate) {
1264                     $l1 .= ',' if $l1;
1265                     $l1 .= $role;
1266                 } else {
1267                     $l0 .= ',' if $l0;
1268                     $l0 .= $role;
1269                 }
1270             }
1271             $ra->{0}->{$l0}->{$user} = 1 if $l0;
1272             $ra->{1}->{$l1}->{$user} = 1 if $l1;
1273         }
1274
1275         foreach my $rolelist (sort keys %{$ra->{0}}) {
1276             my $uglist = join (',', keys %{$ra->{0}->{$rolelist}});
1277             $data .= "acl:0:$path:$uglist:$rolelist:\n";
1278         }
1279         foreach my $rolelist (sort keys %{$ra->{1}}) {
1280             my $uglist = join (',', keys %{$ra->{1}->{$rolelist}});
1281             $data .= "acl:1:$path:$uglist:$rolelist:\n";
1282         }
1283     }
1284
1285     return $data;
1286 }
1287
1288 sub roles {
1289     my ($cfg, $user, $path) = @_;
1290
1291     # NOTE: we do not consider pools here. 
1292     # You need to use $rpcenv->roles() instead if you want that.
1293
1294     return 'Administrator' if $user eq 'root@pam'; # root can do anything
1295
1296     my $perm = {};
1297
1298     foreach my $p (sort keys %{$cfg->{acl}}) {
1299         my $final = ($path eq $p);
1300
1301         next if !(($p eq '/') || $final || ($path =~ m|^$p/|));
1302
1303         my $acl = $cfg->{acl}->{$p};
1304
1305         #print "CHECKACL $path $p\n";
1306         #print "ACL $path = " . Dumper ($acl);
1307
1308         if (my $ri = $acl->{users}->{$user}) {
1309             my $new;
1310             foreach my $role (keys %$ri) {
1311                 my $propagate = $ri->{$role};
1312                 if ($final || $propagate) {
1313                     #print "APPLY ROLE $p $user $role\n";
1314                     $new = {} if !$new;
1315                     $new->{$role} = 1;
1316                 }
1317             }
1318             if ($new) {
1319                 $perm = $new; # overwrite previous settings
1320                 next; # user privs always override group privs
1321             }
1322         }
1323
1324         my $new;
1325         foreach my $g (keys %{$acl->{groups}}) {
1326             next if !$cfg->{groups}->{$g}->{users}->{$user};
1327             if (my $ri = $acl->{groups}->{$g}) {
1328                 foreach my $role (keys %$ri) {
1329                     my $propagate = $ri->{$role};
1330                     if ($final || $propagate) {
1331                         #print "APPLY ROLE $p \@$g $role\n";
1332                         $new = {} if !$new;
1333                         $new->{$role} = 1;
1334                     }
1335                 }
1336             }
1337         }
1338         if ($new) {
1339             $perm = $new; # overwrite previous settings
1340             next;
1341         }
1342     }
1343
1344     return ('NoAccess') if defined ($perm->{NoAccess});
1345     #return () if defined ($perm->{NoAccess});
1346    
1347     #print "permission $user $path = " . Dumper ($perm);
1348
1349     my @ra = keys %$perm;
1350
1351     #print "roles $user $path = " . join (',', @ra) . "\n";
1352
1353     return @ra;
1354 }
1355     
1356 sub permission {
1357     my ($cfg, $user, $path) = @_;
1358
1359     $user = verify_username($user, 1);
1360     return {} if !$user;
1361
1362     my @ra = roles($cfg, $user, $path);
1363     
1364     my $privs = {};
1365
1366     foreach my $role (@ra) {
1367         if (my $privset = $cfg->{roles}->{$role}) {
1368             foreach my $p (keys %$privset) {
1369                 $privs->{$p} = 1;
1370             }
1371         }
1372     }
1373
1374     #print "priviledges $user $path = " . Dumper ($privs);
1375
1376     return $privs;
1377 }
1378
1379 sub check_permissions {
1380     my ($username, $path, $privlist) = @_;
1381
1382     $path = normalize_path($path);
1383     my $usercfg = cfs_read_file('user.cfg');
1384     my $perm = permission($usercfg, $username, $path);
1385
1386     foreach my $priv (split_list($privlist)) {
1387         return undef if !$perm->{$priv};
1388     };
1389
1390     return 1;
1391 }
1392
1393 1;