认证
简介
许多 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 得以实现,对于将提供第一方 Web UI 以及 API,或由独立于后端 Laravel 应用程序的单页应用程序 (SPA) 驱动,或提供移动客户端的应用程序,Sanctum 应被视为首选和推荐的认证包。
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 应用程序的快速方法,该应用程序已经使用了我们首选的 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): void {
$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): void {
$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 方法的数组中。例如,我们可以验证用户是否被标记为“active”:
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,也不会调度 Login 事件:
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 基础认证
您也可以使用 HTTP 基础认证,而不在会话中设置用户标识 Cookie。如果您选择使用 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 中间件包含在应接收会话身份验证的路由上。通常,您应该将此中间件放在路由组定义中,以便它可以应用于应用程序的大部分路由。默认情况下,AuthenticateSession 中间件可以使用 auth.session 中间件别名附加到路由:
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;
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 配置中将其配置为驱动程序:
'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() 的值与 $credentials['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。bcrypt 哈希的“工作因子”可以通过应用程序的 config/hashing.php 配置文件或 BCRYPT_ROUNDS 环境变量进行调整。
通常,随着 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 |
Illuminate\Auth\Events\PasswordResetLinkSent |