Bug 2400 [1/18]: fixing pod syntax in C4/Acquisitions.pm
[koha.git] / C4 / Auth_with_ldap.pm
index 7602628..e6ed181 100644 (file)
@@ -20,6 +20,7 @@ package C4::Auth_with_ldap;
 use strict;
 use Digest::MD5 qw(md5_base64);
 
+use C4::Debug;
 use C4::Context;
 use C4::Members qw(AddMember changepassword);
 use C4::Utils qw( :all );
@@ -30,15 +31,14 @@ use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
 
 BEGIN {
        require Exporter;
-       $VERSION = 3.01;        # set the version for version checking
-       $debug = $ENV{DEBUG} || 0;
+       $VERSION = 3.03;        # set the version for version checking
        @ISA    = qw(Exporter);
        @EXPORT = qw( checkpw_ldap );
 }
 
 # 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
@@ -49,7 +49,7 @@ sub ldapserver_error ($) {
 
 use vars qw($mapping @ldaphosts $base $ldapname $ldappassword);
 my $context = C4::Context->new()       or die 'C4::Context->new failed';
-my $ldap = $context->{server}->{ldapserver}    or die 'No "ldapserver" in server hash from KOHA_CONF: ' . $ENV{KOHA_CONF};
+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');
@@ -77,7 +77,8 @@ sub checkpw_ldap {
     my ($dbh, $userid, $password) = @_;
     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);
@@ -233,10 +234,10 @@ C4::Auth - Authenticates Koha users
           * Modify ldapserver element in KOHA_CONF
           * Establish field mapping in <mapping> element.
 
-       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.
+       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 the required fields are populated in your LDAP database (and mapped in KOHA_CONF).  
+       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;
@@ -302,30 +303,33 @@ C4::Auth - Authenticates Koha users
 
 =head1 KOHA_CONF and field mapping
 
-Example XML stanza for LDAP configuration in KOHA_CONF:
-
-       <!-- LDAP SERVER (optional) -->
-       <server id="ldapserver"  listenref="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>
-       </server>
+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