]>
git.proxmox.com Git - pmg-api.git/blob - PMG/LDAPCache.pm
9ac3fe3563cfb666ee7713fe590f96ca29e5129c
1 package PMG
::LDAPCache
;
9 use Net
::LDAP
::Control
::Paged
;
10 use Net
::LDAP
::Constant qw
(LDAP_CONTROL_PAGED
);
14 use PVE
::Tools
qw(split_list);
19 $DB_HASH->{'cachesize'} = 10000;
20 $DB_RECNO->{'cachesize'} = 10000;
21 $DB_BTREE->{'cachesize'} = 10000;
22 $DB_BTREE->{'flags'} = R_DUP
;
24 my $cachedir = '/var/lib/pmg';
31 # users (hash): UID -> pmail, account, DN
32 # dnames (hash): DN -> UID
33 # accounts (hash): account -> UID
34 # mail (hash): mail -> UID
35 # groups (hash): group -> GID
36 # memberof (btree): UID -> GID
38 my @dbs = ('users', 'dnames', 'groups', 'mails', 'accounts', 'memberof');
41 my ($self, %args) = @_;
43 my $type = ref($self) || $self;
45 die "undefined ldap id" if !$args{id
};
49 if ($ldapcache->{$id}) {
50 $self = $ldapcache->{$id};
52 $ldapcache->{$id} = $self = bless {}, $type;
56 my $config_properties = PMG
::LDAPConfig
::properties
();
58 # set defaults for the fields that have one
59 foreach my $property (keys %$config_properties) {
60 my $d = $config_properties->{$property};
61 next if !defined($d->{default});
62 $self->{$property} = $args{$property} || $d->{default};
65 # split list returns an array not a reference
66 $self->{accountattr
} = [split_list
($self->{accountattr
})];
67 $self->{mailattr
} = [split_list
($self->{mailattr
})];
69 $self->{server1
} = $args{server1
};
70 $self->{server2
} = $args{server2
};
71 $self->{binddn
} = $args{binddn
};
72 $self->{bindpw
} = $args{bindpw
};
73 $self->{basedn
} = $args{basedn
};
74 $self->{port
} = $args{port
};
75 $self->{groupbasedn
} = $args{groupbasedn
};
76 $self->{filter
} = $args{filter
};
78 if ($args{syncmode
} == 1) {
79 # read local data only
85 return $self if !($args{server1
});
87 if ($args{syncmode
} == 2) {
100 my $dir = "$cachedir/ldapdb_$id";
101 my $scheme = LockFile
::Simple-
>make(
102 -warn => 0, -stale
=> 1, -autoclean
=> 1);
103 my $lock = $scheme->lock($dir);
109 my ($class, $id) = @_;
111 if (my $lock = lockdir
($id)) {
112 delete $ldapcache->{$id};
113 delete $last_atime->{$id};
114 my $dir = "$cachedir/ldapdb_$id";
118 syslog
('err' , "can't lock ldap database '$id'");
123 my ($self, $syncmode) = @_;
125 if ($syncmode == 1) {
126 # read local data only
127 $self->{errors
} = '';
129 } elsif ($syncmode == 2) {
138 my ($self, $ldap) = @_;
141 foreach my $attr (@{$self->{mailattr
}}) {
142 $filter .= "($attr=*)";
146 if ($self->{filter
}) {
147 my $tmp = $self->{filter
};
148 $tmp = "($tmp)" if $tmp !~ m/^\(.*\)$/;
150 $filter = "(&${filter}${tmp})";
153 my $page = Net
::LDAP
::Control
::Paged-
>new(size
=> 900);
156 base
=> $self->{basedn
},
159 control
=> [ $page ],
160 attrs
=> [ @{$self->{mailattr
}}, @{$self->{accountattr
}}, 'memberOf' ]
167 my $mesg = $ldap->search(@args);
171 my $err = "ldap user search error: " . $mesg->error;
172 $self->{errors
} .= "$err\n";
177 #foreach my $entry ($mesg->entries) { $entry->dump; }
178 foreach my $entry ($mesg->entries) {
184 foreach my $attr (@{$self->{mailattr
}}) {
185 foreach my $mail ($entry->get_value($attr)) {
187 # Test if the Line starts with one of the following lines:
188 # proxyAddresses: [smtp|SMTP]:
189 # and also discard this starting string, so that $mail is only the
190 # address without any other characters...
192 $mail =~ s/^(smtp|SMTP)[\:\$]//gs;
194 if ($mail !~ m/[\{\}\\\/]/ && $mail =~ m/^\S
+\
@\S+$/) {
195 $umails->{$mail} = 1;
196 $pmail = $mail if !$pmail;
200 my $addresses = [ keys %$umails ];
202 next if !$pmail; # account has no email addresses
205 $self->{dbstat
}->{dnames
}->{dbh
}->get($dn, $cuid);
207 $cuid = ++$self->{dbstat
}->{dnames
}->{idcount
};
208 $self->{dbstat
}->{dnames
}->{dbh
}->put($dn, $cuid);
211 foreach my $attr (@{$self->{accountattr
}}) {
212 my $account = $entry->get_value($attr);
213 if ($account && ($account =~ m/^\S+$/s)) {
214 $account = lc($account);
215 $self->{dbstat
}->{accounts
}->{dbh
}->put($account, $cuid);
216 my $data = pack('n/a* n/a* n/a*', $pmail, $account, $dn);
217 $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
382 eval { $ldap = $self->ldap_connect_and_bind(); };
384 $self->{errors
} .= "$err\n";
389 # open temporary database files
393 foreach my $db (@dbs) {
394 $self->{dbstat
}->{$db}->{tmpfilename
} = "$cachedir/$dir/${db}_tmp$$.db";
395 $olddbh->{$db} = $self->{dbstat
}->{$db}->{dbh
};
398 my $error_cleanup = sub {
399 # close and delete all files
400 foreach my $db (@dbs) {
401 undef $self->{dbstat
}->{$db}->{dbh
};
402 unlink $self->{dbstat
}->{$db}->{tmpfilename
};
403 $self->{dbstat
}->{$db}->{dbh
} = $olddbh->{$db};
408 foreach my $db (@dbs) {
409 my $filename = $self->{dbstat
}->{$db}->{tmpfilename
};
410 $self->{dbstat
}->{$db}->{idcount
} = 0;
413 if ($db eq 'memberof') {
414 $self->{dbstat
}->{$db}->{dbh
} =
415 tie
(my %h, 'DB_File', $filename,
416 O_CREAT
|O_RDWR
, 0666, $DB_BTREE);
418 $self->{dbstat
}->{$db}->{dbh
} =
419 tie
(my %h, 'DB_File', $filename,
420 O_CREAT
|O_RDWR
, 0666, $DB_HASH);
423 die "unable to open database file '$filename': $!\n"
424 if !$self->{dbstat
}->{$db}->{dbh
};
429 $self->{errors
} .= $err;
434 $self->querygroups ($ldap) if $self->{groupbasedn
};
436 $self->queryusers($ldap) if !$self->{errors
};
440 if ($self->{errors
}) {
445 my $lock = lockdir
($self->{id
});
448 my $err = "unable to get database lock for ldap database '$self->{id}'";
449 $self->{errors
} .= "$err\n";
455 foreach my $db (@dbs) {
456 my $filename = $self->{dbstat
}->{$db}->{filename
} =
457 "$cachedir/$dir/${db}.db";
458 $self->{dbstat
}->{$db}->{dbh
}->sync(); # flush everything
459 rename $self->{dbstat
}->{$db}->{tmpfilename
}, $filename;
464 $last_atime->{$self->{id
}} = time();
466 $self->{gcount
} = $self->{dbstat
}->{groups
}->{idcount
};
467 $self->{ucount
} = __count_entries
($self->{dbstat
}->{accounts
}->{dbh
});
468 $self->{mcount
} = __count_entries
($self->{dbstat
}->{mails
}->{dbh
});
471 sub __count_entries
{
479 my $status = $dbh->seq($key, $value, R_FIRST
());
481 while ($status == 0) {
483 $status = $dbh->seq($key, $value, R_NEXT
());
490 my ($self, $try) = @_;
492 my $dir = "ldapdb_" . $self->{id
};
493 mkdir "$cachedir/$dir";
495 my $filename = "$cachedir/$dir/mails.db";
497 return if $last_atime->{$self->{id
}} &&
498 PMG
::Utils
::file_older_than
($filename, $last_atime->{$self->{id
}});
501 foreach my $db (@dbs) {
502 my $filename = $self->{dbstat
}->{$db}->{filename
} =
503 "$cachedir/$dir/${db}.db";
504 $self->{dbstat
}->{$db}->{idcount
} = 0;
505 if ($db eq 'memberof') {
506 $self->{dbstat
}->{$db}->{dbh
} =
507 tie
(my %h, 'DB_File', $filename,
508 O_RDONLY
, 0666, $DB_BTREE);
510 $self->{dbstat
}->{$db}->{dbh
} =
511 tie
(my %h, 'DB_File', $filename,
512 O_RDONLY
, 0666, $DB_HASH);
515 if (!$self->{dbstat
}->{$db}->{dbh
} && !$try) {
516 my $err = "ldap error - unable to open database file '$filename': $!";
517 $self->{errors
} .= "$err\n";
518 syslog
('err', $err) if !$self->{dbstat
}->{$db}->{dbh
};
523 $last_atime->{$self->{id
}} = time();
525 $self->{gcount
} = __count_entries
($self->{dbstat
}->{groups
}->{dbh
});
526 $self->{ucount
} = __count_entries
($self->{dbstat
}->{accounts
}->{dbh
});
527 $self->{mcount
} = __count_entries
($self->{dbstat
}->{mails
}->{dbh
});
531 my ($self, $force) = @_;
533 $self->{errors
} = '';
536 # only sync if file is older than 1 hour
538 my $dir = "ldapdb_" . $self->{id
};
539 mkdir "$cachedir/$dir";
540 my $filename = "$cachedir/$dir/mails.db";
543 !PMG
::Utils
::file_older_than
($filename, time() - 3600)) {
549 $self->sync_database();
551 if ($self->{errors
}) {
561 my $dbh = $self->{dbstat
}->{groups
}->{dbh
};
563 return $res if !$dbh;
567 my $status = $dbh->seq($key, $value, R_FIRST
());
570 while ($status == 0) {
574 $status = $dbh->seq($key, $value, R_NEXT
());
585 my $dbh = $self->{dbstat
}->{users
}->{dbh
};
587 return $res if !$dbh;
591 my $status = $dbh->seq($key, $value, R_FIRST
());
594 while ($status == 0) {
595 my ($pmail, $account, $dn) = unpack('n/a* n/a* n/a*', $value);
601 $status = $dbh->seq($key, $value, R_NEXT
());
608 my ($self, $mail) = @_;
610 my $dbhmails = $self->{dbstat
}->{mails
}->{dbh
};
611 my $dbhusers = $self->{dbstat
}->{users
}->{dbh
};
613 return undef if !$dbhmails || !$dbhusers;
620 $dbhmails->get($mail, $cuid);
621 return undef if !$cuid;
624 $dbhusers->get($cuid, $rdata);
625 return undef if !$rdata;
627 my ($pmail, $account, $dn) = unpack('n/a* n/a* n/a*', $rdata);
629 push @$res, { primary
=> 1, email
=> $pmail };
633 my $status = $dbhmails->seq($key, $value, R_FIRST
());
635 while ($status == 0) {
636 if ($value == $cuid && $key ne $pmail) {
637 push @$res, { primary
=> 0, email
=> $key };
639 $status = $dbhmails->seq($key, $value, R_NEXT
());
646 my ($self, $mail) = @_;
648 my $dbh = $self->{dbstat
}->{mails
}->{dbh
};
654 $dbh->get($mail, $res);
659 my ($self, $account) = @_;
661 my $dbh = $self->{dbstat
}->{accounts
}->{dbh
};
664 $account = lc($account);
667 $dbh->get($account, $res);
672 my ($self, $group) = @_;
674 my $dbh = $self->{dbstat
}->{groups
}->{dbh
};
678 $dbh->get($group, $res);
682 sub account_has_address
{
683 my ($self, $account, $mail) = @_;
685 my $dbhmails = $self->{dbstat
}->{mails
}->{dbh
};
686 my $dbhaccounts = $self->{dbstat
}->{accounts
}->{dbh
};
687 return 0 if !$dbhmails || !$dbhaccounts;
689 $account = lc($account);
693 $dbhaccounts->get($account, $accid);
697 $dbhmails->get($mail, $mailid);
698 return 0 if !$mailid;
700 return ($accid == $mailid);
704 my ($self, $mail, $group) = @_;
706 my $dbhmails = $self->{dbstat
}->{mails
}->{dbh
};
707 my $dbhgroups = $self->{dbstat
}->{groups
}->{dbh
};
708 my $dbhmemberof = $self->{dbstat
}->{memberof
}->{dbh
};
710 return 0 if !$dbhmails || !$dbhgroups || !$dbhmemberof;
715 $dbhmails->get($mail, $cuid);
719 $dbhgroups->get($group, $groupid);
720 return 0 if !$groupid;
722 my @gida = $dbhmemberof->get_dup($cuid);
724 return grep { $_ eq $groupid } @gida;
728 my ($self, $mail, $scan) = @_;
730 my $dbhmails = $self->{dbstat
}->{mails
}->{dbh
};
731 my $dbhusers = $self->{dbstat
}->{users
}->{dbh
};
733 return undef if !$dbhmails || !$dbhusers;
740 $dbhmails->get($mail, $cuid);
741 return undef if !$cuid;
744 $dbhusers->get($cuid, $rdata);
745 return undef if !$rdata;
747 my ($pmail, $account, $dn) = unpack('n/a* n/a* n/a*', $rdata);
750 $res->{account
} = $account;
751 $res->{pmail
} = $pmail;
756 my $status = $dbhmails->seq($key, $value, R_FIRST
());
759 while ($status == 0) {
760 push @$mails, $key if $value == $cuid;
761 $status = $dbhmails->seq($key, $value, R_NEXT
());
763 $res->{mails
} = $mails;