]>
git.proxmox.com Git - pmg-api.git/blob - PMG/LDAPCache.pm
1 package PMG
::LDAPCache
;
9 use Net
::LDAP
::Control
::Paged
;
10 use Net
::LDAP
::Constant qw
(LDAP_CONTROL_PAGED
);
17 $DB_HASH->{'cachesize'} = 10000;
18 $DB_RECNO->{'cachesize'} = 10000;
19 $DB_BTREE->{'cachesize'} = 10000;
20 $DB_BTREE->{'flags'} = R_DUP
;
22 my $cachedir = '/var/lib/pmg';
29 # users (hash): UID -> pmail, account, DN
30 # dnames (hash): DN -> UID
31 # accounts (hash): account -> UID
32 # mail (hash): mail -> UID
33 # groups (hash): group -> GID
34 # memberof (btree): UID -> GID
36 my @dbs = ('users', 'dnames', 'groups', 'mails', 'accounts', 'memberof');
39 my ($self, %args) = @_;
41 my $type = ref($self) || $self;
43 die "undefined ldap id" if !$args{id
};
47 if ($ldapcache->{$id}) {
48 $self = $ldapcache->{$id};
50 $ldapcache->{$id} = $self = bless {}, $type;
54 if (!$args{mailattr
}) {
55 $args{mailattr
} = "mail, userPrincipalName, proxyAddresses, othermailbox";
57 $args{mailattr
} =~ s/[\,\;]/ /g;
58 $args{mailattr
} =~ s/\s+/,/g;
60 if ($args{mode
} && ($args{mode
} eq 'ldap' || $args{mode
} eq 'ldaps')) {
61 $self->{mode
} = $args{mode
};
63 $self->{mode
} = 'ldap';
66 $self->{accountattr
} = $args{accountattr
} || 'sAMAccountName';
67 @{$self->{mailattr
}} = split(/,/, $args{mailattr
});
68 $self->{server1
} = $args{server1
};
69 $self->{server2
} = $args{server2
};
70 $self->{binddn
} = $args{binddn
};
71 $self->{bindpw
} = $args{bindpw
};
72 $self->{basedn
} = $args{basedn
};
73 $self->{port
} = $args{port
};
74 $self->{groupbasedn
} = $args{groupbasedn
};
75 $self->{filter
} = $args{filter
};
77 if ($args{syncmode
} == 1) {
78 # read local data only
84 return $self if !($args{server1
});
86 if ($args{syncmode
} == 2) {
99 my $dir = "$cachedir/ldapdb_$id";
100 my $scheme = LockFile
::Simple-
>make(
101 -warn => 0, -stale
=> 1, -autoclean
=> 1);
102 my $lock = $scheme->lock($dir);
108 my ($class, $id) = @_;
110 if (my $lock = lockdir
($id)) {
111 delete $ldapcache->{$id};
112 delete $last_atime->{$id};
113 my $dir = "$cachedir/ldapdb_$id";
117 syslog
('err' , "can't lock ldap database '$id'");
122 my ($self, $syncmode) = @_;
124 if ($syncmode == 1) {
125 # read local data only
126 $self->{errors
} = '';
128 } elsif ($syncmode == 2) {
137 my ($self, $ldap) = @_;
140 foreach my $attr (@{$self->{mailattr
}}) {
141 $filter .= "($attr=*)";
145 if ($self->{filter
}) {
146 my $tmp = $self->{filter
};
147 $tmp = "($tmp)" if $tmp !~ m/^\(.*\)$/;
149 $filter = "(&${filter}${tmp})";
152 my $page = Net
::LDAP
::Control
::Paged-
>new(size
=> 900);
155 base
=> $self->{basedn
},
158 control
=> [ $page ],
159 attrs
=> [ @{$self->{mailattr
}}, $self->{accountattr
}, 'memberOf' ]
166 my $mesg = $ldap->search(@args);
170 my $err = "ldap user search error: " . $mesg->error;
171 $self->{errors
} .= "$err\n";
176 #foreach my $entry ($mesg->entries) { $entry->dump; }
177 foreach my $entry ($mesg->entries) {
183 foreach my $attr (@{$self->{mailattr
}}) {
184 foreach my $mail ($entry->get_value($attr)) {
186 # Test if the Line starts with one of the following lines:
187 # proxyAddresses: [smtp|SMTP]:
188 # and also discard this starting string, so that $mail is only the
189 # address without any other characters...
191 $mail =~ s/^(smtp|SMTP)[\:\$]//gs;
193 if ($mail !~ m/[\{\}\\\/]/ && $mail =~ m/^\S
+\
@\S+$/) {
194 $umails->{$mail} = 1;
195 $pmail = $mail if !$pmail;
199 my $addresses = [ keys %$umails ];
201 next if !$pmail; # account has no email addresses
204 $self->{dbstat
}->{dnames
}->{dbh
}->get($dn, $cuid);
206 $cuid = ++$self->{dbstat
}->{dnames
}->{idcount
};
207 $self->{dbstat
}->{dnames
}->{dbh
}->put($dn, $cuid);
210 my $account = $entry->get_value($self->{accountattr
});
211 if ($account && ($account =~ m/^\S+$/s)) {
212 $account = lc($account);
213 $self->{dbstat
}->{accounts
}->{dbh
}->put($account, $cuid);
218 my $data = pack('n/a* n/a* n/a*', $pmail, $account, $dn);
219 $self->{dbstat
}->{users
}->{dbh
}->put($cuid, $data);
221 foreach my $mail (@$addresses) {
222 $self->{dbstat
}->{mails
}->{dbh
}->put($mail, $cuid);
225 if (!$self->{groupbasedn
}) {
226 my @groups = $entry->get_value('memberOf');
227 foreach my $group (@groups) {
229 $self->{dbstat
}->{groups
}->{dbh
}->get($group, $cgid);
231 $cgid = ++$self->{dbstat
}->{groups
}->{idcount
};
232 $self->{dbstat
}->{groups
}->{dbh
}->put($group, $cgid);
234 $self->{dbstat
}->{memberof
}->{dbh
}->put($cuid, $cgid);
239 # Get cookie from paged control
240 my ($resp) = $mesg->control(LDAP_CONTROL_PAGED
) or last;
241 $cookie = $resp->cookie or last;
243 # Set cookie in paged control
244 $page->cookie($cookie);
249 # We had an abnormal exit, so let the server know we do not want any more
250 $page->cookie($cookie);
252 $ldap->search(@args);
253 my $err = "LDAP user query unsuccessful";
254 $self->{errors
} .= "$err\n";
260 my ($self, $ldap) = @_;
262 return undef if !$self->{groupbasedn
};
264 my $filter = "(|(objectclass=group)(objectclass=univentionGroup))";
266 my $page = Net
::LDAP
::Control
::Paged-
>new(size
=> 100);
268 my @args = ( base
=> $self->{groupbasedn
},
271 control
=> [ $page ],
272 attrs
=> [ 'member', 'uniqueMember' ],
278 my $mesg = $ldap->search(@args);
282 my $err = "ldap group search error: " . $mesg->error;
283 $self->{errors
} .= "$err\n";
288 foreach my $entry ( $mesg->entries ) {
289 my $group = $entry->dn;
290 my @members = $entry->get_value('member');
291 if (!scalar(@members)) {
292 @members = $entry->get_value('uniqueMember');
295 $self->{dbstat
}->{groups
}->{dbh
}->get($group, $cgid);
297 $cgid = ++$self->{dbstat
}->{groups
}->{idcount
};
298 $self->{dbstat
}->{groups
}->{dbh
}->put($group, $cgid);
301 foreach my $m (@members) {
304 $self->{dbstat
}->{dnames
}->{dbh
}->get($m, $cuid);
306 $cuid = ++$self->{dbstat
}->{dnames
}->{idcount
};
307 $self->{dbstat
}->{dnames
}->{dbh
}->put($m, $cuid);
310 $self->{dbstat
}->{memberof
}->{dbh
}->put($cuid, $cgid);
314 # Get cookie from paged control
315 my ($resp) = $mesg->control(LDAP_CONTROL_PAGED
) or last;
316 $cookie = $resp->cookie or last;
318 # Set cookie in paged control
319 $page->cookie($cookie);
323 # We had an abnormal exit, so let the server know we do not want any more
324 $page->cookie($cookie);
326 $ldap->search(@args);
327 my $err = "LDAP group query unsuccessful";
328 $self->{errors
} .= "$err\n";
336 my $hosts = [ $self->{server1
} ];
338 push @$hosts, $self->{server2
} if $self->{server2
};
340 my $opts = { timeout
=> 10, onerror
=> 'die' };
342 $opts->{port
} = $self->{port
} if $self->{port
};
343 $opts->{schema
} = $self->{mode
};
345 return Net
::LDAP-
>new($hosts, %$opts);
348 sub ldap_connect_and_bind
{
351 my $ldap = $self->ldap_connect() ||
352 die "Can't bind to ldap server '$self->{id}': $!\n";
356 if ($self->{binddn
}) {
357 $mesg = $ldap->bind($self->{binddn
}, password
=> $self->{bindpw
});
359 $mesg = $ldap->bind(); # anonymous bind
362 die "ldap bind failed: " . $mesg->error . "\n" if $mesg->code;
364 if (!$self->{basedn
}) {
365 my $root = $ldap->root_dse(attrs
=> [ 'defaultNamingContext' ]);
366 $self->{basedn
} = $root->get_value('defaultNamingContext');
375 my $dir = "ldapdb_" . $self->{id
};
376 mkdir "$cachedir/$dir";
378 # open ldap connection
380 syslog
('info', "syncing ldap database '$self->{id}'");
384 eval { $ldap = $self->ldap_connect_and_bind(); };
386 $self->{errors
} .= "$err\n";
391 # open temporary database files
395 foreach my $db (@dbs) {
396 $self->{dbstat
}->{$db}->{tmpfilename
} = "$cachedir/$dir/${db}_tmp$$.db";
397 $olddbh->{$db} = $self->{dbstat
}->{$db}->{dbh
};
400 my $error_cleanup = sub {
401 # close and delete all files
402 foreach my $db (@dbs) {
403 undef $self->{dbstat
}->{$db}->{dbh
};
404 unlink $self->{dbstat
}->{$db}->{tmpfilename
};
405 $self->{dbstat
}->{$db}->{dbh
} = $olddbh->{$db};
410 foreach my $db (@dbs) {
411 my $filename = $self->{dbstat
}->{$db}->{tmpfilename
};
412 $self->{dbstat
}->{$db}->{idcount
} = 0;
415 if ($db eq 'memberof') {
416 $self->{dbstat
}->{$db}->{dbh
} =
417 tie
(my %h, 'DB_File', $filename,
418 O_CREAT
|O_RDWR
, 0666, $DB_BTREE);
420 $self->{dbstat
}->{$db}->{dbh
} =
421 tie
(my %h, 'DB_File', $filename,
422 O_CREAT
|O_RDWR
, 0666, $DB_HASH);
425 die "unable to open database file '$filename': $!\n"
426 if !$self->{dbstat
}->{$db}->{dbh
};
431 $self->{errors
} .= $err;
436 $self->querygroups ($ldap) if $self->{groupbasedn
};
438 $self->queryusers($ldap) if !$self->{errors
};
442 if ($self->{errors
}) {
447 my $lock = lockdir
($self->{id
});
450 my $err = "unable to get database lock for ldap database '$self->{id}'";
451 $self->{errors
} .= "$err\n";
457 foreach my $db (@dbs) {
458 my $filename = $self->{dbstat
}->{$db}->{filename
} =
459 "$cachedir/$dir/${db}.db";
460 $self->{dbstat
}->{$db}->{dbh
}->sync(); # flush everything
461 rename $self->{dbstat
}->{$db}->{tmpfilename
}, $filename;
466 $last_atime->{$self->{id
}} = time();
468 $self->{gcount
} = $self->{dbstat
}->{groups
}->{idcount
};
469 $self->{ucount
} = __count_entries
($self->{dbstat
}->{accounts
}->{dbh
});
470 $self->{mcount
} = __count_entries
($self->{dbstat
}->{mails
}->{dbh
});
472 syslog
('info', "ldap sync '$self->{id}' successful ($self->{mcount})");
475 sub __count_entries
{
483 my $status = $dbh->seq($key, $value, R_FIRST
());
485 while ($status == 0) {
487 $status = $dbh->seq($key, $value, R_NEXT
());
494 my ($self, $try) = @_;
496 my $dir = "ldapdb_" . $self->{id
};
497 mkdir "$cachedir/$dir";
499 my $filename = "$cachedir/$dir/mails.db";
501 return if $last_atime->{$self->{id
}} &&
502 PMG
::Utils
::file_older_than
($filename, $last_atime->{$self->{id
}});
505 foreach my $db (@dbs) {
506 my $filename = $self->{dbstat
}->{$db}->{filename
} =
507 "$cachedir/$dir/${db}.db";
508 $self->{dbstat
}->{$db}->{idcount
} = 0;
509 if ($db eq 'memberof') {
510 $self->{dbstat
}->{$db}->{dbh
} =
511 tie
(my %h, 'DB_File', $filename,
512 O_RDONLY
, 0666, $DB_BTREE);
514 $self->{dbstat
}->{$db}->{dbh
} =
515 tie
(my %h, 'DB_File', $filename,
516 O_RDONLY
, 0666, $DB_HASH);
519 if (!$self->{dbstat
}->{$db}->{dbh
} && !$try) {
520 my $err = "ldap error - unable to open database file '$filename': $!";
521 $self->{errors
} .= "$err\n";
522 syslog
('err', $err) if !$self->{dbstat
}->{$db}->{dbh
};
527 $last_atime->{$self->{id
}} = time();
529 $self->{gcount
} = __count_entries
($self->{dbstat
}->{groups
}->{dbh
});
530 $self->{ucount
} = __count_entries
($self->{dbstat
}->{accounts
}->{dbh
});
531 $self->{mcount
} = __count_entries
($self->{dbstat
}->{mails
}->{dbh
});
535 my ($self, $force) = @_;
537 $self->{errors
} = '';
540 # only sync if file is older than 1 hour
542 my $dir = "ldapdb_" . $self->{id
};
543 mkdir "$cachedir/$dir";
544 my $filename = "$cachedir/$dir/mails.db";
547 !PMG
::Utils
::file_older_than
($filename, time() - 3600)) {
553 $self->sync_database();
555 if ($self->{errors
}) {
565 my $dbh = $self->{dbstat
}->{groups
}->{dbh
};
567 return $res if !$dbh;
571 my $status = $dbh->seq($key, $value, R_FIRST
());
574 while ($status == 0) {
578 $status = $dbh->seq($key, $value, R_NEXT
());
589 my $dbh = $self->{dbstat
}->{users
}->{dbh
};
591 return $res if !$dbh;
595 my $status = $dbh->seq($key, $value, R_FIRST
());
598 while ($status == 0) {
599 my ($pmail, $account, $dn) = unpack('n/a* n/a* n/a*', $value);
605 $status = $dbh->seq($key, $value, R_NEXT
());
612 my ($self, $mail) = @_;
614 my $dbhmails = $self->{dbstat
}->{mails
}->{dbh
};
615 my $dbhusers = $self->{dbstat
}->{users
}->{dbh
};
617 return undef if !$dbhmails || !$dbhusers;
624 $dbhmails->get($mail, $cuid);
625 return undef if !$cuid;
628 $dbhusers->get($cuid, $rdata);
629 return undef if !$rdata;
631 my ($pmail, $account, $dn) = unpack('n/a* n/a* n/a*', $rdata);
633 push @$res, { primary
=> 1, email
=> $pmail };
637 my $status = $dbhmails->seq($key, $value, R_FIRST
());
639 while ($status == 0) {
640 if ($value == $cuid && $key ne $pmail) {
641 push @$res, { primary
=> 0, email
=> $key };
643 $status = $dbhmails->seq($key, $value, R_NEXT
());
650 my ($self, $mail) = @_;
652 my $dbh = $self->{dbstat
}->{mails
}->{dbh
};
658 $dbh->get($mail, $res);
663 my ($self, $account) = @_;
665 my $dbh = $self->{dbstat
}->{accounts
}->{dbh
};
668 $account = lc($account);
671 $dbh->get($account, $res);
676 my ($self, $group) = @_;
678 my $dbh = $self->{dbstat
}->{groups
}->{dbh
};
682 $dbh->get($group, $res);
686 sub account_has_address
{
687 my ($self, $account, $mail) = @_;
689 my $dbhmails = $self->{dbstat
}->{mails
}->{dbh
};
690 my $dbhaccounts = $self->{dbstat
}->{accounts
}->{dbh
};
691 return 0 if !$dbhmails || !$dbhaccounts;
693 $account = lc($account);
697 $dbhaccounts->get($account, $accid);
701 $dbhmails->get($mail, $mailid);
702 return 0 if !$mailid;
704 return ($accid == $mailid);
708 my ($self, $mail, $group) = @_;
710 my $dbhmails = $self->{dbstat
}->{mails
}->{dbh
};
711 my $dbhgroups = $self->{dbstat
}->{groups
}->{dbh
};
712 my $dbhmemberof = $self->{dbstat
}->{memberof
}->{dbh
};
714 return 0 if !$dbhmails || !$dbhgroups || !$dbhmemberof;
719 $dbhmails->get($mail, $cuid);
723 $dbhgroups->get($group, $groupid);
724 return 0 if !$groupid;
726 my @gida = $dbhmemberof->get_dup($cuid);
728 return grep { $_ eq $groupid } @gida;
732 my ($self, $mail, $scan) = @_;
734 my $dbhmails = $self->{dbstat
}->{mails
}->{dbh
};
735 my $dbhusers = $self->{dbstat
}->{users
}->{dbh
};
737 return undef if !$dbhmails || !$dbhusers;
744 $dbhmails->get($mail, $cuid);
745 return undef if !$cuid;
748 $dbhusers->get($cuid, $rdata);
749 return undef if !$rdata;
751 my ($pmail, $account, $dn) = unpack('n/a* n/a* n/a*', $rdata);
754 $res->{account
} = $account;
755 $res->{pmail
} = $pmail;
760 my $status = $dbhmails->seq($key, $value, R_FIRST
());
763 while ($status == 0) {
764 push @$mails, $key if $value == $cuid;
765 $status = $dbhmails->seq($key, $value, R_NEXT
());
767 $res->{mails
} = $mails;