C4/Auth_with_ldap.pm

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