Auth使用salt和password進行使用者認證實例
- 小云云原創
- 2018-01-26 11:11:172361瀏覽
本文主要為大家介紹了關於透過修改Laravel Auth使用salt和password進行認證使用者的相關資料，文中透過範例程式碼介紹的非常詳細，對大家的學習或工作具有一定的參考價值，希望能幫助到大家。
Laraval自帶的用戶認證系統Auth非常強大易用，不過在Laravel的用戶認證系統中用戶註冊、登入、找回密碼這些模組中用到密碼加密和認證演算法時使用的都是bcrypt，而很多之前做的專案使用者表裡都是採用儲存salt + password加密字串的方式來記錄使用者的密碼的，這就給使用Laravel框架來重構之前的專案帶來了很大的阻力，不過最近自己透過在網路上找資料、看社群論壇、看源碼等方式完成了Laravel Auth的修改，在這裡分享出來希望能對其他人有所幫助。 在開篇之前需要再說明下如果是新專案應用Laravel框架，那麼不需要對Auth進行任何修改，預設的bcrypt加密演算法是比salt + password更安全更有效率的加密演算法。
修改用戶註冊
首先，在laravel 啟用驗證是用的artisan指令
php artisan make:auth
執行完指令後在routes檔（位置：app/Http /routes.php）會多一個靜態方法呼叫
Route::auth();
這個Route是Laravel的一個Facade (位於Illuminate\Support\Facades\Route), 呼叫的auth方法定義在Illuminate\Routing\Router類別裡,如下可以看到auth方法裡就是定義了一些Auth相關的路由規則
/**
* Register the typical authentication routes for an application.
*
* @return void
*/
public function auth()
{
// Authentication Routes...
$this->get('login', 'Auth\AuthController@showLoginForm');
$this->post('login', 'Auth\AuthController@login');
$this->get('logout', 'Auth\AuthController@logout');
// Registration Routes...
$this->get('register', 'Auth\AuthController@showRegistrationForm');
$this->post('register', 'Auth\AuthController@register');
// Password Reset Routes...
$this->get('password/reset/{token?}', 'Auth\PasswordController@showResetForm');
$this->post('password/email', 'Auth\PasswordController@sendResetLinkEmail');
$this->post('password/reset', 'Auth\PasswordController@reset');
}
透過路由規則可以看到註冊時請求的控制器方法是AuthController的register方法， 該方法定義在\Illuminate\Foundation \Auth\RegistersUsers這個traits裡，AuthController在類別定義裡引入了這個traits.
/**
* Handle a registration request for the application.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\Response
*/
public function register(Request $request)
{
$validator = $this->validator($request->all());
if ($validator->fails()) {
$this->throwValidationException(
$request, $validator
);
}
Auth::guard($this->getGuard())->login($this->create($request->all()));
return redirect($this->redirectPath());
}
在register方法里首先會對request裡的用戶輸入資料進行驗證，你只需要在AuthController的validator方法裡定義自己的每個輸入欄位的驗證規則就可以
protected function validator(array $data)
{
return Validator::make($data, [
'name' => 'required|max:255',
'email' => 'required|email|max:255|unique:user',
'password' => 'required|size:40|confirmed',
]);
}
接著往下看驗證通過後，Laravel會掉用AuthController的create方法來產生新用戶，然後拿著新用戶的資料去登入Auth ::guard($this->getGuard())->login($this->create($request->all()));
所以我們要自訂使用者註冊時產生使用者密碼的加密方式只需要修改AuthController的create方法即可。
例如：
/**
* Create a new user instance after a valid registration.
*
* @param array $data
* @return User
*/
protected function create(array $data)
{
$salt = Str::random(6);
return User::create([
'nickname' => $data['name'],
'email' => $data['email'],
'password' => sha1($salt . $data['password']),
'register_time' => time(),
'register_ip' => ip2long(request()->ip()),
'salt' => $salt
]);
}
修改使用者登入
#修改登入前我們需要先透過路由規則看一下登入要求的特定控制器和方法，在上文提到的auth方法定義裡可以看到
$this->get('login', 'Auth\AuthController@showLoginForm');
$this->post('login', 'Auth\AuthController@login');
$this->get('logout', 'Auth\AuthController@logout');
驗證登入的操作是在\App\Http\Controllers\Auth\AuthController類別的login方法裡。打開AuthController發現Auth相關的方法都是透過性狀(traits)引入到類別內的，在類別內use 要引入的traits，在編譯時PHP就會把traits裡的程式碼copy到類別中，這是PHP5.5引入的特性具體適用場景和用途這裡不細講。 所以AuthController@login方法實際上是定義在
\Illuminate\Foundation\Auth\AuthenticatesUsers這個traits裡的
/**
* Handle a login request to the application.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\Response
*/
public function login(Request $request)
{
$this->validateLogin($request);
$throttles = $this->isUsingThrottlesLoginsTrait();
if ($throttles && $lockedOut = $this->hasTooManyLoginAttempts($request)) {
$this->fireLockoutEvent($request);
return $this->sendLockoutResponse($request);
}
$credentials = $this->getCredentials($request);
if (Auth::guard($this->getGuard())->attempt($credentials, $request->has('remember'))) {
return $this->handleUserWasAuthenticated($request, $throttles);
}
if ($throttles && ! $lockedOut) {
$this->incrementLoginAttempts($request);
}
return $this->sendFailedLoginResponse($request);
}
登入驗證的主要操作是在Auth::guard($this->getGuard( ))->attempt($credentials, $request->has('remember'));這個方法呼叫中來進行的，Auth::guard($this->getGuard()) 取得到的是\ Illuminate\Auth\SessionGuard (具體如何取得的看Auth這個Facade \Illuminate\Auth\AuthManager裡的源碼)
看一下SessionGuard裡attempt 方法是如何實現的：
public function attempt(array $credentials = [], $remember = false, $login = true)
{
$this->fireAttemptEvent($credentials, $remember, $login);
$this->lastAttempted = $user = $this->provider->retrieveByCredentials($credentials);
if ($this->hasValidCredentials($user, $credentials)) {
if ($login) {
$this->login($user, $remember);
}
return true;
}
if ($login) {
$this->fireFailedEvent($user, $credentials);
}
return false;
}
/**
* Determine if the user matches the credentials.
*
* @param mixed $user
* @param array $credentials
* @return bool
*/
protected function hasValidCredentials($user, $credentials)
{
return ! is_null($user) && $this->provider->validateCredentials($user, $credentials);
}
retrieveByCredentials是用傳遞進來的欄位從資料庫中取出使用者資料的，validateCredentials是用來驗證密碼是否正確的實際過程。
這裡要注意的是$this->provider這個provider是一個實現了\Illuminate\Contracts\Auth\UserProvider類別的provider, 我們看到目錄Illuminate\Auth下面有兩個UserProvider的實現，分別為DatabaseUserProvider和EloquentUserProvider, 但是我們驗證密碼的時候是透過那個來驗證的呢，看一下auth的設定檔
'providers' => [ 'users' => [ 'driver' => 'eloquent', 'model' => App\User::class, //这个是driver用的Model ], ],
這裡設定的是driver => eloquent ,驗證的， 這個EloquentUserProvider 是在SessionGuard實例化時被注入進來的， (具體是怎麼通過讀取auth配置文件, 實例化相應的provider注入到SessionGuard裡的請查閱\Illuminate\Auth\AuthManager 裡createSessionDriver方法的源查閱\Illuminate\Auth\AuthManager 裡createSessionDriver方法的源查閱\Illuminate\Auth\AuthManager 裡createSessionDriver方法的源查閱\Illuminate\Auth\AuthManager 裡createSessionDriver方法的源查閱程式碼)
接下來我們繼續查看EloquentUserProvider中retrieveByCredentials和validateCredentials方法的實作：
/**
* Retrieve a user by the given credentials.
*
* @param array $credentials
* @return \Illuminate\Contracts\Auth\Authenticatable|null
*/
public function retrieveByCredentials(array $credentials)
{
if (empty($credentials)) {
return;
}
$query = $this->createModel()->newQuery();
foreach ($credentials as $key => $value) {
if (! Str::contains($key, 'password')) {
$query->where($key, $value);
}
}
return $query->first();
}
/**
* Validate a user against the given credentials.
*
* @param \Illuminate\Contracts\Auth\Authenticatable $user
* @param array $credentials
* @return bool
*/
public function validateCredentials(UserContract $user, array $credentials)
{
$plain = $credentials['password'];
return $this->hasher->check($plain, $user->getAuthPassword());
}
上面兩個方法retrieveByCredentials用除了密碼以外的欄位從資料庫使用者表裡取出使用者記錄，例如用email查詢出使用者記錄，然後validateCredentials方法就是透過$this->haser->check來將輸入的密碼和雜湊的密碼進行比較來驗證密碼是否正確。
好了， 看到这里就很明显了， 我们需要改成自己的密码验证就是自己实现一下validateCredentials就可以了， 修改$this->hasher->check为我们自己的密码验证规则就可以了。
首先我们修改$user->getAuthPassword()把数据库中用户表的salt和password传递到validateCredentials中
修改App\User.php 添加如下代码
/** * The table associated to this model */ protected $table = 'user';／／用户表名不是laravel约定的这里要指定一下
/**
* 禁用Laravel自动管理timestamp列
*/
public $timestamps = false;
/**
* 覆盖Laravel中默认的getAuthPassword方法, 返回用户的password和salt字段
* @return type
*/
public function getAuthPassword()
{
return ['password' => $this->attributes['password'], 'salt' => $this->attributes['salt']];
}
然后我们在建立一个自己的UserProvider接口的实现，放到自定义的目录中：
新建app/Foundation/Auth/AdminEloquentUserProvider.php
namespace App\Foundation\Auth;
use Illuminate\Auth\EloquentUserProvider;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Support\Str;
class AdminEloquentUserProvider extends EloquentUserProvider
{
/**
* Validate a user against the given credentials.
*
* @param \Illuminate\Contracts\Auth\Authenticatable $user
* @param array $credentials
*/
public function validateCredentials(Authenticatable $user, array $credentials) {
$plain = $credentials['password'];
$authPassword = $user->getAuthPassword();
return sha1($authPassword['salt'] . $plain) == $authPassword['password'];
}
}
最后我们修改auth配置文件让Laravel在做Auth验证时使用我们刚定义的Provider，
修改config/auth.php：
'providers' => [ 'users' => [ 'driver' => 'admin-eloquent', 'model' => App\User::class, ] ]
修改app/Provider/AuthServiceProvider.php
public function boot(GateContract $gate)
{
$this->registerPolicies($gate);
\Auth::provider('admin-eloquent', function ($app, $config) {
return New \App\Foundation\Auth\AdminEloquentUserProvider($app['hash'], $config['model']);
});
}
Auth::provider方法是用来注册Provider构造器的，这个构造器是一个Closure，provider方法的具体代码实现在AuthManager文件里
public function provider($name, Closure $callback)
{
$this->customProviderCreators[$name] = $callback;
return $this;
}
闭包返回了AdminEloquentUserProvider对象供Laravel Auth使用，好了做完这些修改后Laravel的Auth在做用户登录验证的时候采用的就是自定义的salt + password的方式了。
修改重置密码
Laravel 的重置密码的工作流程是：
向需要重置密码的用户的邮箱发送一封带有重置密码链接的邮件，链接中会包含用户的email地址和token。
用户点击邮件中的链接在重置密码页面输入新的密码，Laravel通过验证email和token确认用户就是发起重置密码请求的用户后将新密码更新到用户在数据表的记录里。
第一步需要配置Laravel的email功能，此外还需要在数据库中创建一个新表password_resets来存储用户的email和对应的token
CREATE TABLE `password_resets` ( `email` varchar(255) COLLATE utf8_unicode_ci NOT NULL, `token` varchar(255) COLLATE utf8_unicode_ci NOT NULL, `created_at` timestamp NOT NULL, KEY `password_resets_email_index` (`email`), KEY `password_resets_token_index` (`token`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
通过重置密码表单的提交地址可以看到，表单把新的密码用post提交给了/password/reset，我们先来看一下auth相关的路由，确定/password/reset对应的控制器方法。
$this->post('password/reset', 'Auth\PasswordController@reset');
可以看到对应的控制器方法是\App\Http\Controllers\Auth\PasswordController类的reset方法，这个方法实际是定义在\Illuminate\Foundation\Auth\ResetsPasswords 这个traits里，PasswordController引入了这个traits
/**
* Reset the given user's password.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\Response
*/
public function reset(Request $request)
{
$this->validate(
$request,
$this->getResetValidationRules(),
$this->getResetValidationMessages(),
$this->getResetValidationCustomAttributes()
);
$credentials = $this->getResetCredentials($request);
$broker = $this->getBroker();
$response = Password::broker($broker)->reset($credentials, function ($user, $password) {
$this->resetPassword($user, $password);
});
switch ($response) {
case Password::PASSWORD_RESET:
return $this->getResetSuccessResponse($response);
default:
return $this->getResetFailureResponse($request, $response);
}
}
方法开头先通过validator对输入进行验证,接下来在程序里传递把新密码和一个闭包对象传递给Password::broker($broker)->reset();方法，这个方法定义在\Illuminate\Auth\Passwords\PasswordBroker类里.
/**
* Reset the password for the given token.
*
* @param array $credentials
* @param \Closure $callback
* @return mixed
*/
public function reset(array $credentials, Closure $callback)
{
// If the responses from the validate method is not a user instance, we will
// assume that it is a redirect and simply return it from this method and
// the user is properly redirected having an error message on the post.
$user = $this->validateReset($credentials);
if (! $user instanceof CanResetPasswordContract) {
return $user;
}
$pass = $credentials['password'];
// Once we have called this callback, we will remove this token row from the
// table and return the response from this callback so the user gets sent
// to the destination given by the developers from the callback return.
call_user_func($callback, $user, $pass);
$this->tokens->delete($credentials['token']);
return static::PASSWORD_RESET;
}
在PasswordBroker的reset方法里，程序会先对用户提交的数据做再一次的认证，然后把密码和用户实例传递给传递进来的闭包，在闭包调用里完成了将新密码更新到用户表的操作， 在闭包里程序调用了的PasswrodController类的resetPassword方法
function ($user, $password) {
$this->resetPassword($user, $password);
});
PasswrodController类resetPassword方法的定义
protected function resetPassword($user, $password)
{
$user->forceFill([
'password' => bcrypt($password),
'remember_token' => Str::random(60),
])->save();
Auth::guard($this->getGuard())->login($user);
}
在这个方法里Laravel 用的是bcrypt 加密了密码， 那么要改成我们需要的salt + password的方式，我们在PasswordController类里重写resetPassword方法覆盖掉traits里的该方法就可以了。
/**
* 覆盖ResetsPasswords traits里的resetPassword方法,改为用sha1(salt + password)的加密方式
* Reset the given user's password.
*
* @param \Illuminate\Contracts\Auth\CanResetPassword $user
* @param string $password
* @return void
*/
protected function resetPassword($user, $password)
{
$salt = Str::random(6);
$user->forceFill([
'password' => sha1($salt . $password),
'salt' => $salt,
'remember_token' => Str::random(60),
])->save();
\Auth::guard($this->getGuard())->login($user);
}
结语
到这里对Laravel Auth的自定义就完成了，注册、登录和重置密码都改成了sha1(salt + password)的密码加密方式， 所有自定义代码都是通过定义Laravel相关类的子类和重写方法来完成没有修改Laravel的源码，这样既保持了良好的可扩展性也保证了项目能够自由迁移。
注：使用的Laravel版本为5.2
相关推荐：
Laravel5.5中利用Passport实现Auth认证的方法
以上是Auth使用salt和password進行使用者認證實例的詳細內容。更多資訊請關注PHP中文網其他相關文章！