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