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