Bug 24647: Remove PDF::API2::Simple from cpanfile
[koha.git] / C4 / Auth_with_ldap.pm
blob09b2b3f66b55c9de57ca0a0ef38ebecfa831aae0
1 package C4::Auth_with_ldap;
3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use Modern::Perl;
21 use Carp;
23 use C4::Debug;
24 use C4::Context;
25 use C4::Members::Attributes;
26 use C4::Members::AttributeTypes;
27 use C4::Members::Messaging;
28 use C4::Auth qw(checkpw_internal);
29 use Koha::Patrons;
30 use Koha::AuthUtils qw(hash_password);
31 use List::MoreUtils qw( any );
32 use Net::LDAP;
33 use Net::LDAP::Filter;
35 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
37 BEGIN {
38 require Exporter;
39 @ISA = qw(Exporter);
40 @EXPORT = qw( checkpw_ldap );
43 # Redefine checkpw_ldap:
44 # connect to LDAP (named or anonymous)
45 # ~ retrieves $userid from KOHA_CONF mapping
46 # ~ then compares $password with userPassword
47 # ~ then gets the LDAP entry
48 # ~ and calls the memberadd if necessary
50 sub ldapserver_error {
51 return sprintf('No ldapserver "%s" defined in KOHA_CONF: ' . $ENV{KOHA_CONF}, shift);
54 use vars qw($mapping @ldaphosts $base $ldapname $ldappassword);
55 my $context = C4::Context->new() or die 'C4::Context->new failed';
56 my $ldap = C4::Context->config("ldapserver") or die 'No "ldapserver" in server hash from KOHA_CONF: ' . $ENV{KOHA_CONF};
57 my $prefhost = $ldap->{hostname} or die ldapserver_error('hostname');
58 my $base = $ldap->{base} or die ldapserver_error('base');
59 $ldapname = $ldap->{user} ;
60 $ldappassword = $ldap->{pass} ;
61 our %mapping = %{$ldap->{mapping}}; # FIXME dpavlin -- don't die because of || (); from 6eaf8511c70eb82d797c941ef528f4310a15e9f9
62 my @mapkeys = keys %mapping;
63 $debug and print STDERR "Got ", scalar(@mapkeys), " ldap mapkeys ( total ): ", join ' ', @mapkeys, "\n";
64 @mapkeys = grep {defined $mapping{$_}->{is}} @mapkeys;
65 $debug and print STDERR "Got ", scalar(@mapkeys), " ldap mapkeys (populated): ", join ' ', @mapkeys, "\n";
67 my %categorycode_conversions;
68 my $default_categorycode;
69 if(defined $ldap->{categorycode_mapping}) {
70 $default_categorycode = $ldap->{categorycode_mapping}->{default};
71 foreach my $cat (@{$ldap->{categorycode_mapping}->{categorycode}}) {
72 $categorycode_conversions{$cat->{value}} = $cat->{content};
76 my %config = (
77 anonymous => defined ($ldap->{anonymous_bind}) ? $ldap->{anonymous_bind} : 1,
78 replicate => defined($ldap->{replicate}) ? $ldap->{replicate} : 1, # add from LDAP to Koha database for new user
79 update => defined($ldap->{update} ) ? $ldap->{update} : 1, # update from LDAP to Koha database for existing user
82 sub description {
83 my $result = shift or return;
84 return "LDAP error #" . $result->code
85 . ": " . $result->error_name . "\n"
86 . "# " . $result->error_text . "\n";
89 sub search_method {
90 my $db = shift or return;
91 my $userid = shift or return;
92 my $uid_field = $mapping{userid}->{is} or die ldapserver_error("mapping for 'userid'");
93 my $filter = Net::LDAP::Filter->new("$uid_field=$userid") or die "Failed to create new Net::LDAP::Filter";
94 my $search = $db->search(
95 base => $base,
96 filter => $filter,
97 # attrs => ['*'],
99 die "LDAP search failed to return object : " . $search->error if $search->code;
101 my $count = $search->count;
102 if ($search->code > 0) {
103 warn sprintf("LDAP Auth rejected : %s gets %d hits\n", $filter->as_string, $count) . description($search);
104 return 0;
106 if ($count == 0) {
107 warn sprintf("LDAP Auth rejected : search with filter '%s' returns no hit\n", $filter->as_string);
108 return 0;
110 return $search;
113 sub checkpw_ldap {
114 my ($dbh, $userid, $password) = @_;
115 my @hosts = split(',', $prefhost);
116 my $db = Net::LDAP->new(\@hosts);
117 unless ( $db ) {
118 warn "LDAP connexion failed";
119 return 0;
122 #$debug and $db->debug(5);
123 my $userldapentry;
125 # first, LDAP authentication
126 if ( $ldap->{auth_by_bind} ) {
127 my $principal_name;
128 if ( $config{anonymous} ) {
130 # Perform an anonymous bind
131 my $res = $db->bind;
132 if ( $res->code ) {
133 warn "Anonymous LDAP bind failed: " . description($res);
134 return 0;
137 # Perform a LDAP search for the given username
138 my $search = search_method( $db, $userid )
139 or return 0; # warnings are in the sub
140 $userldapentry = $search->shift_entry;
141 $principal_name = $userldapentry->dn;
143 else {
144 $principal_name = $ldap->{principal_name};
145 if ( $principal_name and $principal_name =~ /\%/ ) {
146 $principal_name = sprintf( $principal_name, $userid );
148 else {
149 $principal_name = $userid;
153 # Perform a LDAP bind for the given username using the matched DN
154 my $res = $db->bind( $principal_name, password => $password );
155 if ( $res->code ) {
156 if ( $config{anonymous} ) {
157 # With anonymous_bind approach we can be sure we have found the correct user
158 # and that any 'code' response indicates a 'bad' user (be that blocked, banned
159 # or password changed). We should not fall back to local accounts in this case.
160 warn "LDAP bind failed as kohauser $userid: " . description($res);
161 return -1;
162 } else {
163 # Without a anonymous_bind, we cannot be sure we are looking at a valid ldap user
164 # at all, and thus we should fall back to local logins to restore previous behaviour
165 # see bug 12831
166 warn "LDAP bind failed as kohauser $userid: " . description($res);
167 return 0;
170 if ( !defined($userldapentry)
171 && ( $config{update} or $config{replicate} ) )
173 my $search = search_method( $db, $userid ) or return 0;
174 $userldapentry = $search->shift_entry;
176 } else {
177 my $res = ($config{anonymous}) ? $db->bind : $db->bind($ldapname, password=>$ldappassword);
178 if ($res->code) { # connection refused
179 warn "LDAP bind failed as ldapuser " . ($ldapname || '[ANONYMOUS]') . ": " . description($res);
180 return 0;
182 my $search = search_method($db, $userid) or return 0; # warnings are in the sub
183 # Handle multiple branches. Same login exists several times in different branches.
184 my $bind_ok = 0;
185 while (my $entry = $search->shift_entry) {
186 my $user_ldap_bind_ret = $db->bind($entry->dn, password => $password);
187 unless ($user_ldap_bind_ret->code) {
188 $userldapentry = $entry;
189 $bind_ok = 1;
190 last;
194 unless ($bind_ok) {
195 warn "LDAP Auth rejected : invalid password for user '$userid'.";
196 return -1;
202 # To get here, LDAP has accepted our user's login attempt.
203 # But we still have work to do. See perldoc below for detailed breakdown.
205 my (%borrower);
206 my ($borrowernumber,$cardnumber,$local_userid,$savedpw) = exists_local($userid);
208 if (( $borrowernumber and $config{update} ) or
209 (!$borrowernumber and $config{replicate}) ) {
210 %borrower = ldap_entry_2_hash($userldapentry,$userid);
211 $debug and print STDERR "checkpw_ldap received \%borrower w/ " . keys(%borrower), " keys: ", join(' ', keys %borrower), "\n";
214 if ($borrowernumber) {
215 if ($config{update}) { # A1, B1
216 my $c2 = &update_local($local_userid,$password,$borrowernumber,\%borrower) || '';
217 ($cardnumber eq $c2) or warn "update_local returned cardnumber '$c2' instead of '$cardnumber'";
218 } else { # C1, D1
219 # maybe update just the password?
220 return(1, $cardnumber, $local_userid);
222 } elsif ($config{replicate}) { # A2, C2
223 my @columns = Koha::Patrons->columns;
224 my $patron = Koha::Patron->new(
226 map { exists( $borrower{$_} ) ? ( $_ => $borrower{$_} ) : () } @columns
228 )->store;
229 die "Insert of new patron failed" unless $patron;
230 $borrowernumber = $patron->borrowernumber;
231 C4::Members::Messaging::SetMessagingPreferencesFromDefaults( { borrowernumber => $borrowernumber, categorycode => $borrower{'categorycode'} } );
232 } else {
233 return 0; # B2, D2
235 if (C4::Context->preference('ExtendedPatronAttributes') && $borrowernumber && ($config{update} ||$config{replicate})) {
236 foreach my $attribute_type ( C4::Members::AttributeTypes::GetAttributeTypes() ) {
237 my $code = $attribute_type->{code};
238 unless (exists($borrower{$code}) && $borrower{$code} !~ m/^\s*$/ ) {
239 next;
241 if (C4::Members::Attributes::CheckUniqueness($code, $borrower{$code}, $borrowernumber)) {
242 C4::Members::Attributes::UpdateBorrowerAttribute($borrowernumber, {code => $code, attribute => $borrower{$code}});
243 } else {
244 warn "ERROR_extended_unique_id_failed $code $borrower{$code}";
248 return(1, $cardnumber, $userid);
251 # Pass LDAP entry object and local cardnumber (userid).
252 # Returns borrower hash.
253 # Edit KOHA_CONF so $memberhash{'xxx'} fits your ldap structure.
254 # Ensure that mandatory fields are correctly filled!
256 sub ldap_entry_2_hash {
257 my $userldapentry = shift;
258 my %borrower = ( cardnumber => shift );
259 my %memberhash;
260 $userldapentry->exists('uid'); # This is bad, but required! By side-effect, this initializes the attrs hash.
261 if ($debug) {
262 foreach (keys %$userldapentry) {
263 print STDERR "\n\nLDAP key: $_\t", sprintf('(%s)', ref $userldapentry->{$_}), "\n";
266 my $x = $userldapentry->{attrs} or return;
267 foreach (keys %$x) {
268 $memberhash{$_} = join ' ', @{$x->{$_}};
269 $debug and print STDERR sprintf("building \$memberhash{%s} = ", $_, join(' ', @{$x->{$_}})), "\n";
271 $debug and print STDERR "Finsihed \%memberhash has ", scalar(keys %memberhash), " keys\n",
272 "Referencing \%mapping with ", scalar(keys %mapping), " keys\n";
273 foreach my $key (keys %mapping) {
274 my $data = $memberhash{ lc($mapping{$key}->{is}) }; # Net::LDAP returns all names in lowercase
275 $debug and printf STDERR "mapping %20s ==> %-20s (%s)\n", $key, $mapping{$key}->{is}, $data;
276 unless (defined $data) {
277 $data = $mapping{$key}->{content} || undef;
279 $borrower{$key} = $data;
281 $borrower{initials} = $memberhash{initials} ||
282 ( substr($borrower{'firstname'},0,1)
283 . substr($borrower{ 'surname' },0,1)
284 . " ");
286 # categorycode conversions
287 if(defined $categorycode_conversions{$borrower{categorycode}}) {
288 $borrower{categorycode} = $categorycode_conversions{$borrower{categorycode}};
290 elsif($default_categorycode) {
291 $borrower{categorycode} = $default_categorycode;
294 # check if categorycode exists, if not, fallback to default from koha-conf.xml
295 my $dbh = C4::Context->dbh;
296 my $sth = $dbh->prepare("SELECT categorycode FROM categories WHERE categorycode = ?");
297 $sth->execute( uc($borrower{'categorycode'}) );
298 unless ( my $row = $sth->fetchrow_hashref ) {
299 my $default = $mapping{'categorycode'}->{content};
300 $debug && warn "Can't find ", $borrower{'categorycode'}, " default to: $default for ", $borrower{userid};
301 $borrower{'categorycode'} = $default
304 return %borrower;
307 sub exists_local {
308 my $arg = shift;
309 my $dbh = C4::Context->dbh;
310 my $select = "SELECT borrowernumber,cardnumber,userid,password FROM borrowers ";
312 my $sth = $dbh->prepare("$select WHERE userid=?"); # was cardnumber=?
313 $sth->execute($arg);
314 $debug and printf STDERR "Userid '$arg' exists_local? %s\n", $sth->rows;
315 ($sth->rows == 1) and return $sth->fetchrow;
317 $sth = $dbh->prepare("$select WHERE cardnumber=?");
318 $sth->execute($arg);
319 $debug and printf STDERR "Cardnumber '$arg' exists_local? %s\n", $sth->rows;
320 ($sth->rows == 1) and return $sth->fetchrow;
321 return 0;
324 # This function performs a password update, given the userid, borrowerid,
325 # and digested password. It will verify that things are correct and return the
326 # borrowers cardnumber. The idea is that it is used to keep the local
327 # passwords in sync with the LDAP passwords.
329 # $cardnum = _do_changepassword($userid, $borrowerid, $digest)
331 # Note: if the LDAP config has the update_password tag set to a false value,
332 # then this will not update the password, it will simply return the cardnumber.
333 sub _do_changepassword {
334 my ($userid, $borrowerid, $password) = @_;
336 if ( exists( $ldap->{update_password} ) && !$ldap->{update_password} ) {
338 # We don't store the password in the database
339 my $sth = C4::Context->dbh->prepare(
340 'SELECT cardnumber FROM borrowers WHERE borrowernumber=?');
341 $sth->execute($borrowerid);
342 die "Unable to access borrowernumber "
343 . "with userid=$userid, "
344 . "borrowernumber=$borrowerid"
345 if !$sth->rows;
346 my ($cardnum) = $sth->fetchrow;
347 $sth = C4::Context->dbh->prepare(
348 'UPDATE borrowers SET password = null WHERE borrowernumber=?');
349 $sth->execute($borrowerid);
350 return $cardnum;
353 my $digest = hash_password($password);
354 $debug and print STDERR "changing local password for borrowernumber=$borrowerid to '$digest'\n";
355 Koha::Patrons->find($borrowerid)->set_password({ password => $password, skip_validation => 1 });
357 my ($ok, $cardnum) = checkpw_internal(C4::Context->dbh, $userid, $password);
358 return $cardnum if $ok;
360 warn "Password mismatch after update to borrowernumber=$borrowerid";
361 return;
364 sub update_local {
365 my $userid = shift or croak "No userid";
366 my $password = shift or croak "No password";
367 my $borrowerid = shift or croak "No borrowerid";
368 my $borrower = shift or croak "No borrower record";
370 # skip extended patron attributes in 'borrowers' attribute update
371 my @keys = keys %$borrower;
372 if (C4::Context->preference('ExtendedPatronAttributes')) {
373 foreach my $attribute_type ( C4::Members::AttributeTypes::GetAttributeTypes() ) {
374 my $code = $attribute_type->{code};
375 @keys = grep { $_ ne $code } @keys;
376 $debug and printf STDERR "ignoring extended patron attribute '%s' in update_local()\n", $code;
380 my $dbh = C4::Context->dbh;
381 my $query = "UPDATE borrowers\nSET " .
382 join(',', map {"$_=?"} @keys) .
383 "\nWHERE borrowernumber=? ";
384 my $sth = $dbh->prepare($query);
385 if ($debug) {
386 print STDERR $query, "\n",
387 join "\n", map {"$_ = '" . $borrower->{$_} . "'"} @keys;
388 print STDERR "\nuserid = $userid\n";
390 $sth->execute(
391 ((map {$borrower->{$_}} @keys), $borrowerid)
394 # MODIFY PASSWORD/LOGIN if password was mapped
395 _do_changepassword($userid, $borrowerid, $password) if exists( $borrower->{'password'} );
399 __END__
401 =head1 NAME
403 C4::Auth - Authenticates Koha users
405 =head1 SYNOPSIS
407 use C4::Auth_with_ldap;
409 =head1 LDAP Configuration
411 This module is specific to LDAP authentification. It requires Net::LDAP package and one or more
412 working LDAP servers.
413 To use it :
414 * Modify ldapserver element in KOHA_CONF
415 * Establish field mapping in <mapping> element.
417 For example, if your user records are stored according to the inetOrgPerson schema, RFC#2798,
418 the username would match the "uid" field, and the password should match the "userpassword" field.
420 Make sure that ALL required fields are populated by your LDAP database (and mapped in KOHA_CONF).
421 What are the required fields? Well, in mysql you can check the database table "borrowers" like this:
423 mysql> show COLUMNS from borrowers;
424 +---------------------+--------------+------+-----+---------+----------------+
425 | Field | Type | Null | Key | Default | Extra |
426 +---------------------+--------------+------+-----+---------+----------------+
427 | borrowernumber | int(11) | NO | PRI | NULL | auto_increment |
428 | cardnumber | varchar(16) | YES | UNI | NULL | |
429 | surname | mediumtext | NO | | NULL | |
430 | firstname | text | YES | | NULL | |
431 | title | mediumtext | YES | | NULL | |
432 | othernames | mediumtext | YES | | NULL | |
433 | initials | text | YES | | NULL | |
434 | streetnumber | varchar(10) | YES | | NULL | |
435 | streettype | varchar(50) | YES | | NULL | |
436 | address | mediumtext | NO | | NULL | |
437 | address2 | text | YES | | NULL | |
438 | city | mediumtext | NO | | NULL | |
439 | state | mediumtext | YES | | NULL | |
440 | zipcode | varchar(25) | YES | | NULL | |
441 | country | text | YES | | NULL | |
442 | email | mediumtext | YES | | NULL | |
443 | phone | text | YES | | NULL | |
444 | mobile | varchar(50) | YES | | NULL | |
445 | fax | mediumtext | YES | | NULL | |
446 | emailpro | text | YES | | NULL | |
447 | phonepro | text | YES | | NULL | |
448 | B_streetnumber | varchar(10) | YES | | NULL | |
449 | B_streettype | varchar(50) | YES | | NULL | |
450 | B_address | varchar(100) | YES | | NULL | |
451 | B_address2 | text | YES | | NULL | |
452 | B_city | mediumtext | YES | | NULL | |
453 | B_state | mediumtext | YES | | NULL | |
454 | B_zipcode | varchar(25) | YES | | NULL | |
455 | B_country | text | YES | | NULL | |
456 | B_email | text | YES | | NULL | |
457 | B_phone | mediumtext | YES | | NULL | |
458 | dateofbirth | date | YES | | NULL | |
459 | branchcode | varchar(10) | NO | MUL | | |
460 | categorycode | varchar(10) | NO | MUL | | |
461 | dateenrolled | date | YES | | NULL | |
462 | dateexpiry | date | YES | | NULL | |
463 | gonenoaddress | tinyint(1) | YES | | NULL | |
464 | lost | tinyint(1) | YES | | NULL | |
465 | debarred | date | YES | | NULL | |
466 | debarredcomment | varchar(255) | YES | | NULL | |
467 | contactname | mediumtext | YES | | NULL | |
468 | contactfirstname | text | YES | | NULL | |
469 | contacttitle | text | YES | | NULL | |
470 | borrowernotes | mediumtext | YES | | NULL | |
471 | relationship | varchar(100) | YES | | NULL | |
472 | ethnicity | varchar(50) | YES | | NULL | |
473 | ethnotes | varchar(255) | YES | | NULL | |
474 | sex | varchar(1) | YES | | NULL | |
475 | password | varchar(30) | YES | | NULL | |
476 | flags | int(11) | YES | | NULL | |
477 | userid | varchar(30) | YES | MUL | NULL | |
478 | opacnote | mediumtext | YES | | NULL | |
479 | contactnote | varchar(255) | YES | | NULL | |
480 | sort1 | varchar(80) | YES | | NULL | |
481 | sort2 | varchar(80) | YES | | NULL | |
482 | altcontactfirstname | varchar(255) | YES | | NULL | |
483 | altcontactsurname | varchar(255) | YES | | NULL | |
484 | altcontactaddress1 | varchar(255) | YES | | NULL | |
485 | altcontactaddress2 | varchar(255) | YES | | NULL | |
486 | altcontactaddress3 | varchar(255) | YES | | NULL | |
487 | altcontactstate | mediumtext | YES | | NULL | |
488 | altcontactzipcode | varchar(50) | YES | | NULL | |
489 | altcontactcountry | text | YES | | NULL | |
490 | altcontactphone | varchar(50) | YES | | NULL | |
491 | smsalertnumber | varchar(50) | YES | | NULL | |
492 | privacy | int(11) | NO | | 1 | |
493 +---------------------+--------------+------+-----+---------+----------------+
494 66 rows in set (0.00 sec)
495 Where Null="NO", the field is required.
497 =head1 KOHA_CONF and field mapping
499 Example XML stanza for LDAP configuration in KOHA_CONF.
501 <config>
503 <useldapserver>1</useldapserver>
504 <!-- LDAP SERVER (optional) -->
505 <ldapserver id="ldapserver">
506 <hostname>localhost</hostname>
507 <base>dc=metavore,dc=com</base>
508 <user>cn=Manager,dc=metavore,dc=com</user> <!-- DN, if not anonymous -->
509 <pass>metavore</pass> <!-- password, if not anonymous -->
510 <replicate>1</replicate> <!-- add new users from LDAP to Koha database -->
511 <update>1</update> <!-- update existing users in Koha database -->
512 <auth_by_bind>0</auth_by_bind> <!-- set to 1 to authenticate by binding instead of
513 password comparison, e.g., to use Active Directory -->
514 <anonymous_bind>0</anonymous_bind> <!-- set to 1 if users should be searched using
515 an anonymous bind, even when auth_by_bind is on -->
516 <principal_name>%s@my_domain.com</principal_name>
517 <!-- optional, for auth_by_bind: a printf format to make userPrincipalName from koha userid.
518 Not used with anonymous_bind. -->
519 <update_password>1</update_password> <!-- set to 0 if you don't want LDAP passwords
520 synced to the local database -->
521 <mapping> <!-- match koha SQL field names to your LDAP record field names -->
522 <firstname is="givenname" ></firstname>
523 <surname is="sn" ></surname>
524 <address is="postaladdress" ></address>
525 <city is="l" >Athens, OH</city>
526 <zipcode is="postalcode" ></zipcode>
527 <branchcode is="branch" >MAIN</branchcode>
528 <userid is="uid" ></userid>
529 <password is="userpassword" ></password>
530 <email is="mail" ></email>
531 <categorycode is="employeetype" >PT</categorycode>
532 <phone is="telephonenumber"></phone>
533 </mapping>
534 </ldapserver>
535 </config>
537 The <mapping> subelements establish the relationship between mysql fields and LDAP attributes. The element name
538 is the column in mysql, with the "is" characteristic set to the LDAP attribute name. Optionally, any content
539 between the element tags is taken as the default value. In this example, the default categorycode is "PT" (for
540 patron).
542 =head1 CONFIGURATION
544 Once a user has been accepted by the LDAP server, there are several possibilities for how Koha will behave, depending on
545 your configuration and the presence of a matching Koha user in your local DB:
547 LOCAL_USER
548 OPTION UPDATE REPLICATE EXISTS? RESULT
549 A1 1 1 1 OK : We're updating them anyway.
550 A2 1 1 0 OK : We're adding them anyway.
551 B1 1 0 1 OK : We update them.
552 B2 1 0 0 FAIL: We cannot add new user.
553 C1 0 1 1 OK : We do nothing. (maybe should update password?)
554 C2 0 1 0 OK : We add the new user.
555 D1 0 0 1 OK : We do nothing. (maybe should update password?)
556 D2 0 0 0 FAIL: We cannot add new user.
558 Note: failure here just means that Koha will fallback to checking the local DB. That is, a given user could login with
559 their LDAP password OR their local one. If this is a problem, then you should enable update and supply a mapping for
560 password. Then the local value will be updated at successful LDAP login and the passwords will be synced.
562 If you choose NOT to update local users, the borrowers table will not be affected at all.
563 Note that this means that patron passwords may appear to change if LDAP is ever disabled, because
564 the local table never contained the LDAP values.
566 =head2 auth_by_bind
568 Binds as the user instead of retrieving their record. Recommended if update disabled.
570 =head2 principal_name
572 Provides an optional sprintf-style format for manipulating the userid before the bind.
573 Even though the userPrincipalName is one intended target, any uniquely identifying
574 attribute that the server allows to be used for binding could be used.
576 Currently, principal_name only operates when auth_by_bind is enabled.
578 =head2 update_password
580 If this tag is left out or set to a true value, then the user's LDAP password
581 will be stored (hashed) in the local Koha database. If you don't want this
582 to happen, then set the value of this to '0'. Note that if passwords are not
583 stored locally, and the connection to the LDAP system fails, then the users
584 will not be able to log in at all.
586 =head2 Active Directory
588 The auth_by_bind and principal_name settings are recommended for Active Directory.
590 Under default Active Directory rules, we cannot determine the distinguishedName attribute from the Koha userid as reliably as
591 we would typically under openldap. Instead of:
593 distinguishedName: CN=barnes.7,DC=my_company,DC=com
595 We might get:
597 distinguishedName: CN=Barnes\, Jim,OU=Test Accounts,OU=User Accounts,DC=my_company,DC=com
599 Matching that would require us to know more info about the account (firstname, surname) and to include punctuation and whitespace
600 in Koha userids. But the userPrincipalName should be consistent, something like:
602 userPrincipalName: barnes.7@my_company.com
604 Therefore it is often easier to bind to Active Directory with userPrincipalName, effectively the
605 canonical email address for that user, or what it would be if email were enabled for them. If Koha userid values
606 will match the username portion of the userPrincipalName, and the domain suffix is the same for all users, then use principal_name
607 like this:
608 <principal_name>%s@core.my_company.com</principal_name>
610 The user of the previous example, barnes.7, would then attempt to bind as:
611 barnes.7@core.my_company.com
613 =head1 SEE ALSO
615 CGI(3)
617 Net::LDAP()
619 XML::Simple()
621 Digest::MD5(3)
623 sprintf()
625 =cut
627 # For reference, here's an important difference in the data structure we rely on.
628 # ========================================
629 # Using attrs instead of {asn}->attributes
630 # ========================================
632 # LDAP key: ->{ cn} = ARRAY w/ 3 members.
633 # LDAP key: ->{ cn}->{ sss} = sss
634 # LDAP key: ->{ cn}->{ Steve Smith} = Steve Smith
635 # LDAP key: ->{ cn}->{Steve S. Smith} = Steve S. Smith
637 # LDAP key: ->{ givenname} = ARRAY w/ 1 members.
638 # LDAP key: ->{ givenname}->{Steve} = Steve