1 package PVE
::AccessControl
;
6 use Crypt
::OpenSSL
::Random
;
7 use Crypt
::OpenSSL
::RSA
;
18 use PVE
::Tools
qw(run_command lock_file file_get_contents split_list safe_print);
19 use PVE
::Cluster
qw(cfs_register_file cfs_read_file cfs_write_file cfs_lock_file);
20 use PVE
::JSONSchema
qw(register_standard_option get_standard_option);
22 use PVE
::Auth
::Plugin
;
28 # load and initialize all plugins
30 PVE
::Auth
::AD-
>register();
31 PVE
::Auth
::LDAP-
>register();
32 PVE
::Auth
::PVE-
>register();
33 PVE
::Auth
::PAM-
>register();
34 PVE
::Auth
::Plugin-
>init();
36 # $authdir must be writable by root only!
37 my $confdir = "/etc/pve";
38 my $authdir = "$confdir/priv";
40 my $pve_www_key_fn = "$confdir/pve-www.key";
42 my $pve_auth_key_files = {
43 priv
=> "$authdir/authkey.key",
44 pub
=> "$confdir/authkey.pub",
45 pubold
=> "$confdir/authkey.pub.old",
48 my $pve_auth_key_cache = {};
50 my $ticket_lifetime = 3600 * 2; # 2 hours
51 my $authkey_lifetime = 3600 * 24; # rotate every 24 hours
53 Crypt
::OpenSSL
::RSA-
>import_random_seed();
55 cfs_register_file
('user.cfg',
58 cfs_register_file
('priv/tfa.cfg',
59 \
&parse_priv_tfa_config
,
60 \
&write_priv_tfa_config
);
63 PVE
::Auth
::Plugin
::verify_username
(@_);
66 sub pve_verify_realm
{
67 PVE
::Auth
::Plugin
::pve_verify_realm
(@_);
70 sub lock_user_config
{
71 my ($code, $errmsg) = @_;
73 cfs_lock_file
("user.cfg", undef, $code);
75 $errmsg ?
die "$errmsg: $err" : die $err;
79 my $cache_read_key = sub {
82 my $path = $pve_auth_key_files->{$type};
84 my $read_key_and_mtime = sub {
85 my $fh = IO
::File-
>new($path, "r");
87 return undef if !defined($fh);
90 my $pem = PVE
::Tools
::safe_read_from
($fh, 0, 0, $path);
95 if ($type eq 'pub' || $type eq 'pubold') {
96 $key = eval { Crypt
::OpenSSL
::RSA-
>new_public_key($pem); };
97 } elsif ($type eq 'priv') {
98 $key = eval { Crypt
::OpenSSL
::RSA-
>new_private_key($pem); };
100 die "Invalid authkey type '$type'\n";
103 return { key
=> $key, mtime
=> $st->mtime };
106 if (!defined($pve_auth_key_cache->{$type})) {
107 $pve_auth_key_cache->{$type} = $read_key_and_mtime->();
109 my $st = stat($path);
110 if (!$st || $st->mtime != $pve_auth_key_cache->{$type}->{mtime
}) {
111 $pve_auth_key_cache->{$type} = $read_key_and_mtime->();
115 return $pve_auth_key_cache->{$type};
121 my $type = $old ?
'pubold' : 'pub';
123 my $res = $cache_read_key->($type);
124 return undef if !defined($res);
126 return wantarray ?
($res->{key
}, $res->{mtime
}) : $res->{key
};
130 my $res = $cache_read_key->('priv');
132 if (!defined($res) || !check_authkey
(1)) {
134 $res = $cache_read_key->('priv');
137 return wantarray ?
($res->{key
}, $res->{mtime
}) : $res->{key
};
143 # skip check if non-quorate, as rotation is not possible anyway
144 return 1 if !PVE
::Cluster
::check_cfs_quorum
(1);
146 my ($pub_key, $mtime) = get_pubkey
();
148 warn "auth key pair missing, generating new one..\n" if !$quiet;
151 if (time() - $mtime >= $authkey_lifetime) {
152 warn "auth key pair too old, rotating..\n" if !$quiet;;
155 warn "auth key new enough, skipping rotation\n" if !$quiet;;
162 return if $authkey_lifetime == 0;
164 PVE
::Cluster
::cfs_lock_authkey
(undef, sub {
165 # re-check with lock to avoid double rotation in clusters
166 return if check_authkey
();
168 my $old = get_pubkey
();
169 my $new = Crypt
::OpenSSL
::RSA-
>generate_key(2048);
173 my $pem = $old->get_public_key_x509_string();
174 # mtime is used for caching and ticket age range calculation
175 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pubold
}, $pem);
177 die "Failed to store old auth key: $@\n" if $@;
181 my $pem = $new->get_public_key_x509_string();
182 # mtime is used for caching and ticket age range calculation,
183 # should be close to that of pubold above
184 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pub
}, $pem);
188 warn "Failed to store new auth key - $@\n";
189 warn "Reverting to previous auth key\n";
191 my $pem = $old->get_public_key_x509_string();
192 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pub
}, $pem);
194 die "Failed to restore old auth key: $@\n" if $@;
196 die "Failed to store new auth key - $@\n";
201 my $pem = $new->get_private_key_string();
202 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{priv
}, $pem);
205 warn "Failed to store new auth key - $@\n";
206 warn "Deleting auth key to force regeneration\n";
207 unlink $pve_auth_key_files->{pub
};
208 unlink $pve_auth_key_files->{priv
};
214 PVE
::JSONSchema
::register_standard_option
('tokenid', {
215 description
=> "API token identifier.",
217 format
=> "pve-tokenid",
220 our $token_subid_regex = $PVE::Auth
::Plugin
::realm_regex
;
222 # username@realm username realm tokenid
223 our $token_full_regex = qr/((${PVE::Auth::Plugin::user_regex})\@(${PVE::Auth::Plugin::realm_regex}))!(${token_subid_regex})/;
225 our $userid_or_token_regex = qr/^$PVE::Auth::Plugin::user_regex\@$PVE::Auth::Plugin::realm_regex(?:!$token_subid_regex)?$/;
228 my ($tokenid, $noerr) = @_;
230 if ($tokenid =~ /^${token_full_regex}$/) {
234 die "'$tokenid' is not a valid token ID - not able to split into user and token parts\n" if !$noerr;
240 my ($username, $tokensubid) = @_;
242 my $joined = "${username}!${tokensubid}";
244 return pve_verify_tokenid
($joined);
247 PVE
::JSONSchema
::register_format
('pve-tokenid', \
&pve_verify_tokenid
);
248 sub pve_verify_tokenid
{
249 my ($tokenid, $noerr) = @_;
251 if ($tokenid =~ /^${token_full_regex}$/) {
252 return wantarray ?
($tokenid, $2, $3, $4) : $tokenid;
255 die "value '$tokenid' does not look like a valid token ID\n" if !$noerr;
261 my $csrf_prevention_secret;
262 my $csrf_prevention_secret_legacy;
263 my $get_csrfr_secret = sub {
264 if (!$csrf_prevention_secret) {
265 my $input = PVE
::Tools
::file_get_contents
($pve_www_key_fn);
266 $csrf_prevention_secret = Digest
::SHA
::hmac_sha256_base64
($input);
267 $csrf_prevention_secret_legacy = Digest
::SHA
::sha1_base64
($input);
269 return $csrf_prevention_secret;
272 sub assemble_csrf_prevention_token
{
275 my $secret = &$get_csrfr_secret();
277 return PVE
::Ticket
::assemble_csrf_prevention_token
($secret, $username);
280 sub verify_csrf_prevention_token
{
281 my ($username, $token, $noerr) = @_;
283 my $secret = $get_csrfr_secret->();
285 # FIXME: remove with PVE 7 and/or refactor all into PVE::Ticket ?
286 if ($token =~ m/^([A-Z0-9]{8}):(\S+)$/) {
288 if (length($sig) == 27) {
289 # the legacy secret got populated by above get_csrfr_secret call
290 $secret = $csrf_prevention_secret_legacy;
294 return PVE
::Ticket
::verify_csrf_prevention_token
(
295 $secret, $username, $token, -300, $ticket_lifetime, $noerr);
298 my $get_ticket_age_range = sub {
299 my ($now, $mtime, $rotated) = @_;
301 my $key_age = $now - $mtime;
302 $key_age = 0 if $key_age < 0;
305 my $max = $ticket_lifetime;
308 # ticket creation after rotation is not allowed
309 $min = $key_age - 300;
311 if ($key_age > $authkey_lifetime && $authkey_lifetime > 0) {
312 if (PVE
::Cluster
::check_cfs_quorum
(1)) {
313 # key should have been rotated, clamp range accordingly
314 $min = $key_age - $authkey_lifetime;
316 warn "Cluster not quorate - extending auth key lifetime!\n";
320 $max = $key_age + 300 if $key_age < $ticket_lifetime;
323 return undef if $min > $ticket_lifetime;
327 sub assemble_ticket
{
330 my $rsa_priv = get_privkey
();
332 return PVE
::Ticket
::assemble_rsa_ticket
($rsa_priv, 'PVE', $data);
336 my ($ticket, $noerr) = @_;
343 my ($rsa_pub, $rsa_mtime) = get_pubkey
($old);
344 return undef if !$rsa_pub;
346 my ($min, $max) = $get_ticket_age_range->($now, $rsa_mtime, $old);
347 return undef if !defined($min);
349 return PVE
::Ticket
::verify_rsa_ticket
(
350 $rsa_pub, 'PVE', $ticket, undef, $min, $max, 1);
353 my ($data, $age) = $check->();
355 # check with old, rotated key if current key failed
356 ($data, $age) = $check->(1) if !defined($data);
358 my $auth_failure = sub {
362 # raise error via undef ticket
363 PVE
::Ticket
::verify_rsa_ticket
(undef, 'PVE');
367 if (!defined($data)) {
368 return $auth_failure->();
371 my ($username, $tfa_info);
372 if ($data =~ m{^u2f!([^!]+)!([0-9a-zA-Z/.=_\-+]+)$}) {
373 # Ticket for u2f-users:
374 ($username, my $challenge) = ($1, $2);
375 if ($challenge eq 'verified') {
376 # u2f challenge was completed
378 } elsif (!wantarray) {
379 # The caller is not aware there could be an ongoing challenge,
380 # so we treat this ticket as invalid:
381 return $auth_failure->();
385 challenge
=> $challenge,
387 } elsif ($data =~ /^tfa!(.*)$/) {
388 # TOTP and Yubico don't require a challenge so this is the generic
389 # 'missing 2nd factor ticket'
391 $tfa_info = { type
=> 'tfa' };
393 # Regular ticket (full access)
397 return undef if !PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
399 return wantarray ?
($username, $age, $tfa_info) : $username;
403 # - they do not contain the username in plain text
404 # - they are restricted to a specific resource path (example: '/vms/100')
405 sub assemble_vnc_ticket
{
406 my ($username, $path) = @_;
408 my $rsa_priv = get_privkey
();
410 $path = normalize_path
($path);
412 my $secret_data = "$username:$path";
414 return PVE
::Ticket
::assemble_rsa_ticket
(
415 $rsa_priv, 'PVEVNC', undef, $secret_data);
418 sub verify_vnc_ticket
{
419 my ($ticket, $username, $path, $noerr) = @_;
421 my $secret_data = "$username:$path";
423 my ($rsa_pub, $rsa_mtime) = get_pubkey
();
424 if (!$rsa_pub || (time() - $rsa_mtime > $authkey_lifetime && $authkey_lifetime > 0)) {
428 # raise error via undef ticket
429 PVE
::Ticket
::verify_rsa_ticket
($rsa_pub, 'PVEVNC');
433 return PVE
::Ticket
::verify_rsa_ticket
(
434 $rsa_pub, 'PVEVNC', $ticket, $secret_data, -20, 40, $noerr);
437 sub assemble_spice_ticket
{
438 my ($username, $vmid, $node) = @_;
440 my $secret = &$get_csrfr_secret();
442 return PVE
::Ticket
::assemble_spice_ticket
(
443 $secret, $username, $vmid, $node);
446 sub verify_spice_connect_url
{
447 my ($connect_str) = @_;
449 my $secret = &$get_csrfr_secret();
451 return PVE
::Ticket
::verify_spice_connect_url
($secret, $connect_str);
454 sub read_x509_subject_spice
{
458 my $bio = Net
::SSLeay
::BIO_new_file
($filename, 'r');
459 die "Could not open $filename using OpenSSL\n"
462 my $x509 = Net
::SSLeay
::PEM_read_bio_X509
($bio);
463 Net
::SSLeay
::BIO_free
($bio);
465 die "Could not parse X509 certificate in $filename\n"
468 my $nameobj = Net
::SSLeay
::X509_get_subject_name
($x509);
469 my $subject = Net
::SSLeay
::X509_NAME_oneline
($nameobj);
470 Net
::SSLeay
::X509_free
($x509);
472 # remote-viewer wants comma as seperator (not '/')
474 $subject =~ s!/(\w+=)!,$1!g;
479 # helper to generate SPICE remote-viewer configuration
480 sub remote_viewer_config
{
481 my ($authuser, $vmid, $node, $proxy, $title, $port) = @_;
484 my $host = `hostname -f` || PVE
::INotify
::nodename
();
489 my ($ticket, $proxyticket) = assemble_spice_ticket
($authuser, $vmid, $node);
491 my $filename = "/etc/pve/local/pve-ssl.pem";
492 my $subject = read_x509_subject_spice
($filename);
494 my $cacert = PVE
::Tools
::file_get_contents
("/etc/pve/pve-root-ca.pem", 8192);
495 $cacert =~ s/\n/\\n/g;
497 $proxy = "[$proxy]" if Net
::IP
::ip_is_ipv6
($proxy);
499 'secure-attention' => "Ctrl+Alt+Ins",
500 'toggle-fullscreen' => "Shift+F11",
501 'release-cursor' => "Ctrl+Alt+R",
504 host
=> $proxyticket, # this breaks tls hostname verification, so we need to use 'host-subject'
505 proxy
=> "http://$proxy:3128",
507 'host-subject' => $subject,
510 'delete-this-file' => 1,
513 return ($ticket, $proxyticket, $config);
516 sub check_user_exist
{
517 my ($usercfg, $username, $noerr) = @_;
519 $username = PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
520 return undef if !$username;
522 return $usercfg->{users
}->{$username} if $usercfg && $usercfg->{users
}->{$username};
524 die "no such user ('$username')\n" if !$noerr;
529 sub check_user_enabled
{
530 my ($usercfg, $username, $noerr) = @_;
532 my $data = check_user_exist
($usercfg, $username, $noerr);
533 return undef if !$data;
535 return 1 if $data->{enable
};
537 die "user '$username' is disabled\n" if !$noerr;
542 sub check_token_exist
{
543 my ($usercfg, $username, $tokenid, $noerr) = @_;
545 my $user = check_user_exist
($usercfg, $username, $noerr);
546 return undef if !$user;
548 return $user->{tokens
}->{$tokenid}
549 if defined($user->{tokens
}) && $user->{tokens
}->{$tokenid};
551 die "no such token '$tokenid' for user '$username'\n" if !$noerr;
556 sub verify_one_time_pw
{
557 my ($type, $username, $keys, $tfa_cfg, $otp) = @_;
559 die "missing one time password for two-factor authentication '$type'\n" if !$otp;
561 # fixme: proxy support?
564 if ($type eq 'yubico') {
565 PVE
::OTP
::yubico_verify_otp
($otp, $keys, $tfa_cfg->{url
},
566 $tfa_cfg->{id
}, $tfa_cfg->{key
}, $proxy);
567 } elsif ($type eq 'oath') {
568 PVE
::OTP
::oath_verify_otp
($otp, $keys, $tfa_cfg->{step
}, $tfa_cfg->{digits
});
570 die "unknown tfa type '$type'\n";
574 # password should be utf8 encoded
575 # Note: some plugins delay/sleep if auth fails
576 sub authenticate_user
{
577 my ($username, $password, $otp) = @_;
579 die "no username specified\n" if !$username;
583 ($username, $ruid, $realm) = PVE
::Auth
::Plugin
::verify_username
($username);
585 my $usercfg = cfs_read_file
('user.cfg');
587 check_user_enabled
($usercfg, $username);
590 my $expire = $usercfg->{users
}->{$username}->{expire
};
592 die "account expired\n" if $expire && ($expire < $ctime);
594 my $domain_cfg = cfs_read_file
('domains.cfg');
596 my $cfg = $domain_cfg->{ids
}->{$realm};
597 die "auth domain '$realm' does not exist\n" if !$cfg;
598 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
599 $plugin->authenticate_user($cfg, $realm, $ruid, $password);
601 my ($type, $tfa_data) = user_get_tfa
($username, $realm);
603 if ($type eq 'u2f') {
604 # Note that if the user did not manage to complete the initial u2f registration
605 # challenge we have a hash containing a 'challenge' entry in the user's tfa.cfg entry:
606 $tfa_data = undef if exists $tfa_data->{challenge
};
607 } elsif (!defined($otp)) {
608 # The user requires a 2nd factor but has not provided one. Return success but
609 # don't clear $tfa_data.
611 my $keys = $tfa_data->{keys};
612 my $tfa_cfg = $tfa_data->{config
};
613 verify_one_time_pw
($type, $username, $keys, $tfa_cfg, $otp);
617 # Return the type along with the rest:
626 return wantarray ?
($username, $tfa_data) : $username;
629 sub domain_set_password
{
630 my ($realm, $username, $password) = @_;
632 die "no auth domain specified" if !$realm;
634 my $domain_cfg = cfs_read_file
('domains.cfg');
636 my $cfg = $domain_cfg->{ids
}->{$realm};
637 die "auth domain '$realm' does not exist\n" if !$cfg;
638 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
639 $plugin->store_password($cfg, $realm, $username, $password);
643 my ($username, $usercfg, $group) = @_;
645 $usercfg->{users
}->{$username}->{groups
}->{$group} = 1;
646 $usercfg->{groups
}->{$group}->{users
}->{$username} = 1;
649 sub delete_user_group
{
650 my ($username, $usercfg) = @_;
652 foreach my $group (keys %{$usercfg->{groups
}}) {
654 delete ($usercfg->{groups
}->{$group}->{users
}->{$username})
655 if $usercfg->{groups
}->{$group}->{users
}->{$username};
659 sub delete_user_acl
{
660 my ($username, $usercfg) = @_;
662 foreach my $acl (keys %{$usercfg->{acl
}}) {
664 delete ($usercfg->{acl
}->{$acl}->{users
}->{$username})
665 if $usercfg->{acl
}->{$acl}->{users
}->{$username};
669 sub delete_group_acl
{
670 my ($group, $usercfg) = @_;
672 foreach my $acl (keys %{$usercfg->{acl
}}) {
674 delete ($usercfg->{acl
}->{$acl}->{groups
}->{$group})
675 if $usercfg->{acl
}->{$acl}->{groups
}->{$group};
679 sub delete_pool_acl
{
680 my ($pool, $usercfg) = @_;
682 my $path = "/pool/$pool";
684 delete ($usercfg->{acl
}->{$path})
687 # we automatically create some predefined roles by splitting privs
688 # into 3 groups (per category)
689 # root: only root is allowed to do that
690 # admin: an administrator can to that
691 # user: a normal user/customer can to that
701 'VM.Config.Options', # covers all other things
707 'VM.Snapshot.Rollback',
710 'VM.Config.CDROM', # change CDROM media
722 'Sys.Modify', # edit/change node settings
725 'Permissions.Modify',
737 'Datastore.Allocate',
738 'Datastore.AllocateTemplate',
741 'Datastore.AllocateSpace',
763 'Group.Allocate', # edit/change group settings
764 'Realm.AllocateUser',
772 'Pool.Allocate', # create/delete pools
779 my $valid_privs = {};
781 my $special_roles = {
782 'NoAccess' => {}, # no privileges
783 'Administrator' => $valid_privs, # all privileges
788 foreach my $cat (keys %$privgroups) {
789 my $cd = $privgroups->{$cat};
790 foreach my $p (@{$cd->{root
}}, @{$cd->{admin
}},
791 @{$cd->{user
}}, @{$cd->{audit
}}) {
792 $valid_privs->{$p} = 1;
794 foreach my $p (@{$cd->{admin
}}, @{$cd->{user
}}, @{$cd->{audit
}}) {
796 $special_roles->{"PVE${cat}Admin"}->{$p} = 1;
797 $special_roles->{"PVEAdmin"}->{$p} = 1;
799 if (scalar(@{$cd->{user
}})) {
800 foreach my $p (@{$cd->{user
}}, @{$cd->{audit
}}) {
801 $special_roles->{"PVE${cat}User"}->{$p} = 1;
804 foreach my $p (@{$cd->{audit
}}) {
805 $special_roles->{"PVEAuditor"}->{$p} = 1;
809 $special_roles->{"PVETemplateUser"} = { 'VM.Clone' => 1, 'VM.Audit' => 1 };
814 sub create_priv_properties
{
816 foreach my $priv (keys %$valid_privs) {
817 $properties->{$priv} = {
825 sub role_is_special
{
827 return (exists $special_roles->{$role}) ?
1 : 0;
831 my ($role, $usercfg, $privs) = @_;
835 die "role '$role' does not exist\n" if !$usercfg->{roles
}->{$role};
837 foreach my $priv (split_list
($privs)) {
838 if (defined ($valid_privs->{$priv})) {
839 $usercfg->{roles
}->{$role}->{$priv} = 1;
841 die "invalid privilege '$priv'\n";
853 $path = '/' if !$path;
855 $path = "/$path" if $path !~ m
|^/|;
857 return undef if $path !~ m
|^[[:alnum
:]\
.\
-\_\
/]+$|;
862 PVE
::JSONSchema
::register_format
('pve-groupid', \
&verify_groupname
);
863 sub verify_groupname
{
864 my ($groupname, $noerr) = @_;
866 if ($groupname !~ m/^[A-Za-z0-9\.\-_]+$/) {
868 die "group name '$groupname' contains invalid characters\n" if !$noerr;
876 PVE
::JSONSchema
::register_format
('pve-roleid', \
&verify_rolename
);
877 sub verify_rolename
{
878 my ($rolename, $noerr) = @_;
880 if ($rolename !~ m/^[A-Za-z0-9\.\-_]+$/) {
882 die "role name '$rolename' contains invalid characters\n" if !$noerr;
890 PVE
::JSONSchema
::register_format
('pve-poolid', \
&verify_poolname
);
891 sub verify_poolname
{
892 my ($poolname, $noerr) = @_;
894 if ($poolname !~ m/^[A-Za-z0-9\.\-_]+$/) {
896 die "pool name '$poolname' contains invalid characters\n" if !$noerr;
904 PVE
::JSONSchema
::register_format
('pve-priv', \
&verify_privname
);
905 sub verify_privname
{
906 my ($priv, $noerr) = @_;
908 if (!$valid_privs->{$priv}) {
909 die "invalid privilege '$priv'\n" if !$noerr;
917 sub userconfig_force_defaults
{
920 foreach my $r (keys %$special_roles) {
921 $cfg->{roles
}->{$r} = $special_roles->{$r};
924 # add root user if not exists
925 if (!$cfg->{users
}->{'root@pam'}) {
926 $cfg->{users
}->{'root@pam'}->{enable
} = 1;
930 sub parse_user_config
{
931 my ($filename, $raw) = @_;
935 userconfig_force_defaults
($cfg);
937 $raw = '' if !defined($raw);
938 while ($raw =~ /^\s*(.+?)\s*$/gm) {
942 foreach my $d (split (/:/, $line)) {
948 my $et = shift @data;
951 my ($user, $enable, $expire, $firstname, $lastname, $email, $comment, $keys) = @data;
953 my (undef, undef, $realm) = PVE
::Auth
::Plugin
::verify_username
($user, 1);
955 warn "user config - ignore user '$user' - invalid user name\n";
959 $enable = $enable ?
1 : 0;
961 $expire = 0 if !$expire;
963 if ($expire !~ m/^\d+$/) {
964 warn "user config - ignore user '$user' - (illegal characters in expire '$expire')\n";
967 $expire = int($expire);
969 #if (!verify_groupname ($group, 1)) {
970 # warn "user config - ignore user '$user' - invalid characters in group name\n";
974 $cfg->{users
}->{$user} = {
978 $cfg->{users
}->{$user}->{firstname
} = PVE
::Tools
::decode_text
($firstname) if $firstname;
979 $cfg->{users
}->{$user}->{lastname
} = PVE
::Tools
::decode_text
($lastname) if $lastname;
980 $cfg->{users
}->{$user}->{email
} = $email;
981 $cfg->{users
}->{$user}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
982 $cfg->{users
}->{$user}->{expire
} = $expire;
983 # keys: allowed yubico key ids or oath secrets (base32 encoded)
984 $cfg->{users
}->{$user}->{keys} = $keys if $keys;
986 #$cfg->{users}->{$user}->{groups}->{$group} = 1;
987 #$cfg->{groups}->{$group}->{$user} = 1;
989 } elsif ($et eq 'group') {
990 my ($group, $userlist, $comment) = @data;
992 if (!verify_groupname
($group, 1)) {
993 warn "user config - ignore group '$group' - invalid characters in group name\n";
997 # make sure to add the group (even if there are no members)
998 $cfg->{groups
}->{$group} = { users
=> {} } if !$cfg->{groups
}->{$group};
1000 $cfg->{groups
}->{$group}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1002 foreach my $user (split_list
($userlist)) {
1004 if (!PVE
::Auth
::Plugin
::verify_username
($user, 1)) {
1005 warn "user config - ignore invalid group member '$user'\n";
1009 if ($cfg->{users
}->{$user}) { # user exists
1010 $cfg->{users
}->{$user}->{groups
}->{$group} = 1;
1011 $cfg->{groups
}->{$group}->{users
}->{$user} = 1;
1013 warn "user config - ignore invalid group member '$user'\n";
1017 } elsif ($et eq 'role') {
1018 my ($role, $privlist) = @data;
1020 if (!verify_rolename
($role, 1)) {
1021 warn "user config - ignore role '$role' - invalid characters in role name\n";
1025 # make sure to add the role (even if there are no privileges)
1026 $cfg->{roles
}->{$role} = {} if !$cfg->{roles
}->{$role};
1028 foreach my $priv (split_list
($privlist)) {
1029 if (defined ($valid_privs->{$priv})) {
1030 $cfg->{roles
}->{$role}->{$priv} = 1;
1032 warn "user config - ignore invalid privilege '$priv'\n";
1036 } elsif ($et eq 'acl') {
1037 my ($propagate, $pathtxt, $uglist, $rolelist) = @data;
1039 $propagate = $propagate ?
1 : 0;
1041 if (my $path = normalize_path
($pathtxt)) {
1042 foreach my $role (split_list
($rolelist)) {
1044 if (!verify_rolename
($role, 1)) {
1045 warn "user config - ignore invalid role name '$role' in acl\n";
1049 foreach my $ug (split_list
($uglist)) {
1050 my ($group) = $ug =~ m/^@(\S+)$/;
1052 if ($group && verify_groupname
($group, 1)) {
1053 if ($cfg->{groups
}->{$group}) { # group exists
1054 $cfg->{acl
}->{$path}->{groups
}->{$group}->{$role} = $propagate;
1056 warn "user config - ignore invalid acl group '$group'\n";
1058 } elsif (PVE
::Auth
::Plugin
::verify_username
($ug, 1)) {
1059 if ($cfg->{users
}->{$ug}) { # user exists
1060 $cfg->{acl
}->{$path}->{users
}->{$ug}->{$role} = $propagate;
1062 warn "user config - ignore invalid acl member '$ug'\n";
1064 } elsif (my ($user, $token) = split_tokenid
($ug, 1)) {
1065 if (check_token_exist
($cfg, $user, $token, 1)) {
1066 $cfg->{acl
}->{$path}->{tokens
}->{$ug}->{$role} = $propagate;
1068 warn "user config - ignore invalid acl token '$ug'\n";
1071 warn "user config - invalid user/group '$ug' in acl\n";
1076 warn "user config - ignore invalid path in acl '$pathtxt'\n";
1078 } elsif ($et eq 'pool') {
1079 my ($pool, $comment, $vmlist, $storelist) = @data;
1081 if (!verify_poolname
($pool, 1)) {
1082 warn "user config - ignore pool '$pool' - invalid characters in pool name\n";
1086 # make sure to add the pool (even if there are no members)
1087 $cfg->{pools
}->{$pool} = { vms
=> {}, storage
=> {} } if !$cfg->{pools
}->{$pool};
1089 $cfg->{pools
}->{$pool}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1091 foreach my $vmid (split_list
($vmlist)) {
1092 if ($vmid !~ m/^\d+$/) {
1093 warn "user config - ignore invalid vmid '$vmid' in pool '$pool'\n";
1098 if ($cfg->{vms
}->{$vmid}) {
1099 warn "user config - ignore duplicate vmid '$vmid' in pool '$pool'\n";
1103 $cfg->{pools
}->{$pool}->{vms
}->{$vmid} = 1;
1105 # record vmid ==> pool relation
1106 $cfg->{vms
}->{$vmid} = $pool;
1109 foreach my $storeid (split_list
($storelist)) {
1110 if ($storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
1111 warn "user config - ignore invalid storage '$storeid' in pool '$pool'\n";
1114 $cfg->{pools
}->{$pool}->{storage
}->{$storeid} = 1;
1116 } elsif ($et eq 'token') {
1117 my ($tokenid, $expire, $privsep, $comment) = @data;
1119 my ($user, $token) = split_tokenid
($tokenid, 1);
1120 if (!($user && $token)) {
1121 warn "user config - ignore invalid tokenid '$tokenid'\n";
1125 $privsep = $privsep ?
1 : 0;
1127 $expire = 0 if !$expire;
1129 if ($expire !~ m/^\d+$/) {
1130 warn "user config - ignore token '$tokenid' - (illegal characters in expire '$expire')\n";
1133 $expire = int($expire);
1135 if (my $user_cfg = $cfg->{users
}->{$user}) { # user exists
1136 $user_cfg->{tokens
}->{$token} = {} if !$user_cfg->{tokens
}->{$token};
1137 my $token_cfg = $user_cfg->{tokens
}->{$token};
1138 $token_cfg->{privsep
} = $privsep;
1139 $token_cfg->{expire
} = $expire;
1140 $token_cfg->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1142 warn "user config - ignore token '$tokenid' - user does not exist\n";
1145 warn "user config - ignore config line: $line\n";
1149 userconfig_force_defaults
($cfg);
1154 sub write_user_config
{
1155 my ($filename, $cfg) = @_;
1159 foreach my $user (sort keys %{$cfg->{users
}}) {
1160 my $d = $cfg->{users
}->{$user};
1161 my $firstname = $d->{firstname
} ? PVE
::Tools
::encode_text
($d->{firstname
}) : '';
1162 my $lastname = $d->{lastname
} ? PVE
::Tools
::encode_text
($d->{lastname
}) : '';
1163 my $email = $d->{email
} || '';
1164 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1165 my $expire = int($d->{expire
} || 0);
1166 my $enable = $d->{enable
} ?
1 : 0;
1167 my $keys = $d->{keys} ?
$d->{keys} : '';
1168 $data .= "user:$user:$enable:$expire:$firstname:$lastname:$email:$comment:$keys:\n";
1170 my $user_tokens = $d->{tokens
};
1171 foreach my $token (sort keys %$user_tokens) {
1172 my $td = $user_tokens->{$token};
1173 my $full_tokenid = join_tokenid
($user, $token);
1174 my $comment = $td->{comment
} ? PVE
::Tools
::encode_text
($td->{comment
}) : '';
1175 my $expire = int($td->{expire
} || 0);
1176 my $privsep = $td->{privsep
} ?
1 : 0;
1177 $data .= "token:$full_tokenid:$expire:$privsep:$comment:\n";
1183 foreach my $group (sort keys %{$cfg->{groups
}}) {
1184 my $d = $cfg->{groups
}->{$group};
1185 my $list = join (',', sort keys %{$d->{users
}});
1186 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1187 $data .= "group:$group:$list:$comment:\n";
1192 foreach my $pool (sort keys %{$cfg->{pools
}}) {
1193 my $d = $cfg->{pools
}->{$pool};
1194 my $vmlist = join (',', sort keys %{$d->{vms
}});
1195 my $storelist = join (',', sort keys %{$d->{storage
}});
1196 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1197 $data .= "pool:$pool:$comment:$vmlist:$storelist:\n";
1202 foreach my $role (sort keys %{$cfg->{roles
}}) {
1203 next if $special_roles->{$role};
1205 my $d = $cfg->{roles
}->{$role};
1206 my $list = join (',', sort keys %$d);
1207 $data .= "role:$role:$list:\n";
1212 my $collect_rolelist_members = sub {
1213 my ($acl_members, $result, $prefix, $exclude) = @_;
1215 foreach my $member (keys %$acl_members) {
1216 next if $exclude && $member eq $exclude;
1220 foreach my $role (sort keys %{$acl_members->{$member}}) {
1221 my $propagate = $acl_members->{$member}->{$role};
1230 $result->{0}->{$l0}->{"${prefix}${member}"} = 1 if $l0;
1231 $result->{1}->{$l1}->{"${prefix}${member}"} = 1 if $l1;
1235 foreach my $path (sort keys %{$cfg->{acl
}}) {
1236 my $d = $cfg->{acl
}->{$path};
1238 my $rolelist_members = {};
1240 $collect_rolelist_members->($d->{'groups'}, $rolelist_members, '@');
1242 # no need to save 'root@pam', it is always 'Administrator'
1243 $collect_rolelist_members->($d->{'users'}, $rolelist_members, '', 'root@pam');
1245 $collect_rolelist_members->($d->{'tokens'}, $rolelist_members, '');
1247 foreach my $propagate (0,1) {
1248 my $filtered = $rolelist_members->{$propagate};
1249 foreach my $rolelist (sort keys %$filtered) {
1250 my $uglist = join (',', sort keys %{$filtered->{$rolelist}});
1251 $data .= "acl:$propagate:$path:$uglist:$rolelist:\n";
1260 # The TFA configuration in priv/tfa.cfg format contains one line per user of
1263 # DATA is a base64 encoded json string and its format depends on the type.
1264 sub parse_priv_tfa_config
{
1265 my ($filename, $raw) = @_;
1268 my $cfg = { users
=> $users };
1270 $raw = '' if !defined($raw);
1271 while ($raw =~ /^\s*(.+?)\s*$/gm) {
1273 my ($user, $type, $data) = split(/:/, $line, 3);
1275 my (undef, undef, $realm) = PVE
::Auth
::Plugin
::verify_username
($user, 1);
1277 warn "user tfa config - ignore user '$user' - invalid user name\n";
1281 $data = decode_json
(decode_base64
($data));
1292 sub write_priv_tfa_config
{
1293 my ($filename, $cfg) = @_;
1297 my $users = $cfg->{users
};
1298 foreach my $user (sort keys %$users) {
1299 my $info = $users->{$user};
1300 next if !%$info; # skip empty entries
1302 $info = {%$info}; # copy to verify contents:
1304 my $type = delete $info->{type
};
1305 my $data = delete $info->{data
};
1307 if (my @keys = keys %$info) {
1308 die "invalid keys in TFA config for user $user: " . join(', ', @keys) . "\n";
1311 $data = encode_base64
(encode_json
($data), '');
1312 $output .= "${user}:${type}:${data}\n";
1319 my ($cfg, $user, $path) = @_;
1321 # NOTE: we do not consider pools here.
1322 # Use $rpcenv->permission() for any actual permission checks!
1324 return 'Administrator' if $user eq 'root@pam'; # root can do anything
1328 foreach my $p (sort keys %{$cfg->{acl
}}) {
1329 my $final = ($path eq $p);
1331 next if !(($p eq '/') || $final || ($path =~ m
|^$p/|));
1333 my $acl = $cfg->{acl
}->{$p};
1335 #print "CHECKACL $path $p\n";
1336 #print "ACL $path = " . Dumper ($acl);
1338 if (my $ri = $acl->{users
}->{$user}) {
1340 foreach my $role (keys %$ri) {
1341 my $propagate = $ri->{$role};
1342 if ($final || $propagate) {
1343 #print "APPLY ROLE $p $user $role\n";
1349 $perm = $new; # overwrite previous settings
1350 next; # user privs always override group privs
1355 foreach my $g (keys %{$acl->{groups
}}) {
1356 next if !$cfg->{groups
}->{$g}->{users
}->{$user};
1357 if (my $ri = $acl->{groups
}->{$g}) {
1358 foreach my $role (keys %$ri) {
1359 my $propagate = $ri->{$role};
1360 if ($final || $propagate) {
1361 #print "APPLY ROLE $p \@$g $role\n";
1369 $perm = $new; # overwrite previous settings
1374 return ('NoAccess') if defined ($perm->{NoAccess
});
1375 #return () if defined ($perm->{NoAccess});
1377 #print "permission $user $path = " . Dumper ($perm);
1379 my @ra = keys %$perm;
1381 #print "roles $user $path = " . join (',', @ra) . "\n";
1386 sub remove_vm_access
{
1388 my $delVMaccessFn = sub {
1389 my $usercfg = cfs_read_file
("user.cfg");
1392 if (my $acl = $usercfg->{acl
}->{"/vms/$vmid"}) {
1393 delete $usercfg->{acl
}->{"/vms/$vmid"};
1396 if (my $pool = $usercfg->{vms
}->{$vmid}) {
1397 if (my $data = $usercfg->{pools
}->{$pool}) {
1398 delete $data->{vms
}->{$vmid};
1399 delete $usercfg->{vms
}->{$vmid};
1403 cfs_write_file
("user.cfg", $usercfg) if $modified;
1406 lock_user_config
($delVMaccessFn, "access permissions cleanup for VM $vmid failed");
1409 sub remove_storage_access
{
1412 my $deleteStorageAccessFn = sub {
1413 my $usercfg = cfs_read_file
("user.cfg");
1416 if (my $storage = $usercfg->{acl
}->{"/storage/$storeid"}) {
1417 delete $usercfg->{acl
}->{"/storage/$storeid"};
1420 foreach my $pool (keys %{$usercfg->{pools
}}) {
1421 delete $usercfg->{pools
}->{$pool}->{storage
}->{$storeid};
1424 cfs_write_file
("user.cfg", $usercfg) if $modified;
1427 lock_user_config
($deleteStorageAccessFn,
1428 "access permissions cleanup for storage $storeid failed");
1431 sub add_vm_to_pool
{
1432 my ($vmid, $pool) = @_;
1434 my $addVMtoPoolFn = sub {
1435 my $usercfg = cfs_read_file
("user.cfg");
1436 if (my $data = $usercfg->{pools
}->{$pool}) {
1437 $data->{vms
}->{$vmid} = 1;
1438 $usercfg->{vms
}->{$vmid} = $pool;
1439 cfs_write_file
("user.cfg", $usercfg);
1443 lock_user_config
($addVMtoPoolFn, "can't add VM $vmid to pool '$pool'");
1446 sub remove_vm_from_pool
{
1449 my $delVMfromPoolFn = sub {
1450 my $usercfg = cfs_read_file
("user.cfg");
1451 if (my $pool = $usercfg->{vms
}->{$vmid}) {
1452 if (my $data = $usercfg->{pools
}->{$pool}) {
1453 delete $data->{vms
}->{$vmid};
1454 delete $usercfg->{vms
}->{$vmid};
1455 cfs_write_file
("user.cfg", $usercfg);
1460 lock_user_config
($delVMfromPoolFn, "pool cleanup for VM $vmid failed");
1463 my $USER_CONTROLLED_TFA_TYPES = {
1468 # Delete an entry by setting $data=undef in which case $type is ignored.
1469 # Otherwise both must be valid.
1471 my ($userid, $realm, $type, $data, $cached_usercfg, $cached_domaincfg) = @_;
1473 if (defined($data) && !defined($type)) {
1474 # This is an internal usage error and should not happen
1475 die "cannot set tfa data without a type\n";
1478 my $user_cfg = $cached_usercfg || cfs_read_file
('user.cfg');
1479 my $user = $user_cfg->{users
}->{$userid}
1480 or die "user '$userid' not found\n";
1482 my $domain_cfg = $cached_domaincfg || cfs_read_file
('domains.cfg');
1483 my $realm_cfg = $domain_cfg->{ids
}->{$realm};
1484 die "auth domain '$realm' does not exist\n" if !$realm_cfg;
1486 my $realm_tfa = $realm_cfg->{tfa
};
1487 if (defined($realm_tfa)) {
1488 $realm_tfa = PVE
::Auth
::Plugin
::parse_tfa_config
($realm_tfa);
1489 # If the realm has a TFA setting, we're only allowed to use that.
1490 if (defined($data)) {
1491 my $required_type = $realm_tfa->{type
};
1492 if ($required_type ne $type) {
1493 die "realm '$realm' only allows TFA of type '$required_type\n";
1496 if (defined($data->{config
})) {
1497 # XXX: Is it enough if the type matches? Or should the configuration also match?
1500 # realm-configured tfa always uses a simple key list, so use the user.cfg
1501 $user->{keys} = $data->{keys};
1503 die "realm '$realm' does not allow removing the 2nd factor\n";
1506 # Without a realm-enforced TFA setting the user can add a u2f or totp entry by themselves.
1507 # The 'yubico' type requires yubico server settings, which have to be configured on the
1508 # realm, so this is not supported here:
1509 die "domain '$realm' does not support TFA type '$type'\n"
1510 if defined($data) && !$USER_CONTROLLED_TFA_TYPES->{$type};
1513 # Custom TFA entries are stored in priv/tfa.cfg as they can be more complet: u2f uses a
1514 # public key and a key handle, TOTP requires the usual totp settings...
1516 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
1517 my $tfa = ($tfa_cfg->{users
}->{$userid} //= {});
1519 if (defined($data)) {
1520 $tfa->{type
} = $type;
1521 $tfa->{data
} = $data;
1522 cfs_write_file
('priv/tfa.cfg', $tfa_cfg);
1524 $user->{keys} = "x!$type";
1526 delete $tfa_cfg->{users
}->{$userid};
1527 cfs_write_file
('priv/tfa.cfg', $tfa_cfg);
1529 delete $user->{keys};
1532 cfs_write_file
('user.cfg', $user_cfg);
1536 my ($username, $realm) = @_;
1538 my $user_cfg = cfs_read_file
('user.cfg');
1539 my $user = $user_cfg->{users
}->{$username}
1540 or die "user '$username' not found\n";
1542 my $keys = $user->{keys};
1544 my $domain_cfg = cfs_read_file
('domains.cfg');
1545 my $realm_cfg = $domain_cfg->{ids
}->{$realm};
1546 die "auth domain '$realm' does not exist\n" if !$realm_cfg;
1548 my $realm_tfa = $realm_cfg->{tfa
};
1549 $realm_tfa = PVE
::Auth
::Plugin
::parse_tfa_config
($realm_tfa)
1553 return if !$realm_tfa;
1554 die "missing required 2nd keys\n";
1557 # new style config starts with an 'x' and optionally contains a !<type> suffix
1558 if ($keys !~ /^x(?:!.*)?$/) {
1559 # old style config, find the type via the realm
1560 return if !$realm_tfa;
1561 return ($realm_tfa->{type
}, {
1563 config
=> $realm_tfa,
1566 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
1567 my $tfa = $tfa_cfg->{users
}->{$username};
1568 return if !$tfa; # should not happen (user.cfg wasn't cleaned up?)
1571 # if the realm has a tfa setting we need to verify the type:
1572 die "auth domain '$realm' and user have mismatching TFA settings\n"
1573 if $realm_tfa && $realm_tfa->{type
} ne $tfa->{type
};
1576 return ($tfa->{type
}, $tfa->{data
});
1580 # bash completion helpers
1582 register_standard_option
('userid-completed',
1583 get_standard_option
('userid', { completion
=> \
&complete_username
}),
1586 sub complete_username
{
1588 my $user_cfg = cfs_read_file
('user.cfg');
1590 return [ keys %{$user_cfg->{users
}} ];
1593 sub complete_group
{
1595 my $user_cfg = cfs_read_file
('user.cfg');
1597 return [ keys %{$user_cfg->{groups
}} ];
1600 sub complete_realm
{
1602 my $domain_cfg = cfs_read_file
('domains.cfg');
1604 return [ keys %{$domain_cfg->{ids
}} ];