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