广告:宝塔Linux面板高效运维的服务器管理软件 点击【 https://www.bt.cn/p/uNLv1L 】立即购买
随着RESTful API的普及和应用的广泛使用,越来越多的应用程序需要对API进行身份验证和授权,因此API安全性已成为当今软件开发中极其重要的一个方面。Laravel Sanctum是Laravel 7.0引入的开箱即用的轻量级身份验证系统,它旨在让API身份验证变得简单而安全。在本篇文章中,我们将介绍如何在Laravel中使用Sanctum来保证API的安全性。
安装Laravel Sanctum在开始之前,我们需要确认已经安装好Laravel 7.0+版本。然后我们可以使用composer安装Laravel Sanctum依赖:
composer require laravel/sanctum登录后复制
安装完Sanctum之后,在config/app.php
文件中加入以下代码:
'providers' => [ // ... LaravelSanctumSanctumServiceProvider::class,],'aliases' => [ //... 'Sanctum' => LaravelSanctumSanctum::class,]登录后复制
这样,Laravel应用程序就已经使用了Sanctum提供的服务和功能。
配置数据库接下来,在执行数据库迁移之前,我们需要设置Sanctum的数据库表。 Larave lSanctum默认提供了一个包含以下字段的personal_access_tokens
数据库表:
id
:令牌的唯一标识符tokenable_type
:与令牌关联的模型的类名tokenable_id
:与令牌关联的模型的IDname
:令牌的名称token
:API令牌的值abilities
:令牌的授权在创建personal_access_tokens
表之前,我们需要先创建模型关系。可以通过在AuthServiceProvider
中注册以下内容来完成:
use LaravelSanctumSanctum;//...public function boot(){ $this->registerPolicies(); Sanctum::ignoreMigrations(); Sanctum::actingAs( null, [ 'superuser' ]);}登录后复制
Sanctum::ignoreMigrations()
用于阻止Laravel在artisan migrate
命令中执行Sanctum的数据库迁移文件。但是,在大多数情况下,我们只是将其添加到数据库迁移文件的命令中。Sanctum::actingAs()
还提供了一种仅用于开发的方法,该方法在没有用户身份验证的情况下模拟用户身份。
然后,我们需要运行以下命令来创建personal_access_tokens
表:
php artisan migrate登录后复制创建API令牌
Laravel Sanctum为我们提供了两种方式来为API生成令牌。一种是CreateToken
方法,该方法可以创建一个或多个包含可选名称和授予权限的API令牌。这里我们介绍第二种方法,即使用hasApiTokens()
函数配合createToken()
函数:
// use the HasApiTokens trait within your User Modeluse LaravelSanctumHasApiTokens;class User extends Authenticatable{ use HasApiTokens, Notifiable; // ...}// create a Token with User ID and given Abilities$personalAccessToken = $user->createToken('API Token', ['server:get','server:post']);登录后复制
这里我们在用户模型中使用了HasApiTokens
Trait,以便在用户模型中实现API令牌功能。我们使用createToken
方法来创建一个API令牌,并在创建令牌时指定了一个可选的名称和授权的权限键。
有了API密钥,我们就可以将其注入到每个请求中以进行身份验证。我们可以在Laravel的路由文件中使用sanctum
中间件来保护API路由,以便验证请求中的令牌:
// A Group of API routes that require a valid TokenRoute::group(['middleware' => 'auth:sanctum'], function () { Route::get('/user', function (Request $request) { return $request->user(); });});登录后复制
在这段代码中,我们定义了一个包含验证sanctum
中间件的路由组。 路由组中包含一条路由,该路由仅需要一个有效的Token才能访问。
使用Bearer
令牌是通过HTTP Authorization
头来发送API令牌的最常见方法。可以通过在请求头中加入Authorization: Bearer {{$personalAccessToken->plainTextToken}}
来授权令牌:
curl -H "Authorization: Bearer xxxxx" http://example.com/api/user登录后复制撤销API令牌
最后,我们需要了解如何撤销API令牌。我们可以使用tokens()->delete()
函数来删除某个用户的所有API令牌,或使用revoke()
函数来撤销单个API令牌:
$user->tokens()->delete();$personalAccessToken->revoke();登录后复制
结束语
现在我们已经成功地实现了Sanctum身份验证来保护我们的API。Sanctum和Laravel提供了简单而强大的API身份验证,这使得开发人员可以专注于构建强大的API,并将主要的关注点放在业务逻辑上。在使用Sanctum时,强烈建议您仔细阅读官方文档,这样您就可以全面了解API的身份验证过程,并确保应用程序具有最高的安全性。
以上就是Laravel开发:如何使用Laravel Sanctum实现API身份验证?的详细内容,更多请关注9543建站博客其它相关文章!
发表评论