refactored authentication system.
This commit is contained in:
Taylor Otwell
parent
c49e1964a9
commit
60f61f318b
233
laravel/auth.php
233
laravel/auth.php
|
|
@ -3,214 +3,99 @@
|
||||||
class Auth {
|
class Auth {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The current user of the application.
|
* The currently active authentication drivers.
|
||||||
*
|
*
|
||||||
* @var object
|
* @var array
|
||||||
*/
|
*/
|
||||||
public static $user;
|
public static $drivers = array();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The key used when storing the user ID in the session.
|
* The third-party driver registrar.
|
||||||
*
|
*
|
||||||
* @var string
|
* @var array
|
||||||
*/
|
*/
|
||||||
const user_key = 'laravel_user_id';
|
public static $registrar = array();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Determine if the user of the application is not logged in.
|
* Get an authentication driver instance.
|
||||||
*
|
*
|
||||||
* This method is the inverse of the "check" method.
|
* @param string $driver
|
||||||
*
|
* @return Driver
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public static function guest()
|
public static function driver($driver = null)
|
||||||
{
|
{
|
||||||
return ! static::check();
|
if (is_null($driver)) $driver = Config::get('auth.driver');
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
if ( ! isset(static::$drivers[$driver]))
|
||||||
* Determine if the user of the application is logged in.
|
|
||||||
*
|
|
||||||
* @return bool
|
|
||||||
*/
|
|
||||||
public static function check()
|
|
||||||
{
|
|
||||||
return ! is_null(static::user());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the current user of the application.
|
|
||||||
*
|
|
||||||
* <code>
|
|
||||||
* // Get the current user of the application
|
|
||||||
* $user = Auth::user();
|
|
||||||
*
|
|
||||||
* // Access a property on the current user of the application
|
|
||||||
* $email = Auth::user()->email;
|
|
||||||
* </code>
|
|
||||||
*
|
|
||||||
* @return object|null
|
|
||||||
*/
|
|
||||||
public static function user()
|
|
||||||
{
|
|
||||||
if ( ! is_null(static::$user)) return static::$user;
|
|
||||||
|
|
||||||
$id = Session::get(Auth::user_key);
|
|
||||||
|
|
||||||
// To retrieve the user, we'll first attempt to use the "user" Closure
|
|
||||||
// defined in the auth configuration file, passing in the ID. The user
|
|
||||||
// Closure gives the developer a ton of freedom surrounding how the
|
|
||||||
// user is actually retrieved.
|
|
||||||
$config = Config::get('auth');
|
|
||||||
|
|
||||||
static::$user = call_user_func($config['user'], $id);
|
|
||||||
|
|
||||||
// If the user wasn't found in the database but a "remember me" cookie
|
|
||||||
// exists, we'll attempt to recall the user based on the cookie value.
|
|
||||||
// Since all cookies contain a fingerprint hash verifying that they
|
|
||||||
// haven't changed, we can trust it.
|
|
||||||
$recaller = Cookie::get($config['cookie']);
|
|
||||||
|
|
||||||
if (is_null(static::$user) and ! is_null($recaller))
|
|
||||||
{
|
{
|
||||||
static::$user = static::recall($recaller);
|
static::$drivers[$driver] = static::factory($driver);
|
||||||
}
|
}
|
||||||
|
|
||||||
return static::$user;
|
return static::$drivers[$driver];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Attempt to login a user based on a long-lived "remember me" cookie.
|
* Create a new authentication driver instance.
|
||||||
*
|
*
|
||||||
* @param string $recaller
|
* @param string $driver
|
||||||
* @return mixed
|
* @return Driver
|
||||||
*/
|
*/
|
||||||
protected static function recall($recaller)
|
protected static function factory($driver)
|
||||||
{
|
{
|
||||||
$recaller = explode('|', Crypter::decrypt($recaller));
|
if (isset(static::$registrar[$driver]))
|
||||||
|
|
||||||
// We'll pass the ID that was stored in the cookie into the same user
|
|
||||||
// Closure that is used by the "user" method. If the method returns
|
|
||||||
// a user, we will log them into the application.
|
|
||||||
$user = call_user_func(Config::get('auth.user'), $recaller[0]);
|
|
||||||
|
|
||||||
if ( ! is_null($user))
|
|
||||||
{
|
{
|
||||||
static::login($user);
|
return static::$registrar[$driver]();
|
||||||
|
}
|
||||||
|
|
||||||
return $user;
|
switch ($driver)
|
||||||
|
{
|
||||||
|
case 'fluent':
|
||||||
|
return new Auth\Drivers\Fluent(Config::get('auth.table'));
|
||||||
|
|
||||||
|
case 'eloquent':
|
||||||
|
return new Auth\Drivers\Eloquent(Config::get('auth.model'));
|
||||||
|
|
||||||
|
default:
|
||||||
|
throw new \Exception("Auth driver {$driver} is not supported.");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Attempt to log a user into the application.
|
* Run the logout method on all active drivers.
|
||||||
*
|
|
||||||
* <code>
|
|
||||||
* // Attempt to log a user into the application
|
|
||||||
* $success = Auth::attempt('username', 'password');
|
|
||||||
*
|
|
||||||
* // Attempt to login a user and set the "remember me" cookie
|
|
||||||
* Auth::attempt('username', 'password', true);
|
|
||||||
* </code>
|
|
||||||
*
|
|
||||||
* @param string $username
|
|
||||||
* @param string $password
|
|
||||||
* @param bool $remember
|
|
||||||
* @return bool
|
|
||||||
*/
|
|
||||||
public static function attempt($username, $password = null, $remember = false)
|
|
||||||
{
|
|
||||||
$config = Config::get('auth');
|
|
||||||
|
|
||||||
// When attempting to login the user, we will call the "attempt" closure
|
|
||||||
// from the configuration file. This gives the developer the freedom to
|
|
||||||
// authenticate based on the needs of their application, even allowing
|
|
||||||
// the user of third-party providers.
|
|
||||||
$user = call_user_func($config['attempt'], $username, $password);
|
|
||||||
|
|
||||||
if (is_null($user)) return false;
|
|
||||||
|
|
||||||
static::login($user, $remember);
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Log a user into the application.
|
|
||||||
*
|
|
||||||
* <code>
|
|
||||||
* // Login the user with an ID of 15
|
|
||||||
* Auth::login(15);
|
|
||||||
*
|
|
||||||
* // Login a user by passing a user object
|
|
||||||
* Auth::login($user);
|
|
||||||
*
|
|
||||||
* // Login a user and set a "remember me" cookie
|
|
||||||
* Auth::login($user, true);
|
|
||||||
* </code>
|
|
||||||
*
|
|
||||||
* @param object|int $user
|
|
||||||
* @param bool $remember
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public static function login($user, $remember = false)
|
|
||||||
{
|
|
||||||
$id = (is_object($user)) ? $user->id : (int) $user;
|
|
||||||
|
|
||||||
if ($remember) static::remember($id);
|
|
||||||
|
|
||||||
Session::put(Auth::user_key, $id);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set a cookie so that the user is "remembered".
|
|
||||||
*
|
|
||||||
* @param string $id
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
protected static function remember($id)
|
|
||||||
{
|
|
||||||
$recaller = Crypter::encrypt($id.'|'.Str::random(40));
|
|
||||||
|
|
||||||
// This method assumes the "remember me" cookie should have the same
|
|
||||||
// configuration as the session cookie. Since this cookie, like the
|
|
||||||
// session cookie, should be kept very secure, it's probably safe.
|
|
||||||
// to assume the cookie settings are the same.
|
|
||||||
$config = Config::get('session');
|
|
||||||
|
|
||||||
extract($config, EXTR_SKIP);
|
|
||||||
|
|
||||||
$cookie = Config::get('auth.cookie');
|
|
||||||
|
|
||||||
Cookie::forever($cookie, $recaller, $path, $domain, $secure);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Log the current user out of the application.
|
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public static function logout()
|
public static function logout()
|
||||||
{
|
{
|
||||||
// We will call the "logout" closure first, which gives the developer
|
array_walk(static::$drivers, function($d) { $d->logout(); });
|
||||||
// the chance to do any clean-up or before the user is logged out of
|
}
|
||||||
// the application. No action is taken by default.
|
|
||||||
call_user_func(Config::get('auth.logout'), static::user());
|
|
||||||
|
|
||||||
static::$user = null;
|
/**
|
||||||
|
* Register a third-party authentication driver.
|
||||||
|
*
|
||||||
|
* @param string $driver
|
||||||
|
* @param Closure $resolver
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public static function extend($driver, Closure $resolver)
|
||||||
|
{
|
||||||
|
static::$registrar[$driver] = $resolver;
|
||||||
|
}
|
||||||
|
|
||||||
$config = Config::get('session');
|
/**
|
||||||
|
* Magic Method for calling the methods on the default cache driver.
|
||||||
extract($config, EXTR_SKIP);
|
*
|
||||||
|
* <code>
|
||||||
// When forgetting the cookie, we need to also pass in the path and
|
* // Call the "user" method on the default auth driver
|
||||||
// domain that would have been used when the cookie was originally
|
* $user = Auth::user();
|
||||||
// set by the framework, otherwise it will not be deleted.
|
*
|
||||||
$cookie = Config::get('auth.cookie');
|
* // Call the "check" method on the default auth driver
|
||||||
|
* Auth::check();
|
||||||
Cookie::forget($cookie, $path, $domain, $secure);
|
* </code>
|
||||||
|
*/
|
||||||
Session::forget(Auth::user_key);
|
public static function __callStatic($method, $parameters)
|
||||||
|
{
|
||||||
|
return call_user_func_array(array(static::driver(), $method), $parameters);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
<?php namespace Laravel\Auth\Login\Drivers;
|
<?php namespace Laravel\Auth\Drivers;
|
||||||
|
|
||||||
use Laravel\Str;
|
use Laravel\Str;
|
||||||
use Laravel\Cookie;
|
use Laravel\Cookie;
|
||||||
|
|
@ -41,6 +41,18 @@ public function __construct()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determine if the user of the application is not logged in.
|
||||||
|
*
|
||||||
|
* This method is the inverse of the "check" method.
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function guest()
|
||||||
|
{
|
||||||
|
return ! $this->check();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Determine if the user is logged in.
|
* Determine if the user is logged in.
|
||||||
*
|
*
|
||||||
|
|
@ -58,15 +70,28 @@ public function check()
|
||||||
*
|
*
|
||||||
* @return mixed|null
|
* @return mixed|null
|
||||||
*/
|
*/
|
||||||
abstract public function user();
|
public function user()
|
||||||
|
{
|
||||||
|
if ( ! is_null($this->user)) return $this->user;
|
||||||
|
|
||||||
|
return $this->user = $this->retrieve($this->token);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the a given application user by ID.
|
||||||
|
*
|
||||||
|
* @param int $id
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
abstract public function retrieve($id);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Attempt to log a user into the application.
|
* Attempt to log a user into the application.
|
||||||
*
|
*
|
||||||
* @param dynamic $arguments
|
* @param array $arguments
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
abstract public function attempt();
|
abstract public function attempt($arguments = array());
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Login the user assigned to the given token.
|
* Login the user assigned to the given token.
|
||||||
|
|
@ -74,10 +99,16 @@ abstract public function attempt();
|
||||||
* The token is typically a numeric ID for the user.
|
* The token is typically a numeric ID for the user.
|
||||||
*
|
*
|
||||||
* @param string $token
|
* @param string $token
|
||||||
|
* @param bool $remember
|
||||||
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function login($token)
|
public function login($token, $remember = false)
|
||||||
{
|
{
|
||||||
$this->store($token);
|
$this->store($token);
|
||||||
|
|
||||||
|
if ($remember) $this->remember($token);
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,74 @@
|
||||||
|
<?php namespace Laravel\Auth\Drivers; use User, Laravel\Hash;
|
||||||
|
|
||||||
|
class Eloquent extends Driver {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of the "User" model used by the application.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
public $model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new Eloquent authentication driver.
|
||||||
|
*
|
||||||
|
* @param string $model
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function __construct($model)
|
||||||
|
{
|
||||||
|
$this->model = $model;
|
||||||
|
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the current user of the application.
|
||||||
|
*
|
||||||
|
* If the user is a guest, null should be returned.
|
||||||
|
*
|
||||||
|
* @param int $id
|
||||||
|
* @return mixed|null
|
||||||
|
*/
|
||||||
|
public function retrieve($id)
|
||||||
|
{
|
||||||
|
if (filter_var($id, FILTER_VALIDATE_INT) !== false)
|
||||||
|
{
|
||||||
|
return $this->model()->find($id);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Attempt to log a user into the application.
|
||||||
|
*
|
||||||
|
* @param array $arguments
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function attempt($arguments = array())
|
||||||
|
{
|
||||||
|
$user = $this->model()->where('email', '=', $arguments['email'])->first();
|
||||||
|
|
||||||
|
// This driver uses a basic username and password authentication scheme
|
||||||
|
// so if the credentials match what is in the database we will just
|
||||||
|
// log the user into the application and remember them if asked.
|
||||||
|
$password = $arguments['password'];
|
||||||
|
|
||||||
|
if ( ! is_null($user) and Hash::check($password, $user->password))
|
||||||
|
{
|
||||||
|
return $this->login($user->id, array_get($arguments, 'remember'));
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a fresh model instance.
|
||||||
|
*
|
||||||
|
* @return Eloquent
|
||||||
|
*/
|
||||||
|
protected function model()
|
||||||
|
{
|
||||||
|
return new $this->model;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,64 @@
|
||||||
|
<?php namespace Laravel\Auth\Drivers; use Laravel\Hash, Laravel\Database;
|
||||||
|
|
||||||
|
class Fluent extends Driver {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The "users" table used by the application.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
public $table;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new fluent authentication driver.
|
||||||
|
*
|
||||||
|
* @param string $table
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function __construct($table)
|
||||||
|
{
|
||||||
|
$this->table = $table;
|
||||||
|
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the current user of the application.
|
||||||
|
*
|
||||||
|
* If the user is a guest, null should be returned.
|
||||||
|
*
|
||||||
|
* @param int $id
|
||||||
|
* @return mixed|null
|
||||||
|
*/
|
||||||
|
public function retrieve($id)
|
||||||
|
{
|
||||||
|
if (filter_var($id, FILTER_VALIDATE_INT) !== false)
|
||||||
|
{
|
||||||
|
Database::table($this->table)->find($id);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Attempt to log a user into the application.
|
||||||
|
*
|
||||||
|
* @param array $arguments
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function attempt($arguments = array())
|
||||||
|
{
|
||||||
|
$user = Database::table($this->table)->where_email($arguments['email'])->first();
|
||||||
|
|
||||||
|
// This driver uses a basic username and password authentication scheme
|
||||||
|
// so if the credentials mmatch what is in the database we will just
|
||||||
|
// log the user into the application and remember them if asked.
|
||||||
|
$password = $arguments['password'];
|
||||||
|
|
||||||
|
if ( ! is_null($user) and Hash::check($password, $user->password))
|
||||||
|
{
|
||||||
|
return $this->login($user->id, array_get($arguments, 'remember'));
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue