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