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