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 under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #use warnings; FIXME - Bug 2505
26 use C4::Members qw(AddMember changepassword);
27 use C4::Members::Attributes;
28 use C4::Members::AttributeTypes;
29 use C4::Auth qw(checkpw_internal);
30 use Koha::AuthUtils qw(hash_password);
31 use List::MoreUtils qw( any );
33 use Net::LDAP::Filter;
35 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
39 $VERSION = 3.07.00.049; # set the version for version checking
41 @EXPORT = qw( checkpw_ldap );
44 # Redefine checkpw_ldap:
45 # connect to LDAP (named or anonymous)
46 # ~ retrieves $userid from KOHA_CONF mapping
47 # ~ then compares $password with userPassword
48 # ~ then gets the LDAP entry
49 # ~ and calls the memberadd if necessary
51 sub ldapserver_error {
52 return sprintf('No ldapserver "%s" defined in KOHA_CONF: ' . $ENV{KOHA_CONF}, shift);
55 use vars qw($mapping @ldaphosts $base $ldapname $ldappassword);
56 my $context = C4::Context->new() or die 'C4::Context->new failed';
57 my $ldap = C4::Context->config("ldapserver") or die 'No "ldapserver" in server hash from KOHA_CONF: ' . $ENV{KOHA_CONF};
58 my $prefhost = $ldap->{hostname} or die ldapserver_error('hostname');
59 my $base = $ldap->{base} or die ldapserver_error('base');
60 $ldapname = $ldap->{user} ;
61 $ldappassword = $ldap->{pass} ;
62 our %mapping = %{$ldap->{mapping}}; # FIXME dpavlin -- don't die because of || (); from 6eaf8511c70eb82d797c941ef528f4310a15e9f9
63 my @mapkeys = keys %mapping;
64 $debug and print STDERR "Got ", scalar(@mapkeys), " ldap mapkeys ( total ): ", join ' ', @mapkeys, "\n";
65 @mapkeys = grep {defined $mapping{$_}->{is}} @mapkeys;
66 $debug and print STDERR "Got ", scalar(@mapkeys), " ldap mapkeys (populated): ", join ' ', @mapkeys, "\n";
69 anonymous => ($ldapname and $ldappassword) ? 0 : 1,
70 replicate => defined($ldap->{replicate}) ? $ldap->{replicate} : 1, # add from LDAP to Koha database for new user
71 update => defined($ldap->{update} ) ? $ldap->{update} : 1, # update from LDAP to Koha database for existing user
75 my $result = shift or return;
76 return "LDAP error #" . $result->code
77 . ": " . $result->error_name . "\n"
78 . "# " . $result->error_text . "\n";
82 my $db = shift or return;
83 my $userid = shift or return;
84 my $uid_field = $mapping{userid}->{is} or die ldapserver_error("mapping for 'userid'");
85 my $filter = Net::LDAP::Filter->new("$uid_field=$userid") or die "Failed to create new Net::LDAP::Filter";
86 my $search = $db->search(
90 ) or die "LDAP search failed to return object.";
91 my $count = $search->count;
92 if ($search->code > 0) {
93 warn sprintf("LDAP Auth rejected : %s gets %d hits\n", $filter->as_string, $count) . description($search);
97 warn sprintf("LDAP Auth rejected : %s gets %d hits\n", $filter->as_string, $count);
104 my ($dbh, $userid, $password) = @_;
105 my @hosts = split(',', $prefhost);
106 my $db = Net::LDAP->new(\@hosts);
108 warn "LDAP connexion failed";
112 #$debug and $db->debug(5);
115 if ( $ldap->{auth_by_bind} ) {
116 # Perform an anonymous bind
119 $debug and warn "Anonymous LDAP bind failed: ". description($res);
123 # Perform a LDAP search for the given username
124 my $search = search_method($db, $userid) or return 0; # warnings are in the sub
125 $userldapentry = $search->shift_entry;
127 # Perform a LDAP bind for the given username using the matched DN
128 $res = $db->bind( $userldapentry->dn, password => $password );
130 $debug and warn "LDAP bind failed as kohauser $userid: ". description($res);
135 my $res = ($config{anonymous}) ? $db->bind : $db->bind($ldapname, password=>$ldappassword);
136 if ($res->code) { # connection refused
137 warn "LDAP bind failed as ldapuser " . ($ldapname || '[ANONYMOUS]') . ": " . description($res);
140 my $search = search_method($db, $userid) or return 0; # warnings are in the sub
141 $userldapentry = $search->shift_entry;
142 my $cmpmesg = $db->compare( $userldapentry, attr=>'userpassword', value => $password );
143 if ($cmpmesg->code != 6) {
144 warn "LDAP Auth rejected : invalid password for user '$userid'. " . description($cmpmesg);
149 # To get here, LDAP has accepted our user's login attempt.
150 # But we still have work to do. See perldoc below for detailed breakdown.
153 my ($borrowernumber,$cardnumber,$local_userid,$savedpw) = exists_local($userid);
155 if (( $borrowernumber and $config{update} ) or
156 (!$borrowernumber and $config{replicate}) ) {
157 %borrower = ldap_entry_2_hash($userldapentry,$userid);
158 $debug and print STDERR "checkpw_ldap received \%borrower w/ " . keys(%borrower), " keys: ", join(' ', keys %borrower), "\n";
161 if ($borrowernumber) {
162 if ($config{update}) { # A1, B1
163 my $c2 = &update_local($local_userid,$password,$borrowernumber,\%borrower) || '';
164 ($cardnumber eq $c2) or warn "update_local returned cardnumber '$c2' instead of '$cardnumber'";
166 # maybe update just the password?
167 return(1, $cardnumber, $local_userid);
169 } elsif ($config{replicate}) { # A2, C2
170 $borrowernumber = AddMember(%borrower) or die "AddMember failed";
174 if (C4::Context->preference('ExtendedPatronAttributes') && $borrowernumber && ($config{update} ||$config{replicate})) {
175 my @extended_patron_attributes;
176 foreach my $attribute_type ( C4::Members::AttributeTypes::GetAttributeTypes() ) {
177 my $code = $attribute_type->{code};
178 if ( exists($borrower{$code}) && $borrower{$code} !~ m/^\s*$/ ) { # skip empty values
179 push @extended_patron_attributes, { code => $code, value => $borrower{$code} };
184 foreach my $attr ( @extended_patron_attributes ) {
185 if (C4::Members::Attributes::CheckUniqueness($attr->{code}, $attr->{value}, $borrowernumber)) {
186 push @unique_attr, $attr;
188 warn "ERROR_extended_unique_id_failed $attr->{code} $attr->{value}";
191 C4::Members::Attributes::SetBorrowerAttributes($borrowernumber, \@unique_attr);
193 return(1, $cardnumber, $userid);
196 # Pass LDAP entry object and local cardnumber (userid).
197 # Returns borrower hash.
198 # Edit KOHA_CONF so $memberhash{'xxx'} fits your ldap structure.
199 # Ensure that mandatory fields are correctly filled!
201 sub ldap_entry_2_hash {
202 my $userldapentry = shift;
203 my %borrower = ( cardnumber => shift );
205 $userldapentry->exists('uid'); # This is bad, but required! By side-effect, this initializes the attrs hash.
207 foreach (keys %$userldapentry) {
208 print STDERR "\n\nLDAP key: $_\t", sprintf('(%s)', ref $userldapentry->{$_}), "\n";
211 my $x = $userldapentry->{attrs} or return;
213 $memberhash{$_} = join ' ', @{$x->{$_}};
214 $debug and print STDERR sprintf("building \$memberhash{%s} = ", $_, join(' ', @{$x->{$_}})), "\n";
216 $debug and print STDERR "Finsihed \%memberhash has ", scalar(keys %memberhash), " keys\n",
217 "Referencing \%mapping with ", scalar(keys %mapping), " keys\n";
218 foreach my $key (keys %mapping) {
219 my $data = $memberhash{ lc($mapping{$key}->{is}) }; # Net::LDAP returns all names in lowercase
220 $debug and printf STDERR "mapping %20s ==> %-20s (%s)\n", $key, $mapping{$key}->{is}, $data;
221 unless (defined $data) {
222 $data = $mapping{$key}->{content} || ''; # default or failsafe ''
224 $borrower{$key} = ($data ne '') ? $data : ' ' ;
226 $borrower{initials} = $memberhash{initials} ||
227 ( substr($borrower{'firstname'},0,1)
228 . substr($borrower{ 'surname' },0,1)
231 # check if categorycode exists, if not, fallback to default from koha-conf.xml
232 my $dbh = C4::Context->dbh;
233 my $sth = $dbh->prepare("SELECT categorycode FROM categories WHERE categorycode = ?");
234 $sth->execute( uc($borrower{'categorycode'}) );
235 unless ( my $row = $sth->fetchrow_hashref ) {
236 my $default = $mapping{'categorycode'}->{content};
237 $debug && warn "Can't find ", $borrower{'categorycode'}, " default to: $default for ", $borrower{userid};
238 $borrower{'categorycode'} = $default
246 my $dbh = C4::Context->dbh;
247 my $select = "SELECT borrowernumber,cardnumber,userid,password FROM borrowers ";
249 my $sth = $dbh->prepare("$select WHERE userid=?"); # was cardnumber=?
251 $debug and printf STDERR "Userid '$arg' exists_local? %s\n", $sth->rows;
252 ($sth->rows == 1) and return $sth->fetchrow;
254 $sth = $dbh->prepare("$select WHERE cardnumber=?");
256 $debug and printf STDERR "Cardnumber '$arg' exists_local? %s\n", $sth->rows;
257 ($sth->rows == 1) and return $sth->fetchrow;
261 sub _do_changepassword {
262 my ($userid, $borrowerid, $password) = @_;
264 my $digest = hash_password($password);
266 $debug and print STDERR "changing local password for borrowernumber=$borrowerid to '$digest'\n";
267 changepassword($userid, $borrowerid, $digest);
269 my ($ok, $cardnum) = checkpw_internal(C4::Context->dbh, $userid, $password);
270 return $cardnum if $ok;
272 warn "Password mismatch after update to borrowernumber=$borrowerid";
277 my $userid = shift or croak "No userid";
278 my $password = shift or croak "No password";
279 my $borrowerid = shift or croak "No borrowerid";
280 my $borrower = shift or croak "No borrower record";
282 my @keys = keys %$borrower;
283 my $dbh = C4::Context->dbh;
284 my $query = "UPDATE borrowers\nSET " .
285 join(',', map {"$_=?"} @keys) .
286 "\nWHERE borrowernumber=? ";
287 my $sth = $dbh->prepare($query);
289 print STDERR $query, "\n",
290 join "\n", map {"$_ = '" . $borrower->{$_} . "'"} @keys;
291 print STDERR "\nuserid = $userid\n";
294 ((map {$borrower->{$_}} @keys), $borrowerid)
297 # MODIFY PASSWORD/LOGIN
298 _do_changepassword($userid, $borrowerid, $password);
306 C4::Auth - Authenticates Koha users
310 use C4::Auth_with_ldap;
312 =head1 LDAP Configuration
314 This module is specific to LDAP authentification. It requires Net::LDAP package and one or more
315 working LDAP servers.
317 * Modify ldapserver element in KOHA_CONF
318 * Establish field mapping in <mapping> element.
320 For example, if your user records are stored according to the inetOrgPerson schema, RFC#2798,
321 the username would match the "uid" field, and the password should match the "userpassword" field.
323 Make sure that ALL required fields are populated by your LDAP database (and mapped in KOHA_CONF).
324 What are the required fields? Well, in mysql you can check the database table "borrowers" like this:
326 mysql> show COLUMNS from borrowers;
327 +---------------------+--------------+------+-----+---------+----------------+
328 | Field | Type | Null | Key | Default | Extra |
329 +---------------------+--------------+------+-----+---------+----------------+
330 | borrowernumber | int(11) | NO | PRI | NULL | auto_increment |
331 | cardnumber | varchar(16) | YES | UNI | NULL | |
332 | surname | mediumtext | NO | | NULL | |
333 | firstname | text | YES | | NULL | |
334 | title | mediumtext | YES | | NULL | |
335 | othernames | mediumtext | YES | | NULL | |
336 | initials | text | YES | | NULL | |
337 | streetnumber | varchar(10) | YES | | NULL | |
338 | streettype | varchar(50) | YES | | NULL | |
339 | address | mediumtext | NO | | NULL | |
340 | address2 | text | YES | | NULL | |
341 | city | mediumtext | NO | | NULL | |
342 | state | mediumtext | YES | | NULL | |
343 | zipcode | varchar(25) | YES | | NULL | |
344 | country | text | YES | | NULL | |
345 | email | mediumtext | YES | | NULL | |
346 | phone | text | YES | | NULL | |
347 | mobile | varchar(50) | YES | | NULL | |
348 | fax | mediumtext | YES | | NULL | |
349 | emailpro | text | YES | | NULL | |
350 | phonepro | text | YES | | NULL | |
351 | B_streetnumber | varchar(10) | YES | | NULL | |
352 | B_streettype | varchar(50) | YES | | NULL | |
353 | B_address | varchar(100) | YES | | NULL | |
354 | B_address2 | text | YES | | NULL | |
355 | B_city | mediumtext | YES | | NULL | |
356 | B_state | mediumtext | YES | | NULL | |
357 | B_zipcode | varchar(25) | YES | | NULL | |
358 | B_country | text | YES | | NULL | |
359 | B_email | text | YES | | NULL | |
360 | B_phone | mediumtext | YES | | NULL | |
361 | dateofbirth | date | YES | | NULL | |
362 | branchcode | varchar(10) | NO | MUL | | |
363 | categorycode | varchar(10) | NO | MUL | | |
364 | dateenrolled | date | YES | | NULL | |
365 | dateexpiry | date | YES | | NULL | |
366 | gonenoaddress | tinyint(1) | YES | | NULL | |
367 | lost | tinyint(1) | YES | | NULL | |
368 | debarred | date | YES | | NULL | |
369 | debarredcomment | varchar(255) | YES | | NULL | |
370 | contactname | mediumtext | YES | | NULL | |
371 | contactfirstname | text | YES | | NULL | |
372 | contacttitle | text | YES | | NULL | |
373 | guarantorid | int(11) | YES | MUL | NULL | |
374 | borrowernotes | mediumtext | YES | | NULL | |
375 | relationship | varchar(100) | YES | | NULL | |
376 | ethnicity | varchar(50) | YES | | NULL | |
377 | ethnotes | varchar(255) | YES | | NULL | |
378 | sex | varchar(1) | YES | | NULL | |
379 | password | varchar(30) | YES | | NULL | |
380 | flags | int(11) | YES | | NULL | |
381 | userid | varchar(30) | YES | MUL | NULL | |
382 | opacnote | mediumtext | YES | | NULL | |
383 | contactnote | varchar(255) | YES | | NULL | |
384 | sort1 | varchar(80) | YES | | NULL | |
385 | sort2 | varchar(80) | YES | | NULL | |
386 | altcontactfirstname | varchar(255) | YES | | NULL | |
387 | altcontactsurname | varchar(255) | YES | | NULL | |
388 | altcontactaddress1 | varchar(255) | YES | | NULL | |
389 | altcontactaddress2 | varchar(255) | YES | | NULL | |
390 | altcontactaddress3 | varchar(255) | YES | | NULL | |
391 | altcontactstate | mediumtext | YES | | NULL | |
392 | altcontactzipcode | varchar(50) | YES | | NULL | |
393 | altcontactcountry | text | YES | | NULL | |
394 | altcontactphone | varchar(50) | YES | | NULL | |
395 | smsalertnumber | varchar(50) | YES | | NULL | |
396 | privacy | int(11) | NO | | 1 | |
397 +---------------------+--------------+------+-----+---------+----------------+
398 66 rows in set (0.00 sec)
399 Where Null="NO", the field is required.
401 =head1 KOHA_CONF and field mapping
403 Example XML stanza for LDAP configuration in KOHA_CONF.
407 <useldapserver>1</useldapserver>
408 <!-- LDAP SERVER (optional) -->
409 <ldapserver id="ldapserver">
410 <hostname>localhost</hostname>
411 <base>dc=metavore,dc=com</base>
412 <user>cn=Manager,dc=metavore,dc=com</user> <!-- DN, if not anonymous -->
413 <pass>metavore</pass> <!-- password, if not anonymous -->
414 <replicate>1</replicate> <!-- add new users from LDAP to Koha database -->
415 <update>1</update> <!-- update existing users in Koha database -->
416 <auth_by_bind>0</auth_by_bind> <!-- set to 1 to authenticate by binding instead of
417 password comparison, e.g., to use Active Directory -->
418 <mapping> <!-- match koha SQL field names to your LDAP record field names -->
419 <firstname is="givenname" ></firstname>
420 <surname is="sn" ></surname>
421 <address is="postaladdress" ></address>
422 <city is="l" >Athens, OH</city>
423 <zipcode is="postalcode" ></zipcode>
424 <branchcode is="branch" >MAIN</branchcode>
425 <userid is="uid" ></userid>
426 <password is="userpassword" ></password>
427 <email is="mail" ></email>
428 <categorycode is="employeetype" >PT</categorycode>
429 <phone is="telephonenumber"></phone>
434 The <mapping> subelements establish the relationship between mysql fields and LDAP attributes. The element name
435 is the column in mysql, with the "is" characteristic set to the LDAP attribute name. Optionally, any content
436 between the element tags is taken as the default value. In this example, the default categorycode is "PT" (for
441 Once a user has been accepted by the LDAP server, there are several possibilities for how Koha will behave, depending on
442 your configuration and the presence of a matching Koha user in your local DB:
445 OPTION UPDATE REPLICATE EXISTS? RESULT
446 A1 1 1 1 OK : We're updating them anyway.
447 A2 1 1 0 OK : We're adding them anyway.
448 B1 1 0 1 OK : We update them.
449 B2 1 0 0 FAIL: We cannot add new user.
450 C1 0 1 1 OK : We do nothing. (maybe should update password?)
451 C2 0 1 0 OK : We add the new user.
452 D1 0 0 1 OK : We do nothing. (maybe should update password?)
453 D2 0 0 0 FAIL: We cannot add new user.
455 Note: failure here just means that Koha will fallback to checking the local DB. That is, a given user could login with
456 their LDAP password OR their local one. If this is a problem, then you should enable update and supply a mapping for
457 password. Then the local value will be updated at successful LDAP login and the passwords will be synced.
459 If you choose NOT to update local users, the borrowers table will not be affected at all.
460 Note that this means that patron passwords may appear to change if LDAP is ever disabled, because
461 the local table never contained the LDAP values.
465 Binds as the user instead of retrieving their record. Recommended if update disabled.
467 =head2 principal_name
469 Provides an optional sprintf-style format for manipulating the userid before the bind.
470 Even though the userPrincipalName is one intended target, any uniquely identifying
471 attribute that the server allows to be used for binding could be used.
473 Currently, principal_name only operates when auth_by_bind is enabled.
475 =head2 Active Directory
477 The auth_by_bind and principal_name settings are recommended for Active Directory.
479 Under default Active Directory rules, we cannot determine the distinguishedName attribute from the Koha userid as reliably as
480 we would typically under openldap. Instead of:
482 distinguishedName: CN=barnes.7,DC=my_company,DC=com
486 distinguishedName: CN=Barnes\, Jim,OU=Test Accounts,OU=User Accounts,DC=my_company,DC=com
488 Matching that would require us to know more info about the account (firstname, surname) and to include punctuation and whitespace
489 in Koha userids. But the userPrincipalName should be consistent, something like:
491 userPrincipalName: barnes.7@my_company.com
493 Therefore it is often easier to bind to Active Directory with userPrincipalName, effectively the
494 canonical email address for that user, or what it would be if email were enabled for them. If Koha userid values
495 will match the username portion of the userPrincipalName, and the domain suffix is the same for all users, then use principal_name
497 <principal_name>%s@core.my_company.com</principal_name>
499 The user of the previous example, barnes.7, would then attempt to bind as:
500 barnes.7@core.my_company.com
516 # For reference, here's an important difference in the data structure we rely on.
517 # ========================================
518 # Using attrs instead of {asn}->attributes
519 # ========================================
521 # LDAP key: ->{ cn} = ARRAY w/ 3 members.
522 # LDAP key: ->{ cn}->{ sss} = sss
523 # LDAP key: ->{ cn}->{ Steve Smith} = Steve Smith
524 # LDAP key: ->{ cn}->{Steve S. Smith} = Steve S. Smith
526 # LDAP key: ->{ givenname} = ARRAY w/ 1 members.
527 # LDAP key: ->{ givenname}->{Steve} = Steve