用户认证

未匹配的标注

用户认证

简介

许多 web 应用程序为其用户提供了一种通过应用程序进行身份验证和登录的方法。在 web 应用程序中实现此功能可能是一项复杂且具有潜在风险的工作。因此,Laravel 努力为你提供了一套快速、安全、轻松地实现身份验证的工具。

在其核心,Laravel 的用户认证是由 「看守器」 和 「提供器」 。看守器定义如何对每个请求的用户进行身份验证。例如,Laravel 附带了一个 session 守护程序,它使用 session 存储和 cookie 来维护状态。

提供器定义如何从持久存储中检索用户。Laravel 支持使用 Eloquent 和数据库查询生成器检索用户。不仅如此,你甚至可以根据应用程序的需要自由定制其他提供程序。

应用程序的身份验证配置文件位于 config/auth.php。这个文件包含几个记载了的选项,用于调整Laravel 的身份验证服务的行为。

技巧:守卫和提供器不应与 「角色」 和 「权限」 混淆。要了解有关通过权限授权用户操作的更多信息,请参阅 用户授权 文档。

入门套件

想快点开始吗?在新的 Laravel 应用程序中安装 Laravel 入门套件 。执行迁移数据库后,将浏览器导航到 /register 或分配给应用程序的任何其他 URL。初学者工具包将守护好你的整个认证系统!

即使你在最终的 Laravel 应用程序中选择不使用初学者工具包,安装 Laravel Breeze 初学者工具包也是学习如何在实际的 Laravel 项目中实现所有 Laravel 身份验证功能的绝佳机会 由于 Laravel Breeze 为你创建身份验证控制器、路由和视图,因此你可以查看这些文件中的源码,进而了解如何实现 Laravel 的身份验证功能。

数据库注意事项

默认情况下,Laravel 在 App/Models 目录中包含一个 App\Models\User Eloquent model 。此模型可与默认的 Eloquent 身份验证驱动程序一起使用。如果你的应用程序未使用 Eloquent,则可以使用 Laravel 查询生成器的 database 身份验证提供程序。

App\Models\User 模型构建数据库架构时,请确保密码列的长度至少为 60 个字符。当然,新的 Laravel 应用程序中包含的 users 表迁移文件已经创建了一个超过此长度的列。

此外,还应验证 users(或等效表)是否包含一个可为空的字符串 remember_token ,该列包含 100 个字符。此列将用于为在登录到应用程序时选择 「记住我」 选项的用户存储令牌。同样,新的 Laravel 应用程序中包含的默认 users 表迁移文件已经包含此列。

生态系统概述

Laravel 提供了几个与身份验证相关的包。在继续之前,我们将回顾 Laravel 中的通用身份验证生态系统,并讨论每个包的预期用途。

首先,考虑身份验证是如何工作的。使用 web 浏览器时,用户将通过登录表单提供用户名和密码。如果这些凭据正确,应用程序将在用户的 session 中存储有关已验证用户的信息。发布到浏览器的 cookie 包含 session ID,以便应用程序的后续请求可以将用户与正确的 session 相关联。在接收到 session 的 cookie 之后,应用程序将基于 session ID 检索 session 数据,注意认证信息已经存储在会话中,并且将用户视为 「已认证」。

当远程服务需要通过身份验证才能访问 API 时,我们通常不用 Cookie 进行身份认证,因为没有 web 浏览器。相反,远程服务会在每个请求时向 API 发送一个 token。应用程序可以对照有效 API 令牌表来验证传入 token ,并且 「认证」 与该 API 令牌相关联的用户正在执行的请求。

Laravel 内置的浏览器认证服务

Laravel 包括内置的身份验证和 session 服务,这些服务通常通过 AuthSession facade 使用。这些特性为从 web 浏览器发起的请求提供基于 cookie 的身份验证。它们提供的方法允许你验证用户的凭据并对用户进行身份验证。此外,这些服务将自动在用户会话中存储正确的身份验证数据,并发出用户会话 cookie。本文档包含这些服务的使用方式的讨论。

应用入门工具包

如本文档中所述,你可以手动与这些身份验证服务进行交互,以构建应用程序自己的身份验证层。不过,为了帮助你更快地入门,我们发布了 免费软件包 ,为整个验证层提供了健壮的、现代化的脚手架. 这些包是 Laravel Breeze, Laravel JetstreamLaravel Fortify

Laravel Breeze 是 Laravel 所有身份验证功能的简单、最小实现,包括登录、注册、密码重置、电子邮件验证和密码确认。laravel breeze 的视图层由简单的 Blade 模板 组成,样式为 Tailwind CSS。 要开始使用,请查看 Laravel 的 [应用入门工具包](/docs/Laravel/8.5/starter kits) 文档。

Laravel Fortify 是 Laravel 的无 header 身份验证后端,它实现了本文档中的许多功能,包括基于 cookie 的身份验证以及其他功能,如双因素身份验证和电子邮件验证。Fortify 为 Laravel Jetstream 提供身份验证后端,或者可以单独与 Laravel Sanctum 结合使用,为需要使用 Laravel 进行身份验证的 SPA 提供身份验证。

Laravel Jetstream 是一个健壮的应用程序启动工具包,它使用并公开了 Laravel Fortify 的身份验证服务,用到了一个漂亮的现代化的 UI 库 Tailwind CSSLivewire,和 Inertia.js。 Laravel Jetstream 包括对双因子身份验证的可选支持、团队支持、浏览器会话管理、配置文件管理,以及与 Laravel Sanctum 的内置集成,以提供 API 令牌身份验证。接下来我们将讨论 Laravel 的 API 认证产品。

Laravel 的 API 认证服务

Laravel 提供了两个可选的包来帮助你管理 API 令牌和验证使用 API 令牌发出的请求: PassportSanctum 。请注意,这些库和 Laravel 内置的基于 Cookie 的身份验证库并不是互斥的。这些库主要关注 API 令牌身份验证,而内置的身份验证服务则关注基于 Cookie 的浏览器身份验证。许多应用程序将同时使用 Laravel 内置的基于 Cookie 的身份验证服务和一个 Laravel 的 API 身份验证包。

Passport

Passport 是一个 OAuth2 身份验证提供程序,提供各种 OAuth2 「授权类型」,允许你发布各种类型的令牌。一般来说,这是一个健壮而复杂的 API 认证包。但是,大多数应用程序不需要 OAuth2 规范提供的复杂特性,因为这可能会让用户和开发人员感到麻烦。此外,对于如何使用 OAuth2 身份验证提供程序(如 Passport)对 SPA 应用程序或移动应用程序进行身份验证,开发人员长期以来一直感到十分棘手。

Sanctum

为了应对 OAuth2 的复杂性和开发人员的困惑,我们着手构建一个更简单、更精简的身份验证包,它可以处理来自 web 浏览器的第一方 web 请求和通过令牌的 API 请求。 Laravel Sanctum 发布后,这一目标就实现了。对于除 API 外还提供第一方 web UI 的应用程序,或由单页应用程序(SPA)提供支持的应用程序,或是提供移动客户端的应用程序,Sanctum 是首选推荐的身份验证包。

Laravel Sanctum 是一个混合了 web 和 API 的身份验证包,他让我们管理应用程序的整个身份验证过程成为可能,因为当基于 Sanctum 的应用程序收到请求时,Sanctum 将首先确定请求是否包含引用已验证会话的会话 cookie。Sanctum 通过调用我们前面讨论过的 Laravel 的内置身份验证服务来实现这一点。如果请求没有通过 session cookie 进行身份验证,Sanctum 将检查请求中的 API 令牌。如果存在 API 令牌,Sanctum 将使用该令牌对请求进行身份验证。要了解有关此过程的更多信息,请参阅 Sanctum 的 它是如何工作的 文档。

Laravel Sanctum 是我们选择在 Laravel JetStream 中包含的 API 包应用程序初学者工具包,因为我们认为它最适合大多数 web 应用程序的身份验证需求。

汇总 / 选择你的解决方案

总之,如果你的应用程序将使用浏览器访问,并且你正在构建一个单页面的 Laravel 应用程序,那么你的应用程序可以使用 Laravel 的内置身份验证服务。

接下来,如果你的应用程序提供了一个将由第三方使用的 API ,你可以在 PassportSanctum 之间进行选择,为你的应用程序提供 API 令牌身份验证。一般来说,如果可能的话,应该首选 Sanctum,因为它是 API 认证、SPA 认证和移动认证的简单、完整的解决方案,包括对 「作用于」 或 「abilities」 的支持。

如果您正在构建一个将由 Laravel 后端支持的单页面应用程序(SPA),那么应该使用 Laravel Sanctum 。使用 Sanctum 时,你需要 手动实现自己的后端验证路由 或使用 Laravel Fortify 作为无头验证后端服务,为注册、密码重置、电子邮件验证等功能提供路由和控制器。

当应用程序确定必须使用 OAuth2 规范提供的所有特性时,可以选择 Passport。

如果你想快速入门,我们很高兴向你推荐 Laravel Jetstream 作为一种快速启动新的 Laravel 应用程序的方法,它已经使用了我们首选的 Laravel 内置身份验证服务和 Laravel Sanctum 的身份验证堆栈。

身份认证快速入门

注意:这部分文档讨论了如何通过 [Laravel 应用入门工具包](/docs/Laravel/8.5/starter kits) 对用户进行身份验证,其中包括帮助你快速入门的 UI 脚手架。如果你想直接与 Laravel 的身份验证系统集成,请查看 手动验证用户 上的文档。

安装入门工具包

首先,你应该 Laravel 应用程序启动程序工具包 。我们目前的入门套件,Laravel Breeze 和 Laravel Jetstream,提供了设计精美的起点,可将身份验证纳入你的全新 Laravel 应用程序。

Laravel Breeze 是 Laravel 所有身份验证功能的最轻量、简单的实现,包括登录、注册、密码重置、电子邮件验证和密码确认。Laravel Breeze 的视图层由简单的 Blade模板Tailwind CSS 组成。

Laravel Jetstream 是一个更强大的应用程序启动工具包,包括对使用 Livewire 构建应用程序的支持或者 Inertia.js and Vue 。此外,Jetstream 还提供可选的双因素身份验证支持、团队、配置文件管理、浏览器会话管理、通过 Laravel Sanctum 的 API 支持、帐户删除等。

获取已认证的用户信息

在安装身份验证初学者工具包并允许用户注册应用程序并对其进行身份验证之后,你通常需要与当前通过身份验证的用户进行交互。在处理传入请求时,您可以通过 Auth facade 的 user 方法访问通过身份验证的用户:

use Illuminate\Support\Facades\Auth;

// 获取当前的认证用户信息 ...
$user = Auth::user();

// 获取当前的认证用户id ...
$id = Auth::id();

或者,一旦用户通过身份验证,你就可以通过 Illuminate\Http\Request 实例访问通过身份验证的用户。记住,使用类型提示的类将自动注入到控制器方法中。通过键入 Illuminate\Http\Request 对象,你可以通过请求的 user 方法从应用程序中的任何控制器方法方便地访问经过身份验证的用户:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class FlightController extends Controller
{
    /**
     * 更新现有航班的航班信息。
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request)
    {
        // $request->user()
    }
}

确定当前用户是否经过身份验证

要确定发出传入HTTP请求的用户是否经过身份验证,可以在 Auth facade 上使用 check 方法。如果用户通过身份验证,此方法将返回 true

use Illuminate\Support\Facades\Auth;

if (Auth::check()) {
    // 用户已登录...
}

技巧:即使可以确定是否使用 check 方法对用户进行了身份验证,但在允许用户访问某些路由/控制器之前,通常也会使用中间件验证用户是否经过了身份验证。要了解更多信息,请查看 路由保护 的文档

路由保护

路由中间件 只能用于允许经过身份验证的用户访问给定的路由。Laravel 附带了一个 auth 中间件,它引用了 Illuminate\Auth\Middleware\Authenticate类。由于此中间件已在应用程序的 HTTP 内核中注册,因此你只需将中间件连接到路由定义即可:

Route::get('/flights', function () {
    // 只有经过身份验证的用户才能访问此路由 ...
})->middleware('auth');

给未认证的用户设置重定向

auth 中间件检测到未经验证的用户时,它将将用户重定向到 logo 命名路由 。你可以通过更新应用程序的 app/Http/Middleware/Authenticate.php 文件的 redirectTo 函数来修改此行为:

/**
 * 获取用户应重定向到的路径。
 *
 * @param  \Illuminate\Http\Request  $request
 * @return string
 */
protected function redirectTo($request)
{
    return route('login');
}

指定看守器

auth 中间件附加到路由时,还可以指定应该使用哪个 guard 来验证用户。指定的看守器应与你的 auth.php 配置文件 guards 数组中的一个键相对应:

Route::get('/flights', function () {
    // 只有经过身份验证的用户才能访问此路由...
})->middleware('auth:admin');

登录限流

如果您使用的是 Laravel Breeze 或 Laravel Jetstream 入门套件 ,那么在尝试登录的时候将自动应用速率限制。默认情况下,如果用户在多次尝试后未能提供正确的凭据,一分钟内将无法登录。该限制对与用户的用户名/ email 及其 IP 地址是唯一的。

技巧:如果您想对应用程序中的其他路由进行速率限制,请查看 速率限制 文档。

手动验证用户

并非一定要使用 Laravel 应用入门套件 附带的身份验证框架。如果选择不使用此支架,则需要直接使用 Laravel 身份验证类来管理用户身份验证。别担心,这也很容易!

我们将通过 Auth facade 访问 Laravel 的身份验证服务,因此我们需要确保导入类顶部的 Auth facade。接下来,让我们检查一下 attempt 方法。attempt 方法通常用于处理来自应用程序 login 页面的身份验证尝试。如果身份验证成功,则应重新生成用户的 session 以防止 session 固定

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;

class LoginController extends Controller
{
    /**
     * 处理身份验证尝试。
     *
     * @param  \Illuminate\Http\Request $request
     * @return \Illuminate\Http\Response
     */
    public function authenticate(Request $request)
    {
        $credentials = $request->only('email', 'password');

        if (Auth::attempt($credentials)) {
            $request->session()->regenerate();

            return redirect()->intended('dashboard');
        }

        return back()->withErrors([
            'email' => 'The provided credentials do not match our records.',
        ]);
    }
}

attempt 方法接受键/值对数组作为其第一个参数。数组中的值将用于在数据库表中查找用户。因此,在上面的示例中,将通过 email 列的值检索用户。如果找到该用户,则数据库中存储的哈希密码将与通过数组传递给该方法的 password 值进行比较。你不应该加密传入请求的 password 值,因为框架将在将该值与数据库中的散列密码进行比较之前自动加密该值。如果两个哈希密码匹配,将为用户启动一个经过身份验证的会话。

记住,Laravel 的身份验证服务将根据身份验证看守器的 「provider」 配置从数据库检索用户。在 config/auth.php 配置文件中的默认设置,指定了 Eloquent 的用户提供程序,并指示它在检索用户时使用 App\Models\User 模型。你可以根据应用程序的需要在配置文件中更改这些值。

如果身份验证成功,attempt 方法将返回 true 。否则,将返回 false

Laravel 的重定向器提供的 intended 方法将用户重定向到他们试图访问的 URL,然后被认证中间件截获。如果预期的目的地不可用,可以为该方法提供回退 URI。

指定附加条件

如果你愿意,除了用户的电子邮件和密码之外,还可以向身份验证查询中添加额外的查询条件。为了实现这一点,我们可以简单地将查询条件添加到传递给 attempt 方法的数组中。例如,我们可以验证用户是否标记为 active

if (Auth::attempt(['email' => $email, 'password' => $password, 'active' => 1])) {
    // 认证成功 ...
}

注意:在这些例子中,email 不是必需的选项,它只是作为一个例子。你应该使用与数据库表中的 「用户名」 对应的任何列名。

访问特定的看守器实例

通过 Auth facade 的 guard 方法,可以指定在对用户进行身份验证时要使用哪个 guard 实例。这允许你使用完全不同的可验证模型或用户表来管理应用程序的不同部分的验证。

传递给 guard 方法的名称应存在 auth.php 配置文件中:

if (Auth::guard('admin')->attempt($credentials)) {
    // ...
}

记住用户

许多 web 应用程序在其登录窗体上提供 「记住我」 复选框。如果希望在应用程序中提供 「记住我」 功能,可以将布尔值作为第二个参数传递给 attempt 方法。

当此值为 true 时,Laravel 将无限期地对用户进行身份验证,或者直到用户手动注销。 users 表必须包含字符串 remember_token 列,该列将用于存储 「记住我」 标记。新的 Laravel 应用程序中包含的 users 表迁移文件已经包含此列:

use Illuminate\Support\Facades\Auth;

if (Auth::attempt(['email' => $email, 'password' => $password], $remember)) {
    // 正在为该用户执行记住我操作 ...
}

其他认证方法

认证一个用户实例

如果需要将现有用户实例设置为当前经过身份验证的用户,可以将该用户实例传递给 Auth facade 的 login 方法。给定的用户实例必须是 Illuminate\Contracts\Auth\Authenticatable contract 的实现。Laravel 中包含的 App\Models\User 模型已经实现了此接口。当你已经有一个有效的用户实例时(例如用户直接向你的应用程序注册之后),此身份验证方法非常有用:

use Illuminate\Support\Facades\Auth;

Auth::login($user);

您可以将布尔值作为第二个参数传递给 login 方法。此值指示是否需要验证会话的 「记住我」 功能。请记住,这意味着会话将被无限期地验证,或者直到用户手动注销应用程序:

Auth::login($user, $remember = true);

如果需要,可以在调用 login 方法之前指定身份验证看守器:

Auth::guard('admin')->login($user);

使用 ID 验证一个用户

要使用数据库记录的主键对用户进行身份验证,可以使用 loginUsingId 方法。此方法接受要验证的用户的主键:

Auth::loginUsingId(1);

可以将布尔值作为第二个参数传递给 loginUsingId 方法。此值指示验证会话是否需要 「记住我」 功能。请记住,这意味着 session 将被无限期地验证,或者直到用户手动注销应用程序:

Auth::loginUsingId(1, $remember = true);

只验证一次

可以使用 once 方法通过应用程序对单个请求对用户进行身份验证。调用此方法时不会使用 session 或 Cookie:

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

HTTP Basic 用户认证

HTTP Basic 用户认证 提供了一种快速验证应用程序用户身份的方法,无需设置专用的 「登录」 页面。要开始,请附加 auth.basic middleware 到路由。那个 auth.basic 中间件包含在 Laravel 框架中,因此您不需要定义它:

Route::get('/profile', function () {
    // 只有经过身份验证的用户才能访问此路由 ...
})->middleware('auth.basic');

一旦将中间件连接到路由,在浏览器中访问路由时,将自动提示你输入凭据。默认情况下 auth.basic 中间件将假定 users 数据库表中的 email 列是用户的用户名。

注意 FastCGI

如果你使用的是 PHP FastCGI 和 Apache 来为 Laravel 应用程序提供服务,那么 HTTP Basic 身份验证可能无法正常工作。要更正这些问题,可以将以下行添加到应用程序的 .htaccess 文件中:

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

无状态 HTTP Basic 认证

你也可以使用 HTTP Basic 身份验证,而无需在 session 中设置用户标识符 cookie。如果你选择使用 HTTP 身份验证对应用程序 API 的请求进行身份验证,这将非常有用。为此,定义一个中间件 调用 onceBasic 方法。如果 onceBasic 方法未返回任何响应,则可以将请求进一步传递到应用程序中:

<?php

namespace App\Http\Middleware;

use Illuminate\Support\Facades\Auth;

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

}

然后, 注册路由中间件 并把它附加到路由中:

Route::get('/api/user', function () {
    // 只有经过身份验证的用户才能访问此路由 ...
})->middleware('auth.basic.once');

退出登录

要在应用程序中手动注销用户,可以使用 Auth facade 提供的 logout 方法。这将从用户的 session 中删除身份验证信息,以便后续请求不会得到身份验证。

除了调用 logout 方法外,建议你将用户的 session 置为过期,并重新生成其 CSRF 令牌。注销用户后,通常会将用户重定向到应用程序的根目录:

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;

/**
 * 将用户退出应用程序
 *
 * @param  \Illuminate\Http\Request $request
 * @return \Illuminate\Http\Response
 */
public function logout(Request $request)
{
    Auth::logout();

    $request->session()->invalidate();

    $request->session()->regenerateToken();

    return redirect('/');
}

使其他设备上的 session 失效

Laravel 还提供了这样一种机制,可以使用户在其他设备上处于活动状态置为失效并 「注销」,而不会使其当前设备上的会话失效。当用户正在更改或更新其密码,并且你希望在保持当前设备身份验证的同时使其他设备上的会话无效时,通常会使用此功能。

在开始之前,你应该确保 App\Http\Kernel 类的 web 中间件组中存在 Illuminate\Session\Middleware\AuthenticateSession 中间件,并且没有被注释掉:

'web' => [
    // ...
    \Illuminate\Session\Middleware\AuthenticateSession::class,
    // ...
],

然后,可以使用 Auth facade 提供的 logoutOtherDevices 方法。此方法要求用户确认其当前密码,应用程序应通过输入窗体接受此密码:

use Illuminate\Support\Facades\Auth;

Auth::logoutOtherDevices($currentPassword);

当调用 logoutOtherDevices 方法时,用户的其他 session 将完全失效,这意味着它们将 「注销」 以前通过身份验证的所有看守器。

密码确认

在构建应用程序时,有时可能会有一些地方要求用户在执行某些操作或将用户重定向到应用程序的敏感区域之前确认其密码。Laravel 包括内置的中间件,使这个过程轻而易举。实现此功能需要定义两个路由:一个路由显示请求用户确认其密码的视图,另一个路由确认密码有效并将用户重定向到其预期目的地。

技巧:以下文档讨论了如何直接与 Laravel 的密码确认功能集成;但是,如果您想更快地开始使用, Laravel 应用入门工具箱 包含对此功能的支持!

配置

确认密码后,用户在三个小时内不会被要求再次确认密码。但是,你可以通过更改应用程序 config/auth.php 中的 password_timeout 配置值来配置重新提示用户输入密码之前的时长。

路由

密码确认表单

首先,我们将定义一个路由以显示请求用户确认其密码的视图:

Route::get('/confirm-password', function () {
    return view('auth.confirm-password');
})->middleware('auth')->name('password.confirm');

如您所料,此路由返回的视图应该有一个包含 password 字段的表单。此外,可以随意在视图中包含说明用户正在进入应用程序的受保护区域并且必须确认其密码的文本。

确认密码

接下来,我们将定义一个路由来处理来自 「confirm password」 视图的表单请求。此路由将负责验证密码并将用户重定向到其预期目的地:

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Facades\Redirect;

Route::post('/confirm-password', function (Request $request) {
    if (! Hash::check($request->password, $request->user()->password)) {
        return back()->withErrors([
            'password' => ['The provided password does not match our records.']
        ]);
    }

    $request->session()->passwordConfirmed();

    return redirect()->intended();
})->middleware(['auth', 'throttle:6,1'])->name('password.confirm');

在继续之前,让我们更详细地检查一下这条路由。首先,请求的 password 字段被确定为实际匹配经过身份验证的用户的密码。如果密码有效,我们需要通知 Laravel 的 session,用户已经确认了他们的密码。 passwordConfirmed 方法将在用户会话中设置一个时间戳,Laravel 可以使用它来确定用户上次确认密码的时间。最后,我们可以将用户重定向到他们想要的目的地。

保护路由

你应该确保为执行需要最近密码确认的操作的任何路由分配 password.confirm 中间件。此中间件包含在 Laravel 的默认安装中,并将自动在 session 中存储用户的预期目的地,以便用户在确认密码后可以重定向到该位置。在 session 中存储用户的预期目的地之后,中间件将用户重定向到 password.confirm命名路由

Route::get('/settings', function () {
    // ...
})->middleware(['password.confirm']);

Route::post('/settings', function () {
    // ...
})->middleware(['password.confirm']);

添加自定义的看守器

你可以使用 Auth facade 上的 extend 方法定义自己的身份验证看守器。你应该在 服务提供器 中调用 extend 方法。由于 Laravel 已经附带了 AuthServiceProvider,因此我们可以将代码放置在该提供程序中:

<?php

namespace App\Providers;

use App\Services\Auth\JwtGuard;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Auth;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * 注册任意的身份验证和身份授权的服务
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();

        Auth::extend('jwt', function ($app, $name, array $config) {
            // 返回 Illuminate\Contracts\Auth\Guard 的实例 ...

            return new JwtGuard(Auth::createUserProvider($config['provider']));
        });
    }
}

正如你在上面的示例中所看到的,传递给 extend 方法的回调应该返回 Illuminate\Contracts\Auth\Guard 的实例。此接口包含一些方法,你需要实现这些方法来定义自定义看守器。一旦你的自定义看守器被定义,你就可以在你的应用程序 auth.php 配置文件的 guards 配置中引用该看守器:

'guards' => [
    'api' => [
        'driver' => 'jwt',
        'provider' => 'users',
    ],
],

闭包请求看守器

实现自定义的、基于 HTTP 请求的身份验证系统的最简单方法是使用 Auth::viaRequest 方法。此方法允许你使用单个闭包快速定义身份验证过程。

首先,请在您的 AuthServiceProviderboot 方法中调用 Auth::viaRequest 方法。 VIASRequest 方法接受身份验证驱动程序名称作为其第一个参数。此名称可以是描述自定义看守器的任何字符串。传递给方法的第二个参数应该是一个闭包,该闭包接收传入的 HTTP 请求并返回用户实例,或者,如果验证失败返回 null:

use App\Models\User;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;

/**
 * Register any application authentication / authorization services.
 *
 * @return void
 */
public function boot()
{
    $this->registerPolicies();

    Auth::viaRequest('custom-token', function (Request $request) {
        return User::where('token', $request->token)->first();
    });
}

一旦你定义自定义身份验证驱动程序,就可以将其配置为 auth.php 配置文件:

'guards' => [
    'api' => [
        'driver' => 'custom-token',
    ],
],

添加自定义的用户提供器

如果不使用传统的关系数据库来存储用户,则需要使用自己的身份验证用户提供程序来扩展 Laravel 。我们将使用 Auth facade 上的 provider 方法来定义自定义用户提供器。提供器解析器应返回 illighte\Contracts\Auth\UserProvider 的实例:

<?php

namespace App\Providers;

use App\Extensions\MongoUserProvider;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Auth;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * Register any application authentication / authorization services.
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();

        Auth::provider('mongo', function ($app, array $config) {
            // Return an instance of Illuminate\Contracts\Auth\UserProvider...

            return new MongoUserProvider($app->make('mongo.connection'));
        });
    }
}

使用 provider 方法注册提供程序后,你可以在 auth.php 配置文件中切换到新的提供程序。首先,定义一个使用新驱动程序的 provider

'providers' => [
    'users' => [
        'driver' => 'mongo',
    ],
],

最后,你可以在 guards 配置中引用此提供程序:

'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],
],

用户提供器契约

Illuminate\Contracts\Auth\UserProvider 实现负责从持久性存储系统(如 MySQL、MongoDB 等)中提取 Illuminate\Contracts\Auth\Authenticatable 实例。无论用户数据是如何存储的,这两个接口可以保障 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 匹配的 Authenticatable 实现。

retrieveByToken 函数通过用户唯一的 $identifier 和 「记住我」 $token 检索用户,通常存储在数据库列中,如 remember_token 。与前面的方法一样,应该通过此方法返回具有匹配令牌值的 Authenticatable 实现。

updateMemberToken 方法使用新的 $token 更新 $user 实例的 remember_token。在成功的 「记住我」 身份验证尝试或用户注销时,将为用户分配新令牌。

retrieveByCredentials 方法在尝试对应用程序进行身份验证时接收传递给 Auth::attempt 方法的凭据数组。然后,该方法应该为匹配这些凭证的用户 「查询」 底层持久存储。通常,此方法将运行一个带有 「where」 条件的查询,该条件搜索 「username」 与 $credentials['username'] 值匹配的用户记录。该方法应返回 Authenticatable 的实例。此方法不应尝试执行任何密码验证或身份验证。

validateCredentials 方法应将给定的 $user$credentials 进行比较,以对用户进行身份验证。例如,此方法通常使用 Hash::check 方法将 $user->getAuthPassword() 的值与 $credentials['password'] 的值进行比较。此方法应返回 truefalse,指示密码是否有效。

Authenticatable 锲约

我们已经研究了 UserProvider 上的每个方法,现在让我们看看 Authenticatable 契约。请记住,UserProvider 应该从 retrieveByIdretrieveByTokenretrieveByCredentials 方法返回此接口的实现:

<?php

namespace Illuminate\Contracts\Auth;

interface Authenticatable
{
    public function getAuthIdentifierName();
    public function getAuthIdentifier();
    public function getAuthPassword();
    public function getRememberToken();
    public function setRememberToken($value);
    public function getRememberTokenName();
}

这个接口很简单。getAuthIdentifierName 方法应返回用户的 「主键」 字段的名称, getAuthIdentifier 方法应返回用户的 「主键」 。当使用 MySQL 后端时,这可能是分配给用户记录的自动递增主键。getAuthPassword 方法应返回用户的进行哈希后的密码。

此接口允许身份验证系统与任何 「用户」 类一起工作,而不管你使用的是哪个 ORM 或存储抽象层。默认情况下,Laravel 在实现此接口的 app/Models 目录中包含一个 App\Models\User 类。

事件

在身份验证过程中,Laravel 发送各种 事件。你可以在 EventServiceProvider 中将监听器附加到这些事件上:

/**
 * 应用监听器的对应表
 *
 * @var array
 */
protected $listen = [
    'Illuminate\Auth\Events\Registered' => [
        'App\Listeners\LogRegisteredUser',
    ],

    'Illuminate\Auth\Events\Attempting' => [
        'App\Listeners\LogAuthenticationAttempt',
    ],

    'Illuminate\Auth\Events\Authenticated' => [
        'App\Listeners\LogAuthenticated',
    ],

    'Illuminate\Auth\Events\Login' => [
        'App\Listeners\LogSuccessfulLogin',
    ],

    'Illuminate\Auth\Events\Failed' => [
        'App\Listeners\LogFailedLogin',
    ],

    'Illuminate\Auth\Events\Validated' => [
        'App\Listeners\LogValidated',
    ],

    'Illuminate\Auth\Events\Verified' => [
        'App\Listeners\LogVerified',
    ],

    'Illuminate\Auth\Events\Logout' => [
        'App\Listeners\LogSuccessfulLogout',
    ],

    'Illuminate\Auth\Events\CurrentDeviceLogout' => [
        'App\Listeners\LogCurrentDeviceLogout',
    ],

    'Illuminate\Auth\Events\OtherDeviceLogout' => [
        'App\Listeners\LogOtherDeviceLogout',
    ],

    'Illuminate\Auth\Events\Lockout' => [
        'App\Listeners\LogLockout',
    ],

    'Illuminate\Auth\Events\PasswordReset' => [
        'App\Listeners\LogPasswordReset',
    ],
];

本文章首发在 LearnKu.com 网站上。

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。
上一篇 下一篇
Summer
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
贡献者:6
讨论数量: 0
发起讨论 只看当前版本


暂无话题~