User authorization library. Handles user login and logout, as well as secure password hashing.
Class declared in MODPATH/auth/classes/kohana/auth.php on line 11.
NULL
Loads Session and configuration options.
array
$config
= array(0) - Config Optionsvoidpublic function __construct($config = array())
{
// Save the config in the object
$this->_config = $config;
$this->_session = Session::instance();
}abstract public function check_password($password);Gets the currently logged in user from the session. Returns NULL if no user is currently logged in.
mixed
$default
= NULL - Default value to return if the user is currently not logged in.mixedpublic function get_user($default = NULL)
{
return $this->_session->get($this->_config['session_key'], $default);
}Perform a hmac hash, using the configured method.
string
$str
required - String to hashstringpublic function hash($str)
{
if ( ! $this->_config['hash_key'])
throw new Kohana_Exception('A valid hash key must be set in your auth config.');
return hash_hmac($this->_config['hash_method'], $str, $this->_config['hash_key']);
}Creates a hashed hmac password from a plaintext password. This method is deprecated, Auth::hash should be used instead.
string
$password
required - Plaintext passwordpublic function hash_password($password)
{
return $this->hash($password);
}Singleton pattern
Authpublic static function instance()
{
if ( ! isset(Auth::$_instance))
{
// Load the configuration for this type
$config = Kohana::config('auth');
if ( ! $type = $config->get('driver'))
{
$type = 'file';
}
// Set the session class name
$class = 'Auth_'.ucfirst($type);
// Create a new session instance
Auth::$_instance = new $class($config);
}
return Auth::$_instance;
}Check if there is an active session. Optionally allows checking for a specific role.
string
$role
= NULL - Role namemixedpublic function logged_in($role = NULL)
{
return ($this->get_user() !== NULL);
}Attempt to log in a user by using an ORM object and plain-text password.
string
$username
required - Username to log instring
$password
required - Password to check againstboolean
$remember
= bool FALSE - Enable autologinbooleanpublic function login($username, $password, $remember = FALSE)
{
if (empty($password))
return FALSE;
if (is_string($password))
{
// Create a hashed password
$password = $this->hash($password);
}
return $this->_login($username, $password, $remember);
}Log out a user by removing the related session variables.
boolean
$destroy
= bool FALSE - Completely destroy the sessionboolean
$logout_all
= bool FALSE - Remove all tokens for userbooleanpublic function logout($destroy = FALSE, $logout_all = FALSE)
{
if ($destroy === TRUE)
{
// Destroy the session completely
$this->_session->destroy();
}
else
{
// Remove the user from the session
$this->_session->delete($this->_config['session_key']);
// Regenerate session_id
$this->_session->regenerate();
}
// Double check
return ! $this->logged_in();
}abstract public function password($username);abstract protected function _login($username, $password, $remember);protected function complete_login($user)
{
// Regenerate session_id
$this->_session->regenerate();
// Store username in session
$this->_session->set($this->_config['session_key'], $user);
return TRUE;
}