X-Git-Url: https://git.proxmox.com/?p=pve-access-control.git;a=blobdiff_plain;f=PVE%2FAccessControl.pm;h=655f306fd0d3326f0747e8512858a1f84d20db20;hp=98e2fd6849e68c548f5ebfbb3a9235b6662956d8;hb=fda8ca85d312be337c8980994867f37b29b4eebd;hpb=894e6f0c4b166d09f5623c06812edb3ec5e8bf62 diff --git a/PVE/AccessControl.pm b/PVE/AccessControl.pm index 98e2fd6..655f306 100644 --- a/PVE/AccessControl.pm +++ b/PVE/AccessControl.pm @@ -9,12 +9,15 @@ use Net::SSLeay; use Net::IP; use MIME::Base64; use Digest::SHA; +use IO::File; +use File::stat; +use JSON; use PVE::OTP; use PVE::Ticket; use PVE::Tools qw(run_command lock_file file_get_contents split_list safe_print); use PVE::Cluster qw(cfs_register_file cfs_read_file cfs_write_file cfs_lock_file); -use PVE::JSONSchema; +use PVE::JSONSchema qw(register_standard_option get_standard_option); use PVE::Auth::Plugin; use PVE::Auth::AD; @@ -22,8 +25,6 @@ use PVE::Auth::LDAP; use PVE::Auth::PVE; use PVE::Auth::PAM; -use Data::Dumper; # fixme: remove - # load and initialize all plugins PVE::Auth::AD->register(); @@ -35,18 +36,29 @@ PVE::Auth::Plugin->init(); # $authdir must be writable by root only! my $confdir = "/etc/pve"; my $authdir = "$confdir/priv"; -my $authprivkeyfn = "$authdir/authkey.key"; -my $authpubkeyfn = "$confdir/authkey.pub"; + my $pve_www_key_fn = "$confdir/pve-www.key"; +my $pve_auth_key_files = { + priv => "$authdir/authkey.key", + pub => "$confdir/authkey.pub", + pubold => "$confdir/authkey.pub.old", +}; + +my $pve_auth_key_cache = {}; + my $ticket_lifetime = 3600*2; # 2 hours +# TODO: set to 24h for PVE 6.0 +my $authkey_lifetime = 3600*0; # rotation disabled Crypt::OpenSSL::RSA->import_random_seed(); cfs_register_file('user.cfg', \&parse_user_config, \&write_user_config); - +cfs_register_file('priv/tfa.cfg', + \&parse_priv_tfa_config, + \&write_priv_tfa_config); sub verify_username { PVE::Auth::Plugin::verify_username(@_); @@ -65,16 +77,136 @@ sub lock_user_config { } } -my $pve_auth_pub_key; +my $cache_read_key = sub { + my ($type) = @_; + + my $path = $pve_auth_key_files->{$type}; + + my $read_key_and_mtime = sub { + my $fh = IO::File->new($path, "r"); + + return undef if !defined($fh); + + my $st = stat($fh); + my $pem = PVE::Tools::safe_read_from($fh, 0, 0, $path); + + close $fh; + + my $key; + if ($type eq 'pub' || $type eq 'pubold') { + $key = eval { Crypt::OpenSSL::RSA->new_public_key($pem); }; + } elsif ($type eq 'priv') { + $key = eval { Crypt::OpenSSL::RSA->new_private_key($pem); }; + } else { + die "Invalid authkey type '$type'\n"; + } + + return { key => $key, mtime => $st->mtime }; + }; + + if (!defined($pve_auth_key_cache->{$type})) { + $pve_auth_key_cache->{$type} = $read_key_and_mtime->(); + } else { + my $st = stat($path); + if (!$st || $st->mtime != $pve_auth_key_cache->{$type}->{mtime}) { + $pve_auth_key_cache->{$type} = $read_key_and_mtime->(); + } + } + + return $pve_auth_key_cache->{$type}; +}; + sub get_pubkey { + my ($old) = @_; + + my $type = $old ? 'pubold' : 'pub'; + + my $res = $cache_read_key->($type); + return undef if !defined($res); + + return wantarray ? ($res->{key}, $res->{mtime}) : $res->{key}; +} + +sub get_privkey { + my $res = $cache_read_key->('priv'); + + if (!defined($res) || !check_authkey(1)) { + rotate_authkey(); + $res = $cache_read_key->('priv'); + } + + return wantarray ? ($res->{key}, $res->{mtime}) : $res->{key}; +} + +sub check_authkey { + my ($quiet) = @_; + + # skip check if non-quorate, as rotation is not possible anyway + return 1 if !PVE::Cluster::check_cfs_quorum(1); + + my ($pub_key, $mtime) = get_pubkey(); + if (!$pub_key) { + warn "auth key pair missing, generating new one..\n" if !$quiet; + return 0; + } else { + if (time() - $mtime >= $authkey_lifetime) { + warn "auth key pair too old, rotating..\n" if !$quiet;; + return 0; + } else { + warn "auth key new enough, skipping rotation\n" if !$quiet;; + return 1; + } + } +} - return $pve_auth_pub_key if $pve_auth_pub_key; +sub rotate_authkey { + return if $authkey_lifetime == 0; - my $input = PVE::Tools::file_get_contents($authpubkeyfn); + PVE::Cluster::cfs_lock_authkey(undef, sub { + # re-check with lock to avoid double rotation in clusters + return if check_authkey(); + + my $old = get_pubkey(); + + if ($old) { + eval { + my $pem = $old->get_public_key_x509_string(); + PVE::Tools::file_set_contents($pve_auth_key_files->{pubold}, $pem); + }; + die "Failed to store old auth key: $@\n" if $@; + } - $pve_auth_pub_key = Crypt::OpenSSL::RSA->new_public_key($input); + my $new = Crypt::OpenSSL::RSA->generate_key(2048); + eval { + my $pem = $new->get_public_key_x509_string(); + PVE::Tools::file_set_contents($pve_auth_key_files->{pub}, $pem); + }; + if ($@) { + if ($old) { + warn "Failed to store new auth key - $@\n"; + warn "Reverting to previous auth key\n"; + eval { + my $pem = $old->get_public_key_x509_string(); + PVE::Tools::file_set_contents($pve_auth_key_files->{pub}, $pem); + }; + die "Failed to restore old auth key: $@\n" if $@; + } else { + die "Failed to store new auth key - $@\n"; + } + } - return $pve_auth_pub_key; + eval { + my $pem = $new->get_private_key_string(); + PVE::Tools::file_set_contents($pve_auth_key_files->{priv}, $pem); + }; + if ($@) { + warn "Failed to store new auth key - $@\n"; + warn "Deleting auth key to force regeneration\n"; + unlink $pve_auth_key_files->{pub}; + unlink $pve_auth_key_files->{priv}; + } + }); + die $@ if $@; } my $csrf_prevention_secret; @@ -103,17 +235,34 @@ sub verify_csrf_prevention_token { $secret, $username, $token, -300, $ticket_lifetime, $noerr); } -my $pve_auth_priv_key; -sub get_privkey { +my $get_ticket_age_range = sub { + my ($now, $mtime, $rotated) = @_; - return $pve_auth_priv_key if $pve_auth_priv_key; + my $key_age = $now - $mtime; + $key_age = 0 if $key_age < 0; - my $input = PVE::Tools::file_get_contents($authprivkeyfn); + my $min = -300; + my $max = $ticket_lifetime; + + if ($rotated) { + # ticket creation after rotation is not allowed + $min = $key_age - 300; + } else { + if ($key_age > $authkey_lifetime && $authkey_lifetime > 0) { + if (PVE::Cluster::check_cfs_quorum(1)) { + # key should have been rotated, clamp range accordingly + $min = $key_age - $authkey_lifetime; + } else { + warn "Cluster not quorate - extending auth key lifetime!\n"; + } + } - $pve_auth_priv_key = Crypt::OpenSSL::RSA->new_private_key($input); + $max = $key_age + 300 if $key_age < $ticket_lifetime; + } - return $pve_auth_priv_key; -} + return undef if $min > $ticket_lifetime; + return ($min, $max); +}; sub assemble_ticket { my ($username) = @_; @@ -126,12 +275,34 @@ sub assemble_ticket { sub verify_ticket { my ($ticket, $noerr) = @_; - my $rsa_pub = get_pubkey(); + my $now = time(); + + my $check = sub { + my ($old) = @_; + + my ($rsa_pub, $rsa_mtime) = get_pubkey($old); + return undef if !$rsa_pub; + + my ($min, $max) = $get_ticket_age_range->($now, $rsa_mtime, $old); + return undef if !$min; + + return PVE::Ticket::verify_rsa_ticket( + $rsa_pub, 'PVE', $ticket, undef, $min, $max, 1); + }; + + my ($username, $age) = $check->(); - my ($username, $age) = PVE::Ticket::verify_rsa_ticket( - $rsa_pub, 'PVE', $ticket, undef, -300, $ticket_lifetime, $noerr); + # check with old, rotated key if current key failed + ($username, $age) = $check->(1) if !defined($username); - return undef if $noerr && !defined($username); + if (!defined($username)) { + if ($noerr) { + return undef; + } else { + # raise error via undef ticket + PVE::Ticket::verify_rsa_ticket(undef, 'PVE'); + } + } return undef if !PVE::Auth::Plugin::verify_username($username, $noerr); @@ -157,10 +328,18 @@ sub assemble_vnc_ticket { sub verify_vnc_ticket { my ($ticket, $username, $path, $noerr) = @_; - my $rsa_pub = get_pubkey(); - my $secret_data = "$username:$path"; + my ($rsa_pub, $rsa_mtime) = get_pubkey(); + if (!$rsa_pub || (time() - $rsa_mtime > $authkey_lifetime && $authkey_lifetime > 0)) { + if ($noerr) { + return undef; + } else { + # raise error via undef ticket + PVE::Ticket::verify_rsa_ticket($rsa_pub, 'PVEVNC'); + } + } + return PVE::Ticket::verify_rsa_ticket( $rsa_pub, 'PVEVNC', $ticket, $secret_data, -20, 40, $noerr); } @@ -174,7 +353,6 @@ sub assemble_spice_ticket { $secret, $username, $vmid, $node); } - sub verify_spice_connect_url { my ($connect_str) = @_; @@ -272,9 +450,7 @@ sub check_user_enabled { } sub verify_one_time_pw { - my ($usercfg, $username, $tfa_cfg, $otp) = @_; - - my $type = $tfa_cfg->{type}; + my ($type, $username, $keys, $tfa_cfg, $otp) = @_; die "missing one time password for two-factor authentication '$type'\n" if !$otp; @@ -282,11 +458,9 @@ sub verify_one_time_pw { my $proxy; if ($type eq 'yubico') { - my $keys = $usercfg->{users}->{$username}->{keys}; PVE::OTP::yubico_verify_otp($otp, $keys, $tfa_cfg->{url}, $tfa_cfg->{id}, $tfa_cfg->{key}, $proxy); } elsif ($type eq 'oath') { - my $keys = $usercfg->{users}->{$username}->{keys}; PVE::OTP::oath_verify_otp($otp, $keys, $tfa_cfg->{step}, $tfa_cfg->{digits}); } else { die "unknown tfa type '$type'\n"; @@ -320,12 +494,22 @@ sub authenticate_user { my $plugin = PVE::Auth::Plugin->lookup($cfg->{type}); $plugin->authenticate_user($cfg, $realm, $ruid, $password); - if ($cfg->{tfa}) { - my $tfa_cfg = PVE::Auth::Plugin::parse_tfa_config($cfg->{tfa}); - verify_one_time_pw($usercfg, $username, $tfa_cfg, $otp); + my $u2f; + + my ($type, $tfa_data) = user_get_tfa($username, $realm); + if ($type) { + if ($type eq 'u2f') { + # Note that if the user did not manage to complete the initial u2f registration + # challenge we have a hash containing a 'challenge' entry in the user's tfa.cfg entry: + $u2f = $tfa_data if !exists $tfa_data->{challenge}; + } else { + my $keys = $tfa_data->{keys}; + my $tfa_cfg = $tfa_data->{config}; + verify_one_time_pw($type, $username, $keys, $tfa_cfg, $otp); + } } - return $username; + return wantarray ? ($username, $u2f) : $username; } sub domain_set_password { @@ -406,6 +590,7 @@ my $privgroups = { 'VM.Migrate', 'VM.Monitor', 'VM.Snapshot', + 'VM.Snapshot.Rollback', ], user => [ 'VM.Config.CDROM', # change CDROM media @@ -502,9 +687,20 @@ sub create_roles { create_roles(); +sub create_priv_properties { + my $properties = {}; + foreach my $priv (keys %$valid_privs) { + $properties->{$priv} = { + type => 'boolean', + optional => 1, + }; + } + return $properties; +} + sub role_is_special { my ($role) = @_; - return exists $special_roles->{$role}; + return (exists $special_roles->{$role}) ? 1 : 0; } sub add_role_privs { @@ -539,7 +735,6 @@ sub normalize_path { return $path; } - PVE::JSONSchema::register_format('pve-groupid', \&verify_groupname); sub verify_groupname { my ($groupname, $noerr) = @_; @@ -568,7 +763,7 @@ sub verify_rolename { return $rolename; } -PVE::JSONSchema::register_format('pve-poolid', \&verify_groupname); +PVE::JSONSchema::register_format('pve-poolid', \&verify_poolname); sub verify_poolname { my ($poolname, $noerr) = @_; @@ -898,6 +1093,64 @@ sub write_user_config { return $data; } +# The TFA configuration in priv/tfa.cfg format contains one line per user of +# the form: +# USER:TYPE:DATA +# DATA is a base64 encoded json string and its format depends on the type. +sub parse_priv_tfa_config { + my ($filename, $raw) = @_; + + my $users = {}; + my $cfg = { users => $users }; + + $raw = '' if !defined($raw); + while ($raw =~ /^\s*(.+?)\s*$/gm) { + my $line = $1; + my ($user, $type, $data) = split(/:/, $line, 3); + + my (undef, undef, $realm) = PVE::Auth::Plugin::verify_username($user, 1); + if (!$realm) { + warn "user tfa config - ignore user '$user' - invalid user name\n"; + next; + } + + $data = decode_json(decode_base64($data)); + + $users->{$user} = { + type => $type, + data => $data, + }; + } + + return $cfg; +} + +sub write_priv_tfa_config { + my ($filename, $cfg) = @_; + + my $output = ''; + + my $users = $cfg->{users}; + foreach my $user (sort keys %$users) { + my $info = $users->{$user}; + next if !%$info; # skip empty entries + + $info = {%$info}; # copy to verify contents: + + my $type = delete $info->{type}; + my $data = delete $info->{data}; + + if (my @keys = keys %$info) { + die "invalid keys in TFA config for user $user: " . join(', ', @keys) . "\n"; + } + + $data = encode_base64(encode_json($data), ''); + $output .= "${user}:${type}:${data}\n"; + } + + return $output; +} + sub roles { my ($cfg, $user, $path) = @_; @@ -1080,8 +1333,124 @@ sub remove_vm_from_pool { lock_user_config($delVMfromPoolFn, "pool cleanup for VM $vmid failed"); } +my $CUSTOM_TFA_TYPES = { + u2f => 1, + oath => 1, +}; + +# Delete an entry by setting $data=undef in which case $type is ignored. +# Otherwise both must be valid. +sub user_set_tfa { + my ($userid, $realm, $type, $data, $cached_usercfg, $cached_domaincfg) = @_; + + if (defined($data) && !defined($type)) { + # This is an internal usage error and should not happen + die "cannot set tfa data without a type\n"; + } + + my $user_cfg = $cached_usercfg || cfs_read_file('user.cfg'); + my $user = $user_cfg->{users}->{$userid} + or die "user '$userid' not found\n"; + + my $domain_cfg = $cached_domaincfg || cfs_read_file('domains.cfg'); + my $realm_cfg = $domain_cfg->{ids}->{$realm}; + die "auth domain '$realm' does not exist\n" if !$realm_cfg; + + my $realm_tfa = $realm_cfg->{tfa}; + if (defined($realm_tfa)) { + $realm_tfa = PVE::Auth::Plugin::parse_tfa_config($realm_tfa); + # If the realm has a TFA setting, we're only allowed to use that. + if (defined($data)) { + my $required_type = $realm_tfa->{type}; + if ($required_type ne $type) { + die "realm '$realm' only allows TFA of type '$required_type\n"; + } + + if (defined($data->{config})) { + # XXX: Is it enough if the type matches? Or should the configuration also match? + } + + # realm-configured tfa always uses a simple key list, so use the user.cfg + $user->{keys} = $data->{keys}; + } else { + die "realm '$realm' does not allow removing the 2nd factor\n"; + } + } else { + # Without a realm-enforced TFA setting the user can add a u2f or totp entry by themselves. + # The 'yubico' type requires yubico server settings, which have to be configured on the + # realm, so this is not supported here: + die "domain '$realm' does not support TFA type '$type'\n" + if defined($data) && !$CUSTOM_TFA_TYPES->{$type}; + } + + # Custom TFA entries are stored in priv/tfa.cfg as they can be more complet: u2f uses a + # public key and a key handle, TOTP requires the usual totp settings... + + my $tfa_cfg = cfs_read_file('priv/tfa.cfg'); + my $tfa = ($tfa_cfg->{users}->{$userid} //= {}); + + if (defined($data)) { + $tfa->{type} = $type; + $tfa->{data} = $data; + cfs_write_file('priv/tfa.cfg', $tfa_cfg); + + $user->{keys} = 'x'; + } else { + delete $tfa_cfg->{users}->{$userid}; + cfs_write_file('priv/tfa.cfg', $tfa_cfg); + + delete $user->{keys}; + } + + cfs_write_file('user.cfg', $user_cfg); +} + +sub user_get_tfa { + my ($username, $realm) = @_; + + my $user_cfg = cfs_read_file('user.cfg'); + my $user = $user_cfg->{users}->{$username} + or die "user '$username' not found\n"; + + my $keys = $user->{keys}; + return if !$keys; + + my $domain_cfg = cfs_read_file('domains.cfg'); + my $realm_cfg = $domain_cfg->{ids}->{$realm}; + die "auth domain '$realm' does not exist\n" if !$realm_cfg; + + my $realm_tfa = $realm_cfg->{tfa}; + $realm_tfa = PVE::Auth::Plugin::parse_tfa_config($realm_tfa) + if $realm_tfa; + + if ($keys ne 'x') { + # old style config, find the type via the realm + return if !$realm_tfa; + return ($realm_tfa->{type}, { + keys => $keys, + config => $realm_tfa, + }); + } else { + my $tfa_cfg = cfs_read_file('priv/tfa.cfg'); + my $tfa = $tfa_cfg->{users}->{$username}; + return if !$tfa; # should not happen (user.cfg wasn't cleaned up?) + + if ($realm_tfa) { + # if the realm has a tfa setting we need to verify the type: + die "auth domain '$realm' and user have mismatching TFA settings\n" + if $realm_tfa && $realm_tfa->{type} ne $tfa->{type}; + } + + return ($tfa->{type}, $tfa->{data}); + } +} + # bash completion helpers +register_standard_option('userid-completed', + get_standard_option('userid', { completion => \&complete_username}), +); + sub complete_username { my $user_cfg = cfs_read_file('user.cfg');