ORM Auth driver.
Class declared in MODPATH/orm/classes/auth/orm.php on line 3.
NULL
Logs a user in, based on the authautologin cookie.
mixed
publicfunctionauto_login(){if($token= Cookie::get('authautologin')){// Load the token and user$token= ORM::factory('user_token',array('token'=>$token));if($token->loaded() AND$token->user->loaded()){if($token->user_agent === sha1(Request::$user_agent)){// Save the token to create a new unique token$token->save();// Set the new tokenCookie::set('authautologin',$token->token,$token->expires - time());// Complete the login with the found data$this->complete_login($token->user);// Automatic login was successfulreturn$token->user;}// Token is invalid$token->delete();}}returnFALSE;}
Compare password with original (hashed). Works for current (logged in) user
string
$password
required - $passwordboolean
publicfunctioncheck_password($password){$user=$this->get_user();if( !$user)returnFALSE;return($this->hash($password) ===$user->password);}
Forces a user to be logged in, without specifying a password.
mixed
$user
required - Username string, or user ORM objectboolean
$mark_session_as_forced
= bool FALSE - Mark the session as forcedboolean
publicfunctionforce_login($user,$mark_session_as_forced= FALSE){if( !is_object($user)){$username=$user;// Load the user$user= ORM::factory('user');$user->where($user->unique_key($username),'=',$username)->find();}if($mark_session_as_forced=== TRUE){// Mark the session as forced, to prevent users from changing account information$this->_session->set('auth_forced', TRUE);}// Run the standard completion$this->complete_login($user);}
Gets the currently logged in user from the session (with auto_login check). Returns $default if no user is currently logged in.
mixed
$default
= NULL - To return in case user isn't logged inmixed
publicfunctionget_user($default= NULL){$user= parent::get_user($default);if($user===$default){// check for "remembered" loginif(($user=$this->auto_login()) === FALSE)return$default;}return$user;}
Checks if a session is active.
mixed
$role
= NULL - Role name string, role ORM object, or array with role namesboolean
publicfunctionlogged_in($role= NULL){// Get the user from the session$user=$this->get_user();if( !$user)returnFALSE;if($userinstanceofModel_User AND$user->loaded()){// If we don't have a roll no further checking is neededif( !$role)returnTRUE;if(is_array($role)){// Get all the roles$roles= ORM::factory('role')->where('name','IN',$role)->find_all()->as_array(NULL,'id');// Make sure all the roles are valid onesif(count($roles) !==count($role))returnFALSE;}else{if( !is_object($role)){// Load the role$roles= ORM::factory('role',array('name'=>$role));if( !$roles->loaded())returnFALSE;}}return$user->has('roles',$roles);}}
Log a user out and remove any autologin cookies.
boolean
$destroy
= bool FALSE - Completely destroy the sessionboolean
$logout_all
= bool FALSE - Remove all tokens for userboolean
publicfunctionlogout($destroy= FALSE,$logout_all= FALSE){// Set by force_login()$this->_session->delete('auth_forced');if($token= Cookie::get('authautologin')){// Delete the autologin cookie to prevent re-loginCookie::delete('authautologin');// Clear the autologin token from the database$token= ORM::factory('user_token',array('token'=>$token));if($token->loaded() AND$logout_all){// Delete all user tokens. This isn't the most elegant solution but does the job$tokens= ORM::factory('user_token')->where('user_id','=',$token->user_id)->find_all();foreach($tokensas$_token){$_token->delete();}}elseif($token->loaded()){$token->delete();}}returnparent::logout($destroy);}
Get the stored password for a username.
mixed
$user
required - Username string, or user ORM objectstring
publicfunctionpassword($user){if( !is_object($user)){$username=$user;// Load the user$user= ORM::factory('user');$user->where($user->unique_key($username),'=',$username)->find();}return$user->password;}
Loads Session and configuration options.
array
$config
= array(0) - Config Optionsvoid
publicfunction__construct($config=array()){// Save the config in the object$this->_config =$config;$this->_session = Session::instance($this->_config['session_type']);}
Perform a hmac hash, using the configured method.
string
$str
required - String to hashstring
publicfunctionhash($str){if( !$this->_config['hash_key'])thrownewKohana_Exception('A valid hash key must be set in your auth config.');returnhash_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 password
publicfunctionhash_password($password){return$this->hash($password);}
Singleton pattern
Auth
publicstaticfunctioninstance(){if( ! isset(Auth::$_instance)){// Load the configuration for this type$config= Kohana::$config->load('auth');if( !$type=$config->get('driver')){$type='file';}// Set the session class name$class='Auth_'.ucfirst($type);// Create a new session instanceAuth::$_instance=new$class($config);}returnAuth::$_instance;}
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 autologinboolean
publicfunctionlogin($username,$password,$remember= FALSE){if(empty($password))returnFALSE;return$this->_login($username,$password,$remember);}
Logs a user in.
string
$user
required - Namestring
$password
required - $passwordboolean
$remember
required - Enable autologinboolean
protectedfunction_login($user,$password,$remember){if( !is_object($user)){$username=$user;// Load the user$user= ORM::factory('user');$user->where($user->unique_key($username),'=',$username)->find();}if(is_string($password)){// Create a hashed password$password=$this->hash($password);}// If the passwords match, perform a loginif($user->has('roles', ORM::factory('role',array('name'=>'login'))) AND$user->password ===$password){if($remember=== TRUE){// Token data$data=array('user_id'=>$user->pk(),'expires'=> time() +$this->_config['lifetime'],'user_agent'=> sha1(Request::$user_agent),);// Create a new autologin token$token= ORM::factory('user_token')->values($data)->create();// Set the autologin cookieCookie::set('authautologin',$token->token,$this->_config['lifetime']);}// Finish the login$this->complete_login($user);returnTRUE;}// Login failedreturnFALSE;}
Complete the login for a user by incrementing the logins and setting session data: user_id, username, roles.
object
$user
required - User ORM objectvoid
protectedfunctioncomplete_login($user){$user->complete_login();returnparent::complete_login($user);}