[ Laravel 5.1 文档 ] 服务 —— 用户认证

1、简介

Laravel中实现用户认证非常简单。实际上,几乎所有东西都已经为你配置好了。配置文件位于config/auth.php,其中包含了用于调整认证服务行为的、文档友好的选项配置。

1.1 数据库考量

默认情况下,Laravel在app目录下包含了一个Eloquent模型App\User,这个模型可以和默认的Eloquent认证驱动一起使用。如果你的应用不使用Eloquent,你可以使用database认证驱动,该驱动使用了Laravel查询构建器。

App\User模型构建数据库表结构的时候,确保password字段长度至少有60位。

还有,你应该验证users表包含了可以为空的、字符串类型的remember_token字段长度为100,该字段用于存储被应用维护的”记住我(remember me)“的session令牌,这可以通过在迁移中使用$table->rememberToken();来实现。

2、用户认证快速入门

Laravel处理两个认证控制器,位于App\Http\Controllers\Auth命名空间下,AuthController处理新用户注册和认证,PasswordController包含帮助用户找回密码的逻辑。每个控制器都使用trait来引入它们需要的方法。对很多应用而言,你根本不需要修改这两个控制器。

2.1 路由

默认情况下,没有路由将请求指向用户认证控制器,你要手动在app/Http/routes.php文件中添加它们:

// 认证路由...
Route::get('auth/login', 'Auth\AuthController@getLogin');
Route::post('auth/login', 'Auth\AuthController@postLogin');
Route::get('auth/logout', 'Auth\AuthController@getLogout');
// 注册路由...
Route::get('auth/register', 'Auth\AuthController@getRegister');
Route::post('auth/register', 'Auth\AuthController@postRegister');

2.2 视图

尽管框架包含了用户认证控制器,你还是需要提供这些控制器可以渲染的视图。这些视图位于resources/views/auth目录,你可以按需自定义这些视图文件。登录视图是resources/views/auth/login.blade.php,注册视图是resources/views/auth/register.blade.php

2.2.1 登录表单示例
<!-- resources/views/auth/login.blade.php -->

<form method="POST" action="/auth/login">
    {!! csrf_field() !!}

    <div>
        Email
        <input type="email" name="email" value="{{ old('email') }}">
    </div>

    <div>
        Password
        <input type="password" name="password" id="password">
    </div>

    <div>
        <input type="checkbox" name="remember"> Remember Me
    </div>

    <div>
        <button type="submit">Login</button>
    </div>
</form>
2.2.2 注册表单示例
<!-- resources/views/auth/register.blade.php -->

<form method="POST" action="/auth/register">
    {!! csrf_field() !!}

    <div>
        Name
        <input type="text" name="name" value="{{ old('name') }}">
    </div>

    <div>
        Email
        <input type="email" name="email" value="{{ old('email') }}">
    </div>

    <div>
        Password
        <input type="password" name="password">
    </div>

    <div>
        Confirm Password
        <input type="password" name="password_confirmation">
    </div>

    <div>
        <button type="submit">Register</button>
    </div>
</form>

2.3 认证

既然你已经为自带的认证控制器设置好了路由和视图,接下来就准备为应用注册新用户并进行登录认证。你可以在浏览器中访问定义好的路由,认证控制器已经实现了认证已存在用户以及存储新用户到数据库中的业务逻辑(通过trait)。

当一个用户成功进行登录认证后,将会跳转到/home链接,你需要事先注册一个路由来处理该跳转。你可以通过在AuthController中设置redirectPath属性来自定义post认证之后的跳转路径:

protected $redirectPath = '/dashboard';

当一个用户登录认证失败后,将会跳转到/auth/login链接。你可以通过定义AuthControllerloginPath属性来自定义post认证失败后的跳转路径:

protected $loginPath = '/login';
2.3.1 自定义

要修改新用户注册所必需的表单字段,或者自定义新用户字段如何存储到数据库,你可以修改AuthController类。该类负责为应用验证和创建新用户。

AuthControllervalidator方法包含了新用户的验证规则,你可以随意按需要自定义该方法。

AuthControllercreate方法负责使用Eloquent ORM在数据库中创建新的App\User记录。你可以基于自己的需要随意自定义该方法。

2.4 获取认证用户

你可以通过Auth门面访问认证用户:

$user = Auth::user();

一旦用户通过认证后,你还可以通过Illuminate\Http\Request实例访问认证用户:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Routing\Controller;

class ProfileController extends Controller{
    /**
     * 更新用户属性.
     *
     * @param  Request  $request
     * @return Response
     */
    public function updateProfile(Request $request)
    {
        if ($request->user()) {
            // $request->user() 返回认证用户实例...
        }
    }
}
2.4.1 判断当前用户是否通过认证

要判断某个用户是否登录到应用,可以使用Auth门面check方法,如果用户通过认证则返回true

if (Auth::check()) {
    // The user is logged in...
}

此外,你还可以在用户访问特定路由/控制器之前使用中间件来验证用户是否通过认证,想要了解更多,可以查看路由保护文档

2.5 路由保护

路由中间件可用于只允许通过认证的用户访问给定路由。Laravel通过定义在app\Http\Middleware\Authenticate.phpauth中间件来处理这一操作。你所要做的仅仅是将该中间件加到相应的路由定义中:

// 使用路由闭包...
Route::get('profile', ['middleware' => 'auth', function() {
    // 只有认证用户可以进入...
}]);
// 使用控制器...
Route::get('profile', [
    'middleware' => 'auth',
    'uses' => 'ProfileController@show'
]);

当然,如果你正在使用控制器类,也可以在控制器的构造方法中调用middleware方法而不是在路由器中直接定义:

public function __construct(){
    $this->middleware('auth');
}

2.6 登录失败次数限制

如果你正在使用Laravel内置的AuthController类,Illuminate\Foundation\Auth\ThrottlesLogins trait 可以用于限制用户登录失败次数。默认情况下,用户在几次登录失败后将在一分钟内不能登录,这种限制基于用户的用户名/邮箱地址+IP地址:

<?php

namespace App\Http\Controllers\Auth;

use App\User;use Validator;
use App\Http\Controllers\Controller;
use Illuminate\Foundation\Auth\ThrottlesLogins;
use Illuminate\Foundation\Auth\AuthenticatesAndRegistersUsers;

class AuthController extends Controller{
    use AuthenticatesAndRegistersUsers, ThrottlesLogins;

    // AuthController类的其它部分...
}

3、手动认证用户

当然,你也可以不使用Laravel自带的认证控制器。如果你选择移除这些控制器,你需要直接使用Laravel认证类来管理用户认证。别担心,这很简单!

我们将会通过Auth门面来访问认证服务,因此我们需要确保在类的顶部导入了Auth门面,让我们看看attempt方法:

<?php

namespace App\Http\Controllers;

use Auth;
use Illuminate\Routing\Controller;

class AuthController extends Controller{
    /**
     * 处理登录认证
     *
     * @return Response
     */
    public function authenticate()
    {
        if (Auth::attempt(['email' => $email, 'password' => $password])) {
            // 认证通过...
            return redirect()->intended('dashboard');
        }
    }
}

attempt方法接收键值数组对作为第一个参数,数组中的值被用于从数据表中查找用户,因此,在上面的例子中,用户将会通过email的值获取,如果用户被找到,经哈希运算后存储在数据中的密码将会和传递过来的经哈希运算处理的密码值进行比较。如果两个经哈希运算的密码相匹配那么一个认证session将会为这个用户开启。

如果认证成功的话attempt方法将会返回true。否则,返回false

重定向器上的intended方法将会将用户重定向到登录之前用户想要访问的URL,在目标URL无效的情况下备用URI将会传递给该方法。

如果你想的话,除了用户邮件和密码之外还可以在认证查询时添加额外的条件,例如,我们可以验证被标记为有效的用户:

if (Auth::attempt(['email' => $email, 'password' => $password, 'active' => 1])) {
    // The user is active, not suspended, and exists.
}

要退出应用,可以使用Auth门面的logout方法,这将会清除用户session中的认证信息:

Auth::logout();

注意:在这些例子中,email并不是必须选项,在这里只不过是作为一个例子。你可以在自己的数据库使用任何其他与“用户名”相对应的字段。

3.1 记住用户

如果你想要在应用中提供“记住我”的功能,可以传递一个布尔值作为第二个参数到attempt方法,这样用户登录认证状态就会一直保持直到他们手动退出。当然,你的users表必须包含remember_token字段,该字段用于存储“记住我”令牌。

if (Auth::attempt(['email' => $email, 'password' => $password], $remember)) {
    // The user is being remembered...
}

如果你要“记住”用户,可以使用viaRemember方法来判断用户是否使用“记住我”cookie进行认证:

if (Auth::viaRemember()) {
    //
}

3.2 其它认证方法

3.2.1 认证用户实例

如果你需要将一个已存在的用户实例登录到应用中,可以调用用户实例上的login方法,给定实例必须是Illuminate\Contracts\Auth\Authenticatable契约的实现,当然,Laravel自带的App\User模型已经实现了该接口:

Auth::login($user);
3.2.2 通过ID认证用户

要通过用户ID登录到应用,可以使用loginUsingId方法,该方法接收你想要认证用户的主键作为参数:

Auth::loginUsingId(1);
3.2.3 一次性认证用户

你可以使用once方法只在单个请求中将用户登录到应用,而不存储任何session和cookie,这在构建无状态的API时很有用。once方法和attempt方法用法差不多:

if (Auth::once($credentials)) {
    //
}

4、基于HTTP的基本认证

HTTP基本认证能够帮助用户快速实现登录认证而不用设置专门的登录页面,首先要在路由中加上auth.basic中间件。该中间件是Laravel自带的,所以不需要自己定义:

Route::get('profile', ['middleware' => 'auth.basic', function() {
    // 只有认证用户可以进入...
}]);

中间件加到路由中后,当在浏览器中访问该路由时,会自动提示需要认证信息,默认情况下,auth.basic中间件使用用户记录上的email字段作为“用户名”。

FastCGI上注意点

如果你使用PHP FastCGI,HTTP基本认证将不能正常工作,需要在.htaccess文件加入如下内容:

RewriteCond %{HTTP:Authorization} ^(.+)$
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

4.1 无状态的HTTP基本认证

使用HTTP基本认证也不需要在session中设置用户标识cookie,这在API认证中非常有用。要实现这个,需要定义一个调用onceBasic方法的中间件。如果该方法没有返回任何响应,那么请求会继续走下去:

<?php

namespace Illuminate\Auth\Middleware;

use Auth;
use Closure;

class AuthenticateOnceWithBasicAuth{
    /**
     * 处理输入请求.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        return Auth::onceBasic() ?: $next($request);
    }

}

接下来,注册路由中间件并将其添加到路由中:

Route::get('api/user', ['middleware' => 'auth.basic.once', function() {
    // 只有认证用户可以进入...
}]);

5、重置密码

5.1 数据库考量

大多数web应用提供了用户重置密码的功能,Laravel提供了便利方法用于发送密码提示及执行密码重置而不需要你在每个应用中重新实现。

开始之前,先验证App\User模型实现了Illuminate\Contracts\Auth\CanResetPassword契约。当然,Laravel自带的App\User模型已经实现了该接口,并使用Illuminate\Auth\Passwords\CanResetPassword trait来包含实现该接口需要的方法。

5.1.1 生成重置令牌表迁移

接下来,用来存储密码重置令牌的表必须被创建,Laravel已经自带了这张表的迁移,就存放在database/migrations目录。所有,你所要做的仅仅是运行迁移:

php artisan migrate

5.2 路由

Laravel自带了Auth\PasswordController,其中包含重置用户必须的逻辑。然而,你需要定义一个路由将请求转发到该控制器:

// 密码重置链接请求路由...
Route::get('password/email', 'Auth\PasswordController@getEmail');
Route::post('password/email', 'Auth\PasswordController@postEmail');
// 密码重置路由...
Route::get('password/reset/{token}', 'Auth\PasswordController@getReset');
Route::post('password/reset', 'Auth\PasswordController@postReset');

5.3 视图

除了为Auth\PasswordController定义路由之外,还需要提供相应视图,别担心,我们将会提供示例视图来帮助你开始,当然,你也可以自定义表单样式。

5.3.1 密码重置链接请求表单示例

你需要为密码重置请求表单 提供HTML视图,该视图文件应该放在resources/views/auth/password.blade.php,表单提供了一个输入用户邮箱地址的字段,从而允许用户从邮件中访问密码重置链接:

<!-- resources/views/auth/password.blade.php -->

<form method="POST" action="/password/email">
    {!! csrf_field() !!}

    <div>
        Email
        <input type="email" name="email" value="{{ old('email') }}">
    </div>

    <div>
        <button type="submit">
            Send Password Reset Link
        </button>
    </div>
</form>

当一个用户提交了重置密码请求后,将会收到一封电子邮件,其中包含了一个链接,该链接指向PasswordControllergetReset方法,你需要为该电子邮件创建一个视图resources/views/emails/password.blade.php。该视图将会获取包含密码重置令牌的$token变量,用于和用户重置密码请求进行匹配。下面是一个电子邮件视图的例子:

<!-- resources/views/emails/password.blade.php -->
Click here to reset your password: {{ url('password/reset/'.$token) }}
5.3.2 密码重置表单示例

当用户点击电子邮件中的链接来重置密码时,需要提交一个密码重置表单,该视图位于resources/views/auth/reset.blade.php

下面是一个密码重置表单示例:

<!-- resources/views/auth/reset.blade.php -->

<form method="POST" action="/password/reset">
    {!! csrf_field() !!}
    <input type="hidden" name="token" value="{{ $token }}">

    <div>
        <input type="email" name="email" value="{{ old('email') }}">
    </div>

    <div>
        <input type="password" name="password">
    </div>

    <div>
        <input type="password" name="password_confirmation">
    </div>

    <div>
        <button type="submit">
            Reset Password
        </button>
    </div>
</form>

5.4 重置密码后

如果你已经定义好路由和视图来重置用户密码,只需要在浏览器中访问这些路由即可。框架自带的PasswordController已经包含了发送密码重置链接邮件以及更新数据库中密码的逻辑。

密码被重置后,用户将会自动登录到应用并重定向到/home。你可以通过定义上PasswordControllerredirectTo属性来自定义post密码重置跳转链接:

protected $redirectTo = '/dashboard';

注意:默认情况下,密码重置令牌一小时内有效,你可以通过修改config/auth.php文件中的选项reminder.expire来改变有效时间。

6、社会化登录认证

Laravel中还可以使用Laravel Socialite通过OAuth提供者进行简单、方便的认证,也就是社会化登录,目前支持使用Facebook、Twitter、LinkedIn、GitHub和Bitbucket进行登录认证。

要使用社会化登录,需要在composer.json文件中添加依赖:

composer require laravel/socialite

6.1 配置

安装完社会化登录库后,在配置文件config/app.php中注册Laravel\Socialite\SocialiteServiceProvider

'providers' => [
    // 其它服务提供者...
    Laravel\Socialite\SocialiteServiceProvider::class,
],

还要在app配置文件中添加Socialite门面到aliases数组:

'Socialite' => Laravel\Socialite\Facades\Socialite::class,

你还需要为应用使用的OAuth服务添加认证信息,这些认证信息位于配置文件config/services.php,而且键为facebooktwitter,linkedingooglegithubbitbucket,这取决于应用需要的提供者。例如:

'github' => [
    'client_id' => 'your-github-app-id',
    'client_secret' => 'your-github-app-secret',
    'redirect' => 'http://your-callback-url',
],

6.2 基本使用

接下来,准备好认证用户!你需要两个路由:一个用于重定向用户到OAuth提供者,另一个用户获取认证后来自提供者的回调。我们使用Socialite门面访问Socialite :

<?php

namespace App\Http\Controllers;

use Socialite;
use Illuminate\Routing\Controller;

class AuthController extends Controller{
    /**
     * 将用户重定向到GitHub认证页面.
     *
     * @return Response
     */
    public function redirectToProvider()
    {
        return Socialite::driver('github')->redirect();
    }

    /**
     * 从GitHub获取用户信息.
     *
     * @return Response
     */
    public function handleProviderCallback()
    {
        $user = Socialite::driver('github')->user();

        // $user->token;
    }
}

redirect方法将用户发送到OAuth提供者,user方法读取请求信息并从提供者中获取用户信息,在重定向用户之前,你还可以在请求上使用scope方法设置”作用域”,该方法将会重写已存在的所有作用域:

return Socialite::driver('github')
            ->scopes(['scope1', 'scope2'])->redirect();

当然,你需要定义路由到控制器方法:

 Route::get('auth/github', 'Auth\AuthController@redirectToProvider');
 Route::get('auth/github/callback', 'Auth\AuthController@handleProviderCallback');
6.2.1 获取用户信息

有了用户实例之后,可以获取用户的更多详情:

$user = Socialite::driver('github')->user();
// OAuth Two Providers
$token = $user->token;
// OAuth One Providers
$token = $user->token;
$tokenSecret = $user->tokenSecret;
// All Providers
$user->getId();
$user->getNickname();
$user->getName();
$user->getEmail();
$user->getAvatar();

7、添加自定义认证驱动

如果你没有使用传统的关系型数据库存储用户信息,你需要使用自己的认证驱动扩展Laravel。我们使用Auth门面上的extend方法来定义自定义的驱动,你需要在服务提供者调用extend方法:

<?php

namespace App\Providers;

use Auth;
use App\Extensions\RiakUserProvider;
use Illuminate\Support\ServiceProvider;

class AuthServiceProvider extends ServiceProvider{
    /**
     * Perform post-registration booting of services.
     *
     * @return void
     */
    public function boot()
    {
        Auth::extend('riak', function($app) {
            // 返回Illuminate\Contracts\Auth\UserProvider实例...
            return new RiakUserProvider($app['riak.connection']);
        });
    }

    /**
     * 在容器中注册绑定.
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

通过extend方法注册驱动后,你可以在配置文件config/auth.php中切换到新的驱动。

7.1 UserProvider契约

Illuminate\Contracts\Auth\UserProvider实现只负责从持久化存储系统中获取Illuminate\Contracts\Auth\Authenticatable实现,例如MySQL、Riak等等。这两个接口允许Laravel认证机制继续起作用而不管用户数据如何存储或者何种类来展现。

让我们先看看Illuminate\Contracts\Auth\UserProvider契约

<?php

namespace Illuminate\Contracts\Auth;

interface UserProvider {

    public function retrieveById($identifier);
    public function retrieveByToken($identifier, $token);
    public function updateRememberToken(Authenticatable $user, $token);
    public function retrieveByCredentials(array $credentials);
    public function validateCredentials(Authenticatable $user, array $credentials);

}

retrieveById方法通常获取一个代表用户的键,例如MySQL数据中的自增ID。该方法获取并返回匹配该ID的Authenticatabl实现。

retrieveByToken函数通过唯一标识和存储在remember_token字段中的“记住我”令牌获取用户。和上一个方法一样,该方法也返回Authenticatabl实现。

updateRememberToken方法使用新的$token更新$userremember_token字段,新令牌可以是新生成的令牌(在登录是选择“记住我”被成功赋值)或者null(用户退出)。

retrieveByCredentials方法在尝试登录系统时获取传递给Auth::attempt方法的认证信息数组。该方法接下来去底层持久化存储系统查询与认证信息匹配的用户,通常,该方法运行一个带“where”条件($credentials[‘username’])的查询。然后该方法返回UserInterface的实现。这个方法不做任何密码校验和认证。

validateCredentials方法比较给定$user$credentials来认证用户。例如,这个方法比较$user->getAuthPassword()字符串和经Hash::make处理的$credentials['password']。这个方法只验证用户认证信息并返回布尔值。

7.2 Authenticatable契约

既然我们已经探索了UserProvider上的每一个方法,接下来让我们看看Authenticatable。该提供者应该从retrieveByIdretrieveByCredentials方法中返回接口实现:

<?php

namespace Illuminate\Contracts\Auth;

interface Authenticatable {

    public function getAuthIdentifier();
    public function getAuthPassword();
    public function getRememberToken();
    public function setRememberToken($value);
    public function getRememberTokenName();

}

这个接口很简单,getAuthIdentifier方法返回用户“主键”,在MySQL后台中是ID,getAuthPassword返回经哈希处理的用户密码,这个接口允许认证系统处理任何用户类,不管是你使用的是ORM还是存储抽象层。默认情况下,Laravel自带的app目录下的User类实现了这个接口,所以你可以将这个类作为实现例子。

扩展阅读1:实例教程 —— 使用Laravel内置组件快速实现注册登录
扩展阅读2:实例教程 —— 使用Laravel内置组件快速实现密码重置
扩展阅读3:实例教程 —— 使用Socialite实现GitHub登录认证

学院君

学院君 has written 548 articles

资深PHP工程师,Laravel学院院长