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