]> git.proxmox.com Git - pmg-api.git/blame - PMG/LDAPCache.pm
PMG/API2/LDAP.pm: do not include errors and basedn
[pmg-api.git] / PMG / LDAPCache.pm
CommitLineData
cad3d400
DM
1package PMG::LDAPCache;
2
3use strict;
4use warnings;
cad3d400
DM
5use File::Path;
6use LockFile::Simple;
7use Net::LDAP;
8use Net::LDAP::Control::Paged;
9use Net::LDAP::Constant qw (LDAP_CONTROL_PAGED);
10use DB_File;
11
12use PVE::SafeSyslog;
13
14use PMG::Utils;
15
16$DB_HASH->{'cachesize'} = 10000;
17$DB_RECNO->{'cachesize'} = 10000;
18$DB_BTREE->{'cachesize'} = 10000;
19$DB_BTREE->{'flags'} = R_DUP ;
20
3278b571 21my $cachedir = '/var/lib/pmg';
cad3d400
DM
22
23my $last_atime = {};
24my $ldapcache = {};
25
26# DB Description
27#
28# users (hash): UID -> pmail, account, DN
29# dnames (hash): DN -> UID
30# accounts (hash): account -> UID
31# mail (hash): mail -> UID
32# groups (hash): group -> GID
33# memberof (btree): UID -> GID
34#
35my @dbs = ('users', 'dnames', 'groups', 'mails', 'accounts', 'memberof');
36
37sub new {
909eec64 38 my ($self, %args) = @_;
cad3d400
DM
39
40 my $type = ref($self) || $self;
41
909eec64 42 die "undefined ldap id" if !$args{id};
cad3d400
DM
43
44 my $id = $args{id};
cad3d400
DM
45
46 if ($ldapcache->{$id}) {
47 $self = $ldapcache->{$id};
48 } else {
49 $ldapcache->{$id} = $self = bless {}, $type;
50 $self->{id} = $id;
51 }
52
53 if (!$args{mailattr}) {
54 $args{mailattr} = "mail, userPrincipalName, proxyAddresses, othermailbox";
55 }
56 $args{mailattr} =~ s/[\,\;]/ /g;
57 $args{mailattr} =~ s/\s+/,/g;
58
59 if ($args{mode} && ($args{mode} eq 'ldap' || $args{mode} eq 'ldaps')) {
60 $self->{mode} = $args{mode};
61 } else {
62 $self->{mode} = 'ldap';
63 }
64
65 $self->{accountattr} = $args{accountattr} || 'sAMAccountName';
66 @{$self->{mailattr}} = split(/,/, $args{mailattr});
67 $self->{server1} = $args{server1};
68 $self->{server2} = $args{server2};
69 $self->{binddn} = $args{binddn};
70 $self->{bindpw} = $args{bindpw};
71 $self->{basedn} = $args{basedn};
72 $self->{port} = $args{port};
73 $self->{groupbasedn} = $args{groupbasedn};
74 $self->{filter} = $args{filter};
75
76 if ($args{syncmode} == 1) {
77 # read local data only
78 $self->{errors} = '';
79 $self->loadcache();
80 return $self;
81 }
82
83 return $self if !($args{server1});
84
85 if ($args{syncmode} == 2) {
86 # force sync
87 $self->loaddata(1);
88 } else {
89 $self->loaddata();
90 }
91
92 return $self;
93}
94
95sub lockdir {
96 my ($id) = @_;
97
98 my $dir = "$cachedir/ldapdb_$id";
99 my $scheme = LockFile::Simple->make(
100 -warn => 0, -stale => 1, -autoclean => 1);
101 my $lock = $scheme->lock($dir);
102
103 return $lock;
104}
105
106sub delete {
107 my ($class, $id) = @_;
108
cad3d400
DM
109 if (my $lock = lockdir($id)) {
110 delete $ldapcache->{$id};
111 delete $last_atime->{$id};
112 my $dir = "$cachedir/ldapdb_$id";
113 rmtree $dir;
114 $lock->release;
115 } else {
116 syslog('err' , "can't lock ldap database '$id'");
117 }
118}
119
120sub update {
121 my ($self, $syncmode) = @_;
122
123 if ($syncmode == 1) {
124 # read local data only
125 $self->{errors} = '';
126 $self->loadcache();
127 } elsif ($syncmode == 2) {
128 # force sync
129 $self->loaddata(1);
130 } else {
131 $self->loaddata();
132 }
133}
134
135sub queryusers {
136 my ($self, $ldap) = @_;
137
138 my $filter = '(|';
139 foreach my $attr (@{$self->{mailattr}}) {
140 $filter .= "($attr=*)";
141 }
142 $filter .= ')';
143
144 if ($self->{filter}) {
145 my $tmp = $self->{filter};
146 $tmp = "($tmp)" if $tmp !~ m/^\(.*\)$/;
147
148 $filter = "(&${filter}${tmp})";
149 }
150
151 my $page = Net::LDAP::Control::Paged->new(size => 900);
152
153 my @args = (
154 base => $self->{basedn},
155 scope => "subtree",
156 filter => $filter,
157 control => [ $page ],
158 attrs => [ @{$self->{mailattr}}, $self->{accountattr}, 'memberOf' ]
159 );
160
161 my $cookie;
162
163 while(1) {
164
165 my $mesg = $ldap->search(@args);
166
167 # stop on error
168 if ($mesg->code) {
169 my $err = "ldap user search error: " . $mesg->error;
170 $self->{errors} .= "$err\n";
171 syslog('err', $err);
172 last;
173 }
174
175 #foreach my $entry ($mesg->entries) { $entry->dump; }
176 foreach my $entry ($mesg->entries) {
177 my $dn = $entry->dn;
178
179 my $umails = {};
180 my $pmail;
181
182 foreach my $attr (@{$self->{mailattr}}) {
183 foreach my $mail ($entry->get_value($attr)) {
184 $mail = lc($mail);
185 # Test if the Line starts with one of the following lines:
186 # proxyAddresses: [smtp|SMTP]:
187 # and also discard this starting string, so that $mail is only the
188 # address without any other characters...
189
190 $mail =~ s/^(smtp|SMTP)[\:\$]//gs;
191
192 if ($mail !~ m/[\{\}\\\/]/ && $mail =~ m/^\S+\@\S+$/) {
193 $umails->{$mail} = 1;
194 $pmail = $mail if !$pmail;
195 }
196 }
197 }
198 my $addresses = [ keys %$umails ];
199
200 next if !$pmail; # account has no email addresses
201
202 my $cuid;
203 $self->{dbstat}->{dnames}->{dbh}->get($dn, $cuid);
204 if (!$cuid) {
205 $cuid = ++$self->{dbstat}->{dnames}->{idcount};
206 $self->{dbstat}->{dnames}->{dbh}->put($dn, $cuid);
207 }
208
209 my $account = $entry->get_value($self->{accountattr});
210 if ($account && ($account =~ m/^\S+$/s)) {
211 $account = lc($account);
212 $self->{dbstat}->{accounts}->{dbh}->put($account, $cuid);
213 } else {
214 $account = '';
215 }
216
217 my $data = pack('n/a* n/a* n/a*', $pmail, $account, $dn);
218 $self->{dbstat}->{users}->{dbh}->put($cuid, $data);
219
220 foreach my $mail (@$addresses) {
221 $self->{dbstat}->{mails}->{dbh}->put($mail, $cuid);
222 }
223
224 if (!$self->{groupbasedn}) {
225 my @groups = $entry->get_value('memberOf');
226 foreach my $group (@groups) {
227 my $cgid;
228 $self->{dbstat}->{groups}->{dbh}->get($group, $cgid);
229 if (!$cgid) {
230 $cgid = ++$self->{dbstat}->{groups}->{idcount};
231 $self->{dbstat}->{groups}->{dbh}->put($group, $cgid);
232 }
233 $self->{dbstat}->{memberof}->{dbh}->put($cuid, $cgid);
234 }
235 }
236 }
237
238 # Get cookie from paged control
239 my ($resp) = $mesg->control(LDAP_CONTROL_PAGED) or last;
240 $cookie = $resp->cookie or last;
241
242 # Set cookie in paged control
243 $page->cookie($cookie);
244 }
245
246
247 if ($cookie) {
248 # We had an abnormal exit, so let the server know we do not want any more
249 $page->cookie($cookie);
250 $page->size(0);
251 $ldap->search(@args);
252 my $err = "LDAP user query unsuccessful";
253 $self->{errors} .= "$err\n";
254 syslog('err', $err);
255 }
256}
257
258sub querygroups {
259 my ($self, $ldap) = @_;
260
261 return undef if !$self->{groupbasedn};
262
263 my $filter = "(objectclass=group)";
264
265 my $page = Net::LDAP::Control::Paged->new(size => 100);
266
267 my @args = ( base => $self->{groupbasedn},
268 scope => "subtree",
269 filter => $filter,
270 control => [ $page ],
271 attrs => [ 'member' ]
272 );
273
274 my $cookie;
275 while(1) {
276
277 my $mesg = $ldap->search(@args);
278
279 # stop on error
280 if ($mesg->code) {
281 my $err = "ldap group search error: " . $mesg->error;
282 $self->{errors} .= "$err\n";
283 syslog('err', $err);
284 last;
285 }
286
287 foreach my $entry ( $mesg->entries ) {
288 my $group = $entry->dn;
289 my @members = $entry->get_value('member');
290
291 my $cgid;
292 $self->{dbstat}->{groups}->{dbh}->get($group, $cgid);
293 if (!$cgid) {
294 $cgid = ++$self->{dbstat}->{groups}->{idcount};
295 $self->{dbstat}->{groups}->{dbh}->put($group, $cgid);
296 }
297
298 foreach my $m (@members) {
299
300 my $cuid;
301 $self->{dbstat}->{dnames}->{dbh}->get($m, $cuid);
302 if (!$cuid) {
303 $cuid = ++$self->{dbstat}->{dnames}->{idcount};
304 $self->{dbstat}->{dnames}->{dbh}->put($m, $cuid);
305 }
306
307 $self->{dbstat}->{memberof}->{dbh}->put($cuid, $cgid);
308 }
309 }
310
311 # Get cookie from paged control
312 my ($resp) = $mesg->control(LDAP_CONTROL_PAGED) or last;
313 $cookie = $resp->cookie or last;
314
315 # Set cookie in paged control
316 $page->cookie($cookie);
317 }
318
319 if ($cookie) {
320 # We had an abnormal exit, so let the server know we do not want any more
321 $page->cookie($cookie);
322 $page->size(0);
323 $ldap->search(@args);
324 my $err = "LDAP group query unsuccessful";
325 $self->{errors} .= "$err\n";
326 syslog('err', $err);
327 }
328}
329
330sub ldap_connect {
331 my ($self) = @_;
332
333 my $mode = $self->{mode};
334 my $portstr = '';
335 $portstr = ':' . $self->{port} if $self->{port};
336
337 my $serverstr = "$mode://$self->{server1}${portstr}/";
338 my $ldap = Net::LDAP->new($serverstr);
339 if(!$ldap && $self->{server2} && $self->{server2} ne '127.0.0.1') {
340 $serverstr = "$mode://$self->{server2}${portstr}/";
341 $ldap = Net::LDAP->new($serverstr);
342 }
343
344 return $ldap;
345}
346
b183e761
DM
347sub ldap_connect_and_bind {
348 my ($self) = @_;
349
350 my $ldap = $self->ldap_connect() ||
351 die "Can't bind to ldap server '$self->{id}': $!\n";
352
353 my $mesg;
354
355 if ($self->{binddn}) {
356 $mesg = $ldap->bind($self->{binddn}, password => $self->{bindpw});
357 } else {
358 $mesg = $ldap->bind(); # anonymous bind
359 }
360
361 die "ldap bind failed: " . $mesg->error . "\n" if $mesg->code;
362
363 if (!$self->{basedn}) {
364 my $root = $ldap->root_dse(attrs => [ 'defaultNamingContext' ]);
365 $self->{basedn} = $root->get_value('defaultNamingContext');
366 }
367
368 return $ldap;
369}
370
cad3d400
DM
371sub sync_database {
372 my ($self) = @_;
373
374 my $dir = "ldapdb_" . $self->{id};
375 mkdir "$cachedir/$dir";
376
377 # open ldap connection
378
379 syslog('info', "syncing ldap database '$self->{id}'");
380
b183e761 381 my $ldap;
cad3d400 382
b183e761
DM
383 eval { $ldap = $self->ldap_connect_and_bind(); };
384 if (my $err = $@) {
cad3d400
DM
385 $self->{errors} .= "$err\n";
386 syslog('err', $err);
387 return;
388 }
389
cad3d400
DM
390 # open temporary database files
391
392 my $olddbh = {};
393
394 foreach my $db (@dbs) {
395 $self->{dbstat}->{$db}->{tmpfilename} = "$cachedir/$dir/${db}_tmp$$.db";
396 $olddbh->{$db} = $self->{dbstat}->{$db}->{dbh};
397 }
398
399 eval {
400 foreach my $db (@dbs) {
401 my $filename = $self->{dbstat}->{$db}->{tmpfilename};
402 $self->{dbstat}->{$db}->{idcount} = 0;
403 unlink $filename;
404
405 if ($db eq 'memberof') {
406 $self->{dbstat}->{$db}->{dbh} =
407 tie (my %h, 'DB_File', $filename,
408 O_CREAT|O_RDWR, 0666, $DB_BTREE);
409 } else {
410 $self->{dbstat}->{$db}->{dbh} =
411 tie (my %h, 'DB_File', $filename,
412 O_CREAT|O_RDWR, 0666, $DB_HASH);
413 }
414
415 die "unable to open database file '$filename': $!\n"
416 if !$self->{dbstat}->{$db}->{dbh};
417 }
418 };
419
420 my $err = $@;
421
422 if ($err) {
423 # close and delete all files
424 foreach my $db (@dbs) {
425 undef $self->{dbstat}->{$db}->{dbh};
426 unlink $self->{dbstat}->{$db}->{tmpfilename};
427 $self->{dbstat}->{$db}->{dbh} = $olddbh->{$db};
428 }
429 $self->{errors} .= $err;
430 syslog('err', $err);
431
432 return;
433 }
434
435 $self->querygroups ($ldap) if $self->{groupbasedn};
436
437 if (!$self->{errors}) {
438 $self->queryusers($ldap);
439 }
440
441 $ldap->unbind;
442
443 if ($self->{errors}) {
444 # close and delete all files
445 foreach my $db (@dbs) {
446 undef $self->{dbstat}->{$db}->{dbh};
447 unlink $self->{dbstat}->{$db}->{tmpfilename};
448 $self->{dbstat}->{$db}->{dbh} = $olddbh->{$db};
449 }
450 } else {
451
452 my $lock = lockdir($self->{id});
453
454 if (!$lock) {
455 my $err = "unable to get database lock for ldap database '$self->{id}'";
456 $self->{errors} .= "$err\n";
457 syslog('err', $err);
458
459 # close and delete all files
460 foreach my $db (@dbs) {
461 undef $self->{dbstat}->{$db}->{dbh};
462 unlink $self->{dbstat}->{$db}->{tmpfilename};
463 $self->{dbstat}->{$db}->{dbh} = $olddbh->{$db};
464 }
465 } else {
466 foreach my $db (@dbs) {
467 my $filename = $self->{dbstat}->{$db}->{filename} =
468 "$cachedir/$dir/${db}.db";
469 $self->{dbstat}->{$db}->{dbh}->sync(); # flush everything
470 rename $self->{dbstat}->{$db}->{tmpfilename}, $filename;
471 }
472
473 $lock->release;
474
475 $last_atime->{$self->{id}} = time();
476
477 $self->{gcount} = $self->{dbstat}->{groups}->{idcount};
478 $self->{ucount} = __count_entries($self->{dbstat}->{accounts}->{dbh});
479 $self->{mcount} = __count_entries($self->{dbstat}->{mails}->{dbh});
b183e761
DM
480
481 syslog('info', "ldap sync '$self->{id}' successful ($self->{mcount})");
cad3d400
DM
482 }
483 }
484}
485
486sub __count_entries {
487 my ($dbh) = @_;
488
489 return 0 if !$dbh;
490
491 my $key = 0 ;
492 my $value = "" ;
493 my $count = 0;
494 my $status = $dbh->seq($key, $value, R_FIRST());
495
496 while ($status == 0) {
497 $count++;
498 $status = $dbh->seq($key, $value, R_NEXT());
499 }
500
501 return $count;
502}
503
504sub loadcache {
505 my ($self, $try) = @_;
506
507 my $dir = "ldapdb_" . $self->{id};
508 mkdir "$cachedir/$dir";
509
510 my $filename = "$cachedir/$dir/mails.db";
511
512 return if $last_atime->{$self->{id}} &&
513 PMG::Utils::file_older_than ($filename, $last_atime->{$self->{id}});
514
515 eval {
516 foreach my $db (@dbs) {
517 my $filename = $self->{dbstat}->{$db}->{filename} =
518 "$cachedir/$dir/${db}.db";
519 $self->{dbstat}->{$db}->{idcount} = 0;
520 if ($db eq 'memberof') {
521 $self->{dbstat}->{$db}->{dbh} =
522 tie (my %h, 'DB_File', $filename,
523 O_RDONLY, 0666, $DB_BTREE);
524 } else {
525 $self->{dbstat}->{$db}->{dbh} =
526 tie (my %h, 'DB_File', $filename,
527 O_RDONLY, 0666, $DB_HASH);
528 }
529
530 if (!$self->{dbstat}->{$db}->{dbh} && !$try) {
531 my $err = "ldap error - unable to open database file '$filename': $!";
532 $self->{errors} .= "$err\n";
533 syslog('err', $err) if !$self->{dbstat}->{$db}->{dbh};
534 }
535 }
536 };
537
538 $last_atime->{$self->{id}} = time();
539
540 $self->{gcount} = __count_entries($self->{dbstat}->{groups}->{dbh});
541 $self->{ucount} = __count_entries($self->{dbstat}->{accounts}->{dbh});
542 $self->{mcount} = __count_entries($self->{dbstat}->{mails}->{dbh});
543}
544
545sub loaddata {
546 my ($self, $force) = @_;
547
548 $self->{errors} = '';
549
550 if (!$force) {
551 # only sync if file is older than 1 hour
552
553 my $dir = "ldapdb_" . $self->{id};
554 mkdir "$cachedir/$dir";
555 my $filename = "$cachedir/$dir/mails.db";
556
557 if (-e $filename &&
558 !PMG::Utils::file_older_than($filename, time() - 3600)) {
559 $self->loadcache();
560 return;
561 }
562 }
563
564 $self->sync_database();
565
566 if ($self->{errors}) {
567 $self->loadcache(1);
568 }
569}
570
571sub groups {
572 my ($self) = @_;
573
574 my $dbh = $self->{dbstat}->{groups}->{dbh};
575 return [] if !$dbh;
576
577 my $key = 0 ;
578 my $value = "" ;
579 my $status = $dbh->seq($key, $value, R_FIRST());
580 my $keys;
581
582 while ($status == 0) {
583 push @$keys, $key;
584 $status = $dbh->seq($key, $value, R_NEXT());
585 }
586
587 return $keys;
588}
589
590sub mail_exists {
591 my ($self, $mail) = @_;
592
593 my $dbh = $self->{dbstat}->{mails}->{dbh};
594 return 0 if !$dbh;
595
596 $mail = lc($mail);
597
598 my $res;
599 $dbh->get($mail, $res);
600 return $res;
601}
602
603sub account_exists {
604 my ($self, $account) = @_;
605
606 my $dbh = $self->{dbstat}->{accounts}->{dbh};
607 return 0 if !$dbh;
608
609 $account = lc($account);
610
611 my $res;
612 $dbh->get($account, $res);
613 return $res;
614}
615
616sub account_has_address {
617 my ($self, $account, $mail) = @_;
618
619 my $dbhmails = $self->{dbstat}->{mails}->{dbh};
620 my $dbhaccounts = $self->{dbstat}->{accounts}->{dbh};
621 return 0 if !$dbhmails || !$dbhaccounts;
622
623 $account = lc($account);
624 $mail = lc($mail);
625
626 my $accid;
627 $dbhaccounts->get($account, $accid);
628 return 0 if !$accid;
629
630 my $mailid;
631 $dbhmails->get($mail, $mailid);
632 return 0 if !$mailid;
633
634 return ($accid == $mailid);
635}
636
637sub user_in_group {
638 my ($self, $mail, $group) = @_;
639
640 my $dbhmails = $self->{dbstat}->{mails}->{dbh};
641 my $dbhgroups = $self->{dbstat}->{groups}->{dbh};
642 my $dbhmemberof = $self->{dbstat}->{memberof}->{dbh};
643
644 return 0 if !$dbhmails || !$dbhgroups || !$dbhmemberof;
645
646 $mail = lc($mail);
647
648 my $cuid;
649 $dbhmails->get($mail, $cuid);
650 return 0 if !$cuid;
651
652 my $groupid;
653 $dbhgroups->get($group, $groupid);
654 return 0 if !$groupid;
655
656 my @gida = $dbhmemberof->get_dup($cuid);
657
658 return grep { $_ eq $groupid } @gida;
659}
660
661sub account_info {
662 my ($self, $mail, $scan) = @_;
663
664 my $dbhmails = $self->{dbstat}->{mails}->{dbh};
665 my $dbhusers = $self->{dbstat}->{users}->{dbh};
666
667 return undef if !$dbhmails || !$dbhusers;
668
669 $mail = lc($mail);
670
671 my $res = {};
672
673 my $cuid;
674 $dbhmails->get($mail, $cuid);
675 return undef if !$cuid;
676
677 my $rdata;
678 $dbhusers->get($cuid, $rdata);
679 return undef if !$rdata;
680
681 my ($pmail, $account, $dn) = unpack('n/a* n/a* n/a*', $rdata);
682
683 $res->{dn} = $dn;
684 $res->{account} = $account;
685 $res->{pmail} = $pmail;
686
687 if ($scan) {
688 my $key = 0 ;
689 my $value = "" ;
690 my $status = $dbhmails->seq($key, $value, R_FIRST());
691 my $mails;
692
693 while ($status == 0) {
694 push @$mails, $key if $value == $cuid;
695 $status = $dbhmails->seq($key, $value, R_NEXT());
696 }
697 $res->{mails} = $mails;
698 }
699
700 return $res;
701}
702
7031;