Source for file ldap.php

Documentation is available at ldap.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Plugin
  4.  * @subpackage  Authentication.ldap
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. /**
  13.  * LDAP Authentication Plugin
  14.  *
  15.  * @package     Joomla.Plugin
  16.  * @subpackage  Authentication.ldap
  17.  * @since       1.5
  18.  */
  19. class PlgAuthenticationLdap extends JPlugin
  20. {
  21.     /**
  22.      * This method should handle any authentication and report back to the subject
  23.      *
  24.      * @param   array   $credentials  Array holding the user credentials
  25.      * @param   array   $options      Array of extra options
  26.      * @param   object  &$response    Authentication response object
  27.      *
  28.      * @return  boolean 
  29.      *
  30.      * @since   1.5
  31.      */
  32.     public function onUserAuthenticate($credentials, $options, &$response)
  33.     {
  34.         $userdetails = null;
  35.         $success = 0;
  36.         $userdetails = array();
  37.  
  38.         // For JLog
  39.         $response->type = 'LDAP';
  40.  
  41.         // LDAP does not like Blank passwords (tries to Anon Bind which is bad)
  42.         if (empty($credentials['password']))
  43.         {
  44.             $response->status = JAuthentication::STATUS_FAILURE;
  45.             $response->error_message = JText::_('JGLOBAL_AUTH_PASS_BLANK');
  46.  
  47.             return false;
  48.         }
  49.  
  50.         // Load plugin params info
  51.         $ldap_email        = $this->params->get('ldap_email');
  52.         $ldap_fullname    = $this->params->get('ldap_fullname');
  53.         $ldap_uid        = $this->params->get('ldap_uid');
  54.         $auth_method    = $this->params->get('auth_method');
  55.  
  56.         $ldap = new JClientLdap($this->params);
  57.  
  58.         if (!$ldap->connect())
  59.         {
  60.             $response->status = JAuthentication::STATUS_FAILURE;
  61.             $response->error_message = JText::_('JGLOBAL_AUTH_NO_CONNECT');
  62.  
  63.             return;
  64.         }
  65.  
  66.         switch ($auth_method)
  67.         {
  68.             case 'search':
  69.             {
  70.                 // Bind using Connect Username/password
  71.                 // Force anon bind to mitigate misconfiguration like [#7119]
  72.                 if (strlen($this->params->get('username')))
  73.                 {
  74.                     $bindtest = $ldap->bind();
  75.                 }
  76.                 else
  77.                 {
  78.                     $bindtest = $ldap->anonymous_bind();
  79.                 }
  80.  
  81.                 if ($bindtest)
  82.                 {
  83.                     // Search for users DN
  84.                     $binddata = $ldap->simple_search(str_replace("[search]", $credentials['username'], $this->params->get('search_string')));
  85.  
  86.                     if (isset($binddata[0]) && isset($binddata[0]['dn']))
  87.                     {
  88.                         // Verify Users Credentials
  89.                         $success = $ldap->bind($binddata[0]['dn'], $credentials['password'], 1);
  90.  
  91.                         // Get users details
  92.                         $userdetails = $binddata;
  93.                     }
  94.                     else
  95.                     {
  96.                         $response->status = JAuthentication::STATUS_FAILURE;
  97.                         $response->error_message = JText::_('JGLOBAL_AUTH_USER_NOT_FOUND');
  98.                     }
  99.                 }
  100.                 else
  101.                 {
  102.                     $response->status = JAuthentication::STATUS_FAILURE;
  103.                     $response->error_message = JText::_('JGLOBAL_AUTH_NO_BIND');
  104.                 }
  105.             }    break;
  106.  
  107.             case 'bind':
  108.             {
  109.                 // We just accept the result here
  110.                 $success = $ldap->bind($credentials['username'], $credentials['password']);
  111.  
  112.                 if ($success)
  113.                 {
  114.                     $userdetails = $ldap->simple_search(str_replace("[search]", $credentials['username'], $this->params->get('search_string')));
  115.                 }
  116.                 else
  117.                 {
  118.                     $response->status = JAuthentication::STATUS_FAILURE;
  119.                     $response->error_message = JText::_('JGLOBAL_AUTH_BIND_FAILED');
  120.                 }
  121.             }    break;
  122.         }
  123.  
  124.         if (!$success)
  125.         {
  126.             $response->status = JAuthentication::STATUS_FAILURE;
  127.  
  128.             if (!strlen($response->error_message))
  129.             {
  130.                 $response->error_message = JText::_('JGLOBAL_AUTH_INCORRECT');
  131.             }
  132.         }
  133.         else
  134.         {
  135.             // Grab some details from LDAP and return them
  136.             if (isset($userdetails[0][$ldap_uid][0]))
  137.             {
  138.                 $response->username = $userdetails[0][$ldap_uid][0];
  139.             }
  140.  
  141.             if (isset($userdetails[0][$ldap_email][0]))
  142.             {
  143.                 $response->email = $userdetails[0][$ldap_email][0];
  144.             }
  145.  
  146.             if (isset($userdetails[0][$ldap_fullname][0]))
  147.             {
  148.                 $response->fullname = $userdetails[0][$ldap_fullname][0];
  149.             }
  150.             else
  151.             {
  152.                 $response->fullname = $credentials['username'];
  153.             }
  154.  
  155.             // Were good - So say so.
  156.             $response->status        = JAuthentication::STATUS_SUCCESS;
  157.             $response->error_message = '';
  158.         }
  159.  
  160.         $ldap->close();
  161.     }
  162. }

Documentation generated on Tue, 19 Nov 2013 15:06:43 +0100 by phpDocumentor 1.4.3