moved Pool.pm to pve-manager package
[pve-access-control.git] / PVE / AccessControl.pm
CommitLineData
2c3a6c0a
DM
1package PVE::AccessControl;
2
3use strict;
4use Encode;
5use Crypt::OpenSSL::Random;
6use Crypt::OpenSSL::RSA;
7use MIME::Base64;
8use Digest::SHA;
9use Authen::PAM qw(:constants);
10use Net::LDAP;
11use PVE::Tools qw(run_command lock_file file_get_contents split_list safe_print);
12use PVE::Cluster qw(cfs_register_file cfs_read_file cfs_write_file cfs_lock_file);
13use PVE::JSONSchema;
14use Encode;
15
16use Data::Dumper; # fixme: remove
17
18# $authdir must be writable by root only!
19my $confdir = "/etc/pve";
20my $authdir = "$confdir/priv";
21my $authprivkeyfn = "$authdir/authkey.key";
22my $authpubkeyfn = "$confdir/authkey.pub";
23my $shadowconfigfile = "priv/shadow.cfg";
24my $domainconfigfile = "domains.cfg";
25my $pve_www_key_fn = "$confdir/pve-www.key";
26
27my $ticket_lifetime = 3600*2; # 2 hours
28
29Crypt::OpenSSL::RSA->import_random_seed();
30
31cfs_register_file('user.cfg',
32 \&parse_user_config,
33 \&write_user_config);
34
35cfs_register_file($shadowconfigfile,
36 \&parse_shadow_passwd,
37 \&write_shadow_config);
38
39cfs_register_file($domainconfigfile,
40 \&parse_domains,
41 \&write_domains);
42
43
44sub 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
54sub 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
64sub 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
74my $pve_auth_pub_key;
75sub 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
86my $csrf_prevention_secret;
87my $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
95sub 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
105sub 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
124my $pve_auth_priv_key;
125sub 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
136sub 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
150sub verify_ticket {
151 my ($ticket, $noerr) = @_;
152
adf8d771 153 if ($ticket && $ticket =~ m/^(PVE:\S+)::([^:\s]+)$/) {
2c3a6c0a
DM
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
adf8d771
DM
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')
181sub 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
199sub 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
2c3a6c0a
DM
228sub 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
243sub 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
281sub 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
305sub 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
333sub 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
37d45deb 376sub check_user_exist {
7070c1ae 377 my ($usercfg, $username, $noerr) = @_;
2c3a6c0a 378
7070c1ae 379 $username = verify_username($username, $noerr);
2c3a6c0a
DM
380 return undef if !$username;
381
37d45deb
DM
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
389sub 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};
2c3a6c0a
DM
396
397 return 1 if $username eq 'root@pam'; # root is always enabled
398
37d45deb 399 die "user '$username' is disabled\n" if !$noerr;
7070c1ae
DM
400
401 return undef;
2c3a6c0a
DM
402}
403
404# password should be utf8 encoded
405sub 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
7070c1ae
DM
416 eval { check_user_enabled($usercfg, $username); };
417 if (my $err = $@) {
2c3a6c0a 418 sleep(2);
7070c1ae 419 die $err;
2c3a6c0a
DM
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
435sub 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
446sub 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
456sub 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
463sub 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
476sub 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
490sub 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
497sub 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
508sub 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 }
2c3a6c0a 517}
39c85db8 518
2c3a6c0a
DM
519sub 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 }
39c85db8
DM
528}
529
530sub delete_pool_acl {
531
532 my ($pool, $usercfg) = @_;
2c3a6c0a 533
39c85db8
DM
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 }
2c3a6c0a
DM
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
547my $privgroups = {
548 VM => {
549 root => [],
550 admin => [
551 'VM.Modify',
552 'VM.Allocate',
553 'VM.Migrate',
2c3a6c0a
DM
554 ],
555 user => [
556 'VM.Console',
557 'VM.PowerMgmt',
558 ],
559 audit => [
82b63965 560 'VM.Audit',
2c3a6c0a
DM
561 ],
562 },
563 Sys => {
564 root => [
565 'Sys.PowerMgmt',
37d45deb 566 'Sys.Modify', # edit/change node settings
2c3a6c0a
DM
567 ],
568 admin => [
2e376c58 569 'Permissions.Modify',
2c3a6c0a
DM
570 'Sys.Console',
571 'Sys.Syslog',
572 ],
573 user => [],
574 audit => [
575 'Sys.Audit',
576 ],
577 },
578 Datastore => {
2e376c58 579 root => [],
19f60b5e
DM
580 admin => [
581 'Datastore.Allocate',
582 ],
2c3a6c0a
DM
583 user => [
584 'Datastore.AllocateSpace',
585 ],
586 audit => [
587 'Datastore.Audit',
588 ],
589 },
12683df7 590 User => {
82b63965
DM
591 root => [
592 'Realm.Allocate',
593 ],
12683df7
DM
594 admin => [
595 'User.Modify',
82b63965
DM
596 'Group.Allocate', # edit/change group settings
597 'Realm.AllocateUser',
19f60b5e 598 ],
12683df7
DM
599 user => [],
600 audit => [],
601 },
2c3a6c0a
DM
602};
603
604my $valid_privs = {};
605
606my $special_roles = {
607 'NoAccess' => {}, # no priviledges
608 'Administrator' => $valid_privs, # all priviledges
609};
610
611sub create_roles {
612
613 foreach my $cat (keys %$privgroups) {
614 my $cd = $privgroups->{$cat};
615 foreach my $p (@{$cd->{root}}, @{$cd->{admin}},
616 @{$cd->{user}}, @{$cd->{audit}}) {
617 $valid_privs->{$p} = 1;
618 }
619 foreach my $p (@{$cd->{admin}}, @{$cd->{user}}, @{$cd->{audit}}) {
620
621 $special_roles->{"PVE${cat}Admin"}->{$p} = 1;
622 $special_roles->{"PVEAdmin"}->{$p} = 1;
623 }
624 if (scalar(@{$cd->{user}})) {
625 foreach my $p (@{$cd->{user}}, @{$cd->{audit}}) {
626 $special_roles->{"PVE${cat}User"}->{$p} = 1;
627 }
628 }
629 foreach my $p (@{$cd->{audit}}) {
630 $special_roles->{"PVEAuditor"}->{$p} = 1;
631 }
632 }
633};
634
635create_roles();
636
637my $valid_attributes = {
638 ad => {
639 server1 => '[\w\d]+(.[\w\d]+)*',
640 server2 => '[\w\d]+(.[\w\d]+)*',
641 domain => '\S+',
af4a8a85 642 port => '\d+',
2c3a6c0a
DM
643 secure => '',
644 comment => '.*',
645 },
646 ldap => {
647 server1 => '[\w\d]+(.[\w\d]+)*',
648 server2 => '[\w\d]+(.[\w\d]+)*',
649 base_dn => '\w+=[\w\s]+(,\s*\w+=[\w\s]+)*',
650 user_attr => '\S{2,}',
651 secure => '',
af4a8a85 652 port => '\d+',
2c3a6c0a
DM
653 comment => '.*',
654 }
655};
656
657sub add_role_privs {
658 my ($role, $usercfg, $privs) = @_;
659
660 return if !$privs;
661
662 die "role '$role' does not exist\n" if !$usercfg->{roles}->{$role};
663
664 foreach my $priv (split_list($privs)) {
665 if (defined ($valid_privs->{$priv})) {
666 $usercfg->{roles}->{$role}->{$priv} = 1;
667 } else {
668 die "invalid priviledge '$priv'\n";
669 }
670 }
671}
672
673sub normalize_path {
674 my $path = shift;
675
4bc17477 676 $path =~ s|/+|/|g;
2c3a6c0a
DM
677
678 $path =~ s|/$||;
679
680 $path = '/' if !$path;
681
4bc17477
DM
682 $path = "/$path" if $path !~ m|^/|;
683
2c3a6c0a
DM
684 return undef if $path !~ m|^[[:alnum:]\-\_\/]+$|;
685
686 return $path;
687}
688
689my $realm_regex = qr/[A-Za-z][A-Za-z0-9\.\-_]+/;
690
691sub pve_verify_realm {
692 my ($realm, $noerr) = @_;
693
694 if ($realm !~ m/^${realm_regex}$/) {
695 return undef if $noerr;
696 die "value does not look like a valid realm\n";
697 }
698 return $realm;
699}
700
701PVE::JSONSchema::register_format('pve-userid', \&verify_username);
702sub verify_username {
703 my ($username, $noerr) = @_;
704
705 $username = '' if !$username;
706 my $len = length($username);
707 if ($len < 3) {
708 die "user name '$username' is too short\n" if !$noerr;
709 return undef;
710 }
711 if ($len > 64) {
712 die "user name '$username' is too long ($len > 64)\n" if !$noerr;
713 return undef;
714 }
715
716 # we only allow a limited set of characters (colon is not allowed,
717 # because we store usernames in colon separated lists)!
718 if ($username =~ m/^([^\s:]+)\@(${realm_regex})$/) {
719 return wantarray ? ($username, $1, $2) : $username;
720 }
721
722 die "value '$username' does not look like a valid user name\n" if !$noerr;
723
724 return undef;
725}
726PVE::JSONSchema::register_standard_option('userid', {
727 description => "User ID",
728 type => 'string', format => 'pve-userid',
729 maxLength => 64,
730});
731
732PVE::JSONSchema::register_standard_option('realm', {
733 description => "Authentication domain ID",
734 type => 'string', format => 'pve-configid',
735 maxLength => 32,
736});
737
738PVE::JSONSchema::register_format('pve-groupid', \&verify_groupname);
739sub verify_groupname {
740 my ($groupname, $noerr) = @_;
741
742 if ($groupname !~ m/^[A-Za-z0-9\.\-_]+$/) {
743
744 die "group name '$groupname' contains invalid characters\n" if !$noerr;
745
746 return undef;
747 }
748
749 return $groupname;
750}
751
752PVE::JSONSchema::register_format('pve-roleid', \&verify_rolename);
753sub verify_rolename {
754 my ($rolename, $noerr) = @_;
755
756 if ($rolename !~ m/^[A-Za-z0-9\.\-_]+$/) {
757
758 die "role name '$rolename' contains invalid characters\n" if !$noerr;
759
760 return undef;
761 }
762
763 return $rolename;
764}
765
39c85db8
DM
766PVE::JSONSchema::register_format('pve-poolid', \&verify_groupname);
767sub verify_poolname {
768 my ($poolname, $noerr) = @_;
769
770 if ($poolname !~ m/^[A-Za-z0-9\.\-_]+$/) {
771
772 die "pool name '$poolname' contains invalid characters\n" if !$noerr;
773
774 return undef;
775 }
776
777 return $poolname;
778}
779
2c3a6c0a
DM
780PVE::JSONSchema::register_format('pve-priv', \&verify_privname);
781sub verify_privname {
782 my ($priv, $noerr) = @_;
783
784 if (!$valid_privs->{$priv}) {
785 die "invalid priviledge '$priv'\n" if !$noerr;
786
787 return undef;
788 }
789
790 return $priv;
791}
792
793sub userconfig_force_defaults {
794 my ($cfg) = @_;
795
796 foreach my $r (keys %$special_roles) {
797 $cfg->{roles}->{$r} = $special_roles->{$r};
798 }
799
800 # fixme: remove 'root' group (not required)?
801
802 # add root user
803 $cfg->{users}->{'root@pam'}->{enable} = 1;
804}
805
806sub parse_user_config {
807 my ($filename, $raw) = @_;
808
809 my $cfg = {};
810
811 userconfig_force_defaults($cfg);
812
813 while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
814 my $line = $1;
815
816 next if $line =~ m/^\s*$/; # skip empty lines
817
818 my @data;
819
820 foreach my $d (split (/:/, $line)) {
821 $d =~ s/^\s+//;
822 $d =~ s/\s+$//;
823 push @data, $d
824 }
825
826 my $et = shift @data;
827
828 if ($et eq 'user') {
829 my ($user, $enable, $expire, $firstname, $lastname, $email, $comment) = @data;
830
831 my (undef, undef, $realm) = verify_username($user, 1);
832 if (!$realm) {
833 warn "user config - ignore user '$user' - invalid user name\n";
834 next;
835 }
836
837 $enable = $enable ? 1 : 0;
838
839 $expire = 0 if !$expire;
840
841 if ($expire !~ m/^\d+$/) {
842 warn "user config - ignore user '$user' - (illegal characters in expire '$expire')\n";
843 next;
844 }
845 $expire = int($expire);
846
847 #if (!verify_groupname ($group, 1)) {
848 # warn "user config - ignore user '$user' - invalid characters in group name\n";
849 # next;
850 #}
851
852 $cfg->{users}->{$user} = {
853 enable => $enable,
854 # group => $group,
855 };
856 $cfg->{users}->{$user}->{firstname} = PVE::Tools::decode_text($firstname) if $firstname;
857 $cfg->{users}->{$user}->{lastname} = PVE::Tools::decode_text($lastname) if $lastname;
858 $cfg->{users}->{$user}->{email} = $email;
859 $cfg->{users}->{$user}->{comment} = PVE::Tools::decode_text($comment) if $comment;
860 $cfg->{users}->{$user}->{expire} = $expire;
861
862 #$cfg->{users}->{$user}->{groups}->{$group} = 1;
863 #$cfg->{groups}->{$group}->{$user} = 1;
864
865 } elsif ($et eq 'group') {
866 my ($group, $userlist, $comment) = @data;
867
868 if (!verify_groupname($group, 1)) {
869 warn "user config - ignore group '$group' - invalid characters in group name\n";
870 next;
871 }
872
873 # make sure to add the group (even if there are no members)
874 $cfg->{groups}->{$group} = { users => {} } if !$cfg->{groups}->{$group};
875
876 $cfg->{groups}->{$group}->{comment} = PVE::Tools::decode_text($comment) if $comment;
877
878 foreach my $user (split_list($userlist)) {
879
880 if (!verify_username($user, 1)) {
881 warn "user config - ignore invalid group member '$user'\n";
882 next;
883 }
884
885 if ($cfg->{users}->{$user}) { # user exists
886 $cfg->{users}->{$user}->{groups}->{$group} = 1;
887 $cfg->{groups}->{$group}->{users}->{$user} = 1;
888 } else {
889 warn "user config - ignore invalid group member '$user'\n";
890 }
891 }
892
893 } elsif ($et eq 'role') {
894 my ($role, $privlist) = @data;
895
896 if (!verify_rolename($role, 1)) {
897 warn "user config - ignore role '$role' - invalid characters in role name\n";
898 next;
899 }
900
901 # make sure to add the role (even if there are no privileges)
902 $cfg->{roles}->{$role} = {} if !$cfg->{roles}->{$role};
903
904 foreach my $priv (split_list($privlist)) {
905 if (defined ($valid_privs->{$priv})) {
906 $cfg->{roles}->{$role}->{$priv} = 1;
907 } else {
908 warn "user config - ignore invalid priviledge '$priv'\n";
909 }
910 }
911
912 } elsif ($et eq 'acl') {
913 my ($propagate, $pathtxt, $uglist, $rolelist) = @data;
914
915 if (my $path = normalize_path($pathtxt)) {
916 foreach my $role (split_list($rolelist)) {
917
918 if (!verify_rolename($role, 1)) {
919 warn "user config - ignore invalid role name '$role' in acl\n";
920 next;
921 }
922
923 foreach my $ug (split_list($uglist)) {
924 if ($ug =~ m/^@(\w+)$/) {
925 my $group = $1;
926 if ($cfg->{groups}->{$group}) { # group exists
927 $cfg->{acl}->{$path}->{groups}->{$group}->{$role} = $propagate;
928 } else {
929 warn "user config - ignore invalid acl group '$group'\n";
930 }
931 } elsif (verify_username($ug, 1)) {
932 if ($cfg->{users}->{$ug}) { # user exists
933 $cfg->{acl}->{$path}->{users}->{$ug}->{$role} = $propagate;
934 } else {
935 warn "user config - ignore invalid acl member '$ug'\n";
936 }
937 } else {
938 warn "user config - invalid user/group '$ug' in acl\n";
939 }
940 }
941 }
942 } else {
943 warn "user config - ignore invalid path in acl '$pathtxt'\n";
944 }
4bc17477 945 } elsif ($et eq 'pool') {
39c85db8 946 my ($pool, $comment, $vmlist, $storelist) = @data;
4bc17477 947
39c85db8
DM
948 if (!verify_poolname($pool, 1)) {
949 warn "user config - ignore pool '$pool' - invalid characters in pool name\n";
950 next;
951 }
4bc17477 952
39c85db8
DM
953 # make sure to add the pool (even if there are no members)
954 $cfg->{pools}->{$pool} = { vms => {}, storage => {} } if !$cfg->{pools}->{$pool};
4bc17477 955
39c85db8 956 $cfg->{pools}->{$pool}->{comment} = PVE::Tools::decode_text($comment) if $comment;
4bc17477 957
39c85db8
DM
958 foreach my $vmid (split_list($vmlist)) {
959 if ($vmid !~ m/^\d+$/) {
960 warn "user config - ignore invalid vmid '$vmid' in pool '$pool'\n";
961 next;
4bc17477 962 }
39c85db8 963 $vmid = int($vmid);
4bc17477 964
39c85db8
DM
965 if ($cfg->{vms}->{$vmid}) {
966 warn "user config - ignore duplicate vmid '$vmid' in pool '$pool'\n";
967 next;
4bc17477
DM
968 }
969
39c85db8
DM
970 $cfg->{pools}->{$pool}->{vms}->{$vmid} = 1;
971
972 # record vmid ==> pool relation
973 $cfg->{vms}->{$vmid} = $pool;
974 }
975
976 foreach my $storeid (split_list($storelist)) {
977 if ($storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
978 warn "user config - ignore invalid storage '$storeid' in pool '$pool'\n";
979 next;
980 }
981 $cfg->{pools}->{$pool}->{storage}->{$storeid} = 1;
4bc17477 982 }
2c3a6c0a
DM
983 } else {
984 warn "user config - ignore config line: $line\n";
985 }
986 }
987
988 userconfig_force_defaults($cfg);
989
990 return $cfg;
991}
992
993sub parse_shadow_passwd {
994 my ($filename, $raw) = @_;
995
996 my $shadow = {};
997
998 while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
999 my $line = $1;
1000
1001 next if $line =~ m/^\s*$/; # skip empty lines
1002
1003 if ($line !~ m/^\S+:\S+:$/) {
1004 warn "pve shadow password: ignore invalid line $.\n";
1005 next;
1006 }
1007
1008 my ($userid, $crypt_pass) = split (/:/, $line);
1009 $shadow->{users}->{$userid}->{shadow} = $crypt_pass;
1010 }
1011
1012 return $shadow;
1013}
1014
1015sub write_domains {
1016 my ($filename, $cfg) = @_;
1017
1018 my $data = '';
1019
1020 my $wrote_default;
1021
1022 foreach my $realm (sort keys %$cfg) {
1023 my $entry = $cfg->{$realm};
1024 my $type = lc($entry->{type});
1025
1026 next if !$type;
1027
1028 next if ($type eq 'pam') || ($type eq 'pve');
1029
1030 my $formats = $valid_attributes->{$type};
1031 next if !$formats;
1032
1033 $data .= "$type: $realm\n";
1034
1035 foreach my $k (sort keys %$entry) {
1036 next if $k eq 'type';
1037 my $v = $entry->{$k};
1038 if ($k eq 'default') {
1039 $data .= "\t$k\n" if $v && !$wrote_default;
1040 $wrote_default = 1;
1041 } elsif (defined($formats->{$k})) {
1042 if (!$formats->{$k}) {
0c156363 1043 $data .= "\t$k\n" if $v;
2c3a6c0a
DM
1044 } elsif ($v =~ m/^$formats->{$k}$/) {
1045 $v = PVE::Tools::encode_text($v) if $k eq 'comment';
1046 $data .= "\t$k $v\n";
1047 } else {
1048 die "invalid value '$v' for attribute '$k'\n";
1049 }
1050 } else {
1051 die "invalid attribute '$k' - not supported\n";
1052 }
1053 }
1054
1055 $data .= "\n";
1056 }
1057
1058 return $data;
1059}
1060
1061sub parse_domains {
1062 my ($filename, $raw) = @_;
1063
1064 my $cfg = {};
1065
1066 my $default;
1067
1068 while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
1069 my $line = $1;
1070
1071 next if $line =~ m/^\#/; # skip comment lines
1072 next if $line =~ m/^\s*$/; # skip empty lines
1073
1074 if ($line =~ m/^(\S+):\s*(\S+)\s*$/) {
1075 my $realm = $2;
1076 my $type = lc($1);
1077
1078 my $ignore = 0;
1079 my $entry;
1080
1081 my $formats = $valid_attributes->{$type};
1082 if (!$formats) {
1083 $ignore = 1;
1084 warn "ignoring domain '$realm' - (unsupported authentication type '$type')\n";
1085 } elsif (!pve_verify_realm($realm, 1)) {
1086 $ignore = 1;
1087 warn "ignoring domain '$realm' - (illegal characters)\n";
1088 } else {
1089 $entry = { type => $type };
1090 }
1091
1092 while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
1093 $line = $1;
1094
1095 next if $line =~ m/^\#/; #skip comment lines
1096 last if $line =~ m/^\s*$/;
1097
1098 next if $ignore; # skip
1099
1100 if ($line =~ m/^\s+(default)\s*$/) {
1101 $default = $realm if !$default;
1102 } elsif ($line =~ m/^\s+(\S+)(\s+(.*\S))?\s*$/) {
1103 my ($k, $v) = (lc($1), $3);
1104 if (defined($formats->{$k})) {
1105 if (!$formats->{$k} && !defined($v)) {
1106 $entry->{$k} = 1;
1107 } elsif ($formats->{$k} && $v =~ m/^$formats->{$k}$/) {
1108 if (!defined($entry->{$k})) {
1109 $v = PVE::Tools::decode_text($v) if $k eq 'comment';
1110 $entry->{$k} = $v;
1111 } else {
1112 warn "ignoring duplicate attribute '$k $v'\n";
1113 }
1114 } else {
1115 warn "ignoring value '$v' for attribute '$k' - invalid format\n";
1116 }
1117 } else {
1118 warn "ignoring attribute '$k' - not supported\n";
1119 }
1120 } else {
1121 warn "ignore config line: $line\n";
1122 }
1123 }
1124
1125 if ($entry->{server2} && !$entry->{server1}) {
1126 $entry->{server1} = $entry->{server2};
1127 delete $entry->{server2};
1128 }
1129
1130 if ($ignore) {
1131 # do nothing
1132 } elsif (!$entry->{server1}) {
1133 warn "ignoring domain '$realm' - missing server attribute\n";
1134 } elsif (($entry->{type} eq "ldap") && !$entry->{user_attr}) {
1135 warn "ignoring domain '$realm' - missing user attribute\n";
1136 } elsif (($entry->{type} eq "ldap") && !$entry->{base_dn}) {
1137 warn "ignoring domain '$realm' - missing base_dn attribute\n";
0c156363
DM
1138 } elsif (($entry->{type} eq "ad") && !$entry->{domain}) {
1139 warn "ignoring domain '$realm' - missing domain attribute\n";
2c3a6c0a
DM
1140 } else {
1141 $cfg->{$realm} = $entry;
1142 }
1143
1144 } else {
1145 warn "ignore config line: $line\n";
1146 }
1147 }
1148
1149 $cfg->{$default}->{default} = 1 if $default;
1150
1151 # add default domains
1152
1153 $cfg->{pve} = {
1154 type => 'builtin',
1155 comment => "Proxmox VE authentication server",
1156 };
1157
1158 $cfg->{pam} = {
1159 type => 'builtin',
1160 comment => "Linux PAM standard authentication",
1161 };
1162
1163 return $cfg;
1164}
1165
1166sub write_shadow_config {
1167 my ($filename, $cfg) = @_;
1168
1169 my $data = '';
1170 foreach my $userid (keys %{$cfg->{users}}) {
1171 my $crypt_pass = $cfg->{users}->{$userid}->{shadow};
1172 $data .= "$userid:$crypt_pass:\n";
1173 }
1174
1175 return $data
1176}
1177
1178sub write_user_config {
1179 my ($filename, $cfg) = @_;
1180
1181 my $data = '';
1182
1183 foreach my $user (keys %{$cfg->{users}}) {
2c3a6c0a
DM
1184 my $d = $cfg->{users}->{$user};
1185 my $firstname = $d->{firstname} ? PVE::Tools::encode_text($d->{firstname}) : '';
1186 my $lastname = $d->{lastname} ? PVE::Tools::encode_text($d->{lastname}) : '';
1187 my $email = $d->{email} || '';
1188 my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : '';
5eabc984 1189 my $expire = int($d->{expire} || 0);
2c3a6c0a
DM
1190 my $enable = $d->{enable} ? 1 : 0;
1191 $data .= "user:$user:$enable:$expire:$firstname:$lastname:$email:$comment:\n";
1192 }
1193
1194 $data .= "\n";
1195
1196 foreach my $group (keys %{$cfg->{groups}}) {
1197 my $d = $cfg->{groups}->{$group};
1198 my $list = join (',', keys %{$d->{users}});
1199 my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : '';
1200 $data .= "group:$group:$list:$comment:\n";
1201 }
1202
1203 $data .= "\n";
1204
39c85db8
DM
1205 foreach my $pool (keys %{$cfg->{pools}}) {
1206 my $d = $cfg->{pools}->{$pool};
4bc17477
DM
1207 my $vmlist = join (',', keys %{$d->{vms}});
1208 my $storelist = join (',', keys %{$d->{storage}});
1209 my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : '';
39c85db8 1210 $data .= "pool:$pool:$comment:$vmlist:$storelist:\n";
4bc17477
DM
1211 }
1212
1213 $data .= "\n";
1214
2c3a6c0a
DM
1215 foreach my $role (keys %{$cfg->{roles}}) {
1216 next if $special_roles->{$role};
1217
1218 my $d = $cfg->{roles}->{$role};
1219 my $list = join (',', keys %$d);
1220 $data .= "role:$role:$list:\n";
1221 }
1222
1223 $data .= "\n";
1224
1225 foreach my $path (sort keys %{$cfg->{acl}}) {
1226 my $d = $cfg->{acl}->{$path};
1227
1228 my $ra = {};
1229
1230 foreach my $group (keys %{$d->{groups}}) {
1231 my $l0 = '';
1232 my $l1 = '';
1233 foreach my $role (sort keys %{$d->{groups}->{$group}}) {
1234 my $propagate = $d->{groups}->{$group}->{$role};
1235 if ($propagate) {
1236 $l1 .= ',' if $l1;
1237 $l1 .= $role;
1238 } else {
1239 $l0 .= ',' if $l0;
1240 $l0 .= $role;
1241 }
1242 }
1243 $ra->{0}->{$l0}->{"\@$group"} = 1 if $l0;
1244 $ra->{1}->{$l1}->{"\@$group"} = 1 if $l1;
1245 }
1246
1247 foreach my $user (keys %{$d->{users}}) {
1248 # no need to save, because root is always 'Administartor'
1249 next if $user eq 'root@pam';
1250
1251 my $l0 = '';
1252 my $l1 = '';
1253 foreach my $role (sort keys %{$d->{users}->{$user}}) {
1254 my $propagate = $d->{users}->{$user}->{$role};
1255 if ($propagate) {
1256 $l1 .= ',' if $l1;
1257 $l1 .= $role;
1258 } else {
1259 $l0 .= ',' if $l0;
1260 $l0 .= $role;
1261 }
1262 }
1263 $ra->{0}->{$l0}->{$user} = 1 if $l0;
1264 $ra->{1}->{$l1}->{$user} = 1 if $l1;
1265 }
1266
1267 foreach my $rolelist (sort keys %{$ra->{0}}) {
1268 my $uglist = join (',', keys %{$ra->{0}->{$rolelist}});
1269 $data .= "acl:0:$path:$uglist:$rolelist:\n";
1270 }
1271 foreach my $rolelist (sort keys %{$ra->{1}}) {
1272 my $uglist = join (',', keys %{$ra->{1}->{$rolelist}});
1273 $data .= "acl:1:$path:$uglist:$rolelist:\n";
1274 }
1275 }
1276
1277 return $data;
1278}
1279
1280sub roles {
1281 my ($cfg, $user, $path) = @_;
1282
4bc17477
DM
1283 # NOTE: we do not consider pools here.
1284 # You need to use $rpcenv->roles() instead if you want that.
1285
2c3a6c0a
DM
1286 return 'Administrator' if $user eq 'root@pam'; # root can do anything
1287
1288 my $perm = {};
1289
1290 foreach my $p (sort keys %{$cfg->{acl}}) {
1291 my $final = ($path eq $p);
1292
1293 next if !(($p eq '/') || $final || ($path =~ m|^$p/|));
1294
1295 my $acl = $cfg->{acl}->{$p};
1296
1297 #print "CHECKACL $path $p\n";
1298 #print "ACL $path = " . Dumper ($acl);
1299
1300 if (my $ri = $acl->{users}->{$user}) {
1301 my $new;
1302 foreach my $role (keys %$ri) {
1303 my $propagate = $ri->{$role};
1304 if ($final || $propagate) {
1305 #print "APPLY ROLE $p $user $role\n";
1306 $new = {} if !$new;
1307 $new->{$role} = 1;
1308 }
1309 }
1310 if ($new) {
1311 $perm = $new; # overwrite previous settings
1312 next; # user privs always override group privs
1313 }
1314 }
1315
1316 my $new;
1317 foreach my $g (keys %{$acl->{groups}}) {
1318 next if !$cfg->{groups}->{$g}->{users}->{$user};
1319 if (my $ri = $acl->{groups}->{$g}) {
1320 foreach my $role (keys %$ri) {
1321 my $propagate = $ri->{$role};
1322 if ($final || $propagate) {
1323 #print "APPLY ROLE $p \@$g $role\n";
1324 $new = {} if !$new;
1325 $new->{$role} = 1;
1326 }
1327 }
1328 }
1329 }
1330 if ($new) {
1331 $perm = $new; # overwrite previous settings
1332 next;
1333 }
2c3a6c0a
DM
1334 }
1335
4bc17477
DM
1336 return ('NoAccess') if defined ($perm->{NoAccess});
1337 #return () if defined ($perm->{NoAccess});
2c3a6c0a
DM
1338
1339 #print "permission $user $path = " . Dumper ($perm);
1340
4bc17477 1341 my @ra = keys %$perm;
2c3a6c0a
DM
1342
1343 #print "roles $user $path = " . join (',', @ra) . "\n";
1344
1345 return @ra;
1346}
1347
1348sub permission {
1349 my ($cfg, $user, $path) = @_;
1350
1351 $user = verify_username($user, 1);
1352 return {} if !$user;
1353
1354 my @ra = roles($cfg, $user, $path);
1355
1356 my $privs = {};
1357
1358 foreach my $role (@ra) {
1359 if (my $privset = $cfg->{roles}->{$role}) {
1360 foreach my $p (keys %$privset) {
1361 $privs->{$p} = 1;
1362 }
1363 }
1364 }
1365
1366 #print "priviledges $user $path = " . Dumper ($privs);
1367
1368 return $privs;
1369}
1370
1371sub check_permissions {
1372 my ($username, $path, $privlist) = @_;
1373
1374 $path = normalize_path($path);
1375 my $usercfg = cfs_read_file('user.cfg');
1376 my $perm = permission($usercfg, $username, $path);
1377
1378 foreach my $priv (split_list($privlist)) {
1379 return undef if !$perm->{$priv};
1380 };
1381
1382 return 1;
1383}
1384
13851;