2023-07-26

通过 Laravel Sanctum 实现 PHP 安全验证

通过 Laravel Sanctum 实现 PHP 安全验证

概述:
在现代 Web 开发中,安全验证是一个至关重要的方面。Laravel Sanctum 是 Laravel 提供的一种简单且灵活的身份验证守卫,可以用于前后端分离的应用。本文将介绍如何使用 Laravel Sanctum 实现 PHP 安全验证,并提供相关的代码示例。

步骤一:安装 Laravel Sanctum

首先,在 Laravel 项目中安装 Sanctum 扩展包。可以使用 Composer 进行安装,运行以下命令:

composer require laravel/sanctum
登录后复制

步骤二:配置 Sanctum

安装完成后,需要对 Sanctum 进行配置。打开项目根目录下的 config/app.php 文件,找到 providers 数组,并添加以下代码:

'providers' => [

    // ...

    LaravelSanctumSanctumServiceProvider::class,

],
登录后复制

然后,运行以下命令来发布 Sanctum 的配置文件和数据库迁移文件:

php artisan vendor:publish --provider="LaravelSanctumSanctumServiceProvider"
登录后复制

接着,运行以下命令来执行数据库迁移:

php artisan migrate
登录后复制

步骤三:配置身份验证驱动程序

在设置过程中,需要选择使用 Sanctum 作为默认的身份验证驱动程序。打开 config/auth.php 文件,找到 guards 数组,并将默认的 guard 设置为 sanctum

'defaults' => [
    'guard' => 'sanctum',
    // ...
],
登录后复制

步骤四:启用 Sanctum 中间件

Sanctum 需要使用自己的中间件来处理身份验证。为了启用 Sanctum,需要将 Authenticate 中间件替换为 Sanctum 提供的中间件。打开 app/Http/Kernel.php 文件,将以下代码添加到 $routeMiddleware 数组中:

protected $routeMiddleware = [
    // ...
    'auth' => LaravelSanctumHttpMiddlewareEnsureFrontendRequestsAreStateful::class,
];
登录后复制

步骤五:生成 Sanctum API Token

Sanctum 提供了 API Token 来进行身份验证。API Token 可以通过以下代码来生成:

use LaravelSanctumHasApiTokens;

class User extends Authenticatable
{
    use HasApiTokens;
}
登录后复制

该代码在 User Model 中使用了 HasApiTokens trait 来为用户生成 API Token。

步骤六:保护路由

使用 Sanctum 进行安全验证后,可以通过以下代码来保护需要身份验证的路由:

Route::middleware('auth:sanctum')->group(function () {
    // 这里是需要保护的路由
});
登录后复制

以上代码将会应用 Sanctum 中间件来验证用户的 API Token。

步骤七:进行身份验证

当用户通过前端应用提交请求时,可以通过以下代码来进行身份验证:

use IlluminateHttpRequest;

Route::post('/login', function (Request $request) {
    $credentials = $request->only('email', 'password');
    
    if (Auth::attempt($credentials)) {
        $user = Auth::user();
        $token = $user->createToken('api')->plainTextToken;

        return response()->json([
            'user' => $user,
            'token' => $token,
        ]);
    } else {
        return response()->json(['error' => 'Unauthorized'], 401);
    }
});
登录后复制

以上代码将会通过用户提供的邮箱和密码来进行身份验证,并返回一个带有用户信息和 API Token 的 JSON 响应。

总结:
通过 Laravel Sanctum,我们可以轻松地实现 PHP 应用的安全验证。本文介绍了如何安装和配置 Laravel Sanctum,并提供了相关的代码示例。希望本文对于初学者能够有所帮助,并能启发更多人学习和使用 Laravel Sanctum。

参考链接:

  • [Laravel Sanctum GitHub 官方文档](https://github.com/laravel/sanctum)

以上就是通过 Laravel Sanctum 实现 PHP 安全验证的详细内容,更多请关注php中文网其它相关文章!

https://www.php.cn/faq/584015.html

发表回复

Your email address will not be published. Required fields are marked *