身份验证

• 介绍
  • 入门套件
  • 数据库注意事项
  • 生态系统概述
• 身份验证快速入门
  • 安装入门套件
  • 检索已认证用户
  • 保护路由
  • 登录限流
• 手动认证用户
  • 记住用户
  • 其他身份验证方法
• HTTP基本认证
  • 无状态HTTP基本认证
• 注销
  • 使其他设备上的会话失效
• 密码确认
  • 配置
  • 路由
  • 保护路由
• 添加自定义守卫
  • 闭包请求守卫
• 添加自定义用户提供者
  • 用户提供者契约
  • 可认证合同
• 自动密码重哈希
• 社交认证
• 事件

介绍

许多Web应用程序为用户提供了一种通过应用程序进行身份验证和“登录”的方式。在Web应用程序中实现此功能可能是一个复杂且潜在风险的任务。因此，Laravel 力求为您提供快速、安全、轻松地实现身份验证所需的工具。

从本质上讲，Laravel 的身份验证功能由“守卫”和“提供者”组成。守卫定义了如何为每个请求对用户进行身份验证。例如，Laravel 附带一个 session 守卫，它使用会话存储和 cookie 来维护状态。

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

应用程序的身份验证配置文件位于 config/auth.php。此文件包含几个文档良好的选项，用于调整 Laravel 身份验证服务的行为。

NOTE

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

启动套件

想快速入门吗？在新的 Laravel 应用程序中安装 Laravel 应用程序入门套件。迁移数据库后，将浏览器导航到 /register 或分配给应用程序的任何其他 URL。入门套件将负责为您搭建整个身份验证系统的脚手架！

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

数据库注意事项

默认情况下，Laravel 在 app/Models 目录中包含一个 App\Models\User Eloquent 模型。此模型可与默认的 Eloquent 身份验证驱动程序一起使用。

如果应用程序未使用 Eloquent，则可以使用 database 身份验证提供程序，该提供程序使用 Laravel 查询构建器。如果您的应用程序使用 MongoDB，请查看 MongoDB 的官方 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 包含内置的身份验证和会话服务，通常通过 Auth 和 Session 外观访问。这些功能为从 Web 浏览器启动的请求提供基于 Cookie 的身份验证。它们提供允许您验证用户凭据和对用户进行身份验证的方法。此外，这些服务将自动在用户的会话中存储适当的身份验证数据，并发出用户的会话 Cookie。如何使用这些服务的讨论包含在本文档中。

应用程序入门套件

如本文档中所述，您可以手动与这些身份验证服务进行交互，以构建应用程序自己的身份验证层。但是，为了帮助您更快地入门，我们发布了 免费入门套件，提供了整个身份验证层的强大、现代的脚手架。

Laravel 的 API 身份验证服务

Laravel 提供了两个可选包来帮助您管理 API 令牌和使用 API 令牌进行的请求的身份验证：Passport 和 Sanctum。请注意，这些库和 Laravel 内置的基于 Cookie 的身份验证库并不互斥。这些库主要关注 API 令牌身份验证，而内置身份验证服务则专注于基于 Cookie 的浏览器身份验证。许多应用程序将同时使用 Laravel 内置的基于 Cookie 的身份验证服务和其中一个 Laravel API 身份验证包。

Passport

Passport 是一个 OAuth2 身份验证提供程序，提供多种 OAuth2 “授权类型”，允许您颁发各种类型的令牌。通常，这是一个用于 API 身份验证的强大而复杂的包。然而，大多数应用程序不需要 OAuth2 规范提供的复杂功能，这可能会让用户和开发人员感到困惑。此外，开发人员在使用像 Passport 这样的 OAuth2 身份验证提供程序对 SPA 应用程序或移动应用程序进行身份验证时，历来感到困惑。

Sanctum

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

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

总结和选择您的堆栈

总之，如果您的应用程序将使用浏览器访问并且您正在构建单片 Laravel 应用程序，则您的应用程序将使用 Laravel 的内置身份验证服务。

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

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

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

而且，如果您想快速入门，我们很高兴推荐 我们的应用程序入门套件 作为启动已经使用我们首选身份验证堆栈的新的 Laravel 应用程序的快速方法。

身份验证快速入门

WARNING

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

安装入门套件

首先，您应该 安装 Laravel 应用程序入门套件。我们的入门套件为在新的 Laravel 应用程序中集成身份验证提供了精美的起点。

检索已认证用户

在从入门套件创建应用程序并允许用户注册和通过您的应用程序进行身份验证后，您通常需要与当前经过身份验证的用户进行交互。在处理传入请求时，您可以通过 Auth 外观的 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\RedirectResponse;
use Illuminate\Http\Request;

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

        // ...

        return redirect('/flights');
    }
}

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

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

use Illuminate\Support\Facades\Auth;

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

NOTE

即使可以使用 check 方法确定用户是否经过身份验证，您通常也会使用中间件来验证用户是否经过身份验证，然后才允许用户访问某些路由/控制器。要了解更多信息，请查看有关 保护路由 的文档。

保护路由

路由中间件 可用于仅允许经过身份验证的用户访问给定路由。Laravel 附带一个 auth 中间件，它是 Illuminate\Auth\Middleware\Authenticate 类的 中间件别名。由于此中间件已由 Laravel 在内部别名化，您只需将中间件附加到路由定义即可：

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

重定向未经身份验证的用户

当 auth 中间件检测到未经身份验证的用户时，它会将用户重定向到 login 命名路由。您可以在应用程序的 bootstrap/app.php 文件中使用 redirectGuestsTo 方法来修改此行为：

use Illuminate\Http\Request;

->withMiddleware(function (Middleware $middleware) {
    $middleware->redirectGuestsTo('/login');

    // 使用闭包...
    $middleware->redirectGuestsTo(fn (Request $request) => route('login'));
})

重定向已认证用户

当 guest 中间件检测到已认证用户时，它会将用户重定向到 dashboard 或 home 命名路由。您可以在应用程序的 bootstrap/app.php 文件中使用 redirectUsersTo 方法来修改此行为：

use Illuminate\Http\Request;

->withMiddleware(function (Middleware $middleware) {
    $middleware->redirectUsersTo('/panel');

    // 使用闭包...
    $middleware->redirectUsersTo(fn (Request $request) => route('panel'));
})

指定守卫

将 auth 中间件附加到路由时，您还可以指定应使用哪个“守卫”来对用户进行身份验证。指定的守卫应对应于 auth.php 配置文件的 guards 数组中的一个键：

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

登录限流

如果您正在使用我们的 应用程序入门套件 之一，速率限制将自动应用于登录尝试。默认情况下，如果用户在多次尝试后未能提供正确的凭据，则用户将无法登录一分钟。限流是用户的用户名/电子邮件地址和他们的 IP 地址所独有的。

NOTE

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

手动认证用户

您无需使用 Laravel 应用程序入门套件 附带的身份验证脚手架。如果您选择不使用此脚手架，则需要直接使用 Laravel 身份验证类来管理用户身份验证。别担心，这很简单！

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

<?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 方法的数组中。例如，我们可以验证用户是否被标记为“活动”：

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

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

use Illuminate\Database\Eloquent\Builder;

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

WARNING

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

attemptWhen 方法接收一个闭包作为其第二个参数，可用于在实际对用户进行身份验证之前对潜在用户进行更广泛的检查。闭包接收潜在用户，并应返回 true 或 false 以指示是否可以对用户进行身份验证：

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

访问特定的守卫实例

通过 Auth 外观的 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)) {
    // 用户被记住...
}

如果您的应用程序提供“记住我”功能，您可以使用 viaRemember 方法来确定当前经过身份验证的用户是否使用“记住我”Cookie 进行身份验证：

use Illuminate\Support\Facades\Auth;

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

其他身份验证方法

验证用户实例

如果需要将现有用户实例设置为当前经过身份验证的用户，可以将用户实例传递给 Auth 外观的 login 方法。给定的用户实例必须是 Illuminate\Contracts\Auth\Authenticatable 契约 的实现。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 方法的 remember 参数。此值指示经过身份验证的会话是否需要“记住我”功能。请记住，这意味着会话将无限期地进行身份验证，直到用户手动注销应用程序：

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

验证用户一次

您可以使用 once 方法在应用程序中对用户进行单个请求的身份验证。调用此方法时不会使用会话或 Cookie：

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

HTTP基本认证

HTTP 基本身份验证 提供了一种快速的方法来对应用程序的用户进行身份验证，而无需设置专用的“登录”页面。要开始使用，请将 auth.basic 中间件 附加到路由。auth.basic 中间件包含在 Laravel 框架中，因此您无需定义它：

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

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

关于 FastCGI 的说明

如果您使用 PHP FastCGI 和 Apache 来服务您的 Laravel 应用程序，HTTP 基本身份验证可能无法正常工作。要解决这些问题，可以将以下几行添加到应用程序的 .htaccess 文件中：

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

无状态HTTP基本认证

您还可以在不在会话中设置用户标识符 Cookie 的情况下使用 HTTP 基本身份验证。如果您选择使用 HTTP 身份验证来对应用程序的 API 请求进行身份验证，这将非常有用。为此，定义一个中间件 来调用 onceBasic 方法。如果 onceBasic 方法未返回响应，则可以将请求进一步传递到应用程序中：

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Symfony\Component\HttpFoundation\Response;

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

}

接下来，将中间件附加到路由：

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

注销

要手动将用户从应用程序中注销，您可以使用 Auth 外观提供的 logout 方法。这将从用户的会话中删除身份验证信息，以便后续请求不会被身份验证。

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

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 中间件。通常，您应该将此中间件放置在路由组定义上，以便可以将其应用于应用程序的大多数路由。默认情况下，可以使用 auth.session 中间件别名 将 AuthenticateSession 中间件附加到路由：

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

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

use Illuminate\Support\Facades\Auth;

Auth::logoutOtherDevices($currentPassword);

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

密码确认

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

NOTE

以下文档讨论了如何直接与 Laravel 的密码确认功能集成；但是，如果您想更快地入门，Laravel 应用程序入门套件 包含对此功能的支持！

配置

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

路由

密码确认表单

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

Route::get('/confirm-password', function () {
    return view('auth.confirm-password');
})->middleware('auth')->name('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' => ['提供的密码与我们的记录不匹配。']
        ]);
    }

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

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

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

保护路由

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

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

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

添加自定义守卫

您可以使用 Auth 外观上的 extend 方法定义自己的身份验证守卫。您应该在 服务提供者 中放置对 extend 方法的调用。由于 Laravel 已经附带了 AppServiceProvider，我们可以将代码放在该提供者中：

<?php

namespace App\Providers;

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

class AppServiceProvider 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 配置中引用该守卫：

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

闭包请求守卫

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

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

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' => [
    'api' => [
        'driver' => 'custom-token',
    ],
],

最后，您可以在将身份验证中间件分配给路由时引用守卫：

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

添加自定义用户提供者

如果您没有使用传统的关系数据库来存储用户，则需要使用自己的身份验证用户提供者扩展 Laravel。我们将使用 Auth 外观上的 provider 方法来定义自定义用户提供者。用户提供者解析器应返回 Illuminate\Contracts\Auth\UserProvider 的实现：

<?php

namespace App\Providers;

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

class AppServiceProvider 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：

'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);
    public function rehashPasswordIfRequired(Authenticatable $user, array $credentials, bool $force = false);
}

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() 的值与数组中传递给方法的 password 值进行比较。如果两个哈希密码匹配，则应为用户启动经过身份验证的会话。

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() 的值与数组中传递给方法的 password 值进行比较。此方法应返回 true 或 false，指示密码是否有效。

rehashPasswordIfRequired 方法应在需要时重新哈希给定的 $user 的密码（如果支持）。例如，此方法通常会使用 Hash::needsRehash 方法来确定 $credentials['password'] 值是否需要重新哈希。如果需要重新哈希密码，该方法应使用 Hash::make 方法重新哈希密码并更新底层持久存储中用户的记录。

可认证合同

现在我们已经探讨了 UserProvider 上的每个方法，让我们来看看 Authenticatable 契约。请记住，用户提供者应从 retrieveById、retrieveByToken 和 retrieveByCredentials 方法返回此接口的实现：

<?php

namespace Illuminate\Contracts\Auth;

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

此接口很简单。getAuthIdentifierName 方法应返回用户“主键”列的名称，getAuthIdentifier 方法应返回用户的“主键”。使用 MySQL 后端时，这可能是分配给用户记录的自动递增主键。getAuthPasswordName 方法应返回用户密码列的名称。getAuthPassword 方法应返回用户的哈希密码。

此接口允许身份验证系统与任何“用户”类一起使用，而不管您使用的是什么 ORM 或存储抽象层。默认情况下，Laravel 在 app/Models 目录中包含一个 App\Models\User 类，该类实现了此接口。

自动密码重哈希

Laravel 的默认密码哈希算法是 bcrypt。可以通过应用程序的 config/hashing.php 配置文件或 BCRYPT_ROUNDS 环境变量调整 bcrypt 哈希的“工作因子”。

通常，随着 CPU/GPU 处理能力的提高，bcrypt 工作因子应随时间增加。如果您增加应用程序的 bcrypt 工作因子，Laravel 将在用户通过 Laravel 的入门套件进行身份验证或通过 attempt 方法 手动对用户进行身份验证 时优雅地自动重新哈希用户密码。

通常，自动密码重哈希不应中断应用程序；但是，您可以通过发布 hashing 配置文件来禁用此行为：

php artisan config:publish hashing

一旦发布了配置文件，您可以将 rehash_on_login 配置值设置为 false 来禁用此行为：

'rehash_on_login' => false,

事件

在身份验证过程中，Laravel 会调度各种 事件。您可以为以下任何事件 定义监听器：

事件名称
Illuminate\Auth\Events\Registered
Illuminate\Auth\Events\Attempting
Illuminate\Auth\Events\Authenticated
Illuminate\Auth\Events\Login
Illuminate\Auth\Events\Failed
Illuminate\Auth\Events\Validated
Illuminate\Auth\Events\Verified
Illuminate\Auth\Events\Logout
Illuminate\Auth\Events\CurrentDeviceLogout
Illuminate\Auth\Events\OtherDeviceLogout
Illuminate\Auth\Events\Lockout
Illuminate\Auth\Events\PasswordReset