ORM Auth driver.
Class declared in MODPATH/orm/classes/Auth/ORM.php on line 3.
NULL
NULL
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', ['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 - $password boolean
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 object boolean
$mark_session_as_forced
= bool FALSE - Mark the session as forced boolean
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 in mixed
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 names boolean
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', ['name'=>$role]);if(!$roles->loaded())returnfalse;}else{$roles=$role;}}return$user->has('roles',$roles);}}
Log a user out and remove any autologin cookies.
boolean
$destroy
= bool FALSE - Completely destroy the session boolean
$logout_all
= bool FALSE - Remove all tokens for user boolean
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', ['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 object string
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 Options void
publicfunction__construct($config= []){// 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 hash string
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']);}
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 in string
$password
required - Password to check against boolean
$remember
= bool FALSE - Enable autologin boolean
publicfunctionlogin($username,$password,$remember= false){if(empty($password))returnfalse;return$this->_login($username,$password,$remember);}
Logs a user in.
string
$user
required - Name string
$password
required - $password boolean
$remember
required - Enable autologin boolean
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', ['name'=>'login'])) AND$user->password ===$password) {if($remember=== true) {// Token data$data= ['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 object void
protectedfunctioncomplete_login($user){$user->complete_login();returnparent::complete_login($user);}