]>
Commit | Line | Data |
---|---|---|
1 | package PVE::AccessControl; | |
2 | ||
3 | use strict; | |
4 | use warnings; | |
5 | use Encode; | |
6 | use Crypt::OpenSSL::Random; | |
7 | use Crypt::OpenSSL::RSA; | |
8 | use Net::SSLeay; | |
9 | use Net::IP; | |
10 | use MIME::Base64; | |
11 | use Digest::SHA; | |
12 | use IO::File; | |
13 | use File::stat; | |
14 | use JSON; | |
15 | ||
16 | use PVE::OTP; | |
17 | use PVE::Ticket; | |
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); | |
21 | ||
22 | use PVE::Auth::Plugin; | |
23 | use PVE::Auth::AD; | |
24 | use PVE::Auth::LDAP; | |
25 | use PVE::Auth::PVE; | |
26 | use PVE::Auth::PAM; | |
27 | ||
28 | # load and initialize all plugins | |
29 | ||
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(); | |
35 | ||
36 | # $authdir must be writable by root only! | |
37 | my $confdir = "/etc/pve"; | |
38 | my $authdir = "$confdir/priv"; | |
39 | ||
40 | my $pve_www_key_fn = "$confdir/pve-www.key"; | |
41 | ||
42 | my $pve_auth_key_files = { | |
43 | priv => "$authdir/authkey.key", | |
44 | pub => "$confdir/authkey.pub", | |
45 | pubold => "$confdir/authkey.pub.old", | |
46 | }; | |
47 | ||
48 | my $pve_auth_key_cache = {}; | |
49 | ||
50 | my $ticket_lifetime = 3600 * 2; # 2 hours | |
51 | my $auth_graceperiod = 60 * 5; # 5 minutes | |
52 | my $authkey_lifetime = 3600 * 24; # rotate every 24 hours | |
53 | ||
54 | Crypt::OpenSSL::RSA->import_random_seed(); | |
55 | ||
56 | cfs_register_file('user.cfg', | |
57 | \&parse_user_config, | |
58 | \&write_user_config); | |
59 | cfs_register_file('priv/tfa.cfg', | |
60 | \&parse_priv_tfa_config, | |
61 | \&write_priv_tfa_config); | |
62 | ||
63 | sub verify_username { | |
64 | PVE::Auth::Plugin::verify_username(@_); | |
65 | } | |
66 | ||
67 | sub pve_verify_realm { | |
68 | PVE::Auth::Plugin::pve_verify_realm(@_); | |
69 | } | |
70 | ||
71 | sub lock_user_config { | |
72 | my ($code, $errmsg) = @_; | |
73 | ||
74 | cfs_lock_file("user.cfg", undef, $code); | |
75 | if (my $err = $@) { | |
76 | $errmsg ? die "$errmsg: $err" : die $err; | |
77 | } | |
78 | } | |
79 | ||
80 | my $cache_read_key = sub { | |
81 | my ($type) = @_; | |
82 | ||
83 | my $path = $pve_auth_key_files->{$type}; | |
84 | ||
85 | my $read_key_and_mtime = sub { | |
86 | my $fh = IO::File->new($path, "r"); | |
87 | ||
88 | return undef if !defined($fh); | |
89 | ||
90 | my $st = stat($fh); | |
91 | my $pem = PVE::Tools::safe_read_from($fh, 0, 0, $path); | |
92 | ||
93 | close $fh; | |
94 | ||
95 | my $key; | |
96 | if ($type eq 'pub' || $type eq 'pubold') { | |
97 | $key = eval { Crypt::OpenSSL::RSA->new_public_key($pem); }; | |
98 | } elsif ($type eq 'priv') { | |
99 | $key = eval { Crypt::OpenSSL::RSA->new_private_key($pem); }; | |
100 | } else { | |
101 | die "Invalid authkey type '$type'\n"; | |
102 | } | |
103 | ||
104 | return { key => $key, mtime => $st->mtime }; | |
105 | }; | |
106 | ||
107 | if (!defined($pve_auth_key_cache->{$type})) { | |
108 | $pve_auth_key_cache->{$type} = $read_key_and_mtime->(); | |
109 | } else { | |
110 | my $st = stat($path); | |
111 | if (!$st || $st->mtime != $pve_auth_key_cache->{$type}->{mtime}) { | |
112 | $pve_auth_key_cache->{$type} = $read_key_and_mtime->(); | |
113 | } | |
114 | } | |
115 | ||
116 | return $pve_auth_key_cache->{$type}; | |
117 | }; | |
118 | ||
119 | sub get_pubkey { | |
120 | my ($old) = @_; | |
121 | ||
122 | my $type = $old ? 'pubold' : 'pub'; | |
123 | ||
124 | my $res = $cache_read_key->($type); | |
125 | return undef if !defined($res); | |
126 | ||
127 | return wantarray ? ($res->{key}, $res->{mtime}) : $res->{key}; | |
128 | } | |
129 | ||
130 | sub get_privkey { | |
131 | my $res = $cache_read_key->('priv'); | |
132 | ||
133 | if (!defined($res) || !check_authkey(1)) { | |
134 | rotate_authkey(); | |
135 | $res = $cache_read_key->('priv'); | |
136 | } | |
137 | ||
138 | return wantarray ? ($res->{key}, $res->{mtime}) : $res->{key}; | |
139 | } | |
140 | ||
141 | sub check_authkey { | |
142 | my ($quiet) = @_; | |
143 | ||
144 | # skip check if non-quorate, as rotation is not possible anyway | |
145 | return 1 if !PVE::Cluster::check_cfs_quorum(1); | |
146 | ||
147 | my ($pub_key, $mtime) = get_pubkey(); | |
148 | if (!$pub_key) { | |
149 | warn "auth key pair missing, generating new one..\n" if !$quiet; | |
150 | return 0; | |
151 | } else { | |
152 | my $now = time(); | |
153 | if ($now - $mtime >= $authkey_lifetime) { | |
154 | warn "auth key pair too old, rotating..\n" if !$quiet;; | |
155 | return 0; | |
156 | } elsif ($mtime > $now + $auth_graceperiod) { | |
157 | # a nodes RTC had a time set in the future during key generation -> ticket | |
158 | # validity is clamped to 0+5 min grace period until now >= mtime again | |
159 | my (undef, $old_mtime) = get_pubkey(1); | |
160 | if ($old_mtime && $mtime >= $old_mtime && $mtime - $old_mtime < $ticket_lifetime) { | |
161 | warn "auth key pair generated in the future (key $mtime > host $now)," | |
162 | ." but old key still exists and in valid grace period so avoid automatic" | |
163 | ." fixup. Cluster time not in sync?\n" if !$quiet; | |
164 | return 1; | |
165 | } | |
166 | warn "auth key pair generated in the future (key $mtime > host $now), rotating..\n" if !$quiet; | |
167 | return 0; | |
168 | } else { | |
169 | warn "auth key new enough, skipping rotation\n" if !$quiet;; | |
170 | return 1; | |
171 | } | |
172 | } | |
173 | } | |
174 | ||
175 | sub rotate_authkey { | |
176 | return if $authkey_lifetime == 0; | |
177 | ||
178 | PVE::Cluster::cfs_lock_authkey(undef, sub { | |
179 | # re-check with lock to avoid double rotation in clusters | |
180 | return if check_authkey(); | |
181 | ||
182 | my $old = get_pubkey(); | |
183 | my $new = Crypt::OpenSSL::RSA->generate_key(2048); | |
184 | ||
185 | if ($old) { | |
186 | eval { | |
187 | my $pem = $old->get_public_key_x509_string(); | |
188 | # mtime is used for caching and ticket age range calculation | |
189 | PVE::Tools::file_set_contents($pve_auth_key_files->{pubold}, $pem); | |
190 | }; | |
191 | die "Failed to store old auth key: $@\n" if $@; | |
192 | } | |
193 | ||
194 | eval { | |
195 | my $pem = $new->get_public_key_x509_string(); | |
196 | # mtime is used for caching and ticket age range calculation, | |
197 | # should be close to that of pubold above | |
198 | PVE::Tools::file_set_contents($pve_auth_key_files->{pub}, $pem); | |
199 | }; | |
200 | if ($@) { | |
201 | if ($old) { | |
202 | warn "Failed to store new auth key - $@\n"; | |
203 | warn "Reverting to previous auth key\n"; | |
204 | eval { | |
205 | my $pem = $old->get_public_key_x509_string(); | |
206 | PVE::Tools::file_set_contents($pve_auth_key_files->{pub}, $pem); | |
207 | }; | |
208 | die "Failed to restore old auth key: $@\n" if $@; | |
209 | } else { | |
210 | die "Failed to store new auth key - $@\n"; | |
211 | } | |
212 | } | |
213 | ||
214 | eval { | |
215 | my $pem = $new->get_private_key_string(); | |
216 | PVE::Tools::file_set_contents($pve_auth_key_files->{priv}, $pem); | |
217 | }; | |
218 | if ($@) { | |
219 | warn "Failed to store new auth key - $@\n"; | |
220 | warn "Deleting auth key to force regeneration\n"; | |
221 | unlink $pve_auth_key_files->{pub}; | |
222 | unlink $pve_auth_key_files->{priv}; | |
223 | } | |
224 | }); | |
225 | die $@ if $@; | |
226 | } | |
227 | ||
228 | PVE::JSONSchema::register_standard_option('tokenid', { | |
229 | description => "API token identifier.", | |
230 | type => "string", | |
231 | format => "pve-tokenid", | |
232 | }); | |
233 | ||
234 | our $token_subid_regex = $PVE::Auth::Plugin::realm_regex; | |
235 | ||
236 | # username@realm username realm tokenid | |
237 | our $token_full_regex = qr/((${PVE::Auth::Plugin::user_regex})\@(${PVE::Auth::Plugin::realm_regex}))!(${token_subid_regex})/; | |
238 | ||
239 | our $userid_or_token_regex = qr/^$PVE::Auth::Plugin::user_regex\@$PVE::Auth::Plugin::realm_regex(?:!$token_subid_regex)?$/; | |
240 | ||
241 | sub split_tokenid { | |
242 | my ($tokenid, $noerr) = @_; | |
243 | ||
244 | if ($tokenid =~ /^${token_full_regex}$/) { | |
245 | return ($1, $4); | |
246 | } | |
247 | ||
248 | die "'$tokenid' is not a valid token ID - not able to split into user and token parts\n" if !$noerr; | |
249 | ||
250 | return undef; | |
251 | } | |
252 | ||
253 | sub join_tokenid { | |
254 | my ($username, $tokensubid) = @_; | |
255 | ||
256 | my $joined = "${username}!${tokensubid}"; | |
257 | ||
258 | return pve_verify_tokenid($joined); | |
259 | } | |
260 | ||
261 | PVE::JSONSchema::register_format('pve-tokenid', \&pve_verify_tokenid); | |
262 | sub pve_verify_tokenid { | |
263 | my ($tokenid, $noerr) = @_; | |
264 | ||
265 | if ($tokenid =~ /^${token_full_regex}$/) { | |
266 | return wantarray ? ($tokenid, $2, $3, $4) : $tokenid; | |
267 | } | |
268 | ||
269 | die "value '$tokenid' does not look like a valid token ID\n" if !$noerr; | |
270 | ||
271 | return undef; | |
272 | } | |
273 | ||
274 | ||
275 | my $csrf_prevention_secret; | |
276 | my $csrf_prevention_secret_legacy; | |
277 | my $get_csrfr_secret = sub { | |
278 | if (!$csrf_prevention_secret) { | |
279 | my $input = PVE::Tools::file_get_contents($pve_www_key_fn); | |
280 | $csrf_prevention_secret = Digest::SHA::hmac_sha256_base64($input); | |
281 | $csrf_prevention_secret_legacy = Digest::SHA::sha1_base64($input); | |
282 | } | |
283 | return $csrf_prevention_secret; | |
284 | }; | |
285 | ||
286 | sub assemble_csrf_prevention_token { | |
287 | my ($username) = @_; | |
288 | ||
289 | my $secret = &$get_csrfr_secret(); | |
290 | ||
291 | return PVE::Ticket::assemble_csrf_prevention_token ($secret, $username); | |
292 | } | |
293 | ||
294 | sub verify_csrf_prevention_token { | |
295 | my ($username, $token, $noerr) = @_; | |
296 | ||
297 | my $secret = $get_csrfr_secret->(); | |
298 | ||
299 | # FIXME: remove with PVE 7 and/or refactor all into PVE::Ticket ? | |
300 | if ($token =~ m/^([A-Z0-9]{8}):(\S+)$/) { | |
301 | my $sig = $2; | |
302 | if (length($sig) == 27) { | |
303 | # the legacy secret got populated by above get_csrfr_secret call | |
304 | $secret = $csrf_prevention_secret_legacy; | |
305 | } | |
306 | } | |
307 | ||
308 | return PVE::Ticket::verify_csrf_prevention_token( | |
309 | $secret, $username, $token, -$auth_graceperiod, $ticket_lifetime, $noerr); | |
310 | } | |
311 | ||
312 | my $get_ticket_age_range = sub { | |
313 | my ($now, $mtime, $rotated) = @_; | |
314 | ||
315 | my $key_age = $now - $mtime; | |
316 | $key_age = 0 if $key_age < 0; | |
317 | ||
318 | my $min = -$auth_graceperiod; | |
319 | my $max = $ticket_lifetime; | |
320 | ||
321 | if ($rotated) { | |
322 | # ticket creation after rotation is not allowed | |
323 | $min = $key_age - $auth_graceperiod; | |
324 | } else { | |
325 | if ($key_age > $authkey_lifetime && $authkey_lifetime > 0) { | |
326 | if (PVE::Cluster::check_cfs_quorum(1)) { | |
327 | # key should have been rotated, clamp range accordingly | |
328 | $min = $key_age - $authkey_lifetime; | |
329 | } else { | |
330 | warn "Cluster not quorate - extending auth key lifetime!\n"; | |
331 | } | |
332 | } | |
333 | ||
334 | $max = $key_age + $auth_graceperiod if $key_age < $ticket_lifetime; | |
335 | } | |
336 | ||
337 | return undef if $min > $ticket_lifetime; | |
338 | return ($min, $max); | |
339 | }; | |
340 | ||
341 | sub assemble_ticket { | |
342 | my ($data) = @_; | |
343 | ||
344 | my $rsa_priv = get_privkey(); | |
345 | ||
346 | return PVE::Ticket::assemble_rsa_ticket($rsa_priv, 'PVE', $data); | |
347 | } | |
348 | ||
349 | sub verify_ticket { | |
350 | my ($ticket, $noerr) = @_; | |
351 | ||
352 | my $now = time(); | |
353 | ||
354 | my $check = sub { | |
355 | my ($old) = @_; | |
356 | ||
357 | my ($rsa_pub, $rsa_mtime) = get_pubkey($old); | |
358 | return undef if !$rsa_pub; | |
359 | ||
360 | my ($min, $max) = $get_ticket_age_range->($now, $rsa_mtime, $old); | |
361 | return undef if !defined($min); | |
362 | ||
363 | return PVE::Ticket::verify_rsa_ticket( | |
364 | $rsa_pub, 'PVE', $ticket, undef, $min, $max, 1); | |
365 | }; | |
366 | ||
367 | my ($data, $age) = $check->(); | |
368 | ||
369 | # check with old, rotated key if current key failed | |
370 | ($data, $age) = $check->(1) if !defined($data); | |
371 | ||
372 | my $auth_failure = sub { | |
373 | if ($noerr) { | |
374 | return undef; | |
375 | } else { | |
376 | # raise error via undef ticket | |
377 | PVE::Ticket::verify_rsa_ticket(undef, 'PVE'); | |
378 | } | |
379 | }; | |
380 | ||
381 | if (!defined($data)) { | |
382 | return $auth_failure->(); | |
383 | } | |
384 | ||
385 | my ($username, $tfa_info); | |
386 | if ($data =~ m{^u2f!([^!]+)!([0-9a-zA-Z/.=_\-+]+)$}) { | |
387 | # Ticket for u2f-users: | |
388 | ($username, my $challenge) = ($1, $2); | |
389 | if ($challenge eq 'verified') { | |
390 | # u2f challenge was completed | |
391 | $challenge = undef; | |
392 | } elsif (!wantarray) { | |
393 | # The caller is not aware there could be an ongoing challenge, | |
394 | # so we treat this ticket as invalid: | |
395 | return $auth_failure->(); | |
396 | } | |
397 | $tfa_info = { | |
398 | type => 'u2f', | |
399 | challenge => $challenge, | |
400 | }; | |
401 | } elsif ($data =~ /^tfa!(.*)$/) { | |
402 | # TOTP and Yubico don't require a challenge so this is the generic | |
403 | # 'missing 2nd factor ticket' | |
404 | $username = $1; | |
405 | $tfa_info = { type => 'tfa' }; | |
406 | } else { | |
407 | # Regular ticket (full access) | |
408 | $username = $data; | |
409 | } | |
410 | ||
411 | return undef if !PVE::Auth::Plugin::verify_username($username, $noerr); | |
412 | ||
413 | return wantarray ? ($username, $age, $tfa_info) : $username; | |
414 | } | |
415 | ||
416 | sub verify_token { | |
417 | my ($api_token) = @_; | |
418 | ||
419 | die "no API token specified\n" if !$api_token; | |
420 | ||
421 | my ($tokenid, $value); | |
422 | if ($api_token =~ /^(.*)=(.*)$/) { | |
423 | $tokenid = $1; | |
424 | $value = $2; | |
425 | } else { | |
426 | die "no tokenid specified\n"; | |
427 | } | |
428 | ||
429 | my ($username, $token) = split_tokenid($tokenid); | |
430 | ||
431 | my $usercfg = cfs_read_file('user.cfg'); | |
432 | check_user_enabled($usercfg, $username); | |
433 | check_token_exist($usercfg, $username, $token); | |
434 | ||
435 | my $ctime = time(); | |
436 | ||
437 | my $user = $usercfg->{users}->{$username}; | |
438 | die "account expired\n" if $user->{expire} && ($user->{expire} < $ctime); | |
439 | ||
440 | my $token_info = $user->{tokens}->{$token}; | |
441 | die "token expired\n" if $token_info->{expire} && ($token_info->{expire} < $ctime); | |
442 | ||
443 | die "invalid token value!\n" if !PVE::Cluster::verify_token($tokenid, $value); | |
444 | ||
445 | return wantarray ? ($tokenid) : $tokenid; | |
446 | } | |
447 | ||
448 | ||
449 | # VNC tickets | |
450 | # - they do not contain the username in plain text | |
451 | # - they are restricted to a specific resource path (example: '/vms/100') | |
452 | sub assemble_vnc_ticket { | |
453 | my ($username, $path) = @_; | |
454 | ||
455 | my $rsa_priv = get_privkey(); | |
456 | ||
457 | $path = normalize_path($path); | |
458 | ||
459 | my $secret_data = "$username:$path"; | |
460 | ||
461 | return PVE::Ticket::assemble_rsa_ticket( | |
462 | $rsa_priv, 'PVEVNC', undef, $secret_data); | |
463 | } | |
464 | ||
465 | sub verify_vnc_ticket { | |
466 | my ($ticket, $username, $path, $noerr) = @_; | |
467 | ||
468 | my $secret_data = "$username:$path"; | |
469 | ||
470 | my ($rsa_pub, $rsa_mtime) = get_pubkey(); | |
471 | if (!$rsa_pub || (time() - $rsa_mtime > $authkey_lifetime && $authkey_lifetime > 0)) { | |
472 | if ($noerr) { | |
473 | return undef; | |
474 | } else { | |
475 | # raise error via undef ticket | |
476 | PVE::Ticket::verify_rsa_ticket($rsa_pub, 'PVEVNC'); | |
477 | } | |
478 | } | |
479 | ||
480 | return PVE::Ticket::verify_rsa_ticket( | |
481 | $rsa_pub, 'PVEVNC', $ticket, $secret_data, -20, 40, $noerr); | |
482 | } | |
483 | ||
484 | sub assemble_spice_ticket { | |
485 | my ($username, $vmid, $node) = @_; | |
486 | ||
487 | my $secret = &$get_csrfr_secret(); | |
488 | ||
489 | return PVE::Ticket::assemble_spice_ticket( | |
490 | $secret, $username, $vmid, $node); | |
491 | } | |
492 | ||
493 | sub verify_spice_connect_url { | |
494 | my ($connect_str) = @_; | |
495 | ||
496 | my $secret = &$get_csrfr_secret(); | |
497 | ||
498 | return PVE::Ticket::verify_spice_connect_url($secret, $connect_str); | |
499 | } | |
500 | ||
501 | sub read_x509_subject_spice { | |
502 | my ($filename) = @_; | |
503 | ||
504 | # read x509 subject | |
505 | my $bio = Net::SSLeay::BIO_new_file($filename, 'r'); | |
506 | die "Could not open $filename using OpenSSL\n" | |
507 | if !$bio; | |
508 | ||
509 | my $x509 = Net::SSLeay::PEM_read_bio_X509($bio); | |
510 | Net::SSLeay::BIO_free($bio); | |
511 | ||
512 | die "Could not parse X509 certificate in $filename\n" | |
513 | if !$x509; | |
514 | ||
515 | my $nameobj = Net::SSLeay::X509_get_subject_name($x509); | |
516 | my $subject = Net::SSLeay::X509_NAME_oneline($nameobj); | |
517 | Net::SSLeay::X509_free($x509); | |
518 | ||
519 | # remote-viewer wants comma as seperator (not '/') | |
520 | $subject =~ s!^/!!; | |
521 | $subject =~ s!/(\w+=)!,$1!g; | |
522 | ||
523 | return $subject; | |
524 | } | |
525 | ||
526 | # helper to generate SPICE remote-viewer configuration | |
527 | sub remote_viewer_config { | |
528 | my ($authuser, $vmid, $node, $proxy, $title, $port) = @_; | |
529 | ||
530 | if (!$proxy) { | |
531 | my $host = `hostname -f` || PVE::INotify::nodename(); | |
532 | chomp $host; | |
533 | $proxy = $host; | |
534 | } | |
535 | ||
536 | my ($ticket, $proxyticket) = assemble_spice_ticket($authuser, $vmid, $node); | |
537 | ||
538 | my $filename = "/etc/pve/local/pve-ssl.pem"; | |
539 | my $subject = read_x509_subject_spice($filename); | |
540 | ||
541 | my $cacert = PVE::Tools::file_get_contents("/etc/pve/pve-root-ca.pem", 8192); | |
542 | $cacert =~ s/\n/\\n/g; | |
543 | ||
544 | $proxy = "[$proxy]" if Net::IP::ip_is_ipv6($proxy); | |
545 | my $config = { | |
546 | 'secure-attention' => "Ctrl+Alt+Ins", | |
547 | 'toggle-fullscreen' => "Shift+F11", | |
548 | 'release-cursor' => "Ctrl+Alt+R", | |
549 | type => 'spice', | |
550 | title => $title, | |
551 | host => $proxyticket, # this breaks tls hostname verification, so we need to use 'host-subject' | |
552 | proxy => "http://$proxy:3128", | |
553 | 'tls-port' => $port, | |
554 | 'host-subject' => $subject, | |
555 | ca => $cacert, | |
556 | password => $ticket, | |
557 | 'delete-this-file' => 1, | |
558 | }; | |
559 | ||
560 | return ($ticket, $proxyticket, $config); | |
561 | } | |
562 | ||
563 | sub check_user_exist { | |
564 | my ($usercfg, $username, $noerr) = @_; | |
565 | ||
566 | $username = PVE::Auth::Plugin::verify_username($username, $noerr); | |
567 | return undef if !$username; | |
568 | ||
569 | return $usercfg->{users}->{$username} if $usercfg && $usercfg->{users}->{$username}; | |
570 | ||
571 | die "no such user ('$username')\n" if !$noerr; | |
572 | ||
573 | return undef; | |
574 | } | |
575 | ||
576 | sub check_user_enabled { | |
577 | my ($usercfg, $username, $noerr) = @_; | |
578 | ||
579 | my $data = check_user_exist($usercfg, $username, $noerr); | |
580 | return undef if !$data; | |
581 | ||
582 | return 1 if $data->{enable}; | |
583 | ||
584 | die "user '$username' is disabled\n" if !$noerr; | |
585 | ||
586 | return undef; | |
587 | } | |
588 | ||
589 | sub check_token_exist { | |
590 | my ($usercfg, $username, $tokenid, $noerr) = @_; | |
591 | ||
592 | my $user = check_user_exist($usercfg, $username, $noerr); | |
593 | return undef if !$user; | |
594 | ||
595 | return $user->{tokens}->{$tokenid} | |
596 | if defined($user->{tokens}) && $user->{tokens}->{$tokenid}; | |
597 | ||
598 | die "no such token '$tokenid' for user '$username'\n" if !$noerr; | |
599 | ||
600 | return undef; | |
601 | } | |
602 | ||
603 | sub verify_one_time_pw { | |
604 | my ($type, $username, $keys, $tfa_cfg, $otp) = @_; | |
605 | ||
606 | die "missing one time password for two-factor authentication '$type'\n" if !$otp; | |
607 | ||
608 | # fixme: proxy support? | |
609 | my $proxy; | |
610 | ||
611 | if ($type eq 'yubico') { | |
612 | PVE::OTP::yubico_verify_otp($otp, $keys, $tfa_cfg->{url}, | |
613 | $tfa_cfg->{id}, $tfa_cfg->{key}, $proxy); | |
614 | } elsif ($type eq 'oath') { | |
615 | PVE::OTP::oath_verify_otp($otp, $keys, $tfa_cfg->{step}, $tfa_cfg->{digits}); | |
616 | } else { | |
617 | die "unknown tfa type '$type'\n"; | |
618 | } | |
619 | } | |
620 | ||
621 | # password should be utf8 encoded | |
622 | # Note: some plugins delay/sleep if auth fails | |
623 | sub authenticate_user { | |
624 | my ($username, $password, $otp) = @_; | |
625 | ||
626 | die "no username specified\n" if !$username; | |
627 | ||
628 | my ($ruid, $realm); | |
629 | ||
630 | ($username, $ruid, $realm) = PVE::Auth::Plugin::verify_username($username); | |
631 | ||
632 | my $usercfg = cfs_read_file('user.cfg'); | |
633 | ||
634 | check_user_enabled($usercfg, $username); | |
635 | ||
636 | my $ctime = time(); | |
637 | my $expire = $usercfg->{users}->{$username}->{expire}; | |
638 | ||
639 | die "account expired\n" if $expire && ($expire < $ctime); | |
640 | ||
641 | my $domain_cfg = cfs_read_file('domains.cfg'); | |
642 | ||
643 | my $cfg = $domain_cfg->{ids}->{$realm}; | |
644 | die "auth domain '$realm' does not exist\n" if !$cfg; | |
645 | my $plugin = PVE::Auth::Plugin->lookup($cfg->{type}); | |
646 | $plugin->authenticate_user($cfg, $realm, $ruid, $password); | |
647 | ||
648 | my ($type, $tfa_data) = user_get_tfa($username, $realm); | |
649 | if ($type) { | |
650 | if ($type eq 'u2f') { | |
651 | # Note that if the user did not manage to complete the initial u2f registration | |
652 | # challenge we have a hash containing a 'challenge' entry in the user's tfa.cfg entry: | |
653 | $tfa_data = undef if exists $tfa_data->{challenge}; | |
654 | } elsif (!defined($otp)) { | |
655 | # The user requires a 2nd factor but has not provided one. Return success but | |
656 | # don't clear $tfa_data. | |
657 | } else { | |
658 | my $keys = $tfa_data->{keys}; | |
659 | my $tfa_cfg = $tfa_data->{config}; | |
660 | verify_one_time_pw($type, $username, $keys, $tfa_cfg, $otp); | |
661 | $tfa_data = undef; | |
662 | } | |
663 | ||
664 | # Return the type along with the rest: | |
665 | if ($tfa_data) { | |
666 | $tfa_data = { | |
667 | type => $type, | |
668 | data => $tfa_data, | |
669 | }; | |
670 | } | |
671 | } | |
672 | ||
673 | return wantarray ? ($username, $tfa_data) : $username; | |
674 | } | |
675 | ||
676 | sub domain_set_password { | |
677 | my ($realm, $username, $password) = @_; | |
678 | ||
679 | die "no auth domain specified" if !$realm; | |
680 | ||
681 | my $domain_cfg = cfs_read_file('domains.cfg'); | |
682 | ||
683 | my $cfg = $domain_cfg->{ids}->{$realm}; | |
684 | die "auth domain '$realm' does not exist\n" if !$cfg; | |
685 | my $plugin = PVE::Auth::Plugin->lookup($cfg->{type}); | |
686 | $plugin->store_password($cfg, $realm, $username, $password); | |
687 | } | |
688 | ||
689 | sub add_user_group { | |
690 | my ($username, $usercfg, $group) = @_; | |
691 | ||
692 | $usercfg->{users}->{$username}->{groups}->{$group} = 1; | |
693 | $usercfg->{groups}->{$group}->{users}->{$username} = 1; | |
694 | } | |
695 | ||
696 | sub delete_user_group { | |
697 | my ($username, $usercfg) = @_; | |
698 | ||
699 | foreach my $group (keys %{$usercfg->{groups}}) { | |
700 | ||
701 | delete ($usercfg->{groups}->{$group}->{users}->{$username}) | |
702 | if $usercfg->{groups}->{$group}->{users}->{$username}; | |
703 | } | |
704 | } | |
705 | ||
706 | sub delete_user_acl { | |
707 | my ($username, $usercfg) = @_; | |
708 | ||
709 | foreach my $acl (keys %{$usercfg->{acl}}) { | |
710 | ||
711 | delete ($usercfg->{acl}->{$acl}->{users}->{$username}) | |
712 | if $usercfg->{acl}->{$acl}->{users}->{$username}; | |
713 | } | |
714 | } | |
715 | ||
716 | sub delete_group_acl { | |
717 | my ($group, $usercfg) = @_; | |
718 | ||
719 | foreach my $acl (keys %{$usercfg->{acl}}) { | |
720 | ||
721 | delete ($usercfg->{acl}->{$acl}->{groups}->{$group}) | |
722 | if $usercfg->{acl}->{$acl}->{groups}->{$group}; | |
723 | } | |
724 | } | |
725 | ||
726 | sub delete_pool_acl { | |
727 | my ($pool, $usercfg) = @_; | |
728 | ||
729 | my $path = "/pool/$pool"; | |
730 | ||
731 | delete ($usercfg->{acl}->{$path}) | |
732 | } | |
733 | ||
734 | # we automatically create some predefined roles by splitting privs | |
735 | # into 3 groups (per category) | |
736 | # root: only root is allowed to do that | |
737 | # admin: an administrator can to that | |
738 | # user: a normal user/customer can to that | |
739 | my $privgroups = { | |
740 | VM => { | |
741 | root => [], | |
742 | admin => [ | |
743 | 'VM.Config.Disk', | |
744 | 'VM.Config.CPU', | |
745 | 'VM.Config.Memory', | |
746 | 'VM.Config.Network', | |
747 | 'VM.Config.HWType', | |
748 | 'VM.Config.Options', # covers all other things | |
749 | 'VM.Allocate', | |
750 | 'VM.Clone', | |
751 | 'VM.Migrate', | |
752 | 'VM.Monitor', | |
753 | 'VM.Snapshot', | |
754 | 'VM.Snapshot.Rollback', | |
755 | ], | |
756 | user => [ | |
757 | 'VM.Config.CDROM', # change CDROM media | |
758 | 'VM.Config.Cloudinit', | |
759 | 'VM.Console', | |
760 | 'VM.Backup', | |
761 | 'VM.PowerMgmt', | |
762 | ], | |
763 | audit => [ | |
764 | 'VM.Audit', | |
765 | ], | |
766 | }, | |
767 | Sys => { | |
768 | root => [ | |
769 | 'Sys.PowerMgmt', | |
770 | 'Sys.Modify', # edit/change node settings | |
771 | ], | |
772 | admin => [ | |
773 | 'Permissions.Modify', | |
774 | 'Sys.Console', | |
775 | 'Sys.Syslog', | |
776 | ], | |
777 | user => [], | |
778 | audit => [ | |
779 | 'Sys.Audit', | |
780 | ], | |
781 | }, | |
782 | Datastore => { | |
783 | root => [], | |
784 | admin => [ | |
785 | 'Datastore.Allocate', | |
786 | 'Datastore.AllocateTemplate', | |
787 | ], | |
788 | user => [ | |
789 | 'Datastore.AllocateSpace', | |
790 | ], | |
791 | audit => [ | |
792 | 'Datastore.Audit', | |
793 | ], | |
794 | }, | |
795 | SDN => { | |
796 | root => [], | |
797 | admin => [ | |
798 | 'SDN.Allocate', | |
799 | 'SDN.Audit', | |
800 | ], | |
801 | audit => [ | |
802 | 'SDN.Audit', | |
803 | ], | |
804 | }, | |
805 | User => { | |
806 | root => [ | |
807 | 'Realm.Allocate', | |
808 | ], | |
809 | admin => [ | |
810 | 'User.Modify', | |
811 | 'Group.Allocate', # edit/change group settings | |
812 | 'Realm.AllocateUser', | |
813 | ], | |
814 | user => [], | |
815 | audit => [], | |
816 | }, | |
817 | Pool => { | |
818 | root => [], | |
819 | admin => [ | |
820 | 'Pool.Allocate', # create/delete pools | |
821 | ], | |
822 | user => [], | |
823 | audit => [], | |
824 | }, | |
825 | }; | |
826 | ||
827 | my $valid_privs = {}; | |
828 | ||
829 | my $special_roles = { | |
830 | 'NoAccess' => {}, # no privileges | |
831 | 'Administrator' => $valid_privs, # all privileges | |
832 | }; | |
833 | ||
834 | sub create_roles { | |
835 | ||
836 | foreach my $cat (keys %$privgroups) { | |
837 | my $cd = $privgroups->{$cat}; | |
838 | foreach my $p (@{$cd->{root}}, @{$cd->{admin}}, | |
839 | @{$cd->{user}}, @{$cd->{audit}}) { | |
840 | $valid_privs->{$p} = 1; | |
841 | } | |
842 | foreach my $p (@{$cd->{admin}}, @{$cd->{user}}, @{$cd->{audit}}) { | |
843 | ||
844 | $special_roles->{"PVE${cat}Admin"}->{$p} = 1; | |
845 | $special_roles->{"PVEAdmin"}->{$p} = 1; | |
846 | } | |
847 | if (scalar(@{$cd->{user}})) { | |
848 | foreach my $p (@{$cd->{user}}, @{$cd->{audit}}) { | |
849 | $special_roles->{"PVE${cat}User"}->{$p} = 1; | |
850 | } | |
851 | } | |
852 | foreach my $p (@{$cd->{audit}}) { | |
853 | $special_roles->{"PVEAuditor"}->{$p} = 1; | |
854 | } | |
855 | } | |
856 | ||
857 | $special_roles->{"PVETemplateUser"} = { 'VM.Clone' => 1, 'VM.Audit' => 1 }; | |
858 | }; | |
859 | ||
860 | create_roles(); | |
861 | ||
862 | sub create_priv_properties { | |
863 | my $properties = {}; | |
864 | foreach my $priv (keys %$valid_privs) { | |
865 | $properties->{$priv} = { | |
866 | type => 'boolean', | |
867 | optional => 1, | |
868 | }; | |
869 | } | |
870 | return $properties; | |
871 | } | |
872 | ||
873 | sub role_is_special { | |
874 | my ($role) = @_; | |
875 | return (exists $special_roles->{$role}) ? 1 : 0; | |
876 | } | |
877 | ||
878 | sub add_role_privs { | |
879 | my ($role, $usercfg, $privs) = @_; | |
880 | ||
881 | return if !$privs; | |
882 | ||
883 | die "role '$role' does not exist\n" if !$usercfg->{roles}->{$role}; | |
884 | ||
885 | foreach my $priv (split_list($privs)) { | |
886 | if (defined ($valid_privs->{$priv})) { | |
887 | $usercfg->{roles}->{$role}->{$priv} = 1; | |
888 | } else { | |
889 | die "invalid privilege '$priv'\n"; | |
890 | } | |
891 | } | |
892 | } | |
893 | ||
894 | sub normalize_path { | |
895 | my $path = shift; | |
896 | ||
897 | $path =~ s|/+|/|g; | |
898 | ||
899 | $path =~ s|/$||; | |
900 | ||
901 | $path = '/' if !$path; | |
902 | ||
903 | $path = "/$path" if $path !~ m|^/|; | |
904 | ||
905 | return undef if $path !~ m|^[[:alnum:]\.\-\_\/]+$|; | |
906 | ||
907 | return $path; | |
908 | } | |
909 | ||
910 | PVE::JSONSchema::register_format('pve-groupid', \&verify_groupname); | |
911 | sub verify_groupname { | |
912 | my ($groupname, $noerr) = @_; | |
913 | ||
914 | if ($groupname !~ m/^[A-Za-z0-9\.\-_]+$/) { | |
915 | ||
916 | die "group name '$groupname' contains invalid characters\n" if !$noerr; | |
917 | ||
918 | return undef; | |
919 | } | |
920 | ||
921 | return $groupname; | |
922 | } | |
923 | ||
924 | PVE::JSONSchema::register_format('pve-roleid', \&verify_rolename); | |
925 | sub verify_rolename { | |
926 | my ($rolename, $noerr) = @_; | |
927 | ||
928 | if ($rolename !~ m/^[A-Za-z0-9\.\-_]+$/) { | |
929 | ||
930 | die "role name '$rolename' contains invalid characters\n" if !$noerr; | |
931 | ||
932 | return undef; | |
933 | } | |
934 | ||
935 | return $rolename; | |
936 | } | |
937 | ||
938 | PVE::JSONSchema::register_format('pve-poolid', \&verify_poolname); | |
939 | sub verify_poolname { | |
940 | my ($poolname, $noerr) = @_; | |
941 | ||
942 | if ($poolname !~ m/^[A-Za-z0-9\.\-_]+$/) { | |
943 | ||
944 | die "pool name '$poolname' contains invalid characters\n" if !$noerr; | |
945 | ||
946 | return undef; | |
947 | } | |
948 | ||
949 | return $poolname; | |
950 | } | |
951 | ||
952 | PVE::JSONSchema::register_format('pve-priv', \&verify_privname); | |
953 | sub verify_privname { | |
954 | my ($priv, $noerr) = @_; | |
955 | ||
956 | if (!$valid_privs->{$priv}) { | |
957 | die "invalid privilege '$priv'\n" if !$noerr; | |
958 | ||
959 | return undef; | |
960 | } | |
961 | ||
962 | return $priv; | |
963 | } | |
964 | ||
965 | sub userconfig_force_defaults { | |
966 | my ($cfg) = @_; | |
967 | ||
968 | foreach my $r (keys %$special_roles) { | |
969 | $cfg->{roles}->{$r} = $special_roles->{$r}; | |
970 | } | |
971 | ||
972 | # add root user if not exists | |
973 | if (!$cfg->{users}->{'root@pam'}) { | |
974 | $cfg->{users}->{'root@pam'}->{enable} = 1; | |
975 | } | |
976 | } | |
977 | ||
978 | sub parse_user_config { | |
979 | my ($filename, $raw) = @_; | |
980 | ||
981 | my $cfg = {}; | |
982 | ||
983 | userconfig_force_defaults($cfg); | |
984 | ||
985 | $raw = '' if !defined($raw); | |
986 | while ($raw =~ /^\s*(.+?)\s*$/gm) { | |
987 | my $line = $1; | |
988 | my @data; | |
989 | ||
990 | foreach my $d (split (/:/, $line)) { | |
991 | $d =~ s/^\s+//; | |
992 | $d =~ s/\s+$//; | |
993 | push @data, $d | |
994 | } | |
995 | ||
996 | my $et = shift @data; | |
997 | ||
998 | if ($et eq 'user') { | |
999 | my ($user, $enable, $expire, $firstname, $lastname, $email, $comment, $keys) = @data; | |
1000 | ||
1001 | my (undef, undef, $realm) = PVE::Auth::Plugin::verify_username($user, 1); | |
1002 | if (!$realm) { | |
1003 | warn "user config - ignore user '$user' - invalid user name\n"; | |
1004 | next; | |
1005 | } | |
1006 | ||
1007 | $enable = $enable ? 1 : 0; | |
1008 | ||
1009 | $expire = 0 if !$expire; | |
1010 | ||
1011 | if ($expire !~ m/^\d+$/) { | |
1012 | warn "user config - ignore user '$user' - (illegal characters in expire '$expire')\n"; | |
1013 | next; | |
1014 | } | |
1015 | $expire = int($expire); | |
1016 | ||
1017 | #if (!verify_groupname ($group, 1)) { | |
1018 | # warn "user config - ignore user '$user' - invalid characters in group name\n"; | |
1019 | # next; | |
1020 | #} | |
1021 | ||
1022 | $cfg->{users}->{$user} = { | |
1023 | enable => $enable, | |
1024 | # group => $group, | |
1025 | }; | |
1026 | $cfg->{users}->{$user}->{firstname} = PVE::Tools::decode_text($firstname) if $firstname; | |
1027 | $cfg->{users}->{$user}->{lastname} = PVE::Tools::decode_text($lastname) if $lastname; | |
1028 | $cfg->{users}->{$user}->{email} = $email; | |
1029 | $cfg->{users}->{$user}->{comment} = PVE::Tools::decode_text($comment) if $comment; | |
1030 | $cfg->{users}->{$user}->{expire} = $expire; | |
1031 | # keys: allowed yubico key ids or oath secrets (base32 encoded) | |
1032 | $cfg->{users}->{$user}->{keys} = $keys if $keys; | |
1033 | ||
1034 | #$cfg->{users}->{$user}->{groups}->{$group} = 1; | |
1035 | #$cfg->{groups}->{$group}->{$user} = 1; | |
1036 | ||
1037 | } elsif ($et eq 'group') { | |
1038 | my ($group, $userlist, $comment) = @data; | |
1039 | ||
1040 | if (!verify_groupname($group, 1)) { | |
1041 | warn "user config - ignore group '$group' - invalid characters in group name\n"; | |
1042 | next; | |
1043 | } | |
1044 | ||
1045 | # make sure to add the group (even if there are no members) | |
1046 | $cfg->{groups}->{$group} = { users => {} } if !$cfg->{groups}->{$group}; | |
1047 | ||
1048 | $cfg->{groups}->{$group}->{comment} = PVE::Tools::decode_text($comment) if $comment; | |
1049 | ||
1050 | foreach my $user (split_list($userlist)) { | |
1051 | ||
1052 | if (!PVE::Auth::Plugin::verify_username($user, 1)) { | |
1053 | warn "user config - ignore invalid group member '$user'\n"; | |
1054 | next; | |
1055 | } | |
1056 | ||
1057 | if ($cfg->{users}->{$user}) { # user exists | |
1058 | $cfg->{users}->{$user}->{groups}->{$group} = 1; | |
1059 | } else { | |
1060 | warn "user config - ignore invalid group member '$user'\n"; | |
1061 | } | |
1062 | $cfg->{groups}->{$group}->{users}->{$user} = 1; | |
1063 | } | |
1064 | ||
1065 | } elsif ($et eq 'role') { | |
1066 | my ($role, $privlist) = @data; | |
1067 | ||
1068 | if (!verify_rolename($role, 1)) { | |
1069 | warn "user config - ignore role '$role' - invalid characters in role name\n"; | |
1070 | next; | |
1071 | } | |
1072 | ||
1073 | # make sure to add the role (even if there are no privileges) | |
1074 | $cfg->{roles}->{$role} = {} if !$cfg->{roles}->{$role}; | |
1075 | ||
1076 | foreach my $priv (split_list($privlist)) { | |
1077 | if (defined ($valid_privs->{$priv})) { | |
1078 | $cfg->{roles}->{$role}->{$priv} = 1; | |
1079 | } else { | |
1080 | warn "user config - ignore invalid privilege '$priv'\n"; | |
1081 | } | |
1082 | } | |
1083 | ||
1084 | } elsif ($et eq 'acl') { | |
1085 | my ($propagate, $pathtxt, $uglist, $rolelist) = @data; | |
1086 | ||
1087 | $propagate = $propagate ? 1 : 0; | |
1088 | ||
1089 | if (my $path = normalize_path($pathtxt)) { | |
1090 | foreach my $role (split_list($rolelist)) { | |
1091 | ||
1092 | if (!verify_rolename($role, 1)) { | |
1093 | warn "user config - ignore invalid role name '$role' in acl\n"; | |
1094 | next; | |
1095 | } | |
1096 | ||
1097 | if (!$cfg->{roles}->{$role}) { | |
1098 | warn "user config - ignore invalid acl role '$role'\n"; | |
1099 | next; | |
1100 | } | |
1101 | ||
1102 | foreach my $ug (split_list($uglist)) { | |
1103 | my ($group) = $ug =~ m/^@(\S+)$/; | |
1104 | ||
1105 | if ($group && verify_groupname($group, 1)) { | |
1106 | if (!$cfg->{groups}->{$group}) { # group does not exist | |
1107 | warn "user config - ignore invalid acl group '$group'\n"; | |
1108 | } | |
1109 | $cfg->{acl}->{$path}->{groups}->{$group}->{$role} = $propagate; | |
1110 | } elsif (PVE::Auth::Plugin::verify_username($ug, 1)) { | |
1111 | if (!$cfg->{users}->{$ug}) { # user does not exist | |
1112 | warn "user config - ignore invalid acl member '$ug'\n"; | |
1113 | } | |
1114 | $cfg->{acl}->{$path}->{users}->{$ug}->{$role} = $propagate; | |
1115 | } elsif (my ($user, $token) = split_tokenid($ug, 1)) { | |
1116 | if (check_token_exist($cfg, $user, $token, 1)) { | |
1117 | $cfg->{acl}->{$path}->{tokens}->{$ug}->{$role} = $propagate; | |
1118 | } else { | |
1119 | warn "user config - ignore invalid acl token '$ug'\n"; | |
1120 | } | |
1121 | } else { | |
1122 | warn "user config - invalid user/group '$ug' in acl\n"; | |
1123 | } | |
1124 | } | |
1125 | } | |
1126 | } else { | |
1127 | warn "user config - ignore invalid path in acl '$pathtxt'\n"; | |
1128 | } | |
1129 | } elsif ($et eq 'pool') { | |
1130 | my ($pool, $comment, $vmlist, $storelist) = @data; | |
1131 | ||
1132 | if (!verify_poolname($pool, 1)) { | |
1133 | warn "user config - ignore pool '$pool' - invalid characters in pool name\n"; | |
1134 | next; | |
1135 | } | |
1136 | ||
1137 | # make sure to add the pool (even if there are no members) | |
1138 | $cfg->{pools}->{$pool} = { vms => {}, storage => {} } if !$cfg->{pools}->{$pool}; | |
1139 | ||
1140 | $cfg->{pools}->{$pool}->{comment} = PVE::Tools::decode_text($comment) if $comment; | |
1141 | ||
1142 | foreach my $vmid (split_list($vmlist)) { | |
1143 | if ($vmid !~ m/^\d+$/) { | |
1144 | warn "user config - ignore invalid vmid '$vmid' in pool '$pool'\n"; | |
1145 | next; | |
1146 | } | |
1147 | $vmid = int($vmid); | |
1148 | ||
1149 | if ($cfg->{vms}->{$vmid}) { | |
1150 | warn "user config - ignore duplicate vmid '$vmid' in pool '$pool'\n"; | |
1151 | next; | |
1152 | } | |
1153 | ||
1154 | $cfg->{pools}->{$pool}->{vms}->{$vmid} = 1; | |
1155 | ||
1156 | # record vmid ==> pool relation | |
1157 | $cfg->{vms}->{$vmid} = $pool; | |
1158 | } | |
1159 | ||
1160 | foreach my $storeid (split_list($storelist)) { | |
1161 | if ($storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) { | |
1162 | warn "user config - ignore invalid storage '$storeid' in pool '$pool'\n"; | |
1163 | next; | |
1164 | } | |
1165 | $cfg->{pools}->{$pool}->{storage}->{$storeid} = 1; | |
1166 | } | |
1167 | } elsif ($et eq 'token') { | |
1168 | my ($tokenid, $expire, $privsep, $comment) = @data; | |
1169 | ||
1170 | my ($user, $token) = split_tokenid($tokenid, 1); | |
1171 | if (!($user && $token)) { | |
1172 | warn "user config - ignore invalid tokenid '$tokenid'\n"; | |
1173 | next; | |
1174 | } | |
1175 | ||
1176 | $privsep = $privsep ? 1 : 0; | |
1177 | ||
1178 | $expire = 0 if !$expire; | |
1179 | ||
1180 | if ($expire !~ m/^\d+$/) { | |
1181 | warn "user config - ignore token '$tokenid' - (illegal characters in expire '$expire')\n"; | |
1182 | next; | |
1183 | } | |
1184 | $expire = int($expire); | |
1185 | ||
1186 | if (my $user_cfg = $cfg->{users}->{$user}) { # user exists | |
1187 | $user_cfg->{tokens}->{$token} = {} if !$user_cfg->{tokens}->{$token}; | |
1188 | my $token_cfg = $user_cfg->{tokens}->{$token}; | |
1189 | $token_cfg->{privsep} = $privsep; | |
1190 | $token_cfg->{expire} = $expire; | |
1191 | $token_cfg->{comment} = PVE::Tools::decode_text($comment) if $comment; | |
1192 | } else { | |
1193 | warn "user config - ignore token '$tokenid' - user does not exist\n"; | |
1194 | } | |
1195 | } else { | |
1196 | warn "user config - ignore config line: $line\n"; | |
1197 | } | |
1198 | } | |
1199 | ||
1200 | userconfig_force_defaults($cfg); | |
1201 | ||
1202 | return $cfg; | |
1203 | } | |
1204 | ||
1205 | sub write_user_config { | |
1206 | my ($filename, $cfg) = @_; | |
1207 | ||
1208 | my $data = ''; | |
1209 | ||
1210 | foreach my $user (sort keys %{$cfg->{users}}) { | |
1211 | my $d = $cfg->{users}->{$user}; | |
1212 | my $firstname = $d->{firstname} ? PVE::Tools::encode_text($d->{firstname}) : ''; | |
1213 | my $lastname = $d->{lastname} ? PVE::Tools::encode_text($d->{lastname}) : ''; | |
1214 | my $email = $d->{email} || ''; | |
1215 | my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : ''; | |
1216 | my $expire = int($d->{expire} || 0); | |
1217 | my $enable = $d->{enable} ? 1 : 0; | |
1218 | my $keys = $d->{keys} ? $d->{keys} : ''; | |
1219 | $data .= "user:$user:$enable:$expire:$firstname:$lastname:$email:$comment:$keys:\n"; | |
1220 | ||
1221 | my $user_tokens = $d->{tokens}; | |
1222 | foreach my $token (sort keys %$user_tokens) { | |
1223 | my $td = $user_tokens->{$token}; | |
1224 | my $full_tokenid = join_tokenid($user, $token); | |
1225 | my $comment = $td->{comment} ? PVE::Tools::encode_text($td->{comment}) : ''; | |
1226 | my $expire = int($td->{expire} || 0); | |
1227 | my $privsep = $td->{privsep} ? 1 : 0; | |
1228 | $data .= "token:$full_tokenid:$expire:$privsep:$comment:\n"; | |
1229 | } | |
1230 | } | |
1231 | ||
1232 | $data .= "\n"; | |
1233 | ||
1234 | foreach my $group (sort keys %{$cfg->{groups}}) { | |
1235 | my $d = $cfg->{groups}->{$group}; | |
1236 | my $list = join (',', sort keys %{$d->{users}}); | |
1237 | my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : ''; | |
1238 | $data .= "group:$group:$list:$comment:\n"; | |
1239 | } | |
1240 | ||
1241 | $data .= "\n"; | |
1242 | ||
1243 | foreach my $pool (sort keys %{$cfg->{pools}}) { | |
1244 | my $d = $cfg->{pools}->{$pool}; | |
1245 | my $vmlist = join (',', sort keys %{$d->{vms}}); | |
1246 | my $storelist = join (',', sort keys %{$d->{storage}}); | |
1247 | my $comment = $d->{comment} ? PVE::Tools::encode_text($d->{comment}) : ''; | |
1248 | $data .= "pool:$pool:$comment:$vmlist:$storelist:\n"; | |
1249 | } | |
1250 | ||
1251 | $data .= "\n"; | |
1252 | ||
1253 | foreach my $role (sort keys %{$cfg->{roles}}) { | |
1254 | next if $special_roles->{$role}; | |
1255 | ||
1256 | my $d = $cfg->{roles}->{$role}; | |
1257 | my $list = join (',', sort keys %$d); | |
1258 | $data .= "role:$role:$list:\n"; | |
1259 | } | |
1260 | ||
1261 | $data .= "\n"; | |
1262 | ||
1263 | my $collect_rolelist_members = sub { | |
1264 | my ($acl_members, $result, $prefix, $exclude) = @_; | |
1265 | ||
1266 | foreach my $member (keys %$acl_members) { | |
1267 | next if $exclude && $member eq $exclude; | |
1268 | ||
1269 | my $l0 = ''; | |
1270 | my $l1 = ''; | |
1271 | foreach my $role (sort keys %{$acl_members->{$member}}) { | |
1272 | my $propagate = $acl_members->{$member}->{$role}; | |
1273 | if ($propagate) { | |
1274 | $l1 .= ',' if $l1; | |
1275 | $l1 .= $role; | |
1276 | } else { | |
1277 | $l0 .= ',' if $l0; | |
1278 | $l0 .= $role; | |
1279 | } | |
1280 | } | |
1281 | $result->{0}->{$l0}->{"${prefix}${member}"} = 1 if $l0; | |
1282 | $result->{1}->{$l1}->{"${prefix}${member}"} = 1 if $l1; | |
1283 | } | |
1284 | }; | |
1285 | ||
1286 | foreach my $path (sort keys %{$cfg->{acl}}) { | |
1287 | my $d = $cfg->{acl}->{$path}; | |
1288 | ||
1289 | my $rolelist_members = {}; | |
1290 | ||
1291 | $collect_rolelist_members->($d->{'groups'}, $rolelist_members, '@'); | |
1292 | ||
1293 | # no need to save 'root@pam', it is always 'Administrator' | |
1294 | $collect_rolelist_members->($d->{'users'}, $rolelist_members, '', 'root@pam'); | |
1295 | ||
1296 | $collect_rolelist_members->($d->{'tokens'}, $rolelist_members, ''); | |
1297 | ||
1298 | foreach my $propagate (0,1) { | |
1299 | my $filtered = $rolelist_members->{$propagate}; | |
1300 | foreach my $rolelist (sort keys %$filtered) { | |
1301 | my $uglist = join (',', sort keys %{$filtered->{$rolelist}}); | |
1302 | $data .= "acl:$propagate:$path:$uglist:$rolelist:\n"; | |
1303 | } | |
1304 | ||
1305 | } | |
1306 | } | |
1307 | ||
1308 | return $data; | |
1309 | } | |
1310 | ||
1311 | # The TFA configuration in priv/tfa.cfg format contains one line per user of | |
1312 | # the form: | |
1313 | # USER:TYPE:DATA | |
1314 | # DATA is a base64 encoded json string and its format depends on the type. | |
1315 | sub parse_priv_tfa_config { | |
1316 | my ($filename, $raw) = @_; | |
1317 | ||
1318 | my $users = {}; | |
1319 | my $cfg = { users => $users }; | |
1320 | ||
1321 | $raw = '' if !defined($raw); | |
1322 | while ($raw =~ /^\s*(.+?)\s*$/gm) { | |
1323 | my $line = $1; | |
1324 | my ($user, $type, $data) = split(/:/, $line, 3); | |
1325 | ||
1326 | my (undef, undef, $realm) = PVE::Auth::Plugin::verify_username($user, 1); | |
1327 | if (!$realm) { | |
1328 | warn "user tfa config - ignore user '$user' - invalid user name\n"; | |
1329 | next; | |
1330 | } | |
1331 | ||
1332 | $data = decode_json(decode_base64($data)); | |
1333 | ||
1334 | $users->{$user} = { | |
1335 | type => $type, | |
1336 | data => $data, | |
1337 | }; | |
1338 | } | |
1339 | ||
1340 | return $cfg; | |
1341 | } | |
1342 | ||
1343 | sub write_priv_tfa_config { | |
1344 | my ($filename, $cfg) = @_; | |
1345 | ||
1346 | my $output = ''; | |
1347 | ||
1348 | my $users = $cfg->{users}; | |
1349 | foreach my $user (sort keys %$users) { | |
1350 | my $info = $users->{$user}; | |
1351 | next if !%$info; # skip empty entries | |
1352 | ||
1353 | $info = {%$info}; # copy to verify contents: | |
1354 | ||
1355 | my $type = delete $info->{type}; | |
1356 | my $data = delete $info->{data}; | |
1357 | ||
1358 | if (my @keys = keys %$info) { | |
1359 | die "invalid keys in TFA config for user $user: " . join(', ', @keys) . "\n"; | |
1360 | } | |
1361 | ||
1362 | $data = encode_base64(encode_json($data), ''); | |
1363 | $output .= "${user}:${type}:${data}\n"; | |
1364 | } | |
1365 | ||
1366 | return $output; | |
1367 | } | |
1368 | ||
1369 | sub roles { | |
1370 | my ($cfg, $user, $path) = @_; | |
1371 | ||
1372 | # NOTE: we do not consider pools here. | |
1373 | # NOTE: for privsep tokens, this does not filter roles by those that the | |
1374 | # corresponding user has. | |
1375 | # Use $rpcenv->permission() for any actual permission checks! | |
1376 | ||
1377 | return 'Administrator' if $user eq 'root@pam'; # root can do anything | |
1378 | ||
1379 | if (pve_verify_tokenid($user, 1)) { | |
1380 | my $tokenid = $user; | |
1381 | my ($username, $token) = split_tokenid($tokenid); | |
1382 | ||
1383 | my $token_info = $cfg->{users}->{$username}->{tokens}->{$token}; | |
1384 | return () if !$token_info; | |
1385 | ||
1386 | my $user_roles = roles($cfg, $username, $path); | |
1387 | ||
1388 | # return full user privileges | |
1389 | return $user_roles if !$token_info->{privsep}; | |
1390 | } | |
1391 | ||
1392 | my $roles = {}; | |
1393 | ||
1394 | foreach my $p (sort keys %{$cfg->{acl}}) { | |
1395 | my $final = ($path eq $p); | |
1396 | ||
1397 | next if !(($p eq '/') || $final || ($path =~ m|^$p/|)); | |
1398 | ||
1399 | my $acl = $cfg->{acl}->{$p}; | |
1400 | ||
1401 | #print "CHECKACL $path $p\n"; | |
1402 | #print "ACL $path = " . Dumper ($acl); | |
1403 | if (my $ri = $acl->{tokens}->{$user}) { | |
1404 | my $new; | |
1405 | foreach my $role (keys %$ri) { | |
1406 | my $propagate = $ri->{$role}; | |
1407 | if ($final || $propagate) { | |
1408 | #print "APPLY ROLE $p $user $role\n"; | |
1409 | $new = {} if !$new; | |
1410 | $new->{$role} = $propagate; | |
1411 | } | |
1412 | } | |
1413 | if ($new) { | |
1414 | $roles = $new; # overwrite previous settings | |
1415 | next; | |
1416 | } | |
1417 | } | |
1418 | ||
1419 | if (my $ri = $acl->{users}->{$user}) { | |
1420 | my $new; | |
1421 | foreach my $role (keys %$ri) { | |
1422 | my $propagate = $ri->{$role}; | |
1423 | if ($final || $propagate) { | |
1424 | #print "APPLY ROLE $p $user $role\n"; | |
1425 | $new = {} if !$new; | |
1426 | $new->{$role} = $propagate; | |
1427 | } | |
1428 | } | |
1429 | if ($new) { | |
1430 | $roles = $new; # overwrite previous settings | |
1431 | next; # user privs always override group privs | |
1432 | } | |
1433 | } | |
1434 | ||
1435 | my $new; | |
1436 | foreach my $g (keys %{$acl->{groups}}) { | |
1437 | next if !$cfg->{groups}->{$g}->{users}->{$user}; | |
1438 | if (my $ri = $acl->{groups}->{$g}) { | |
1439 | foreach my $role (keys %$ri) { | |
1440 | my $propagate = $ri->{$role}; | |
1441 | if ($final || $propagate) { | |
1442 | #print "APPLY ROLE $p \@$g $role\n"; | |
1443 | $new = {} if !$new; | |
1444 | $new->{$role} = $propagate; | |
1445 | } | |
1446 | } | |
1447 | } | |
1448 | } | |
1449 | if ($new) { | |
1450 | $roles = $new; # overwrite previous settings | |
1451 | next; | |
1452 | } | |
1453 | } | |
1454 | ||
1455 | return { 'NoAccess' => $roles->{NoAccess} } if defined ($roles->{NoAccess}); | |
1456 | #return () if defined ($roles->{NoAccess}); | |
1457 | ||
1458 | #print "permission $user $path = " . Dumper ($roles); | |
1459 | ||
1460 | #print "roles $user $path = " . join (',', @ra) . "\n"; | |
1461 | ||
1462 | return $roles; | |
1463 | } | |
1464 | ||
1465 | sub remove_vm_access { | |
1466 | my ($vmid) = @_; | |
1467 | my $delVMaccessFn = sub { | |
1468 | my $usercfg = cfs_read_file("user.cfg"); | |
1469 | my $modified; | |
1470 | ||
1471 | if (my $acl = $usercfg->{acl}->{"/vms/$vmid"}) { | |
1472 | delete $usercfg->{acl}->{"/vms/$vmid"}; | |
1473 | $modified = 1; | |
1474 | } | |
1475 | if (my $pool = $usercfg->{vms}->{$vmid}) { | |
1476 | if (my $data = $usercfg->{pools}->{$pool}) { | |
1477 | delete $data->{vms}->{$vmid}; | |
1478 | delete $usercfg->{vms}->{$vmid}; | |
1479 | $modified = 1; | |
1480 | } | |
1481 | } | |
1482 | cfs_write_file("user.cfg", $usercfg) if $modified; | |
1483 | }; | |
1484 | ||
1485 | lock_user_config($delVMaccessFn, "access permissions cleanup for VM $vmid failed"); | |
1486 | } | |
1487 | ||
1488 | sub remove_storage_access { | |
1489 | my ($storeid) = @_; | |
1490 | ||
1491 | my $deleteStorageAccessFn = sub { | |
1492 | my $usercfg = cfs_read_file("user.cfg"); | |
1493 | my $modified; | |
1494 | ||
1495 | if (my $storage = $usercfg->{acl}->{"/storage/$storeid"}) { | |
1496 | delete $usercfg->{acl}->{"/storage/$storeid"}; | |
1497 | $modified = 1; | |
1498 | } | |
1499 | foreach my $pool (keys %{$usercfg->{pools}}) { | |
1500 | delete $usercfg->{pools}->{$pool}->{storage}->{$storeid}; | |
1501 | $modified = 1; | |
1502 | } | |
1503 | cfs_write_file("user.cfg", $usercfg) if $modified; | |
1504 | }; | |
1505 | ||
1506 | lock_user_config($deleteStorageAccessFn, | |
1507 | "access permissions cleanup for storage $storeid failed"); | |
1508 | } | |
1509 | ||
1510 | sub add_vm_to_pool { | |
1511 | my ($vmid, $pool) = @_; | |
1512 | ||
1513 | my $addVMtoPoolFn = sub { | |
1514 | my $usercfg = cfs_read_file("user.cfg"); | |
1515 | if (my $data = $usercfg->{pools}->{$pool}) { | |
1516 | $data->{vms}->{$vmid} = 1; | |
1517 | $usercfg->{vms}->{$vmid} = $pool; | |
1518 | cfs_write_file("user.cfg", $usercfg); | |
1519 | } | |
1520 | }; | |
1521 | ||
1522 | lock_user_config($addVMtoPoolFn, "can't add VM $vmid to pool '$pool'"); | |
1523 | } | |
1524 | ||
1525 | sub remove_vm_from_pool { | |
1526 | my ($vmid) = @_; | |
1527 | ||
1528 | my $delVMfromPoolFn = sub { | |
1529 | my $usercfg = cfs_read_file("user.cfg"); | |
1530 | if (my $pool = $usercfg->{vms}->{$vmid}) { | |
1531 | if (my $data = $usercfg->{pools}->{$pool}) { | |
1532 | delete $data->{vms}->{$vmid}; | |
1533 | delete $usercfg->{vms}->{$vmid}; | |
1534 | cfs_write_file("user.cfg", $usercfg); | |
1535 | } | |
1536 | } | |
1537 | }; | |
1538 | ||
1539 | lock_user_config($delVMfromPoolFn, "pool cleanup for VM $vmid failed"); | |
1540 | } | |
1541 | ||
1542 | my $USER_CONTROLLED_TFA_TYPES = { | |
1543 | u2f => 1, | |
1544 | oath => 1, | |
1545 | }; | |
1546 | ||
1547 | # Delete an entry by setting $data=undef in which case $type is ignored. | |
1548 | # Otherwise both must be valid. | |
1549 | sub user_set_tfa { | |
1550 | my ($userid, $realm, $type, $data, $cached_usercfg, $cached_domaincfg) = @_; | |
1551 | ||
1552 | if (defined($data) && !defined($type)) { | |
1553 | # This is an internal usage error and should not happen | |
1554 | die "cannot set tfa data without a type\n"; | |
1555 | } | |
1556 | ||
1557 | my $user_cfg = $cached_usercfg || cfs_read_file('user.cfg'); | |
1558 | my $user = $user_cfg->{users}->{$userid} | |
1559 | or die "user '$userid' not found\n"; | |
1560 | ||
1561 | my $domain_cfg = $cached_domaincfg || cfs_read_file('domains.cfg'); | |
1562 | my $realm_cfg = $domain_cfg->{ids}->{$realm}; | |
1563 | die "auth domain '$realm' does not exist\n" if !$realm_cfg; | |
1564 | ||
1565 | my $realm_tfa = $realm_cfg->{tfa}; | |
1566 | if (defined($realm_tfa)) { | |
1567 | $realm_tfa = PVE::Auth::Plugin::parse_tfa_config($realm_tfa); | |
1568 | # If the realm has a TFA setting, we're only allowed to use that. | |
1569 | if (defined($data)) { | |
1570 | my $required_type = $realm_tfa->{type}; | |
1571 | if ($required_type ne $type) { | |
1572 | die "realm '$realm' only allows TFA of type '$required_type\n"; | |
1573 | } | |
1574 | ||
1575 | if (defined($data->{config})) { | |
1576 | # XXX: Is it enough if the type matches? Or should the configuration also match? | |
1577 | } | |
1578 | ||
1579 | # realm-configured tfa always uses a simple key list, so use the user.cfg | |
1580 | $user->{keys} = $data->{keys}; | |
1581 | } else { | |
1582 | die "realm '$realm' does not allow removing the 2nd factor\n"; | |
1583 | } | |
1584 | } else { | |
1585 | # Without a realm-enforced TFA setting the user can add a u2f or totp entry by themselves. | |
1586 | # The 'yubico' type requires yubico server settings, which have to be configured on the | |
1587 | # realm, so this is not supported here: | |
1588 | die "domain '$realm' does not support TFA type '$type'\n" | |
1589 | if defined($data) && !$USER_CONTROLLED_TFA_TYPES->{$type}; | |
1590 | } | |
1591 | ||
1592 | # Custom TFA entries are stored in priv/tfa.cfg as they can be more complet: u2f uses a | |
1593 | # public key and a key handle, TOTP requires the usual totp settings... | |
1594 | ||
1595 | my $tfa_cfg = cfs_read_file('priv/tfa.cfg'); | |
1596 | my $tfa = ($tfa_cfg->{users}->{$userid} //= {}); | |
1597 | ||
1598 | if (defined($data)) { | |
1599 | $tfa->{type} = $type; | |
1600 | $tfa->{data} = $data; | |
1601 | cfs_write_file('priv/tfa.cfg', $tfa_cfg); | |
1602 | ||
1603 | $user->{keys} = "x!$type"; | |
1604 | } else { | |
1605 | delete $tfa_cfg->{users}->{$userid}; | |
1606 | cfs_write_file('priv/tfa.cfg', $tfa_cfg); | |
1607 | ||
1608 | delete $user->{keys}; | |
1609 | } | |
1610 | ||
1611 | cfs_write_file('user.cfg', $user_cfg); | |
1612 | } | |
1613 | ||
1614 | sub user_get_tfa { | |
1615 | my ($username, $realm) = @_; | |
1616 | ||
1617 | my $user_cfg = cfs_read_file('user.cfg'); | |
1618 | my $user = $user_cfg->{users}->{$username} | |
1619 | or die "user '$username' not found\n"; | |
1620 | ||
1621 | my $keys = $user->{keys}; | |
1622 | ||
1623 | my $domain_cfg = cfs_read_file('domains.cfg'); | |
1624 | my $realm_cfg = $domain_cfg->{ids}->{$realm}; | |
1625 | die "auth domain '$realm' does not exist\n" if !$realm_cfg; | |
1626 | ||
1627 | my $realm_tfa = $realm_cfg->{tfa}; | |
1628 | $realm_tfa = PVE::Auth::Plugin::parse_tfa_config($realm_tfa) | |
1629 | if $realm_tfa; | |
1630 | ||
1631 | if (!$keys) { | |
1632 | return if !$realm_tfa; | |
1633 | die "missing required 2nd keys\n"; | |
1634 | } | |
1635 | ||
1636 | # new style config starts with an 'x' and optionally contains a !<type> suffix | |
1637 | if ($keys !~ /^x(?:!.*)?$/) { | |
1638 | # old style config, find the type via the realm | |
1639 | return if !$realm_tfa; | |
1640 | return ($realm_tfa->{type}, { | |
1641 | keys => $keys, | |
1642 | config => $realm_tfa, | |
1643 | }); | |
1644 | } else { | |
1645 | my $tfa_cfg = cfs_read_file('priv/tfa.cfg'); | |
1646 | my $tfa = $tfa_cfg->{users}->{$username}; | |
1647 | return if !$tfa; # should not happen (user.cfg wasn't cleaned up?) | |
1648 | ||
1649 | if ($realm_tfa) { | |
1650 | # if the realm has a tfa setting we need to verify the type: | |
1651 | die "auth domain '$realm' and user have mismatching TFA settings\n" | |
1652 | if $realm_tfa && $realm_tfa->{type} ne $tfa->{type}; | |
1653 | } | |
1654 | ||
1655 | return ($tfa->{type}, $tfa->{data}); | |
1656 | } | |
1657 | } | |
1658 | ||
1659 | # bash completion helpers | |
1660 | ||
1661 | register_standard_option('userid-completed', | |
1662 | get_standard_option('userid', { completion => \&complete_username}), | |
1663 | ); | |
1664 | ||
1665 | sub complete_username { | |
1666 | ||
1667 | my $user_cfg = cfs_read_file('user.cfg'); | |
1668 | ||
1669 | return [ keys %{$user_cfg->{users}} ]; | |
1670 | } | |
1671 | ||
1672 | sub complete_group { | |
1673 | ||
1674 | my $user_cfg = cfs_read_file('user.cfg'); | |
1675 | ||
1676 | return [ keys %{$user_cfg->{groups}} ]; | |
1677 | } | |
1678 | ||
1679 | sub complete_realm { | |
1680 | ||
1681 | my $domain_cfg = cfs_read_file('domains.cfg'); | |
1682 | ||
1683 | return [ keys %{$domain_cfg->{ids}} ]; | |
1684 | } | |
1685 | ||
1686 | 1; |