Skip to content

认证

介绍

许多 Web 应用程序为其用户提供了一种与应用程序进行认证和“登录”的方式。在 Web 应用程序中实现此功能可能是一个复杂且潜在风险的工作。因此,Laravel 力求为您提供快速、安全、简单地实现认证所需的工具。

在其核心,Laravel 的认证功能由“守卫”和“提供者”组成。守卫定义了用户如何为每个请求进行认证。例如,Laravel 附带了一个 session 守卫,它使用会话存储和 Cookie 来维护状态。

提供者定义了如何从持久存储中检索用户。Laravel 支持使用 Eloquent 和数据库查询构建器检索用户。然而,您可以根据应用程序的需要自由定义其他提供者。

应用程序的认证配置文件位于 config/auth.php。此文件包含几个经过良好文档记录的选项,用于调整 Laravel 认证服务的行为。

lightbulb

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

入门套件

想要快速入门?在新的 Laravel 应用程序中安装一个 Laravel 应用程序入门套件。迁移数据库后,导航到 /register 或分配给应用程序的任何其他 URL。入门套件将负责搭建整个认证系统!

即使您选择不在最终的 Laravel 应用程序中使用入门套件,安装 Laravel Breeze 入门套件也是一个很好的机会,可以学习如何在实际的 Laravel 项目中实现所有的 Laravel 认证功能。 由于 Laravel Breeze 为您创建了认证控制器、路由和视图,您可以检查这些文件中的代码,了解如何实现 Laravel 的认证功能。

数据库注意事项

默认情况下,Laravel 在 app/Models 目录中包含一个 App\Models\User Eloquent 模型。此模型可与默认的 Eloquent 认证驱动程序一起使用。如果应用程序不使用 Eloquent,您可以使用 database 认证提供者,该提供者使用 Laravel 查询构建器。

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

此外,您应验证 users(或等效)表包含一个可为空的、长度为 100 个字符的字符串 remember_token 列。此列将用于存储选择“记住我”选项的用户的令牌。再次说明,新 Laravel 应用程序中包含的默认 users 表迁移已经包含此列。

生态系统概览

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

首先,考虑认证如何工作。使用 Web 浏览器时,用户将通过登录表单提供其用户名和密码。如果这些凭据正确,应用程序将在用户的 会话 中存储有关已认证用户的信息。发给浏览器的 Cookie 包含会话 ID,以便后续请求可以将用户与正确的会话关联。在收到会话 Cookie 后,应用程序将根据会话 ID 检索会话数据,注意到认证信息已存储在会话中,并将用户视为“已认证”。

当远程服务需要认证以访问 API 时,通常不使用 Cookie 进行认证,因为没有 Web 浏览器。相反,远程服务在每个请求中向 API 发送 API 令牌。应用程序可以根据有效 API 令牌表验证传入的令牌,并将请求“认证”为由与该 API 令牌关联的用户执行。

Laravel 的内置浏览器认证服务

Laravel 包含内置的认证和会话服务,通常通过 AuthSession facade 访问。这些功能为从 Web 浏览器发起的请求提供基于 Cookie 的认证。它们提供了允许您验证用户凭据和认证用户的方法。此外,这些服务将自动在用户的会话中存储适当的认证数据,并发出用户的会话 Cookie。如何使用这些服务的讨论包含在本文档中。

应用程序入门套件

如本文档中所述,您可以手动与这些认证服务交互,以构建应用程序自己的认证层。然而,为了帮助您更快地入门,我们发布了 免费包,提供了整个认证层的强大、现代的脚手架。这些包是 Laravel BreezeLaravel JetstreamLaravel Fortify

Laravel Breeze 是一个简单、最小的实现,包含了 Laravel 的所有认证功能,包括登录、注册、密码重置、电子邮件验证和密码确认。Laravel Breeze 的视图层由简单的 Blade 模板 组成,使用 Tailwind CSS 进行样式化。要开始,请查看 Laravel 的 应用程序入门套件 文档。

Laravel Fortify 是一个无头认证后端,适用于 Laravel,实施了本文档中描述的许多功能,包括基于 Cookie 的认证以及其他功能,如双因素认证和电子邮件验证。Fortify 提供了 Laravel Jetstream 的认证后端,或者可以独立使用,并与 Laravel Sanctum 结合使用,为需要与 Laravel 进行认证的 SPA 提供认证。

Laravel Jetstream 是一个强大的应用程序入门套件,使用 Tailwind CSSLivewire 和 / 或 Inertia 提供美观、现代的 UI,消费和暴露 Laravel Fortify 的认证服务。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 规范提供的复杂功能,这可能会让用户和开发人员感到困惑。此外,开发人员在使用像 Passport 这样的 OAuth2 认证提供者认证 SPA 应用程序或移动应用程序时,历史上一直感到困惑。

Sanctum

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

Laravel Sanctum 是一个混合 Web / API 认证包,可以管理应用程序的整个认证过程。这是可能的,因为当基于 Sanctum 的应用程序接收到请求时,Sanctum 将首先确定请求是否包含引用已认证会话的会话 Cookie。Sanctum 通过调用我们之前讨论的 Laravel 的内置认证服务来实现这一点。如果请求不是通过会话 Cookie 进行认证的,Sanctum 将检查请求中是否有 API 令牌。如果存在 API 令牌,Sanctum 将使用该令牌认证请求。要了解有关此过程的更多信息,请查阅 Sanctum 的 “工作原理” 文档。

Laravel Sanctum 是我们选择与 Laravel Jetstream 应用程序入门套件一起包含的 API 包,因为我们认为它最适合大多数 Web 应用程序的认证需求。

总结和选择您的堆栈

总之,如果您的应用程序将通过浏览器访问,并且您正在构建一个单体 Laravel 应用程序,您的应用程序将使用 Laravel 的内置认证服务。

接下来,如果您的应用程序提供一个将由第三方使用的 API,您将选择 PassportSanctum 为应用程序提供 API 令牌认证。一般来说,Sanctum 应该在可能的情况下优先选择,因为它是一个简单、完整的 API 认证、SPA 认证和移动认证解决方案,包括对“范围”或“能力”的支持。

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

当您的应用程序绝对需要 OAuth2 规范提供的所有功能时,可以选择 Passport。

如果您想快速入门,我们很高兴推荐 Laravel Breeze 作为快速启动新 Laravel 应用程序的方式,该应用程序已经使用了我们首选的 Laravel 内置认证服务和 Laravel Sanctum 认证堆栈。

认证快速入门

exclamation

本文档的这一部分讨论了通过 Laravel 应用程序入门套件 认证用户,其中包括 UI 脚手架以帮助您快速入门。如果您想直接与 Laravel 的认证系统集成,请查看有关 手动认证用户 的文档。

安装入门套件

首先,您应该 安装一个 Laravel 应用程序入门套件。我们当前的入门套件,Laravel Breeze 和 Laravel Jetstream,提供了美观的起点,将认证集成到您的新 Laravel 应用程序中。

Laravel Breeze 是一个简单、最小的实现,包含了 Laravel 的所有认证功能,包括登录、注册、密码重置、电子邮件验证和密码确认。Laravel Breeze 的视图层由简单的 Blade 模板 组成,使用 Tailwind CSS 进行样式化。此外,Breeze 提供了基于 LivewireInertia 的脚手架选项,可以选择使用 Vue 或 React 进行 Inertia 基于的脚手架。

Laravel Jetstream 是一个更强大的应用程序入门套件,支持使用 LivewireInertia 和 Vue 为应用程序搭建脚手架。此外,Jetstream 提供了对双因素认证、团队、配置文件管理、浏览器会话管理、通过 Laravel Sanctum 的 API 支持、账户删除等功能的可选支持。

检索已认证用户

安装认证入门套件并允许用户注册和认证后,您通常需要与当前已认证用户进行交互。在处理传入请求时,您可以通过 Auth facade 的 user 方法访问已认证用户:

php
use Illuminate\Support\Facades\Auth;

// 检索当前已认证用户...
$user = Auth::user();

// 检索当前已认证用户的 ID...
$id = Auth::id();

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

php
<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class FlightController extends Controller
{
    /**
     * 更新现有航班的航班信息。
     */
    public function update(Request $request): RedirectResponse
    {
        $user = $request->user();

        // ...

        return redirect('/flights');
    }
}

确定当前用户是否已认证

要确定发出传入 HTTP 请求的用户是否已认证,您可以使用 Auth facade 上的 check 方法。如果用户已认证,此方法将返回 true

php
use Illuminate\Support\Facades\Auth;

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

尽管可以使用 check 方法确定用户是否已认证,但通常会使用中间件来验证用户在允许用户访问某些路由/控制器之前是否已认证。要了解更多信息,请查看有关 保护路由 的文档。

保护路由

路由中间件 可用于仅允许已认证用户访问给定路由。Laravel 附带了一个 auth 中间件,它引用了 Illuminate\Auth\Middleware\Authenticate 类。由于此中间件已在应用程序的 HTTP 内核中注册,您只需将中间件附加到路由定义即可:

php
Route::get('/flights', function () {
    // 只有已认证用户可以访问此路由...
})->middleware('auth');

重定向未认证用户

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

php
use Illuminate\Http\Request;

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

指定守卫

auth 中间件附加到路由时,您还可以指定应使用哪个“守卫”来认证用户。指定的守卫应对应于 auth.php 配置文件中 guards 数组中的一个键:

php
Route::get('/flights', function () {
    // 只有已认证用户可以访问此路由...
})->middleware('auth:admin');

登录限流

如果您使用的是 Laravel Breeze 或 Laravel Jetstream 入门套件,速率限制将自动应用于登录尝试。默认情况下,如果用户在多次尝试后未能提供正确的凭据,则用户将无法登录一分钟。限流是针对用户的用户名/电子邮件地址和他们的 IP 地址的唯一限流。

lightbulb

如果您想限制应用程序中的其他路由,请查看 速率限制文档

手动认证用户

您不需要使用 Laravel 的 应用程序入门套件 中包含的认证脚手架。如果您选择不使用此脚手架,您将需要直接使用 Laravel 认证类来管理用户认证。别担心,这很简单!

我们将通过 Auth facade 访问 Laravel 的认证服务,因此我们需要确保在类的顶部导入 Auth facade。接下来,让我们看看 attempt 方法。attempt 方法通常用于处理应用程序“登录”表单的认证尝试。如果认证成功,您应该重新生成用户的 会话 以防止 会话固定

php
<?php

namespace App\Http\Controllers;

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

class LoginController extends Controller
{
    /**
     * 处理认证尝试。
     */
    public function authenticate(Request $request): RedirectResponse
    {
        $credentials = $request->validate([
            'email' => ['required', 'email'],
            'password' => ['required'],
        ]);

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

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

        return back()->withErrors([
            'email' => '提供的凭据与我们的记录不匹配。',
        ])->onlyInput('email');
    }
}

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

请记住,Laravel 的认证服务将根据认证守卫的“提供者”配置从数据库中检索用户。在默认的 config/auth.php 配置文件中,指定了 Eloquent 用户提供者,并指示在检索用户时使用 App\Models\User 模型。您可以根据应用程序的需要在配置文件中更改这些值。

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

Laravel 的重定向器提供的 intended 方法将用户重定向到他们在被认证中间件拦截之前试图访问的 URL。如果目标地址不可用,可以为此方法提供一个备用 URI。

指定额外条件

如果您愿意,您还可以在认证查询中添加额外的查询条件,除了用户的电子邮件和密码。为此,我们可以简单地将查询条件添加到传递给 attempt 方法的数组中。例如,我们可以验证用户是否被标记为“活跃”:

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

对于复杂的查询条件,您可以在凭据数组中提供一个闭包。此闭包将与查询实例一起调用,允许您根据应用程序的需要自定义查询:

php
use Illuminate\Database\Eloquent\Builder;

if (Auth::attempt([
    'email' => $email,
    'password' => $password,
    fn (Builder $query) => $query->has('activeSubscription'),
])) {
    // 认证成功...
}
exclamation

在这些示例中,email 不是必需选项,它仅用作示例。您应该使用与数据库表中的“用户名”对应的列名。

attemptWhen 方法接收一个闭包作为其第二个参数,可用于在实际认证用户之前对潜在用户进行更广泛的检查。闭包接收潜在用户,并应返回 truefalse 以指示用户是否可以认证:

php
if (Auth::attemptWhen([
    'email' => $email,
    'password' => $password,
], function (User $user) {
    return $user->isNotBanned();
})) {
    // 认证成功...
}

访问特定守卫实例

通过 Auth facade 的 guard 方法,您可以指定在认证用户时要使用哪个守卫实例。这允许您使用完全独立的可认证模型或用户表来管理应用程序不同部分的认证。

传递给 guard 方法的守卫名称应对应于 auth.php 配置文件中配置的守卫之一:

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

记住用户

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

当此值为 true 时,Laravel 将无限期地保持用户认证状态,直到他们手动注销。您的 users 表必须包含字符串 remember_token 列,该列将用于存储“记住我”令牌。新 Laravel 应用程序中包含的 users 表迁移已经包含此列:

php
use Illuminate\Support\Facades\Auth;

if (Auth::attempt(['email' => $email, 'password' => $password], $remember)) {
    // 用户正在被记住...
}

如果应用程序提供“记住我”功能,您可以使用 viaRemember 方法来确定当前已认证用户是否使用“记住我”Cookie 进行认证:

php
use Illuminate\Support\Facades\Auth;

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

其他认证方法

认证用户实例

如果您需要将现有用户实例设置为当前已认证用户,可以将用户实例传递给 Auth facade 的 login 方法。给定的用户实例必须是 Illuminate\Contracts\Auth\Authenticatable 契约 的实现。Laravel 附带的 App\Models\User 模型已经实现了此接口。当您已经有一个有效的用户实例时,此认证方法非常有用,例如在用户注册后直接使用:

php
use Illuminate\Support\Facades\Auth;

Auth::login($user);

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

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

如果需要,您可以在调用 login 方法之前指定认证守卫:

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

通过 ID 认证用户

要使用用户数据库记录的主键认证用户,您可以使用 loginUsingId 方法。此方法接受要认证的用户的主键:

php
Auth::loginUsingId(1);

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

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

一次性认证用户

您可以使用 once 方法在应用程序中认证用户以进行单个请求。调用此方法时不会使用会话或 Cookie:

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

HTTP 基本认证

HTTP 基本认证提供了一种简单的方式来保护路由,允许用户通过浏览器的内置对话框进行认证。要启用 HTTP 基本认证,您只需在路由定义中使用 auth.basic 中间件即可:

php
Route::get('/profile', function () {
    // 只有已认证用户可以访问此路由...
})->middleware('auth.basic');

无状态 HTTP 基本认证

您可以使用 onceBasic 方法实现无状态 HTTP 基本认证。无状态 HTTP 基本认证不会在会话中存储任何会话状态:

php
Route::get('/api/user', function () {
    return Auth::onceBasic() ?: response()->json(['message' => 'Unauthorized.'], 401);
});

注销

要手动注销应用程序中的用户,您可以使用 Auth facade 提供的 logout 方法。这将从用户的会话中删除认证信息,以便后续请求不再认证。

除了调用 logout 方法外,建议您使用户的会话失效并重新生成他们的 CSRF 令牌。注销用户后,通常会将用户重定向到应用程序的根目录:

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

/**
 * 将用户从应用程序中注销。
 */
public function logout(Request $request): RedirectResponse
{
    Auth::logout();

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

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

    return redirect('/');
}

使其他设备上的会话失效

Laravel 还提供了一种机制,用于使用户在其他设备上活动的会话失效并“注销”,而不使当前设备上的会话失效。此功能通常在用户更改或更新密码时使用,您希望使其他设备上的会话失效,同时保持当前设备的认证状态。

在开始之前,您应确保在应接收会话认证的路由上包含 Illuminate\Session\Middleware\AuthenticateSession 中间件。通常,您应将此中间件放置在路由组定义上,以便可以应用于应用程序的大多数路由。默认情况下,可以使用应用程序的 HTTP 内核中定义的 auth.session 路由中间件别名将 AuthenticateSession 中间件附加到路由:

php
Route::middleware(['auth', 'auth.session'])->group(function () {
    Route::get('/', function () {
        // ...
    });
});

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

php
use Illuminate\Support\Facades\Auth;

Auth::logoutOtherDevices($currentPassword);

调用 logoutOtherDevices 方法时,用户的其他会话将完全失效,这意味着他们将从之前认证的所有守卫中“注销”。

密码确认

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

lightbulb

以下文档讨论了如何直接与 Laravel 的密码确认功能集成;然而,如果您想更快地入门,Laravel 应用程序入门套件 包括对此功能的支持!

配置

确认密码后,用户在三小时内不会再次被要求确认密码。然而,您可以通过更改应用程序的 config/auth.php 配置文件中的 password_timeout 配置值来配置用户在重新提示其密码之前的时间长度。

路由

密码确认表单

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

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

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

确认密码

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

php
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' => ['提供的密码与我们的记录不匹配。']
        ]);
    }

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

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

在继续之前,让我们更详细地检查此路由。首先,确定请求的 password 字段实际上与已认证用户的密码匹配。如果密码有效,我们需要通知 Laravel 的会话用户已确认其密码。passwordConfirmed 方法将在用户的会话中设置一个时间戳,Laravel 可以使用该时间戳来确定用户上次确认密码的时间。最后,我们可以将用户重定向到其预期目的地。

保护路由

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

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

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

添加自定义守卫

您可以使用 Auth facade 上的 extend 方法定义自己的认证守卫。您应在 服务提供者 中调用 extend 方法。由于 Laravel 已经附带了一个 AuthServiceProvider,我们可以将代码放在该提供者中:

php
<?php

namespace App\Providers;

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

class AuthServiceProvider extends ServiceProvider
{
    /**
     * 注册任何应用程序认证/授权服务。
     */
    public function boot(): void
    {
        Auth::extend('jwt', function (Application $app, string $name, array $config) {
            // 返回 Illuminate\Contracts\Auth\Guard 的实例...

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

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

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

闭包请求守卫

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

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

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

/**
 * 注册任何应用程序认证/授权服务。
 */
public function boot(): void
{
    Auth::viaRequest('custom-token', function (Request $request) {
        return User::where('token', (string) $request->token)->first();
    });
}

定义自定义认证驱动程序后,您可以在 auth.php 配置文件的 guards 配置中将其配置为驱动程序:

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

最后,您可以在将认证中间件分配给路由时引用该守卫:

php
Route::middleware('auth:api')->group(function () {
    // ...
});

添加自定义用户提供者

如果您不使用传统的关系数据库来存储用户,您将需要使用自己的认证用户提供者扩展 Laravel。我们将使用 Auth facade 上的 provider 方法定义自定义用户提供者。用户提供者解析器应返回 Illuminate\Contracts\Auth\UserProvider 的实现:

php
<?php

namespace App\Providers;

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

class AuthServiceProvider extends ServiceProvider
{
    /**
     * 注册任何应用程序认证/授权服务。
     */
    public function boot(): void
    {
        Auth::provider('mongo', function (Application $app, array $config) {
            // 返回 Illuminate\Contracts\Auth\UserProvider 的实例...

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

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

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

最后,您可以在 guards 配置中引用此提供者:

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

用户提供者契约

Illuminate\Contracts\Auth\UserProvider 实现负责从持久存储系统(如 MySQL、MongoDB 等)中获取 Illuminate\Contracts\Auth\Authenticatable 实现。这两个接口允许 Laravel 认证机制继续工作,无论用户数据如何存储或使用什么类型的类来表示已认证用户:

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

php
<?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 实现。

updateRememberToken 方法使用新 $token 更新 $user 实例的 remember_token。在成功的“记住我”认证尝试或用户注销时,将为用户分配一个新的令牌。

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

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

可认证契约

现在我们已经探讨了 UserProvider 上的每个方法,让我们看看 Authenticatable 契约。请记住,用户提供者应从 retrieveByIdretrieveByTokenretrieveByCredentials 方法返回此接口的实现:

php
<?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 中附加监听器到这些事件:

php
/**
 * 应用程序的事件监听器映射。
 *
 * @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',
    ],
];