]> git.proxmox.com Git - pve-access-control.git/blame - PVE/API2/Domains.pm
do not modify ACLs/Groups for missing users
[pve-access-control.git] / PVE / API2 / Domains.pm
CommitLineData
2c3a6c0a
DM
1package PVE::API2::Domains;
2
3use strict;
4use warnings;
673d2bf2 5use PVE::Exception qw(raise_param_exc);
5bb4e06a 6use PVE::Tools qw(extract_param);
2c3a6c0a
DM
7use PVE::Cluster qw (cfs_read_file cfs_write_file);
8use PVE::AccessControl;
9use PVE::JSONSchema qw(get_standard_option);
10
11use PVE::SafeSyslog;
2c3a6c0a 12use PVE::RESTHandler;
5bb4e06a 13use PVE::Auth::Plugin;
2c3a6c0a
DM
14
15my $domainconfigfile = "domains.cfg";
16
17use base qw(PVE::RESTHandler);
18
19__PACKAGE__->register_method ({
32449f35
DC
20 name => 'index',
21 path => '',
2c3a6c0a
DM
22 method => 'GET',
23 description => "Authentication domain index.",
32449f35 24 permissions => {
82b63965 25 description => "Anyone can access that, because we need that list for the login box (before the user is authenticated).",
32449f35 26 user => 'world',
82b63965 27 },
2c3a6c0a
DM
28 parameters => {
29 additionalProperties => 0,
30 properties => {},
31 },
32 returns => {
33 type => 'array',
34 items => {
35 type => "object",
36 properties => {
37 realm => { type => 'string' },
f3c87f9b 38 type => { type => 'string' },
96f8ebd6
DM
39 tfa => {
40 description => "Two-factor authentication provider.",
41 type => 'string',
1abc2c0a 42 enum => [ 'yubico', 'oath' ],
96f8ebd6
DM
43 optional => 1,
44 },
52b2eff3
DM
45 comment => {
46 description => "A comment. The GUI use this text when you select a domain (Realm) on the login window.",
47 type => 'string',
48 optional => 1,
49 },
2c3a6c0a
DM
50 },
51 },
52 links => [ { rel => 'child', href => "{realm}" } ],
53 },
54 code => sub {
55 my ($param) = @_;
32449f35 56
2c3a6c0a
DM
57 my $res = [];
58
59 my $cfg = cfs_read_file($domainconfigfile);
5bb4e06a
DM
60 my $ids = $cfg->{ids};
61
62 foreach my $realm (keys %$ids) {
63 my $d = $ids->{$realm};
2c3a6c0a
DM
64 my $entry = { realm => $realm, type => $d->{type} };
65 $entry->{comment} = $d->{comment} if $d->{comment};
66 $entry->{default} = 1 if $d->{default};
96f8ebd6
DM
67 if ($d->{tfa} && (my $tfa_cfg = PVE::Auth::Plugin::parse_tfa_config($d->{tfa}))) {
68 $entry->{tfa} = $tfa_cfg->{type};
69 }
2c3a6c0a
DM
70 push @$res, $entry;
71 }
72
73 return $res;
74 }});
75
76__PACKAGE__->register_method ({
32449f35 77 name => 'create',
2c3a6c0a 78 protected => 1,
32449f35 79 path => '',
2c3a6c0a 80 method => 'POST',
32449f35 81 permissions => {
82b63965 82 check => ['perm', '/access/realm', ['Realm.Allocate']],
96919234 83 },
2c3a6c0a 84 description => "Add an authentication server.",
5bb4e06a 85 parameters => PVE::Auth::Plugin->createSchema(),
2c3a6c0a
DM
86 returns => { type => 'null' },
87 code => sub {
88 my ($param) = @_;
89
5bb4e06a 90 PVE::Auth::Plugin::lock_domain_config(
2c3a6c0a 91 sub {
32449f35 92
2c3a6c0a 93 my $cfg = cfs_read_file($domainconfigfile);
5bb4e06a 94 my $ids = $cfg->{ids};
2c3a6c0a 95
5bb4e06a
DM
96 my $realm = extract_param($param, 'realm');
97 my $type = $param->{type};
32449f35
DC
98
99 die "domain '$realm' already exists\n"
5bb4e06a 100 if $ids->{$realm};
2c3a6c0a
DM
101
102 die "unable to use reserved name '$realm'\n"
103 if ($realm eq 'pam' || $realm eq 'pve');
104
5bb4e06a
DM
105 die "unable to create builtin type '$type'\n"
106 if ($type eq 'pam' || $type eq 'pve');
af4a8a85 107
5bb4e06a
DM
108 my $plugin = PVE::Auth::Plugin->lookup($type);
109 my $config = $plugin->check_config($realm, $param, 1, 1);
2c3a6c0a 110
5bb4e06a
DM
111 if ($config->{default}) {
112 foreach my $r (keys %$ids) {
113 delete $ids->{$r}->{default};
0c156363 114 }
af4a8a85
DM
115 }
116
5bb4e06a
DM
117 $ids->{$realm} = $config;
118
2c3a6c0a
DM
119 cfs_write_file($domainconfigfile, $cfg);
120 }, "add auth server failed");
121
122 return undef;
123 }});
124
125__PACKAGE__->register_method ({
32449f35
DC
126 name => 'update',
127 path => '{realm}',
2c3a6c0a 128 method => 'PUT',
32449f35 129 permissions => {
82b63965 130 check => ['perm', '/access/realm', ['Realm.Allocate']],
96919234 131 },
2c3a6c0a
DM
132 description => "Update authentication server settings.",
133 protected => 1,
5bb4e06a 134 parameters => PVE::Auth::Plugin->updateSchema(),
2c3a6c0a
DM
135 returns => { type => 'null' },
136 code => sub {
137 my ($param) = @_;
138
5bb4e06a 139 PVE::Auth::Plugin::lock_domain_config(
2c3a6c0a 140 sub {
32449f35 141
2c3a6c0a 142 my $cfg = cfs_read_file($domainconfigfile);
5bb4e06a 143 my $ids = $cfg->{ids};
2c3a6c0a 144
5bb4e06a
DM
145 my $digest = extract_param($param, 'digest');
146 PVE::SectionConfig::assert_if_modified($cfg, $digest);
147
148 my $realm = extract_param($param, 'realm');
2c3a6c0a 149
32449f35 150 die "domain '$realm' does not exist\n"
5bb4e06a
DM
151 if !$ids->{$realm};
152
153 my $delete_str = extract_param($param, 'delete');
154 die "no options specified\n" if !$delete_str && !scalar(keys %$param);
2c3a6c0a 155
5bb4e06a
DM
156 foreach my $opt (PVE::Tools::split_list($delete_str)) {
157 delete $ids->{$realm}->{$opt};
2c3a6c0a 158 }
32449f35 159
5bb4e06a
DM
160 my $plugin = PVE::Auth::Plugin->lookup($ids->{$realm}->{type});
161 my $config = $plugin->check_config($realm, $param, 0, 1);
2c3a6c0a 162
5bb4e06a
DM
163 if ($config->{default}) {
164 foreach my $r (keys %$ids) {
165 delete $ids->{$r}->{default};
2c3a6c0a
DM
166 }
167 }
168
5bb4e06a
DM
169 foreach my $p (keys %$config) {
170 $ids->{$realm}->{$p} = $config->{$p};
af4a8a85
DM
171 }
172
2c3a6c0a
DM
173 cfs_write_file($domainconfigfile, $cfg);
174 }, "update auth server failed");
175
176 return undef;
177 }});
178
179# fixme: return format!
180__PACKAGE__->register_method ({
32449f35
DC
181 name => 'read',
182 path => '{realm}',
2c3a6c0a
DM
183 method => 'GET',
184 description => "Get auth server configuration.",
32449f35 185 permissions => {
82b63965 186 check => ['perm', '/access/realm', ['Realm.Allocate', 'Sys.Audit'], any => 1],
96919234 187 },
2c3a6c0a
DM
188 parameters => {
189 additionalProperties => 0,
190 properties => {
191 realm => get_standard_option('realm'),
192 },
193 },
194 returns => {},
195 code => sub {
196 my ($param) = @_;
197
198 my $cfg = cfs_read_file($domainconfigfile);
199
200 my $realm = $param->{realm};
32449f35 201
5bb4e06a 202 my $data = $cfg->{ids}->{$realm};
2c3a6c0a
DM
203 die "domain '$realm' does not exist\n" if !$data;
204
5bb4e06a
DM
205 $data->{digest} = $cfg->{digest};
206
2c3a6c0a
DM
207 return $data;
208 }});
209
210
211__PACKAGE__->register_method ({
32449f35
DC
212 name => 'delete',
213 path => '{realm}',
2c3a6c0a 214 method => 'DELETE',
32449f35 215 permissions => {
82b63965 216 check => ['perm', '/access/realm', ['Realm.Allocate']],
96919234 217 },
2c3a6c0a
DM
218 description => "Delete an authentication server.",
219 protected => 1,
220 parameters => {
221 additionalProperties => 0,
222 properties => {
223 realm => get_standard_option('realm'),
224 }
225 },
226 returns => { type => 'null' },
227 code => sub {
228 my ($param) = @_;
229
5bb4e06a 230 PVE::Auth::Plugin::lock_domain_config(
2c3a6c0a
DM
231 sub {
232
233 my $cfg = cfs_read_file($domainconfigfile);
5bb4e06a 234 my $ids = $cfg->{ids};
2c3a6c0a
DM
235
236 my $realm = $param->{realm};
32449f35 237
5bb4e06a 238 die "domain '$realm' does not exist\n" if !$ids->{$realm};
2c3a6c0a 239
5bb4e06a 240 delete $ids->{$realm};
2c3a6c0a
DM
241
242 cfs_write_file($domainconfigfile, $cfg);
243 }, "delete auth server failed");
32449f35 244
2c3a6c0a
DM
245 return undef;
246 }});
247
673d2bf2
DC
248__PACKAGE__->register_method ({
249 name => 'sync',
250 path => '{realm}/sync',
251 method => 'POST',
252 permissions => {
253 description => "You need 'Realm.AllocateUser' on '/access/realm/<realm>' on the realm and 'User.Modify' permissions to '/access/groups/'.",
254 check => [ 'and',
255 [ 'userid-param', 'Realm.AllocateUser'],
256 [ 'userid-group', ['User.Modify']],
257 ],
258 },
259 description => "Syncs users and/or groups from LDAP to user.cfg. ".
260 "NOTE: Synced groups will have the name 'name-\$realm', so ".
261 "make sure those groups do not exist to prevent overwriting.",
262 protected => 1,
263 parameters => {
264 additionalProperties => 0,
265 properties => {
266 realm => get_standard_option('realm'),
267 scope => {
268 description => "Select what to sync.",
269 type => 'string',
270 enum => [qw(users groups both)],
271 },
272 full => {
273 description => "If set, uses the LDAP Directory as source of truth, ".
274 "deleting all information not contained there. ".
275 "Otherwise only syncs information set explicitly.",
276 type => 'boolean',
277 },
278 enable => {
279 description => "Enable newly synced users.",
280 type => 'boolean',
281 },
282 purge => {
283 description => "Remove ACLs for users/groups that were removed from the config.",
284 type => 'boolean',
285 },
286 }
287 },
288 returns => { type => 'string' },
289 code => sub {
290 my ($param) = @_;
291
292 my $rpcenv = PVE::RPCEnvironment::get();
293 my $authuser = $rpcenv->get_user();
294
295
296 my $realm = $param->{realm};
297 my $cfg = cfs_read_file($domainconfigfile);
298 my $ids = $cfg->{ids};
299
300 raise_param_exc({ 'realm' => 'Realm does not exist.' }) if !defined($ids->{$realm});
301 my $type = $ids->{$realm}->{type};
302
303 if ($type ne 'ldap' && $type ne 'ad') {
304 die "Only LDAP/AD realms can be synced.\n";
305 }
306
307 my $scope = $param->{scope};
308 my $sync_users;
309 my $sync_groups;
310
311 my $errorstring = "syncing ";
312 if ($scope eq 'users') {
313 $errorstring .= "users ";
314 $sync_users = 1;
315 } elsif ($scope eq 'groups') {
316 $errorstring .= "groups ";
317 $sync_groups = 1;
318 } elsif ($scope eq 'both') {
319 $errorstring .= "users and groups ";
320 $sync_users = $sync_groups = 1;
321 }
322 $errorstring .= "failed.";
323
324 my $plugin = PVE::Auth::Plugin->lookup($ids->{$realm}->{type});
325
326 my $realmdata = $ids->{$realm};
327 my $users = {};
328 my $groups = {};
329
330
331 my $worker = sub {
332 print "starting sync for $realm\n";
333 if ($sync_groups) {
334 my $dnmap = {};
335 ($users, $dnmap) = $plugin->get_users($realmdata, $realm);
336 $groups = $plugin->get_groups($realmdata, $realm, $dnmap);
337 } else {
338 $users = $plugin->get_users($realmdata, $realm);
339 }
340
341 PVE::AccessControl::lock_user_config(
342 sub {
343 my $usercfg = cfs_read_file("user.cfg");
344 print "got data from server, modifying users/groups\n";
345
346 if ($sync_users) {
347 print "syncing users\n";
348 my $oldusers = $usercfg->{users};
349
350 my $oldtokens = {};
351 my $oldenabled = {};
352
353 if ($param->{full}) {
354 print "full sync, deleting existing users first\n";
355 foreach my $userid (keys %$oldusers) {
356 next if $userid !~ m/\@$realm$/;
357 # we save the old tokens
358 $oldtokens->{$userid} = $oldusers->{$userid}->{tokens};
359 $oldenabled->{$userid} = $oldusers->{$userid}->{enable} // 0;
360 delete $oldusers->{$userid};
361 PVE::AccessControl::delete_user_acl($userid, $usercfg)
362 if $param->{purge} && !$users->{$userid};
363 print "removed user '$userid'\n";
364 }
365 }
366
367 foreach my $userid (keys %$users) {
368 my $user = $users->{$userid};
369 if (!defined($oldusers->{$userid})) {
370 $oldusers->{$userid} = $user;
371
372 if (defined($oldenabled->{$userid})) {
373 $oldusers->{$userid}->{enable} = $oldenabled->{$userid};
374 } elsif ($param->{enable}) {
375 $oldusers->{$userid}->{enable} = 1;
376 }
377
378 if (defined($oldtokens->{$userid})) {
379 $oldusers->{$userid}->{tokens} = $oldtokens->{$userid};
380 }
381
382 print "added user '$userid'\n";
383 } else {
384 my $olduser = $oldusers->{$userid};
385 foreach my $attr (keys %$user) {
386 $olduser->{$attr} = $user->{$attr};
387 }
388 print "updated user '$userid'\n";
389 }
390 }
391 }
392
393 if ($sync_groups) {
394 print "syncing groups\n";
395 my $oldgroups = $usercfg->{groups};
396
397 if ($param->{full}) {
398 print "full sync, deleting existing groups first\n";
399 foreach my $groupid (keys %$oldgroups) {
400 next if $groupid !~ m/\-$realm$/;
401 delete $oldgroups->{$groupid};
402 PVE::AccessControl::delete_group_acl($groupid, $usercfg)
403 if $param->{purge} && !$groups->{$groupid};
404 print "removed group '$groupid'\n";
405 }
406 }
407
408 foreach my $groupid (keys %$groups) {
409 my $group = $groups->{$groupid};
410 if (!defined($oldgroups->{$groupid})) {
411 $oldgroups->{$groupid} = $group;
412 print "added group '$groupid'\n";
413 } else {
414 my $oldgroup = $oldgroups->{$groupid};
415 foreach my $attr (keys %$group) {
416 $oldgroup->{$attr} = $group->{$attr};
417 }
418 print "updated group '$groupid'\n";
419 }
420 }
421 }
422 cfs_write_file("user.cfg", $usercfg);
423 print "updated user.cfg\n";
424 }, $errorstring);
425 };
426
427 return $rpcenv->fork_worker('ldapsync', $realm, $authuser, $worker);
428 }});
429
2c3a6c0a 4301;