- md5
- dd438a0b355b18585212a055ff03fa0c
- sha1
- e9ed04862daa6800c5dde1b6c0b10ca26780f66f
- sha256
- 901dd30b85dee32d1a968afec5603c3d3f64bd6e8bc987718149bb2d3f50e6d2
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
<?php
/**
* Joomla! Content Management System
*
* @copyright Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Authentication;
defined('JPATH_PLATFORM') or die;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\Event\DispatcherAwareTrait;
use Joomla\Event\DispatcherInterface;
/**
* Authentication class, provides an interface for the Joomla authentication system
*
* @since 11.1
*/
class Authentication extends \JObject
{
use DispatcherAwareTrait;
/**
* This is the status code returned when the authentication is success (permit login)
* @const STATUS_SUCCESS successful response
* @since 11.2
*/
const STATUS_SUCCESS = 1;
/**
* Status to indicate cancellation of authentication (unused)
* @const STATUS_CANCEL cancelled request (unused)
* @since 11.2
*/
const STATUS_CANCEL = 2;
/**
* This is the status code returned when the authentication failed (prevent login if no success)
* @const STATUS_FAILURE failed request
* @since 11.2
*/
const STATUS_FAILURE = 4;
/**
* This is the status code returned when the account has expired (prevent login)
* @const STATUS_EXPIRED an expired account (will prevent login)
* @since 11.2
*/
const STATUS_EXPIRED = 8;
/**
* This is the status code returned when the account has been denied (prevent login)
* @const STATUS_DENIED denied request (will prevent login)
* @since 11.2
*/
const STATUS_DENIED = 16;
/**
* This is the status code returned when the account doesn't exist (not an error)
* @const STATUS_UNKNOWN unknown account (won't permit or prevent login)
* @since 11.2
*/
const STATUS_UNKNOWN = 32;
/**
* @var Authentication JAuthentication instances container.
* @since 11.3
*/
protected static $instance;
/**
* Constructor
*
* @param DispatcherInterface $dispatcher The event dispatcher we're going to use
*
* @since 11.1
*/
public function __construct(DispatcherInterface $dispatcher = null)
{
// Set the dispatcher
if (!is_object($dispatcher))
{
$dispatcher = \JFactory::getContainer()->get('dispatcher');
}
$this->setDispatcher($dispatcher);
$isLoaded = PluginHelper::importPlugin('authentication');
if (!$isLoaded)
{
\JLog::add(\JText::_('JLIB_USER_ERROR_AUTHENTICATION_LIBRARIES'), \JLog::WARNING, 'jerror');
}
}
/**
* Returns the global authentication object, only creating it
* if it doesn't already exist.
*
* @return Authentication The global Authentication object
*
* @since 11.1
*/
public static function getInstance()
{
if (empty(self::$instance))
{
self::$instance = new static;
}
return self::$instance;
}
/**
* Finds out if a set of login credentials are valid by asking all observing
* objects to run their respective authentication routines.
*
* @param array $credentials Array holding the user credentials.
* @param array $options Array holding user options.
*
* @return AuthenticationResponse Response object with status variable filled in for last plugin or first successful plugin.
*
* @see AuthenticationResponse
* @since 11.1
*/
public function authenticate($credentials, $options = array())
{
// Get plugins
$plugins = PluginHelper::getPlugin('authentication');
// Create authentication response
$response = new AuthenticationResponse;
// Get the dispatcher
$dispatcher = $this->getDispatcher();
/*
* Loop through the plugins and check if the credentials can be used to authenticate
* the user
*
* Any errors raised in the plugin should be returned via the AuthenticationResponse
* and handled appropriately.
*/
foreach ($plugins as $plugin)
{
$className = 'plg' . $plugin->type . $plugin->name;
if (class_exists($className))
{
$plugin = new $className($dispatcher, (array) $plugin);
}
else
{
// Bail here if the plugin can't be created
\JLog::add(\JText::sprintf('JLIB_USER_ERROR_AUTHENTICATION_FAILED_LOAD_PLUGIN', $className), \JLog::WARNING, 'jerror');
continue;
}
// Try to authenticate
$plugin->onUserAuthenticate($credentials, $options, $response);
// If authentication is successful break out of the loop
if ($response->status === self::STATUS_SUCCESS)
{
if (empty($response->type))
{
$response->type = $plugin->_name ?? $plugin->name;
}
break;
}
}
if (empty($response->username))
{
$response->username = $credentials['username'];
}
if (empty($response->fullname))
{
$response->fullname = $credentials['username'];
}
if (empty($response->password) && isset($credentials['password']))
{
$response->password = $credentials['password'];
}
return $response;
}
/**
* Authorises that a particular user should be able to login
*
* @param AuthenticationResponse $response response including username of the user to authorise
* @param array $options list of options
*
* @return AuthenticationResponse[] Array of authentication response objects
*
* @since 11.2
*/
public static function authorise($response, $options = array())
{
// Get plugins in case they haven't been imported already
PluginHelper::importPlugin('user');
PluginHelper::importPlugin('authentication');
$results = \JFactory::getApplication()->triggerEvent('onUserAuthorisation', array($response, $options));
return $results;
}
}
No other release has this exact content. See every version of this file.