Bug 5446 Fix a bug introduces by previous patch
[koha.git] / C4 / Auth_with_ldap.pm
blobb25697ce36d074ddd0e4395c2a3cbc8f66cc5f3b
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
10 # version.
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.
20 use strict;
21 #use warnings; FIXME - Bug 2505
22 use Digest::MD5 qw(md5_base64);
24 use C4::Debug;
25 use C4::Context;
26 use C4::Members qw(AddMember changepassword);
27 use C4::Members::Attributes;
28 use C4::Members::AttributeTypes;
29 use C4::Utils qw( :all );
30 use List::MoreUtils qw( any );
31 use Net::LDAP;
32 use Net::LDAP::Filter;
34 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
36 BEGIN {
37 require Exporter;
38 $VERSION = 3.10; # set the version for version checking
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 %config = (
68 anonymous => ($ldapname and $ldappassword) ? 0 : 1,
69 replicate => defined($ldap->{replicate}) ? $ldap->{replicate} : 1, # add from LDAP to Koha database for new user
70 update => defined($ldap->{update} ) ? $ldap->{update} : 1, # update from LDAP to Koha database for existing user
73 sub description ($) {
74 my $result = shift or return undef;
75 return "LDAP error #" . $result->code
76 . ": " . $result->error_name . "\n"
77 . "# " . $result->error_text . "\n";
80 sub search_method {
81 my $db = shift or return;
82 my $userid = shift or return;
83 my $uid_field = $mapping{userid}->{is} or die ldapserver_error("mapping for 'userid'");
84 my $filter = Net::LDAP::Filter->new("$uid_field=$userid") or die "Failed to create new Net::LDAP::Filter";
85 my $res = ($config{anonymous}) ? $db->bind : $db->bind($ldapname, password=>$ldappassword);
86 if ($res->code) { # connection refused
87 warn "LDAP bind failed as ldapuser " . ($ldapname || '[ANONYMOUS]') . ": " . description($res);
88 return 0;
90 my $search = $db->search(
91 base => $base,
92 filter => $filter,
93 # attrs => ['*'],
94 ) or die "LDAP search failed to return object.";
95 my $count = $search->count;
96 if ($search->code > 0) {
97 warn sprintf("LDAP Auth rejected : %s gets %d hits\n", $filter->as_string, $count) . description($search);
98 return 0;
100 if ($count != 1) {
101 warn sprintf("LDAP Auth rejected : %s gets %d hits\n", $filter->as_string, $count);
102 return 0;
104 return $search;
107 sub checkpw_ldap {
108 my ($dbh, $userid, $password) = @_;
109 my @hosts = split(',', $prefhost);
110 my $db = Net::LDAP->new(\@hosts);
111 #$debug and $db->debug(5);
112 my $userldapentry;
113 if ( $ldap->{auth_by_bind} ) {
114 my $principal_name = $ldap->{principal_name};
115 if ($principal_name and $principal_name =~ /\%/) {
116 $principal_name = sprintf($principal_name,$userid);
117 } else {
118 $principal_name = $userid;
120 my $res = $db->bind( $principal_name, password => $password );
121 if ( $res->code ) {
122 $debug and warn "LDAP bind failed as kohauser $principal_name: ". description($res);
123 return 0;
126 # FIXME dpavlin -- we really need $userldapentry leater on even if using auth_by_bind!
127 my $search = search_method($db, $userid) or return 0; # warnings are in the sub
128 $userldapentry = $search->shift_entry;
130 } else {
131 my $search = search_method($db, $userid) or return 0; # warnings are in the sub
132 $userldapentry = $search->shift_entry;
133 my $cmpmesg = $db->compare( $userldapentry, attr=>'userpassword', value => $password );
134 if ($cmpmesg->code != 6) {
135 warn "LDAP Auth rejected : invalid password for user '$userid'. " . description($cmpmesg);
136 return 0;
140 # To get here, LDAP has accepted our user's login attempt.
141 # But we still have work to do. See perldoc below for detailed breakdown.
143 my (%borrower);
144 my ($borrowernumber,$cardnumber,$local_userid,$savedpw) = exists_local($userid);
146 if (( $borrowernumber and $config{update} ) or
147 (!$borrowernumber and $config{replicate}) ) {
148 %borrower = ldap_entry_2_hash($userldapentry,$userid);
149 $debug and print STDERR "checkpw_ldap received \%borrower w/ " . keys(%borrower), " keys: ", join(' ', keys %borrower), "\n";
152 if ($borrowernumber) {
153 if ($config{update}) { # A1, B1
154 my $c2 = &update_local($local_userid,$password,$borrowernumber,\%borrower) || '';
155 ($cardnumber eq $c2) or warn "update_local returned cardnumber '$c2' instead of '$cardnumber'";
156 } else { # C1, D1
157 # maybe update just the password?
158 return(1, $cardnumber); # FIXME dpavlin -- don't destroy ExtendedPatronAttributes
160 } elsif ($config{replicate}) { # A2, C2
161 $borrowernumber = AddMember(%borrower) or die "AddMember failed";
162 } else {
163 return 0; # B2, D2
165 if (C4::Context->preference('ExtendedPatronAttributes') && $borrowernumber && ($config{update} ||$config{replicate})) {
166 my @types = C4::Members::AttributeTypes::GetAttributeTypes();
167 my @attributes = grep{my $key=$_; any{$_ eq $key}@types;} keys %borrower;
168 my $extended_patron_attributes = map{{code=>$_,value=>$borrower{$_}}}@attributes;
169 my $extended_patron_attributes = [] unless $extended_patron_attributes;
170 my @errors;
171 #Check before add
172 for (my $i; $i< scalar(@$extended_patron_attributes)-1;$i++) {
173 my $attr=$extended_patron_attributes->[$i];
174 unless (C4::Members::Attributes::CheckUniqueness($attr->{code}, $attr->{value}, $borrowernumber)) {
175 unshift @errors, $i;
176 warn "ERROR_extended_unique_id_failed $attr->{code} $attr->{value}";
179 #Removing erroneous attributes
180 foreach my $index (@errors){
181 @$extended_patron_attributes=splice(@$extended_patron_attributes,$index,1);
183 C4::Members::Attributes::SetBorrowerAttributes($borrowernumber, $extended_patron_attributes);
185 return(1, $cardnumber);
188 # Pass LDAP entry object and local cardnumber (userid).
189 # Returns borrower hash.
190 # Edit KOHA_CONF so $memberhash{'xxx'} fits your ldap structure.
191 # Ensure that mandatory fields are correctly filled!
193 sub ldap_entry_2_hash ($$) {
194 my $userldapentry = shift;
195 my %borrower = ( cardnumber => shift );
196 my %memberhash;
197 $userldapentry->exists('uid'); # This is bad, but required! By side-effect, this initializes the attrs hash.
198 if ($debug) {
199 print STDERR "\nkeys(\%\$userldapentry) = " . join(', ', keys %$userldapentry), "\n", $userldapentry->dump();
200 foreach (keys %$userldapentry) {
201 print STDERR "\n\nLDAP key: $_\t", sprintf('(%s)', ref $userldapentry->{$_}), "\n";
202 hashdump("LDAP key: ",$userldapentry->{$_});
205 my $x = $userldapentry->{attrs} or return undef;
206 foreach (keys %$x) {
207 $memberhash{$_} = join ' ', @{$x->{$_}};
208 $debug and print STDERR sprintf("building \$memberhash{%s} = ", $_, join(' ', @{$x->{$_}})), "\n";
210 $debug and print STDERR "Finsihed \%memberhash has ", scalar(keys %memberhash), " keys\n",
211 "Referencing \%mapping with ", scalar(keys %mapping), " keys\n";
212 foreach my $key (keys %mapping) {
213 my $data = $memberhash{$mapping{$key}->{is}};
214 $debug and printf STDERR "mapping %20s ==> %-20s (%s)\n", $key, $mapping{$key}->{is}, $data;
215 unless (defined $data) {
216 $data = $mapping{$key}->{content} || ''; # default or failsafe ''
218 $borrower{$key} = ($data ne '') ? $data : ' ' ;
220 $borrower{initials} = $memberhash{initials} ||
221 ( substr($borrower{'firstname'},0,1)
222 . substr($borrower{ 'surname' },0,1)
223 . " ");
224 return %borrower;
227 sub exists_local($) {
228 my $arg = shift;
229 my $dbh = C4::Context->dbh;
230 my $select = "SELECT borrowernumber,cardnumber,userid,password FROM borrowers ";
232 my $sth = $dbh->prepare("$select WHERE userid=?"); # was cardnumber=?
233 $sth->execute($arg);
234 $debug and printf STDERR "Userid '$arg' exists_local? %s\n", $sth->rows;
235 ($sth->rows == 1) and return $sth->fetchrow;
237 $sth = $dbh->prepare("$select WHERE cardnumber=?");
238 $sth->execute($arg);
239 $debug and printf STDERR "Cardnumber '$arg' exists_local? %s\n", $sth->rows;
240 ($sth->rows == 1) and return $sth->fetchrow;
241 return 0;
244 sub _do_changepassword {
245 my ($userid, $borrowerid, $digest) = @_;
246 $debug and print STDERR "changing local password for borrowernumber=$borrowerid to '$digest'\n";
247 changepassword($userid, $borrowerid, $digest);
249 # Confirm changes
250 my $sth = C4::Context->dbh->prepare("SELECT password,cardnumber FROM borrowers WHERE borrowernumber=? ");
251 $sth->execute($borrowerid);
252 if ($sth->rows) {
253 my ($md5password, $cardnum) = $sth->fetchrow;
254 ($digest eq $md5password) and return $cardnum;
255 warn "Password mismatch after update to cardnumber=$cardnum (borrowernumber=$borrowerid)";
256 return undef;
258 die "Unexpected error after password update to userid/borrowernumber: $userid / $borrowerid.";
261 sub update_local($$$$) {
262 my $userid = shift or return undef;
263 my $digest = md5_base64(shift) or return undef;
264 my $borrowerid = shift or return undef;
265 my $borrower = shift or return undef;
266 my @keys = keys %$borrower;
267 my $dbh = C4::Context->dbh;
268 my $query = "UPDATE borrowers\nSET " .
269 join(',', map {"$_=?"} @keys) .
270 "\nWHERE borrowernumber=? ";
271 my $sth = $dbh->prepare($query);
272 if ($debug) {
273 print STDERR $query, "\n",
274 join "\n", map {"$_ = '" . $borrower->{$_} . "'"} @keys;
275 print STDERR "\nuserid = $userid\n";
277 $sth->execute(
278 ((map {$borrower->{$_}} @keys), $borrowerid)
281 # MODIFY PASSWORD/LOGIN
282 _do_changepassword($userid, $borrowerid, $digest);
286 __END__
288 =head1 NAME
290 C4::Auth - Authenticates Koha users
292 =head1 SYNOPSIS
294 use C4::Auth_with_ldap;
296 =head1 LDAP Configuration
298 This module is specific to LDAP authentification. It requires Net::LDAP package and one or more
299 working LDAP servers.
300 To use it :
301 * Modify ldapserver element in KOHA_CONF
302 * Establish field mapping in <mapping> element.
304 For example, if your user records are stored according to the inetOrgPerson schema, RFC#2798,
305 the username would match the "uid" field, and the password should match the "userpassword" field.
307 Make sure that ALL required fields are populated by your LDAP database (and mapped in KOHA_CONF).
308 What are the required fields? Well, in mysql you can check the database table "borrowers" like this:
310 mysql> show COLUMNS from borrowers;
311 +------------------+--------------+------+-----+---------+----------------+
312 | Field | Type | Null | Key | Default | Extra |
313 +------------------+--------------+------+-----+---------+----------------+
314 | borrowernumber | int(11) | NO | PRI | NULL | auto_increment |
315 | cardnumber | varchar(16) | YES | UNI | NULL | |
316 | surname | mediumtext | NO | | | |
317 | firstname | text | YES | | NULL | |
318 | title | mediumtext | YES | | NULL | |
319 | othernames | mediumtext | YES | | NULL | |
320 | initials | text | YES | | NULL | |
321 | streetnumber | varchar(10) | YES | | NULL | |
322 | streettype | varchar(50) | YES | | NULL | |
323 | address | mediumtext | NO | | | |
324 | address2 | text | YES | | NULL | |
325 | city | mediumtext | NO | | | |
326 | zipcode | varchar(25) | YES | | NULL | |
327 | email | mediumtext | YES | | NULL | |
328 | phone | text | YES | | NULL | |
329 | mobile | varchar(50) | YES | | NULL | |
330 | fax | mediumtext | YES | | NULL | |
331 | emailpro | text | YES | | NULL | |
332 | phonepro | text | YES | | NULL | |
333 | B_streetnumber | varchar(10) | YES | | NULL | |
334 | B_streettype | varchar(50) | YES | | NULL | |
335 | B_address | varchar(100) | YES | | NULL | |
336 | B_city | mediumtext | YES | | NULL | |
337 | B_zipcode | varchar(25) | YES | | NULL | |
338 | B_email | text | YES | | NULL | |
339 | B_phone | mediumtext | YES | | NULL | |
340 | dateofbirth | date | YES | | NULL | |
341 | branchcode | varchar(10) | NO | MUL | | |
342 | categorycode | varchar(10) | NO | MUL | | |
343 | dateenrolled | date | YES | | NULL | |
344 | dateexpiry | date | YES | | NULL | |
345 | gonenoaddress | tinyint(1) | YES | | NULL | |
346 | lost | tinyint(1) | YES | | NULL | |
347 | debarred | tinyint(1) | YES | | NULL | |
348 | contactname | mediumtext | YES | | NULL | |
349 | contactfirstname | text | YES | | NULL | |
350 | contacttitle | text | YES | | NULL | |
351 | guarantorid | int(11) | YES | | NULL | |
352 | borrowernotes | mediumtext | YES | | NULL | |
353 | relationship | varchar(100) | YES | | NULL | |
354 | ethnicity | varchar(50) | YES | | NULL | |
355 | ethnotes | varchar(255) | YES | | NULL | |
356 | sex | varchar(1) | YES | | NULL | |
357 | password | varchar(30) | YES | | NULL | |
358 | flags | int(11) | YES | | NULL | |
359 | userid | varchar(30) | YES | MUL | NULL | | # UNIQUE in next release.
360 | opacnote | mediumtext | YES | | NULL | |
361 | contactnote | varchar(255) | YES | | NULL | |
362 | sort1 | varchar(80) | YES | | NULL | |
363 | sort2 | varchar(80) | YES | | NULL | |
364 +------------------+--------------+------+-----+---------+----------------+
365 50 rows in set (0.01 sec)
367 Where Null="NO", the field is required.
369 =head1 KOHA_CONF and field mapping
371 Example XML stanza for LDAP configuration in KOHA_CONF.
373 <config>
375 <useldapserver>1</useldapserver>
376 <!-- LDAP SERVER (optional) -->
377 <ldapserver id="ldapserver">
378 <hostname>localhost</hostname>
379 <base>dc=metavore,dc=com</base>
380 <user>cn=Manager,dc=metavore,dc=com</user> <!-- DN, if not anonymous -->
381 <pass>metavore</pass> <!-- password, if not anonymous -->
382 <replicate>1</replicate> <!-- add new users from LDAP to Koha database -->
383 <update>1</update> <!-- update existing users in Koha database -->
384 <auth_by_bind>0</auth_by_bind> <!-- set to 1 to authenticate by binding instead of
385 password comparison, e.g., to use Active Directory -->
386 <principal_name>%s@my_domain.com</principal_name>
387 <!-- optional, for auth_by_bind: a printf format to make userPrincipalName from koha userid -->
388 <mapping> <!-- match koha SQL field names to your LDAP record field names -->
389 <firstname is="givenname" ></firstname>
390 <surname is="sn" ></surname>
391 <address is="postaladdress" ></address>
392 <city is="l" >Athens, OH</city>
393 <zipcode is="postalcode" ></zipcode>
394 <branchcode is="branch" >MAIN</branchcode>
395 <userid is="uid" ></userid>
396 <password is="userpassword" ></password>
397 <email is="mail" ></email>
398 <categorycode is="employeetype" >PT</categorycode>
399 <phone is="telephonenumber"></phone>
400 </mapping>
401 </ldapserver>
402 </config>
404 The <mapping> subelements establish the relationship between mysql fields and LDAP attributes. The element name
405 is the column in mysql, with the "is" characteristic set to the LDAP attribute name. Optionally, any content
406 between the element tags is taken as the default value. In this example, the default categorycode is "PT" (for
407 patron).
409 =head1 CONFIGURATION
411 Once a user has been accepted by the LDAP server, there are several possibilities for how Koha will behave, depending on
412 your configuration and the presence of a matching Koha user in your local DB:
414 LOCAL_USER
415 OPTION UPDATE REPLICATE EXISTS? RESULT
416 A1 1 1 1 OK : We're updating them anyway.
417 A2 1 1 0 OK : We're adding them anyway.
418 B1 1 0 1 OK : We update them.
419 B2 1 0 0 FAIL: We cannot add new user.
420 C1 0 1 1 OK : We do nothing. (maybe should update password?)
421 C2 0 1 0 OK : We add the new user.
422 D1 0 0 1 OK : We do nothing. (maybe should update password?)
423 D2 0 0 0 FAIL: We cannot add new user.
425 Note: failure here just means that Koha will fallback to checking the local DB. That is, a given user could login with
426 their LDAP password OR their local one. If this is a problem, then you should enable update and supply a mapping for
427 password. Then the local value will be updated at successful LDAP login and the passwords will be synced.
429 If you choose NOT to update local users, the borrowers table will not be affected at all.
430 Note that this means that patron passwords may appear to change if LDAP is ever disabled, because
431 the local table never contained the LDAP values.
433 =head2 auth_by_bind
435 Binds as the user instead of retrieving their record. Recommended if update disabled.
437 =head2 principal_name
439 Provides an optional sprintf-style format for manipulating the userid before the bind.
440 Even though the userPrincipalName is one intended target, any uniquely identifying
441 attribute that the server allows to be used for binding could be used.
443 Currently, principal_name only operates when auth_by_bind is enabled.
445 =head2 Active Directory
447 The auth_by_bind and principal_name settings are recommended for Active Directory.
449 Under default Active Directory rules, we cannot determine the distinguishedName attribute from the Koha userid as reliably as
450 we would typically under openldap. Instead of:
452 distinguishedName: CN=barnes.7,DC=my_company,DC=com
454 We might get:
456 distinguishedName: CN=Barnes\, Jim,OU=Test Accounts,OU=User Accounts,DC=my_company,DC=com
458 Matching that would require us to know more info about the account (firstname, surname) and to include punctuation and whitespace
459 in Koha userids. But the userPrincipalName should be consistent, something like:
461 userPrincipalName: barnes.7@my_company.com
463 Therefore it is often easier to bind to Active Directory with userPrincipalName, effectively the
464 canonical email address for that user, or what it would be if email were enabled for them. If Koha userid values
465 will match the username portion of the userPrincipalName, and the domain suffix is the same for all users, then use principal_name
466 like this:
467 <principal_name>%s@core.my_company.com</principal_name>
469 The user of the previous example, barnes.7, would then attempt to bind as:
470 barnes.7@core.my_company.com
472 =head1 SEE ALSO
474 CGI(3)
476 Net::LDAP()
478 XML::Simple()
480 Digest::MD5(3)
482 sprintf()
484 =cut
486 # For reference, here's an important difference in the data structure we rely on.
487 # ========================================
488 # Using attrs instead of {asn}->attributes
489 # ========================================
491 # LDAP key: ->{ cn} = ARRAY w/ 3 members.
492 # LDAP key: ->{ cn}->{ sss} = sss
493 # LDAP key: ->{ cn}->{ Steve Smith} = Steve Smith
494 # LDAP key: ->{ cn}->{Steve S. Smith} = Steve S. Smith
496 # LDAP key: ->{ givenname} = ARRAY w/ 1 members.
497 # LDAP key: ->{ givenname}->{Steve} = Steve