src/PVE/API2/User.pm

   1 package PVE::API2::User;
   2
   3 use strict;
   4 use warnings;
   5
   6 use PVE::Exception qw(raise raise_perm_exc raise_param_exc);
   7 use PVE::Cluster qw (cfs_read_file cfs_write_file);
   8 use PVE::Tools qw(split_list extract_param);
   9 use PVE::JSONSchema qw(get_standard_option register_standard_option);
  10 use PVE::SafeSyslog;
  11
  12 use PVE::AccessControl;
  13 use PVE::Auth::Plugin;
  14 use PVE::TokenConfig;
  15
  16 use PVE::RESTHandler;
  17
  18 use base qw(PVE::RESTHandler);
  19
  20 register_standard_option('user-enable', {
  21     description => "Enable the account (default). You can set this to '0' to disable the account",
  22     type => 'boolean',
  23     optional => 1,
  24     default => 1,
  25 });
  26 register_standard_option('user-expire', {
  27     description => "Account expiration date (seconds since epoch). '0' means no expiration date.",
  28     type => 'integer',
  29     minimum => 0,
  30     optional => 1,
  31 });
  32 register_standard_option('user-firstname', { type => 'string', optional => 1 });
  33 register_standard_option('user-lastname', { type => 'string', optional => 1 });
  34 register_standard_option('user-email', { type => 'string', optional => 1, format => 'email-opt' });
  35 register_standard_option('user-comment', { type => 'string', optional => 1 });
  36 register_standard_option('user-keys', {
  37     description => "Keys for two factor auth (yubico).",
  38     type => 'string',
  39     optional => 1,
  40 });
  41 register_standard_option('group-list', {
  42     type => 'string', format => 'pve-groupid-list',
  43     optional => 1,
  44     completion => \&PVE::AccessControl::complete_group,
  45 });
  46 register_standard_option('token-subid', {
  47     type => 'string',
  48     pattern => $PVE::AccessControl::token_subid_regex,
  49     description => 'User-specific token identifier.',
  50 });
  51 register_standard_option('token-expire', {
  52     description => "API token expiration date (seconds since epoch). '0' means no expiration date.",
  53     type => 'integer',
  54     minimum => 0,
  55     optional => 1,
  56     default => 'same as user',
  57 });
  58 register_standard_option('token-privsep', {
  59     description => "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.",
  60     type => 'boolean',
  61     optional => 1,
  62     default => 1,
  63 });
  64 register_standard_option('token-comment', { type => 'string', optional => 1 });
  65 register_standard_option('token-info', {
  66     type => 'object',
  67     properties => {
  68         expire => get_standard_option('token-expire'),
  69         privsep => get_standard_option('token-privsep'),
  70         comment => get_standard_option('token-comment'),
  71     }
  72 });
  73
  74 my $token_info_extend = sub {
  75     my ($props) = @_;
  76
  77     my $obj = get_standard_option('token-info');
  78     my $base_props = $obj->{properties};
  79     $obj->{properties} = {};
  80
  81     foreach my $prop (keys %$base_props) {
  82         $obj->{properties}->{$prop} = $base_props->{$prop};
  83     }
  84
  85     foreach my $add_prop (keys %$props) {
  86         $obj->{properties}->{$add_prop} = $props->{$add_prop};
  87     }
  88
  89     return $obj;
  90 };
  91
  92 my $extract_user_data = sub {
  93     my ($data, $full) = @_;
  94
  95     my $res = {};
  96
  97     foreach my $prop (qw(enable expire firstname lastname email comment keys)) {
  98         $res->{$prop} = $data->{$prop} if defined($data->{$prop});
  99     }
 100
 101     return $res if !$full;
 102
 103     $res->{groups} = $data->{groups} ? [ keys %{$data->{groups}} ] : [];
 104     $res->{tokens} = $data->{tokens};
 105
 106     return $res;
 107 };
 108
 109 __PACKAGE__->register_method ({
 110     name => 'index',
 111     path => '',
 112     method => 'GET',
 113     description => "User index.",
 114     permissions => {
 115         description => "The returned list is restricted to users where you have 'User.Modify' or 'Sys.Audit' permissions on '/access/groups' or on a group the user belongs too. But it always includes the current (authenticated) user.",
 116         user => 'all',
 117     },
 118     parameters => {
 119         additionalProperties => 0,
 120         properties => {
 121             enabled => {
 122                 type => 'boolean',
 123                 description => "Optional filter for enable property.",
 124                 optional => 1,
 125             },
 126             full => {
 127                 type => 'boolean',
 128                 description => "Include group and token information.",
 129                 optional => 1,
 130                 default => 0,
 131             }
 132         },
 133     },
 134     returns => {
 135         type => 'array',
 136         items => {
 137             type => "object",
 138             properties => {
 139                 userid => get_standard_option('userid-completed'),
 140                 enable => get_standard_option('user-enable'),
 141                 expire => get_standard_option('user-expire'),
 142                 firstname => get_standard_option('user-firstname'),
 143                 lastname => get_standard_option('user-lastname'),
 144                 email => get_standard_option('user-email'),
 145                 comment => get_standard_option('user-comment'),
 146                 keys => get_standard_option('user-keys'),
 147                 groups => get_standard_option('group-list'),
 148                 tokens => {
 149                     type => 'array',
 150                     optional => 1,
 151                     items => $token_info_extend->({
 152                         tokenid => get_standard_option('token-subid'),
 153                     }),
 154                 },
 155                 'realm-type' => {
 156                     type => 'string', format => 'pve-realm',
 157                     description => 'The type of the users realm',
 158                     optional => 1, # it should always be there, but we use conditional code below, so..
 159                 },
 160             },
 161         },
 162         links => [ { rel => 'child', href => "{userid}" } ],
 163     },
 164     code => sub {
 165         my ($param) = @_;
 166
 167         my $rpcenv = PVE::RPCEnvironment::get();
 168         my $usercfg = $rpcenv->{user_cfg};
 169         my $authuser = $rpcenv->get_user();
 170
 171         my $domainscfg = cfs_read_file('domains.cfg');
 172         my $domainids = $domainscfg->{ids};
 173
 174         my $res = [];
 175
 176         my $privs = [ 'User.Modify', 'Sys.Audit' ];
 177         my $canUserMod = $rpcenv->check_any($authuser, "/access/groups", $privs, 1);
 178         my $groups = $rpcenv->filter_groups($authuser, $privs, 1);
 179         my $allowed_users = $rpcenv->group_member_join([keys %$groups]);
 180
 181         foreach my $user (sort keys %{$usercfg->{users}}) {
 182             if (!($canUserMod || $user eq $authuser)) {
 183                 next if !$allowed_users->{$user};
 184             }
 185
 186             my $entry = $extract_user_data->($usercfg->{users}->{$user}, $param->{full});
 187
 188             if (defined($param->{enabled})) {
 189                 next if $entry->{enable} && !$param->{enabled};
 190                 next if !$entry->{enable} && $param->{enabled};
 191             }
 192
 193             $entry->{groups} = join(',', @{$entry->{groups}}) if $entry->{groups};
 194
 195             if (defined(my $tokens = $entry->{tokens})) {
 196                 $entry->{tokens} = [
 197                     map { { tokenid => $_, %{$tokens->{$_}} } } sort keys %$tokens
 198                 ];
 199             }
 200
 201             if ($user =~ /($PVE::Auth::Plugin::realm_regex)$/) {
 202                 my $realm = $1;
 203                 $entry->{'realm-type'} = $domainids->{$realm}->{type} if exists $domainids->{$realm};
 204             }
 205
 206             $entry->{userid} = $user;
 207
 208             push @$res, $entry;
 209         }
 210
 211         return $res;
 212     }});
 213
 214 __PACKAGE__->register_method ({
 215     name => 'create_user',
 216     protected => 1,
 217     path => '',
 218     method => 'POST',
 219     permissions => {
 220         description => "You need 'Realm.AllocateUser' on '/access/realm/<realm>' on the realm of user <userid>, and 'User.Modify' permissions to '/access/groups/<group>' for any group specified (or 'User.Modify' on '/access/groups' if you pass no groups.",
 221         check => [
 222             'and',
 223             [ 'userid-param', 'Realm.AllocateUser'],
 224             [ 'userid-group', ['User.Modify'], groups_param => 1],
 225         ],
 226     },
 227     description => "Create new user.",
 228     parameters => {
 229         additionalProperties => 0,
 230         properties => {
 231             userid => get_standard_option('userid-completed'),
 232             enable => get_standard_option('user-enable'),
 233             expire => get_standard_option('user-expire'),
 234             firstname => get_standard_option('user-firstname'),
 235             lastname => get_standard_option('user-lastname'),
 236             email => get_standard_option('user-email'),
 237             comment => get_standard_option('user-comment'),
 238             keys => get_standard_option('user-keys'),
 239             password => {
 240                 description => "Initial password.",
 241                 type => 'string',
 242                 optional => 1,
 243                 minLength => 5,
 244                 maxLength => 64
 245             },
 246             groups => get_standard_option('group-list'),
 247         },
 248     },
 249     returns => { type => 'null' },
 250     code => sub {
 251         my ($param) = @_;
 252
 253         PVE::AccessControl::lock_user_config(sub {
 254             my ($username, $ruid, $realm) = PVE::AccessControl::verify_username($param->{userid});
 255
 256             my $usercfg = cfs_read_file("user.cfg");
 257
 258             # ensure "user exists" check works for case insensitive realms
 259             $username = PVE::AccessControl::lookup_username($username, 1);
 260             die "user '$username' already exists\n" if $usercfg->{users}->{$username};
 261
 262             PVE::AccessControl::domain_set_password($realm, $ruid, $param->{password})
 263                 if defined($param->{password});
 264
 265             my $enable = defined($param->{enable}) ? $param->{enable} : 1;
 266             $usercfg->{users}->{$username} = { enable => $enable };
 267             $usercfg->{users}->{$username}->{expire} = $param->{expire} if $param->{expire};
 268
 269             if ($param->{groups}) {
 270                 foreach my $group (split_list($param->{groups})) {
 271                     if ($usercfg->{groups}->{$group}) {
 272                         PVE::AccessControl::add_user_group($username, $usercfg, $group);
 273                     } else {
 274                         die "no such group '$group'\n";
 275                     }
 276                 }
 277             }
 278
 279             $usercfg->{users}->{$username}->{firstname} = $param->{firstname} if $param->{firstname};
 280             $usercfg->{users}->{$username}->{lastname} = $param->{lastname} if $param->{lastname};
 281             $usercfg->{users}->{$username}->{email} = $param->{email} if $param->{email};
 282             $usercfg->{users}->{$username}->{comment} = $param->{comment} if $param->{comment};
 283             $usercfg->{users}->{$username}->{keys} = $param->{keys} if $param->{keys};
 284
 285             cfs_write_file("user.cfg", $usercfg);
 286         }, "create user failed");
 287
 288         return undef;
 289     }});
 290
 291 __PACKAGE__->register_method ({
 292     name => 'read_user',
 293     path => '{userid}',
 294     method => 'GET',
 295     description => "Get user configuration.",
 296     permissions => {
 297         check => ['userid-group', ['User.Modify', 'Sys.Audit']],
 298     },
 299     parameters => {
 300         additionalProperties => 0,
 301         properties => {
 302             userid => get_standard_option('userid-completed'),
 303         },
 304     },
 305     returns => {
 306         additionalProperties => 0,
 307         properties => {
 308             enable => get_standard_option('user-enable'),
 309             expire => get_standard_option('user-expire'),
 310             firstname => get_standard_option('user-firstname'),
 311             lastname => get_standard_option('user-lastname'),
 312             email => get_standard_option('user-email'),
 313             comment => get_standard_option('user-comment'),
 314             keys => get_standard_option('user-keys'),
 315             groups => {
 316                 type => 'array',
 317                 optional => 1,
 318                 items => {
 319                     type => 'string',
 320                     format => 'pve-groupid',
 321                 },
 322             },
 323             tokens => {
 324                 optional => 1,
 325                 type => 'object',
 326             },
 327         },
 328         type => "object"
 329     },
 330     code => sub {
 331         my ($param) = @_;
 332
 333         my ($username, undef, $domain) = PVE::AccessControl::verify_username($param->{userid});
 334
 335         my $usercfg = cfs_read_file("user.cfg");
 336
 337         my $data = PVE::AccessControl::check_user_exist($usercfg, $username);
 338
 339         return &$extract_user_data($data, 1);
 340     }});
 341
 342 __PACKAGE__->register_method ({
 343     name => 'update_user',
 344     protected => 1,
 345     path => '{userid}',
 346     method => 'PUT',
 347     permissions => {
 348         check => ['userid-group', ['User.Modify'], groups_param => 1 ],
 349     },
 350     description => "Update user configuration.",
 351     parameters => {
 352         additionalProperties => 0,
 353         properties => {
 354             userid => get_standard_option('userid-completed'),
 355             enable => get_standard_option('user-enable'),
 356             expire => get_standard_option('user-expire'),
 357             firstname => get_standard_option('user-firstname'),
 358             lastname => get_standard_option('user-lastname'),
 359             email => get_standard_option('user-email'),
 360             comment => get_standard_option('user-comment'),
 361             keys => get_standard_option('user-keys'),
 362             groups => get_standard_option('group-list'),
 363             append => {
 364                 type => 'boolean',
 365                 optional => 1,
 366                 requires => 'groups',
 367             },
 368         },
 369     },
 370     returns => { type => 'null' },
 371     code => sub {
 372         my ($param) = @_;
 373
 374         my ($username, $ruid, $realm) = PVE::AccessControl::verify_username($param->{userid});
 375
 376         PVE::AccessControl::lock_user_config(sub {
 377             my $usercfg = cfs_read_file("user.cfg");
 378
 379             PVE::AccessControl::check_user_exist($usercfg, $username);
 380
 381             $usercfg->{users}->{$username}->{enable} = $param->{enable} if defined($param->{enable});
 382             $usercfg->{users}->{$username}->{expire} = $param->{expire} if defined($param->{expire});
 383
 384             PVE::AccessControl::delete_user_group($username, $usercfg)
 385                 if (!$param->{append} && defined($param->{groups}));
 386
 387             if ($param->{groups}) {
 388                 foreach my $group (split_list($param->{groups})) {
 389                     if ($usercfg->{groups}->{$group}) {
 390                         PVE::AccessControl::add_user_group($username, $usercfg, $group);
 391                     } else {
 392                         die "no such group '$group'\n";
 393                     }
 394                 }
 395             }
 396
 397             $usercfg->{users}->{$username}->{firstname} = $param->{firstname} if defined($param->{firstname});
 398             $usercfg->{users}->{$username}->{lastname} = $param->{lastname} if defined($param->{lastname});
 399             $usercfg->{users}->{$username}->{email} = $param->{email} if defined($param->{email});
 400             $usercfg->{users}->{$username}->{comment} = $param->{comment} if defined($param->{comment});
 401             $usercfg->{users}->{$username}->{keys} = $param->{keys} if defined($param->{keys});
 402
 403             cfs_write_file("user.cfg", $usercfg);
 404         }, "update user failed");
 405
 406         return undef;
 407     }});
 408
 409 __PACKAGE__->register_method ({
 410     name => 'delete_user',
 411     protected => 1,
 412     path => '{userid}',
 413     method => 'DELETE',
 414     description => "Delete user.",
 415     permissions => {
 416         check => [ 'and',
 417             [ 'userid-param', 'Realm.AllocateUser'],
 418             [ 'userid-group', ['User.Modify']],
 419         ],
 420     },
 421     parameters => {
 422         additionalProperties => 0,
 423         properties => {
 424             userid => get_standard_option('userid-completed'),
 425         }
 426     },
 427     returns => { type => 'null' },
 428     code => sub {
 429         my ($param) = @_;
 430
 431         my $rpcenv = PVE::RPCEnvironment::get();
 432         my $authuser = $rpcenv->get_user();
 433
 434         my ($userid, $ruid, $realm) = PVE::AccessControl::verify_username($param->{userid});
 435
 436         PVE::AccessControl::lock_user_config(sub {
 437             my $usercfg = cfs_read_file("user.cfg");
 438
 439             # NOTE: disable the user first (transaction like), so if (e.g.) we fail in the middle of
 440             # TFA deletion the user will be still disabled and not just without TFA protection.
 441             $usercfg->{users}->{$userid}->{enable} = 0;
 442             cfs_write_file("user.cfg", $usercfg);
 443
 444             my $domain_cfg = cfs_read_file('domains.cfg');
 445             if (my $cfg = $domain_cfg->{ids}->{$realm}) {
 446                 my $plugin = PVE::Auth::Plugin->lookup($cfg->{type});
 447                 $plugin->delete_user($cfg, $realm, $ruid);
 448             }
 449
 450             # Remove user from cache before removing the TFA entry so realms with TFA-enforcement
 451             # know that it's OK to drop any TFA entry in that case.
 452             delete $usercfg->{users}->{$userid};
 453
 454             my $partial_deletion = '';
 455             eval {
 456                 PVE::AccessControl::user_remove_tfa($userid);
 457                 $partial_deletion = ' - but deleted related TFA';
 458
 459                 PVE::AccessControl::delete_user_group($userid, $usercfg);
 460                 $partial_deletion .= ', Groups';
 461                 PVE::AccessControl::delete_user_acl($userid, $usercfg);
 462                 $partial_deletion .= ', ACLs';
 463
 464                 cfs_write_file("user.cfg", $usercfg);
 465             };
 466             die "$@$partial_deletion\n" if $@;
 467         }, "delete user failed");
 468
 469         return undef;
 470     }});
 471
 472 __PACKAGE__->register_method ({
 473     name => 'read_user_tfa_type',
 474     path => '{userid}/tfa',
 475     method => 'GET',
 476     protected => 1,
 477     description => "Get user TFA types (Personal and Realm).",
 478     permissions => {
 479         check => [ 'or',
 480             ['userid-param', 'self'],
 481             ['userid-group', ['User.Modify', 'Sys.Audit']],
 482         ],
 483     },
 484     parameters => {
 485         additionalProperties => 0,
 486         properties => {
 487             userid => get_standard_option('userid-completed'),
 488             multiple => {
 489                 type => 'boolean',
 490                 description => 'Request all entries as an array.',
 491                 optional => 1,
 492                 default => 0,
 493             },
 494         },
 495     },
 496     returns => {
 497         additionalProperties => 0,
 498         properties => {
 499             realm => {
 500                 type => 'string',
 501                 enum => [qw(oath yubico)],
 502                 description => "The type of TFA the users realm has set, if any.",
 503                 optional => 1,
 504             },
 505             user => {
 506                 type => 'string',
 507                 enum => [qw(oath u2f)],
 508                 description =>
 509                     "The type of TFA the user has set, if any."
 510                     . " Only set if 'multiple' was not passed.",
 511                 optional => 1,
 512             },
 513             types => {
 514                 type => 'array',
 515                 description =>
 516                     "Array of the user configured TFA types, if any."
 517                     . " Only available if 'multiple' was not passed.",
 518                 optional => 1,
 519                 items => {
 520                     type => 'string',
 521                     enum => [qw(totp u2f yubico webauthn recovedry)],
 522                     description => 'A TFA type.',
 523                 },
 524             },
 525         },
 526         type => "object"
 527     },
 528     code => sub {
 529         my ($param) = @_;
 530
 531         my ($username, undef, $realm) = PVE::AccessControl::verify_username($param->{userid});
 532
 533         my $domain_cfg = cfs_read_file('domains.cfg');
 534         my $realm_cfg = $domain_cfg->{ids}->{$realm};
 535         die "auth domain '$realm' does not exist\n" if !$realm_cfg;
 536
 537         my $res = {};
 538         my $realm_tfa = {};
 539         $realm_tfa = PVE::Auth::Plugin::parse_tfa_config($realm_cfg->{tfa}) if $realm_cfg->{tfa};
 540         $res->{realm} = $realm_tfa->{type} if $realm_tfa->{type};
 541
 542         my $tfa_cfg = cfs_read_file('priv/tfa.cfg');
 543         if ($param->{multiple}) {
 544             my $tfa = $tfa_cfg->get_user($username);
 545             my $user = [];
 546             foreach my $type (keys %$tfa) {
 547                 next if !scalar($tfa->{$type}->@*);
 548                 push @$user, $type;
 549             }
 550             $res->{user} = $user;
 551         } else {
 552             my $tfa = $tfa_cfg->{users}->{$username};
 553             $res->{user} = $tfa->{type} if $tfa->{type};
 554         }
 555         return $res;
 556     }});
 557
 558 __PACKAGE__->register_method ({
 559     name => 'token_index',
 560     path => '{userid}/token',
 561     method => 'GET',
 562     description => "Get user API tokens.",
 563     permissions => {
 564         check => [
 565             'or',
 566             ['userid-param', 'self'],
 567             ['perm', '/access/users/{userid}', ['User.Modify']],
 568         ],
 569     },
 570     parameters => {
 571         additionalProperties => 0,
 572         properties => {
 573             userid => get_standard_option('userid-completed'),
 574         },
 575     },
 576     returns => {
 577         type => "array",
 578         items => $token_info_extend->({
 579                     tokenid => get_standard_option('token-subid'),
 580         }),
 581         links => [ { rel => 'child', href => "{tokenid}" } ],
 582     },
 583     code => sub {
 584         my ($param) = @_;
 585
 586         my $userid = PVE::AccessControl::verify_username($param->{userid});
 587         my $usercfg = cfs_read_file("user.cfg");
 588
 589         my $user = PVE::AccessControl::check_user_exist($usercfg, $userid);
 590
 591         my $tokens = $user->{tokens} // {};
 592         return [ map { $tokens->{$_}->{tokenid} = $_; $tokens->{$_} } keys %$tokens];
 593     }});
 594
 595 __PACKAGE__->register_method ({
 596     name => 'read_token',
 597     path => '{userid}/token/{tokenid}',
 598     method => 'GET',
 599     description => "Get specific API token information.",
 600     permissions => {
 601         check => [
 602             'or',
 603             ['userid-param', 'self'],
 604             ['perm', '/access/users/{userid}', ['User.Modify']],
 605         ],
 606     },
 607     parameters => {
 608         additionalProperties => 0,
 609         properties => {
 610             userid => get_standard_option('userid-completed'),
 611             tokenid => get_standard_option('token-subid'),
 612         },
 613     },
 614     returns => get_standard_option('token-info'),
 615     code => sub {
 616         my ($param) = @_;
 617
 618         my $userid = PVE::AccessControl::verify_username($param->{userid});
 619         my $tokenid = $param->{tokenid};
 620
 621         my $usercfg = cfs_read_file("user.cfg");
 622
 623         return PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid);
 624     }});
 625
 626 __PACKAGE__->register_method ({
 627     name => 'generate_token',
 628     path => '{userid}/token/{tokenid}',
 629     method => 'POST',
 630     description => "Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards!",
 631     protected => 1,
 632     permissions => {
 633         check => [
 634             'or',
 635             ['userid-param', 'self'],
 636             ['perm', '/access/users/{userid}', ['User.Modify']],
 637         ],
 638     },
 639     parameters => {
 640         additionalProperties => 0,
 641         properties => {
 642             userid => get_standard_option('userid-completed'),
 643             tokenid => get_standard_option('token-subid'),
 644             expire => get_standard_option('token-expire'),
 645             privsep => get_standard_option('token-privsep'),
 646             comment => get_standard_option('token-comment'),
 647         },
 648     },
 649     returns => {
 650         additionalProperties => 0,
 651         type => "object",
 652         properties => {
 653             info => get_standard_option('token-info'),
 654             value => {
 655                 type => 'string',
 656                 description => 'API token value used for authentication.',
 657             },
 658             'full-tokenid' => {
 659                 type => 'string',
 660                 format_description => '<userid>!<tokenid>',
 661                 description => 'The full token id.',
 662             },
 663         },
 664     },
 665     code => sub {
 666         my ($param) = @_;
 667
 668         my $userid = PVE::AccessControl::verify_username(extract_param($param, 'userid'));
 669         my $tokenid = extract_param($param, 'tokenid');
 670
 671         my $usercfg = cfs_read_file("user.cfg");
 672
 673         my $token = PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid, 1);
 674         my ($full_tokenid, $value);
 675
 676         PVE::AccessControl::check_user_exist($usercfg, $userid);
 677         raise_param_exc({ 'tokenid' => 'Token already exists.' }) if defined($token);
 678
 679         my $generate_and_add_token = sub {
 680             $usercfg = cfs_read_file("user.cfg");
 681             PVE::AccessControl::check_user_exist($usercfg, $userid);
 682             die "Token already exists.\n" if defined(PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid, 1));
 683
 684             $full_tokenid = PVE::AccessControl::join_tokenid($userid, $tokenid);
 685             $value = PVE::TokenConfig::generate_token($full_tokenid);
 686
 687             $token = {};
 688             $token->{privsep} = defined($param->{privsep}) ? $param->{privsep} : 1;
 689             $token->{expire} = $param->{expire} if defined($param->{expire});
 690             $token->{comment} = $param->{comment} if $param->{comment};
 691
 692             $usercfg->{users}->{$userid}->{tokens}->{$tokenid} = $token;
 693             cfs_write_file("user.cfg", $usercfg);
 694         };
 695
 696         PVE::AccessControl::lock_user_config($generate_and_add_token, 'generating token failed');
 697
 698         return {
 699             info => $token,
 700             value => $value,
 701             'full-tokenid' => $full_tokenid,
 702         };
 703     }});
 704
 705
 706 __PACKAGE__->register_method ({
 707     name => 'update_token_info',
 708     path => '{userid}/token/{tokenid}',
 709     method => 'PUT',
 710     description => "Update API token for a specific user.",
 711     protected => 1,
 712     permissions => {
 713         check => [
 714             'or',
 715             ['userid-param', 'self'],
 716             ['perm', '/access/users/{userid}', ['User.Modify']],
 717         ],
 718     },
 719     parameters => {
 720         additionalProperties => 0,
 721         properties => {
 722             userid => get_standard_option('userid-completed'),
 723             tokenid => get_standard_option('token-subid'),
 724             expire => get_standard_option('token-expire'),
 725             privsep => get_standard_option('token-privsep'),
 726             comment => get_standard_option('token-comment'),
 727         },
 728     },
 729     returns => get_standard_option('token-info', { description => "Updated token information." }),
 730     code => sub {
 731         my ($param) = @_;
 732
 733         my $userid = PVE::AccessControl::verify_username(extract_param($param, 'userid'));
 734         my $tokenid = extract_param($param, 'tokenid');
 735
 736         my $usercfg = cfs_read_file("user.cfg");
 737         my $token = PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid);
 738
 739         PVE::AccessControl::lock_user_config(sub {
 740             $usercfg = cfs_read_file("user.cfg");
 741             $token = PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid);
 742
 743             my $full_tokenid = PVE::AccessControl::join_tokenid($userid, $tokenid);
 744
 745             $token->{privsep} = $param->{privsep} if defined($param->{privsep});
 746             $token->{expire} = $param->{expire} if defined($param->{expire});
 747             $token->{comment} = $param->{comment} if $param->{comment};
 748
 749             $usercfg->{users}->{$userid}->{tokens}->{$tokenid} = $token;
 750             cfs_write_file("user.cfg", $usercfg);
 751         }, 'updating token info failed');
 752
 753         return $token;
 754     }});
 755
 756
 757 __PACKAGE__->register_method ({
 758     name => 'remove_token',
 759     path => '{userid}/token/{tokenid}',
 760     method => 'DELETE',
 761     description => "Remove API token for a specific user.",
 762     protected => 1,
 763     permissions => {
 764         check => [
 765             'or',
 766             ['userid-param', 'self'],
 767             ['perm', '/access/users/{userid}', ['User.Modify']],
 768         ],
 769     },
 770     parameters => {
 771         additionalProperties => 0,
 772         properties => {
 773             userid => get_standard_option('userid-completed'),
 774             tokenid => get_standard_option('token-subid'),
 775         },
 776     },
 777     returns => { type => 'null' },
 778     code => sub {
 779         my ($param) = @_;
 780
 781         my $userid = PVE::AccessControl::verify_username(extract_param($param, 'userid'));
 782         my $tokenid = extract_param($param, 'tokenid');
 783
 784         my $usercfg = cfs_read_file("user.cfg");
 785         my $token = PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid);
 786
 787         PVE::AccessControl::lock_user_config(sub {
 788             $usercfg = cfs_read_file("user.cfg");
 789
 790             PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid);
 791
 792             my $full_tokenid = PVE::AccessControl::join_tokenid($userid, $tokenid);
 793             PVE::TokenConfig::delete_token($full_tokenid);
 794             delete $usercfg->{users}->{$userid}->{tokens}->{$tokenid};
 795
 796             cfs_write_file("user.cfg", $usercfg);
 797         }, 'deleting token failed');
 798
 799         return;
 800     }});
 801 1;