]>
Commit | Line | Data |
---|---|---|
2c3a6c0a DM |
1 | package PVE::API2::AccessControl; |
2 | ||
3 | use strict; | |
4 | use warnings; | |
5 | ||
2b4c98ab WB |
6 | use JSON; |
7 | use MIME::Base64; | |
8 | ||
e240695b | 9 | use PVE::Exception qw(raise raise_perm_exc raise_param_exc); |
2c3a6c0a DM |
10 | use PVE::SafeSyslog; |
11 | use PVE::RPCEnvironment; | |
a427cecb | 12 | use PVE::Cluster qw(cfs_read_file); |
158514a8 | 13 | use PVE::DataCenterConfig; |
2c3a6c0a DM |
14 | use PVE::RESTHandler; |
15 | use PVE::AccessControl; | |
16 | use PVE::JSONSchema qw(get_standard_option); | |
17 | use PVE::API2::Domains; | |
18 | use PVE::API2::User; | |
19 | use PVE::API2::Group; | |
20 | use PVE::API2::Role; | |
21 | use PVE::API2::ACL; | |
ac344d7d | 22 | use PVE::API2::OpenId; |
dc547a13 | 23 | use PVE::API2::TFA; |
8967f86f | 24 | use PVE::Auth::Plugin; |
47d731c7 | 25 | use PVE::OTP; |
2c3a6c0a | 26 | |
2b4c98ab WB |
27 | my $u2f_available = 0; |
28 | eval { | |
29 | require PVE::U2F; | |
30 | $u2f_available = 1; | |
31 | }; | |
32 | ||
2c3a6c0a DM |
33 | use base qw(PVE::RESTHandler); |
34 | ||
35 | __PACKAGE__->register_method ({ | |
30dd4869 | 36 | subclass => "PVE::API2::User", |
2c3a6c0a DM |
37 | path => 'users', |
38 | }); | |
39 | ||
40 | __PACKAGE__->register_method ({ | |
30dd4869 | 41 | subclass => "PVE::API2::Group", |
2c3a6c0a DM |
42 | path => 'groups', |
43 | }); | |
44 | ||
45 | __PACKAGE__->register_method ({ | |
30dd4869 | 46 | subclass => "PVE::API2::Role", |
2c3a6c0a DM |
47 | path => 'roles', |
48 | }); | |
49 | ||
50 | __PACKAGE__->register_method ({ | |
30dd4869 | 51 | subclass => "PVE::API2::ACL", |
2c3a6c0a DM |
52 | path => 'acl', |
53 | }); | |
54 | ||
55 | __PACKAGE__->register_method ({ | |
30dd4869 | 56 | subclass => "PVE::API2::Domains", |
2c3a6c0a DM |
57 | path => 'domains', |
58 | }); | |
59 | ||
ac344d7d DM |
60 | __PACKAGE__->register_method ({ |
61 | subclass => "PVE::API2::OpenId", | |
62 | path => 'openid', | |
63 | }); | |
64 | ||
dc547a13 WB |
65 | __PACKAGE__->register_method ({ |
66 | subclass => "PVE::API2::TFA", | |
67 | path => 'tfa', | |
68 | }); | |
69 | ||
2c3a6c0a | 70 | __PACKAGE__->register_method ({ |
30dd4869 TM |
71 | name => 'index', |
72 | path => '', | |
2c3a6c0a DM |
73 | method => 'GET', |
74 | description => "Directory index.", | |
30dd4869 | 75 | permissions => { |
82b63965 DM |
76 | user => 'all', |
77 | }, | |
2c3a6c0a DM |
78 | parameters => { |
79 | additionalProperties => 0, | |
80 | properties => {}, | |
81 | }, | |
82 | returns => { | |
83 | type => 'array', | |
84 | items => { | |
85 | type => "object", | |
86 | properties => { | |
87 | subdir => { type => 'string' }, | |
88 | }, | |
89 | }, | |
90 | links => [ { rel => 'child', href => "{subdir}" } ], | |
91 | }, | |
92 | code => sub { | |
93 | my ($param) = @_; | |
30dd4869 | 94 | |
2c3a6c0a DM |
95 | my $res = []; |
96 | ||
97 | my $ma = __PACKAGE__->method_attributes(); | |
98 | ||
99 | foreach my $info (@$ma) { | |
100 | next if !$info->{subclass}; | |
101 | ||
102 | my $subpath = $info->{match_re}->[0]; | |
103 | ||
104 | push @$res, { subdir => $subpath }; | |
105 | } | |
106 | ||
107 | push @$res, { subdir => 'ticket' }; | |
37d45deb | 108 | push @$res, { subdir => 'password' }; |
2c3a6c0a DM |
109 | |
110 | return $res; | |
111 | }}); | |
112 | ||
adf8d771 | 113 | |
cfd8636b WB |
114 | my sub verify_auth : prototype($$$$$$) { |
115 | my ($rpcenv, $username, $pw_or_ticket, $otp, $path, $privs) = @_; | |
adf8d771 DM |
116 | |
117 | my $normpath = PVE::AccessControl::normalize_path($path); | |
37d3c16b | 118 | die "invalid path - $path\n" if defined($path) && !defined($normpath); |
adf8d771 DM |
119 | |
120 | my $ticketuser; | |
121 | if (($ticketuser = PVE::AccessControl::verify_ticket($pw_or_ticket, 1)) && | |
122 | ($ticketuser eq $username)) { | |
123 | # valid ticket | |
124 | } elsif (PVE::AccessControl::verify_vnc_ticket($pw_or_ticket, $username, $normpath, 1)) { | |
125 | # valid vnc ticket | |
126 | } else { | |
afb10353 WB |
127 | $username = PVE::AccessControl::authenticate_user( |
128 | $username, | |
129 | $pw_or_ticket, | |
130 | $otp, | |
afb10353 | 131 | ); |
adf8d771 DM |
132 | } |
133 | ||
134 | my $privlist = [ PVE::Tools::split_list($privs) ]; | |
135 | if (!($normpath && scalar(@$privlist) && $rpcenv->check($username, $normpath, $privlist))) { | |
136 | die "no permission ($path, $privs)\n"; | |
137 | } | |
138 | ||
139 | return { username => $username }; | |
140 | }; | |
141 | ||
cfd8636b WB |
142 | my sub create_ticket_do : prototype($$$$$) { |
143 | my ($rpcenv, $username, $pw_or_ticket, $otp, $tfa_challenge) = @_; | |
afb10353 WB |
144 | |
145 | die "TFA response should be in 'password', not 'otp' when 'tfa-challenge' is set\n" | |
146 | if defined($otp) && defined($tfa_challenge); | |
147 | ||
148 | my ($ticketuser, undef, $tfa_info); | |
149 | if (!defined($tfa_challenge)) { | |
150 | # We only verify this ticket if we're not responding to a TFA challenge, as in that case | |
151 | # it is a TFA-data ticket and will be verified by `authenticate_user`. | |
152 | ||
153 | ($ticketuser, undef, $tfa_info) = PVE::AccessControl::verify_ticket($pw_or_ticket, 1); | |
154 | } | |
adf8d771 | 155 | |
f25628d3 WB |
156 | if (defined($ticketuser) && ($ticketuser eq 'root@pam' || $ticketuser eq $username)) { |
157 | if (defined($tfa_info)) { | |
158 | die "incomplete ticket\n"; | |
159 | } | |
adf8d771 DM |
160 | # valid ticket. Note: root@pam can create tickets for other users |
161 | } else { | |
afb10353 WB |
162 | ($username, $tfa_info) = PVE::AccessControl::authenticate_user( |
163 | $username, | |
164 | $pw_or_ticket, | |
165 | $otp, | |
afb10353 WB |
166 | $tfa_challenge, |
167 | ); | |
18f8ba18 WB |
168 | } |
169 | ||
170 | my %extra; | |
171 | my $ticket_data = $username; | |
afb10353 | 172 | my $aad; |
cfd8636b | 173 | if (defined($tfa_info)) { |
f25628d3 | 174 | $extra{NeedTFA} = 1; |
cfd8636b WB |
175 | $ticket_data = "!tfa!$tfa_info"; |
176 | $aad = $username; | |
adf8d771 DM |
177 | } |
178 | ||
afb10353 | 179 | my $ticket = PVE::AccessControl::assemble_ticket($ticket_data, $aad); |
adf8d771 DM |
180 | my $csrftoken = PVE::AccessControl::assemble_csrf_prevention_token($username); |
181 | ||
182 | return { | |
183 | ticket => $ticket, | |
184 | username => $username, | |
185 | CSRFPreventionToken => $csrftoken, | |
18f8ba18 | 186 | %extra, |
adf8d771 DM |
187 | }; |
188 | }; | |
189 | ||
39e4e363 | 190 | __PACKAGE__->register_method ({ |
30dd4869 TM |
191 | name => 'get_ticket', |
192 | path => 'ticket', | |
39e4e363 DM |
193 | method => 'GET', |
194 | permissions => { user => 'world' }, | |
36dd9dbd | 195 | description => "Dummy. Useful for formatters which want to provide a login page.", |
39e4e363 DM |
196 | parameters => { |
197 | additionalProperties => 0, | |
198 | }, | |
199 | returns => { type => "null" }, | |
200 | code => sub { return undef; }}); | |
30dd4869 | 201 | |
2c3a6c0a | 202 | __PACKAGE__->register_method ({ |
30dd4869 TM |
203 | name => 'create_ticket', |
204 | path => 'ticket', | |
2c3a6c0a | 205 | method => 'POST', |
30dd4869 | 206 | permissions => { |
96919234 | 207 | description => "You need to pass valid credientials.", |
30dd4869 | 208 | user => 'world' |
96919234 | 209 | }, |
2c3a6c0a | 210 | protected => 1, # else we can't access shadow files |
49372390 | 211 | allowtoken => 0, # we don't want tokens to create tickets |
adf8d771 | 212 | description => "Create or verify authentication ticket.", |
2c3a6c0a DM |
213 | parameters => { |
214 | additionalProperties => 0, | |
215 | properties => { | |
216 | username => { | |
3a5ae7a0 SI |
217 | description => "User name", |
218 | type => 'string', | |
219 | maxLength => 64, | |
220 | completion => \&PVE::AccessControl::complete_username, | |
2c3a6c0a DM |
221 | }, |
222 | realm => get_standard_option('realm', { | |
223 | description => "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>\@<relam>.", | |
3e5bfdf6 DM |
224 | optional => 1, |
225 | completion => \&PVE::AccessControl::complete_realm, | |
226 | }), | |
30dd4869 | 227 | password => { |
2c3a6c0a DM |
228 | description => "The secret password. This can also be a valid ticket.", |
229 | type => 'string', | |
230 | }, | |
96f8ebd6 DM |
231 | otp => { |
232 | description => "One-time password for Two-factor authentication.", | |
233 | type => 'string', | |
234 | optional => 1, | |
235 | }, | |
2c3a6c0a | 236 | path => { |
adf8d771 | 237 | description => "Verify ticket, and check if user have access 'privs' on 'path'", |
2c3a6c0a DM |
238 | type => 'string', |
239 | requires => 'privs', | |
240 | optional => 1, | |
241 | maxLength => 64, | |
242 | }, | |
30dd4869 | 243 | privs => { |
adf8d771 | 244 | description => "Verify ticket, and check if user have access 'privs' on 'path'", |
2c3a6c0a DM |
245 | type => 'string' , format => 'pve-priv-list', |
246 | requires => 'path', | |
247 | optional => 1, | |
248 | maxLength => 64, | |
249 | }, | |
afb10353 WB |
250 | 'new-format' => { |
251 | type => 'boolean', | |
cfd8636b | 252 | description => 'This parameter is now ignored and assumed to be 1.', |
afb10353 | 253 | optional => 1, |
cfd8636b | 254 | default => 1, |
afb10353 WB |
255 | }, |
256 | 'tfa-challenge' => { | |
257 | type => 'string', | |
258 | description => "The signed TFA challenge string the user wants to respond to.", | |
259 | optional => 1, | |
260 | }, | |
2c3a6c0a DM |
261 | } |
262 | }, | |
263 | returns => { | |
264 | type => "object", | |
265 | properties => { | |
2c3a6c0a | 266 | username => { type => 'string' }, |
adf8d771 DM |
267 | ticket => { type => 'string', optional => 1}, |
268 | CSRFPreventionToken => { type => 'string', optional => 1 }, | |
e842fec5 | 269 | clustername => { type => 'string', optional => 1 }, |
18f8ba18 | 270 | # cap => computed api permissions, unless there's a u2f challenge |
2c3a6c0a DM |
271 | } |
272 | }, | |
273 | code => sub { | |
274 | my ($param) = @_; | |
30dd4869 | 275 | |
2c3a6c0a DM |
276 | my $username = $param->{username}; |
277 | $username .= "\@$param->{realm}" if $param->{realm}; | |
278 | ||
eb41d200 | 279 | $username = PVE::AccessControl::lookup_username($username); |
2c3a6c0a | 280 | my $rpcenv = PVE::RPCEnvironment::get(); |
2c3a6c0a | 281 | |
adf8d771 | 282 | my $res; |
adf8d771 | 283 | eval { |
7070c1ae DM |
284 | # test if user exists and is enabled |
285 | $rpcenv->check_user_enabled($username); | |
286 | ||
2c3a6c0a | 287 | if ($param->{path} && $param->{privs}) { |
afb10353 | 288 | $res = verify_auth($rpcenv, $username, $param->{password}, $param->{otp}, |
cfd8636b | 289 | $param->{path}, $param->{privs}); |
2c3a6c0a | 290 | } else { |
afb10353 WB |
291 | $res = create_ticket_do( |
292 | $rpcenv, | |
293 | $username, | |
294 | $param->{password}, | |
295 | $param->{otp}, | |
afb10353 WB |
296 | $param->{'tfa-challenge'}, |
297 | ); | |
2c3a6c0a | 298 | } |
2c3a6c0a DM |
299 | }; |
300 | if (my $err = $@) { | |
adf8d771 | 301 | my $clientip = $rpcenv->get_client_ip() || ''; |
2c3a6c0a | 302 | syslog('err', "authentication failure; rhost=$clientip user=$username msg=$err"); |
6126ab75 | 303 | # do not return any info to prevent user enumeration attacks |
fe2defd9 | 304 | die PVE::Exception->new("authentication failure\n", code => 401); |
2c3a6c0a DM |
305 | } |
306 | ||
ac344d7d | 307 | $res->{cap} = $rpcenv->compute_api_permission($username) |
f25628d3 | 308 | if !defined($res->{NeedTFA}); |
dd2cfee0 | 309 | |
0fb0c62d FG |
310 | my $clinfo = PVE::Cluster::get_clinfo(); |
311 | if ($clinfo->{cluster}->{name} && $rpcenv->check($username, '/', ['Sys.Audit'], 1)) { | |
312 | $res->{clustername} = $clinfo->{cluster}->{name}; | |
e842fec5 TL |
313 | } |
314 | ||
2c3a6c0a DM |
315 | PVE::Cluster::log_msg('info', 'root@pam', "successful auth for user '$username'"); |
316 | ||
adf8d771 | 317 | return $res; |
2c3a6c0a DM |
318 | }}); |
319 | ||
37d45deb | 320 | __PACKAGE__->register_method ({ |
765305e2 | 321 | name => 'change_password', |
30dd4869 | 322 | path => 'password', |
37d45deb | 323 | method => 'PUT', |
30dd4869 | 324 | permissions => { |
82b63965 | 325 | description => "Each user is allowed to change his own password. A user can change the password of another user if he has 'Realm.AllocateUser' (on the realm of user <userid>) and 'User.Modify' permission on /access/groups/<group> on a group where user <userid> is member of.", |
30dd4869 | 326 | check => [ 'or', |
12683df7 | 327 | ['userid-param', 'self'], |
82b63965 DM |
328 | [ 'and', |
329 | [ 'userid-param', 'Realm.AllocateUser'], | |
330 | [ 'userid-group', ['User.Modify']] | |
331 | ] | |
12683df7 DM |
332 | ], |
333 | }, | |
37d45deb | 334 | protected => 1, # else we can't access shadow files |
49372390 | 335 | allowtoken => 0, # we don't want tokens to change the regular user password |
37d45deb DM |
336 | description => "Change user password.", |
337 | parameters => { | |
338 | additionalProperties => 0, | |
339 | properties => { | |
3a5ae7a0 | 340 | userid => get_standard_option('userid-completed'), |
30dd4869 | 341 | password => { |
37d45deb DM |
342 | description => "The new password.", |
343 | type => 'string', | |
30dd4869 | 344 | minLength => 5, |
37d45deb DM |
345 | maxLength => 64, |
346 | }, | |
347 | } | |
348 | }, | |
349 | returns => { type => "null" }, | |
350 | code => sub { | |
351 | my ($param) = @_; | |
352 | ||
353 | my $rpcenv = PVE::RPCEnvironment::get(); | |
354 | my $authuser = $rpcenv->get_user(); | |
355 | ||
356 | my ($userid, $ruid, $realm) = PVE::AccessControl::verify_username($param->{userid}); | |
357 | ||
12683df7 | 358 | $rpcenv->check_user_exist($userid); |
37d45deb DM |
359 | |
360 | if ($authuser eq 'root@pam') { | |
361 | # OK - root can change anything | |
362 | } else { | |
363 | if ($authuser eq $userid) { | |
364 | $rpcenv->check_user_enabled($userid); | |
365 | # OK - each user can change its own password | |
366 | } else { | |
12683df7 | 367 | # only root may change root password |
37d45deb | 368 | raise_perm_exc() if $userid eq 'root@pam'; |
59321f26 DM |
369 | # do not allow to change system user passwords |
370 | raise_perm_exc() if $realm eq 'pam'; | |
37d45deb DM |
371 | } |
372 | } | |
373 | ||
374 | PVE::AccessControl::domain_set_password($realm, $ruid, $param->{password}); | |
375 | ||
376 | PVE::Cluster::log_msg('info', 'root@pam', "changed password for user '$userid'"); | |
377 | ||
378 | return undef; | |
379 | }}); | |
380 | ||
2b4c98ab WB |
381 | sub get_u2f_config() { |
382 | die "u2f support not available\n" if !$u2f_available; | |
383 | ||
384 | my $dc = cfs_read_file('datacenter.cfg'); | |
385 | my $u2f = $dc->{u2f}; | |
386 | die "u2f not configured in datacenter.cfg\n" if !$u2f; | |
2b4c98ab WB |
387 | return $u2f; |
388 | } | |
389 | ||
390 | sub get_u2f_instance { | |
391 | my ($rpcenv, $publicKey, $keyHandle) = @_; | |
392 | ||
393 | # We store the public key base64 encoded (as the api provides it in binary) | |
394 | $publicKey = decode_base64($publicKey) if defined($publicKey); | |
395 | ||
396 | my $u2fconfig = get_u2f_config(); | |
397 | my $u2f = PVE::U2F->new(); | |
398 | ||
399 | # via the 'Host' header (in case a node has multiple hosts available). | |
400 | my $origin = $u2fconfig->{origin}; | |
401 | if (!defined($origin)) { | |
402 | $origin = $rpcenv->get_request_host(1); | |
403 | if ($origin) { | |
404 | $origin = "https://$origin"; | |
405 | } else { | |
406 | die "failed to figure out u2f origin\n"; | |
407 | } | |
408 | } | |
409 | ||
410 | my $appid = $u2fconfig->{appid} // $origin; | |
411 | $u2f->set_appid($appid); | |
412 | $u2f->set_origin($origin); | |
413 | $u2f->set_publicKey($publicKey) if defined($publicKey); | |
414 | $u2f->set_keyHandle($keyHandle) if defined($keyHandle); | |
415 | return $u2f; | |
416 | } | |
417 | ||
47d731c7 WB |
418 | sub verify_user_tfa_config { |
419 | my ($type, $tfa_cfg, $value) = @_; | |
420 | ||
421 | if (!defined($type)) { | |
422 | die "missing tfa 'type'\n"; | |
423 | } | |
424 | ||
425 | if ($type ne 'oath') { | |
426 | die "invalid type for custom tfa authentication\n"; | |
427 | } | |
428 | ||
429 | my $secret = $tfa_cfg->{keys} | |
430 | or die "missing TOTP secret\n"; | |
431 | $tfa_cfg = $tfa_cfg->{config}; | |
432 | # Copy the hash to verify that we have no unexpected keys without modifying the original hash. | |
433 | $tfa_cfg = {%$tfa_cfg}; | |
434 | ||
435 | # We can only verify 1 secret but oath_verify_otp allows multiple: | |
436 | if (scalar(PVE::Tools::split_list($secret)) != 1) { | |
437 | die "only exactly one secret key allowed\n"; | |
438 | } | |
439 | ||
440 | my $digits = delete($tfa_cfg->{digits}) // 6; | |
441 | my $step = delete($tfa_cfg->{step}) // 30; | |
442 | # Maybe also this? | |
443 | # my $algorithm = delete($tfa_cfg->{algorithm}) // 'sha1'; | |
444 | ||
445 | if (length(my $more = join(', ', keys %$tfa_cfg))) { | |
446 | die "unexpected tfa config keys: $more\n"; | |
447 | } | |
448 | ||
449 | PVE::OTP::oath_verify_otp($value, $secret, $step, $digits); | |
450 | } | |
451 | ||
2b4c98ab | 452 | |
c3fa8a36 FG |
453 | __PACKAGE__->register_method({ |
454 | name => 'permissions', | |
455 | path => 'permissions', | |
456 | method => 'GET', | |
457 | description => 'Retrieve effective permissions of given user/token.', | |
458 | permissions => { | |
459 | description => "Each user/token is allowed to dump their own permissions. A user can dump the permissions of another user if they have 'Sys.Audit' permission on /access.", | |
460 | user => 'all', | |
461 | }, | |
462 | parameters => { | |
463 | additionalProperties => 0, | |
464 | properties => { | |
465 | userid => { | |
466 | type => 'string', | |
467 | description => "User ID or full API token ID", | |
468 | pattern => $PVE::AccessControl::userid_or_token_regex, | |
469 | optional => 1, | |
470 | }, | |
471 | path => get_standard_option('acl-path', { | |
472 | description => "Only dump this specific path, not the whole tree.", | |
473 | optional => 1, | |
474 | }), | |
475 | }, | |
476 | }, | |
477 | returns => { | |
478 | type => 'object', | |
479 | description => 'Map of "path" => (Map of "privilege" => "propagate boolean").', | |
480 | }, | |
481 | code => sub { | |
482 | my ($param) = @_; | |
483 | ||
484 | my $rpcenv = PVE::RPCEnvironment::get(); | |
485 | ||
486 | my $userid = $param->{userid}; | |
487 | if (defined($userid)) { | |
488 | $rpcenv->check($rpcenv->get_user(), '/access', ['Sys.Audit']); | |
489 | } else { | |
490 | $userid = $rpcenv->get_user(); | |
491 | } | |
492 | ||
493 | my $res; | |
494 | ||
495 | if (my $path = $param->{path}) { | |
496 | my $perms = $rpcenv->permissions($userid, $path); | |
497 | if ($perms) { | |
498 | $res = { $path => $perms }; | |
499 | } else { | |
500 | $res = {}; | |
501 | } | |
502 | } else { | |
503 | $res = $rpcenv->get_effective_permissions($userid); | |
504 | } | |
505 | ||
506 | return $res; | |
507 | }}); | |
508 | ||
2c3a6c0a | 509 | 1; |