身份验证
简介
许多 Web 应用程序都为其用户提供了一种通过应用程序进行身份验证和“登录”的方式。在 Web 应用程序中实现此功能可能是一项复杂且有潜在风险的工作。因此,Laravel 致力于为您提供快速、安全且轻松地实现身份验证所需的工具。
Laravel 的身份验证设施的核心由“守卫”和“提供者”组成。守卫定义了每个请求如何验证用户身份。例如,Laravel 附带一个 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 模型。此模型可以与默认的 Eloquent 身份验证驱动程序一起使用。
如果您的应用程序未使用 Eloquent,则可以使用使用 Laravel 查询构建器的 database
身份验证提供程序。如果您的应用程序正在使用 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 Breeze、Laravel Jetstream 和 Laravel Fortify。
Laravel Breeze 是 Laravel 所有身份验证功能的简单、最小的实现,包括登录、注册、密码重置、电子邮件验证和密码确认。Laravel Breeze 的视图层由简单的 Blade 模板组成,这些模板使用 Tailwind CSS 样式化。要开始使用,请查看有关 Laravel 应用程序入门套件的文档。
Laravel Fortify 是一个 Laravel 的无头身份验证后端,它实现了本文档中介绍的许多功能,包括基于 Cookie 的身份验证以及其他功能,如双因素身份验证和电子邮件验证。Fortify 为 Laravel Jetstream 提供身份验证后端,也可以与 Laravel Sanctum 结合使用,以提供需要使用 Laravel 进行身份验证的 SPA 的身份验证。
Laravel Jetstream 是一个强大的应用程序入门套件,它使用 Tailwind CSS、Livewire 和/或 Inertia 提供的美观、现代的 UI 来使用和公开 Laravel Fortify 的身份验证服务。Laravel Jetstream 包括对双因素身份验证、团队支持、浏览器会话管理、个人资料管理的可选支持,并与 Laravel Sanctum 集成,以提供 API 令牌身份验证。下面讨论 Laravel 的 API 身份验证产品。
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 Sanctum 是我们选择包含在 Laravel Jetstream 应用程序入门套件中的 API 软件包,因为我们认为它最适合大多数 Web 应用程序的身份验证需求。
总结和选择您的技术栈
总而言之,如果您的应用程序将通过浏览器访问,并且您正在构建一个单体 Laravel 应用程序,那么您的应用程序将使用 Laravel 内置的身份验证服务。
接下来,如果您的应用程序提供将由第三方使用的 API,您将在 Passport 或 Sanctum 之间进行选择,以提供应用程序的 API 令牌身份验证。通常,应尽可能首选 Sanctum,因为它是一个简单、完整的 API 身份验证解决方案,包括对“范围”或“能力”的支持,适用于 SPA 身份验证和移动身份验证。
如果您正在构建一个由 Laravel 后端提供支持的单页应用程序 (SPA),则应使用 Laravel Sanctum。使用 Sanctum 时,您需要 手动实现您自己的后端身份验证路由,或者利用 Laravel Fortify 作为无头身份验证后端服务,该服务为注册、密码重置、电子邮件验证等功能提供路由和控制器。
当您的应用程序绝对需要 OAuth2 规范提供的所有功能时,可以选择 Passport。
并且,如果您想快速入门,我们很高兴推荐 Laravel Breeze,作为启动一个已经使用我们首选的 Laravel 内置身份验证服务和 Laravel Sanctum 身份验证技术栈的新 Laravel 应用程序的快速方法。
身份验证快速入门
本文档的这一部分讨论通过 Laravel 应用程序入门套件验证用户身份,其中包括 UI 脚手架以帮助您快速入门。如果您想直接与 Laravel 的身份验证系统集成,请查看有关手动验证用户的文档。
安装入门套件
首先,您应该 安装 Laravel 应用程序入门套件。我们当前的入门套件 Laravel Breeze 和 Laravel Jetstream 为将身份验证集成到您的新 Laravel 应用程序中提供了设计精美的起点。
Laravel Breeze 是 Laravel 所有身份验证功能的最小、简单的实现,包括登录、注册、密码重置、电子邮件验证和密码确认。Laravel Breeze 的视图层由使用 Tailwind CSS 样式化的简单 Blade 模板组成。此外,Breeze 还基于 Livewire 或 Inertia 提供脚手架选项,可以选择使用 Vue 或 React 进行基于 Inertia 的脚手架。
Laravel Jetstream 是一个更强大的应用程序入门套件,它包括支持使用 Livewire 或 Inertia 和 Vue 为您的应用程序搭建脚手架。此外,Jetstream 还具有对双因素身份验证、团队、个人资料管理、浏览器会话管理、通过 Laravel Sanctum 的 API 支持、帐户删除等功能的可选支持。
检索已验证的用户
安装身份验证入门套件并允许用户注册并使用您的应用程序进行身份验证后,您通常需要与当前已验证的用户进行交互。在处理传入请求时,您可以通过 Auth
外观的 user
方法访问已验证的用户。
use Illuminate\Support\Facades\Auth; // Retrieve the currently authenticated user...$user = Auth::user(); // Retrieve the currently authenticated user's 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{ /** * Update the flight information for an existing flight. */ public function update(Request $request): RedirectResponse { $user = $request->user(); // ... return redirect('/flights'); }}
确定当前用户是否已通过身份验证
要确定发出传入 HTTP 请求的用户是否已通过身份验证,您可以使用 Auth
外观上的 check
方法。如果用户已通过身份验证,此方法将返回 true
。
use Illuminate\Support\Facades\Auth; if (Auth::check()) { // The user is logged in...}
即使可以使用 check
方法确定用户是否已通过身份验证,您通常会使用中间件来验证用户是否已通过身份验证,然后再允许用户访问某些路由/控制器。要了解有关此的更多信息,请查看有关保护路由的文档。
保护路由
路由中间件可用于仅允许已验证的用户访问给定路由。Laravel 自带一个 auth
中间件,它是 Illuminate\Auth\Middleware\Authenticate
类的 中间件别名。由于此中间件已在 Laravel 内部别名,因此您只需将中间件附加到路由定义即可。
Route::get('/flights', function () { // Only authenticated users may access this route...})->middleware('auth');
重定向未通过身份验证的用户
当 auth
中间件检测到未通过身份验证的用户时,它会将用户重定向到 login
命名路由。您可以使用应用程序的 bootstrap/app.php
文件中的 redirectGuestsTo
方法修改此行为。
use Illuminate\Http\Request; ->withMiddleware(function (Middleware $middleware) { $middleware->redirectGuestsTo('/login'); // Using a closure... $middleware->redirectGuestsTo(fn (Request $request) => route('login'));})
指定保护
将 auth
中间件附加到路由时,您还可以指定应使用哪个“保护”来验证用户身份。指定的保护应与您的 auth.php
配置文件中的 guards
数组中的一个键相对应。
Route::get('/flights', function () { // Only authenticated users may access this route...})->middleware('auth:admin');
登录节流
如果您使用的是 Laravel Breeze 或 Laravel Jetstream 入门套件,则速率限制将自动应用于登录尝试。默认情况下,如果用户多次尝试后未能提供正确的凭据,则他们将无法登录一分钟。限制对用户的用户名/电子邮件地址及其 IP 地址都是唯一的。
如果您想在应用程序中限制其他路由的速率,请查看速率限制文档。
手动验证用户
您不需要使用 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{ /** * Handle an authentication attempt. */ 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' => 'The provided credentials do not match our records.', ])->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])) { // Authentication was successful...}
对于复杂的查询条件,您可以在凭据数组中提供一个闭包。这个闭包将在查询实例上被调用,允许您根据应用程序的需求自定义查询。
use Illuminate\Database\Eloquent\Builder; if (Auth::attempt([ 'email' => $email, 'password' => $password, fn (Builder $query) => $query->has('activeSubscription'),])) { // Authentication was successful...}
在这些示例中,email
不是必需的选项,它仅用作示例。您应该使用与数据库表中“用户名”对应的任何列名。
attemptWhen
方法,它接收一个闭包作为其第二个参数,可用于在实际验证用户之前对潜在用户进行更广泛的检查。该闭包接收潜在用户,并应返回 true
或 false
以指示是否可以验证该用户。
if (Auth::attemptWhen([ 'email' => $email, 'password' => $password,], function (User $user) { return $user->isNotBanned();})) { // Authentication was successful...}
访问特定的 Guard 实例
通过 Auth
门面的 guard
方法,您可以指定在验证用户时要使用的 guard 实例。这允许您使用完全不同的可验证模型或用户表来管理应用程序不同部分的身份验证。
传递给 guard
方法的 guard 名称应与您 auth.php
配置文件中配置的 guard 之一相对应。
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)) { // The user is being remembered...}
如果您的应用程序提供“记住我”功能,您可以使用 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
方法之前指定一个身份验证 guard。
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 () { // Only authenticated users may access this route...})->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{ /** * Handle an incoming request. * * @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 () { // Only authenticated users may access this route...})->middleware(AuthenticateOnceWithBasicAuth::class);
注销
要手动注销应用程序的用户,可以使用 Auth
门面提供的 logout
方法。这将从用户的会话中删除身份验证信息,以便后续请求不会被身份验证。
除了调用 logout
方法之外,还建议您使用户的会话无效并重新生成他们的 CSRF 令牌。注销用户后,您通常会将用户重定向到应用程序的根目录。
use Illuminate\Http\Request;use Illuminate\Http\RedirectResponse;use Illuminate\Support\Facades\Auth; /** * Log the user out of the application. */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
方法时,用户的其他会话将被完全无效化,这意味着他们将“注销”他们先前验证过的所有 guard。
密码确认
在构建应用程序时,您可能偶尔会有一些操作需要用户在执行操作之前或在用户被重定向到应用程序的敏感区域之前确认其密码。Laravel 包含内置的中间件,使此过程变得轻而易举。实现此功能将需要您定义两个路由:一个路由显示一个视图,要求用户确认其密码,另一个路由确认密码有效并将用户重定向到其预期的目的地。
以下文档讨论了如何直接与 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' => ['The provided password does not match our records.'] ]); } $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
方法来定义自己的身份验证 guard。您应该在服务提供者中调用 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{ // ... /** * Bootstrap any application services. */ public function boot(): void { Auth::extend('jwt', function (Application $app, string $name, array $config) { // Return an instance of Illuminate\Contracts\Auth\Guard... return new JwtGuard(Auth::createUserProvider($config['provider'])); }); }}
如上面的示例所示,传递给 extend
方法的回调应返回 Illuminate\Contracts\Auth\Guard
的实现。此接口包含一些您需要实现以定义自定义 guard 的方法。定义自定义 guard 后,您可以在 auth.php
配置文件的 guards
配置中引用该 guard。
'guards' => [ 'api' => [ 'driver' => 'jwt', 'provider' => 'users', ],],
闭包请求守卫
实现基于 HTTP 请求的自定义身份验证系统的最简单方法是使用 Auth::viaRequest
方法。此方法允许您使用单个闭包快速定义身份验证过程。
要开始使用,请在应用程序的 AppServiceProvider
的 boot
方法中调用 Auth::viaRequest
方法。viaRequest
方法接受身份验证驱动程序名称作为其第一个参数。此名称可以是描述您的自定义 guard 的任何字符串。传递给该方法的第二个参数应该是一个闭包,该闭包接收传入的 HTTP 请求并返回用户实例,如果身份验证失败,则返回 null
。
use App\Models\User;use Illuminate\Http\Request;use Illuminate\Support\Facades\Auth; /** * Bootstrap any application services. */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', ],],
最后,您可以在将身份验证中间件分配给路由时引用 guard。
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{ // ... /** * Bootstrap any application services. */ public function boot(): void { Auth::provider('mongo', function (Application $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); public function rehashPasswordIfRequired(Authenticatable $user, array $credentials, bool $force = false);}
retrieveById
函数通常接收一个表示用户的键,例如 MySQL 数据库中的自增 ID。该方法应检索并返回与该 ID 匹配的 Authenticatable
实现。
retrieveByToken
函数通过其唯一的 $identifier
和“记住我” $token
(通常存储在数据库列中,如 remember_token
)检索用户。与上一个方法一样,此方法应返回具有匹配 token 值的 Authenticatable
实现。
updateRememberToken
方法使用新的 $token
更新 $user
实例的 remember_token
。在成功“记住我”身份验证尝试或用户注销时,会为用户分配新的 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。可以通过应用程序的 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 |