use strict;
use Digest::MD5 qw(md5_base64);
+use C4::Debug;
use C4::Context;
-use C4::Members qw(AddMember );
-
+use C4::Members qw(AddMember changepassword);
+use C4::Utils qw( :all );
use Net::LDAP;
use Net::LDAP::Filter;
-# use Net::LDAP qw(:all);
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
BEGIN {
require Exporter;
- $VERSION = 3.01; # set the version for version checking
- our $debug = $ENV{DEBUG} || 0;
- @ISA = qw(Exporter C4::Auth);
- @EXPORT = qw( checkauth );
+ $VERSION = 3.03; # set the version for version checking
+ @ISA = qw(Exporter);
+ @EXPORT = qw( checkpw_ldap );
}
-=head1 NAME
-
-C4::Auth - Authenticates Koha users
-
-=head1 SYNOPSIS
-
- use C4::Auth_with_ldap;
-
-=head1 LDAP specific
-
- This module is specific to LDAP authentification. It requires Net::LDAP package and one or more
- working LDAP servers.
- To use it :
- * modify the code between LOCAL and /LOCAL to fit your LDAP server parameters & fields.
-
- It is assumed your user records are stored according to the inetOrgPerson schema, RFC#2798.
- Thus the username must match the "uid" field, and the password must match the "userPassword" field.
-
-=cut
-
-# Redefine checkauth:
+# Redefine checkpw_ldap:
# connect to LDAP (named or anonymous)
-# ~ retrieves $userid from "uid"
+# ~ retrieves $userid from KOHA_CONF mapping
# ~ then compares $password with userPassword
# ~ then gets the LDAP entry
# ~ and calls the memberadd if necessary
-my %mapping = (
- firstname => 'givenName',
- surname => 'sn',
- streetaddress => 'l',
- branchcode => 'branch',
- emailaddress => 'mail',
- categorycode => 'employeeType',
- city => 'null',
- phone => 'telephoneNumber',
-);
+sub ldapserver_error ($) {
+ return sprintf('No ldapserver "%s" defined in KOHA_CONF: ' . $ENV{KOHA_CONF}, shift);
+}
-my (@ldaphosts) = (qw(localhost)); # potentially multiple LDAP hosts!
-my $base = "dc=metavore,dc=com";
-my $ldapname = "cn=Manager,$base"; # The LDAP user.
-my $ldappassword = 'metavore';
+use vars qw($mapping @ldaphosts $base $ldapname $ldappassword);
+my $context = C4::Context->new() or die 'C4::Context->new failed';
+my $ldap = C4::Context->config("ldapserver") or die 'No "ldapserver" in server hash from KOHA_CONF: ' . $ENV{KOHA_CONF};
+my $prefhost = $ldap->{hostname} or die ldapserver_error('hostname');
+my $base = $ldap->{base} or die ldapserver_error('base');
+$ldapname = $ldap->{user} or die ldapserver_error('user');
+$ldappassword = $ldap->{pass} or die ldapserver_error('pass');
+our %mapping = %{$ldap->{mapping}} or die ldapserver_error('mapping');
+my @mapkeys = keys %mapping;
+$debug and print STDERR "Got ", scalar(@mapkeys), " ldap mapkeys ( total ): ", join ' ', @mapkeys, "\n";
+@mapkeys = grep {defined $mapping{$_}->{is}} @mapkeys;
+$debug and print STDERR "Got ", scalar(@mapkeys), " ldap mapkeys (populated): ", join ' ', @mapkeys, "\n";
my %config = (
anonymous => ($ldapname and $ldappassword) ? 0 : 1,
- replicate => 0, # add from LDAP to Koha database for new user
- update => 0, # update from LDAP to Koha database for existing user
+ replicate => $ldap->{replicate} || 1, # add from LDAP to Koha database for new user
+ update => $ldap->{update} || 1, # update from LDAP to Koha database for existing user
);
sub description ($) {
. "# " . $result->error_text . "\n";
}
-sub checkauth {
+sub checkpw_ldap {
my ($dbh, $userid, $password) = @_;
- if ( $userid eq C4::Context->config('user')
- && $password eq C4::Context->config('pass') )
- {
- return 2; # Koha superuser account
- }
- my $db = Net::LDAP->new(\@ldaphosts);
+ my $db = Net::LDAP->new([$prefhost]);
#$debug and $db->debug(5);
- my $filter = Net::LDAP::Filter->new("uid=$userid") or die "Failed to create new Net::LDAP::Filter";
+ my $uid_field = $mapping{userid}->{is} or die ldapserver_error("mapping for 'userid'");
+ my $filter = Net::LDAP::Filter->new("$uid_field=$userid") or die "Failed to create new Net::LDAP::Filter";
my $res = ($config{anonymous}) ? $db->bind : $db->bind($ldapname, password=>$ldappassword);
if ($res->code) { # connection refused
warn "LDAP bind failed as $ldapname: " . description($res);
}
my $userldapentry = $search->shift_entry;
- my $cmpmesg = $db->compare( $userldapentry, attr=>'userPassword', value => $password );
- if($cmpmesg->code != 6) {
+ my $cmpmesg = $db->compare( $userldapentry, attr=>'userpassword', value => $password );
+ if ($cmpmesg->code != 6) {
warn "LDAP Auth rejected : invalid password for user '$userid'. " . description($cmpmesg);
return 0;
}
- unless($config{update} or $config{replicate}) {
+ unless ($config{update} or $config{replicate}) {
return 1;
}
my %borrower = ldap_entry_2_hash($userldapentry,$userid);
- if (exists_local($userid)) {
- ($config{update} ) and &update_local($userid,$password,%borrower);
+ $debug and print "checkpw_ldap received \%borrower w/ " . keys(%borrower), " keys: ", join(' ', keys %borrower), "\n";
+ my ($borrowernumber,$cardnumber,$savedpw);
+ ($borrowernumber,$cardnumber,$userid,$savedpw) = exists_local($userid);
+ if ($borrowernumber) {
+ ($config{update} ) and my $c2 = &update_local($userid,$password,$borrowernumber,\%borrower) || '';
+ ($cardnumber eq $c2) or warn "update_local returned cardnumber '$c2' instead of '$cardnumber'";
} else {
- ($config{replicate}) and AddMember(%borrower);
+ ($config{replicate}) and $borrowernumber = AddMember(%borrower);
}
- return 1;
+ return(1, $cardnumber);
}
# Pass LDAP entry object and local cardnumber (userid).
# Returns borrower hash.
-# Edit %mapping so $memberhash{'xxx'} fits your ldap structure.
+# Edit KOHA_CONF so $memberhash{'xxx'} fits your ldap structure.
# Ensure that mandatory fields are correctly filled!
#
sub ldap_entry_2_hash ($$) {
my $userldapentry = shift;
my %borrower = ( cardnumber => shift );
my %memberhash;
- my $x = $userldapentry->{asn}{attributes} or return undef;
- my $key;
- foreach my $k (@$x) {
- foreach my $k2 ( keys %$k ) {
- if ($k2 eq 'type') {
- $key = $$k{$k2};
- } else {
- $memberhash{$key} .= map {$_ . " "} @$k{$k2};
- }
+ $userldapentry->exists('uid'); # This is bad, but required! By side-effect, this initializes the attrs hash.
+ if ($debug) {
+ print "\nkeys(\%\$userldapentry) = " . join(', ', keys %$userldapentry), "\n", $userldapentry->dump();
+ foreach (keys %$userldapentry) {
+ print "\n\nLDAP key: $_\t", sprintf('(%s)', ref $userldapentry->{$_}), "\n";
+ hashdump("LDAP key: ",$userldapentry->{$_});
}
}
- foreach my $key (%mapping) {
- my $data = $memberhash{$mapping{$key}};
- defined $data or $data = ' ';
+ my $x = $userldapentry->{attrs} or return undef;
+ my $key;
+ foreach (keys %$x) {
+ $memberhash{$_} = join ' ', @{$x->{$_}};
+ $debug and print sprintf("building \$memberhash{%s} = ", $_, join(' ', @{$x->{$_}})), "\n";
+ }
+ $debug and print "Finsihed \%memberhash has ", scalar(keys %memberhash), " keys\n",
+ "Referencing \%mapping with ", scalar(keys %mapping), " keys\n";
+ foreach my $key (keys %mapping) {
+ my $data = $memberhash{$mapping{$key}->{is}};
+ $debug and printf "mapping %20s ==> %-20s (%s)\n", $key, $mapping{$key}->{is}, $data;
+ unless (defined $data) {
+ $data = $mapping{$key}->{content} || ''; # default or failsafe ''
+ }
$borrower{$key} = ($data ne '') ? $data : ' ' ;
}
$borrower{initials} = $memberhash{initials} ||
( substr($borrower{'firstname'},0,1)
. substr($borrower{ 'surname' },0,1)
- . " ");
+ . " ");
return %borrower;
}
sub exists_local($) {
- my $sth = C4::Context->dbh->prepare("SELECT password from borrowers WHERE cardnumber=?");
- $sth->execute(shift);
- return ($sth->rows) ? 1 : 0 ;
+ my $arg = shift;
+ my $dbh = C4::Context->dbh;
+ my $select = "SELECT borrowernumber,cardnumber,userid,password FROM borrowers ";
+
+ my $sth = $dbh->prepare("$select WHERE userid=?"); # was cardnumber=?
+ $sth->execute($arg);
+ $debug and printf "Userid '$arg' exists_local? %s\n", $sth->rows;
+ ($sth->rows == 1) and return $sth->fetchrow;
+
+ $sth = $dbh->prepare("$select WHERE cardnumber=?");
+ $sth->execute($arg);
+ $debug and printf "Cardnumber '$arg' exists_local? %s\n", $sth->rows;
+ ($sth->rows == 1) and return $sth->fetchrow;
+ return 0;
}
-sub update_local($$%) {
- # warn "MODIFY borrower";
- my $userid = shift or return undef;
- my $digest = md5_base64(shift) or return undef;
- my %borrower = shift or return undef;
+sub update_local($$$$) {
+ my $userid = shift or return undef;
+ my $digest = md5_base64(shift) or return undef;
+ my $borrowerid = shift or return undef;
+ my $borrower = shift or return undef;
+ my @keys = keys %$borrower;
my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("
-UPDATE borrowers
-SET firstname=?,surname=?,initials=?,streetaddress=?,city=?,phone=?, categorycode=?,branchcode=?,emailaddress=?,sort1=?
-WHERE cardnumber=?
- ");
+ my $query = "UPDATE borrowers\nSET " .
+ join(',', map {"$_=?"} @keys) .
+ "\nWHERE borrowernumber=? ";
+ my $sth = $dbh->prepare($query);
+ if ($debug) {
+ print STDERR $query, "\n",
+ join "\n", map {"$_ = '" . $borrower->{$_} . "'"} @keys;
+ print STDERR "\nuserid = $userid\n";
+ }
$sth->execute(
- $borrower{firstname}, $borrower{surname},
- $borrower{initials}, $borrower{streetaddress},
- $borrower{city}, $borrower{phone},
- $borrower{categorycode}, $borrower{branchcode},
- $borrower{emailaddress}, $borrower{sort1},
- $userid
+ ((map {$borrower->{$_}} @keys), $borrowerid)
);
# MODIFY PASSWORD/LOGIN
# search borrowerid
- $sth = $dbh->prepare("SELECT borrowernumber from borrowers WHERE cardnumber=? ");
- $sth->execute($userid);
- my ($borrowerid) = $sth->fetchrow;
- # warn "change local password for $borrowerid setting $password";
+ $debug and print "changing local password for borrowernumber=$borrowerid to '$digest'\n";
changepassword($userid, $borrowerid, $digest);
# Confirm changes
- my $cardnumber;
- $sth = $dbh->prepare("SELECT password,cardnumber from borrowers WHERE userid=? ");
- $cardnumber = confirmer($sth,$userid,$digest) and return $cardnumber;
- $sth = $dbh->prepare("SELECT password,cardnumber from borrowers WHERE cardnumber=? ");
- $cardnumber = confirmer($sth,$userid,$digest) and return $cardnumber;
- die "Unexpected error after password update to $userid / $cardnumber.";
-}
-
-sub confirmer($$) {
- my $sth = shift or return undef;
- my $userid = shift or return undef;
- my $digest = shift or return undef;
- $sth->execute($userid);
+ $sth = $dbh->prepare("SELECT password,cardnumber FROM borrowers WHERE borrowernumber=? ");
+ $sth->execute($borrowerid);
if ($sth->rows) {
- my ($md5password, $othernum) = $sth->fetchrow;
- ($digest eq $md5password) and return $othernum;
- warn "Password mismatch after update to userid=$userid";
+ my ($md5password, $cardnum) = $sth->fetchrow;
+ ($digest eq $md5password) and return $cardnum;
+ warn "Password mismatch after update to cardnumber=$cardnum (borrowernumber=$borrowerid)";
return undef;
- }
- warn "Could not recover record after updating password for userid=$userid";
- return 0;
+ }
+ die "Unexpected error after password update to userid/borrowernumber: $userid / $borrowerid.";
}
+
1;
__END__
-=back
+=head1 NAME
+
+C4::Auth - Authenticates Koha users
+
+=head1 SYNOPSIS
+
+ use C4::Auth_with_ldap;
+
+=head1 LDAP Configuration
+
+ This module is specific to LDAP authentification. It requires Net::LDAP package and one or more
+ working LDAP servers.
+ To use it :
+ * Modify ldapserver element in KOHA_CONF
+ * Establish field mapping in <mapping> element.
+
+ For example, if your user records are stored according to the inetOrgPerson schema, RFC#2798,
+ the username would match the "uid" field, and the password should match the "userpassword" field.
+
+ Make sure that ALL required fields are populated by your LDAP database (and mapped in KOHA_CONF).
+ What are the required fields? Well, in mysql you can check the database table "borrowers" like this:
+
+ mysql> show COLUMNS from borrowers;
+ +------------------+--------------+------+-----+---------+----------------+
+ | Field | Type | Null | Key | Default | Extra |
+ +------------------+--------------+------+-----+---------+----------------+
+ | borrowernumber | int(11) | NO | PRI | NULL | auto_increment |
+ | cardnumber | varchar(16) | YES | UNI | NULL | |
+ | surname | mediumtext | NO | | | |
+ | firstname | text | YES | | NULL | |
+ | title | mediumtext | YES | | NULL | |
+ | othernames | mediumtext | YES | | NULL | |
+ | initials | text | YES | | NULL | |
+ | streetnumber | varchar(10) | YES | | NULL | |
+ | streettype | varchar(50) | YES | | NULL | |
+ | address | mediumtext | NO | | | |
+ | address2 | text | YES | | NULL | |
+ | city | mediumtext | NO | | | |
+ | zipcode | varchar(25) | YES | | NULL | |
+ | email | mediumtext | YES | | NULL | |
+ | phone | text | YES | | NULL | |
+ | mobile | varchar(50) | YES | | NULL | |
+ | fax | mediumtext | YES | | NULL | |
+ | emailpro | text | YES | | NULL | |
+ | phonepro | text | YES | | NULL | |
+ | B_streetnumber | varchar(10) | YES | | NULL | |
+ | B_streettype | varchar(50) | YES | | NULL | |
+ | B_address | varchar(100) | YES | | NULL | |
+ | B_city | mediumtext | YES | | NULL | |
+ | B_zipcode | varchar(25) | YES | | NULL | |
+ | B_email | text | YES | | NULL | |
+ | B_phone | mediumtext | YES | | NULL | |
+ | dateofbirth | date | YES | | NULL | |
+ | branchcode | varchar(10) | NO | MUL | | |
+ | categorycode | varchar(10) | NO | MUL | | |
+ | dateenrolled | date | YES | | NULL | |
+ | dateexpiry | date | YES | | NULL | |
+ | gonenoaddress | tinyint(1) | YES | | NULL | |
+ | lost | tinyint(1) | YES | | NULL | |
+ | debarred | tinyint(1) | YES | | NULL | |
+ | contactname | mediumtext | YES | | NULL | |
+ | contactfirstname | text | YES | | NULL | |
+ | contacttitle | text | YES | | NULL | |
+ | guarantorid | int(11) | YES | | NULL | |
+ | borrowernotes | mediumtext | YES | | NULL | |
+ | relationship | varchar(100) | YES | | NULL | |
+ | ethnicity | varchar(50) | YES | | NULL | |
+ | ethnotes | varchar(255) | YES | | NULL | |
+ | sex | varchar(1) | YES | | NULL | |
+ | password | varchar(30) | YES | | NULL | |
+ | flags | int(11) | YES | | NULL | |
+ | userid | varchar(30) | YES | MUL | NULL | | # UNIQUE in next release.
+ | opacnote | mediumtext | YES | | NULL | |
+ | contactnote | varchar(255) | YES | | NULL | |
+ | sort1 | varchar(80) | YES | | NULL | |
+ | sort2 | varchar(80) | YES | | NULL | |
+ +------------------+--------------+------+-----+---------+----------------+
+ 50 rows in set (0.01 sec)
+
+ Where Null="NO", the field is required.
+
+=cut
+
+=head1 KOHA_CONF and field mapping
+
+Example XML stanza for LDAP configuration in KOHA_CONF.
+
+ <config>
+ ...
+ <!-- LDAP SERVER (optional) -->
+ <ldapserver id="ldapserver">
+ <hostname>localhost</hostname>
+ <base>dc=metavore,dc=com</base>
+ <user>cn=Manager,dc=metavore,dc=com</user> <!-- DN, if not anonymous -->
+ <pass>metavore</pass> <!-- password, if not anonymous -->
+ <replicate>1</replicate> <!-- add new users from LDAP to Koha database -->
+ <update>1</update> <!-- update existing users in Koha database -->
+ <mapping> <!-- match koha SQL field names to your LDAP record field names -->
+ <firstname is="givenname" ></firstname>
+ <surname is="sn" ></surname>
+ <address is="postaladdress" ></address>
+ <city is="l" >Athens, OH</city>
+ <zipcode is="postalcode" ></zipcode>
+ <branchcode is="branch" >MAIN</branchcode>
+ <userid is="uid" ></userid>
+ <password is="userpassword" ></password>
+ <email is="mail" ></email>
+ <categorycode is="employeetype" >PT</categorycode>
+ <phone is="telephonenumber"></phone>
+ </mapping>
+ </ldapserver>
+ </config>
+
+The <mapping> subelements establish the relationship between mysql fields and LDAP attributes. The element name
+is the column in mysql, with the "is" characteristic set to the LDAP attribute name. Optionally, any content
+between the element tags is taken as the default value. In this example, the default categorycode is "PT" (for
+patron).
+
+=cut
+
+# ========================================
+# Using attrs instead of {asn}->attributes
+# ========================================
+#
+# LDAP key: ->{ cn} = ARRAY w/ 3 members.
+# LDAP key: ->{ cn}->{ sss} = sss
+# LDAP key: ->{ cn}->{ Steve Smith} = Steve Smith
+# LDAP key: ->{ cn}->{Steve S. Smith} = Steve S. Smith
+#
+# LDAP key: ->{ givenname} = ARRAY w/ 1 members.
+# LDAP key: ->{ givenname}->{Steve} = Steve
+#
=head1 SEE ALSO
Net::LDAP()
+XML::Simple()
+
Digest::MD5(3)
=cut
projects / koha.git / blobdiff