您好,欢迎访问一九零五行业门户网

PHP开发:使用 Laravel Sanctum 实现 SPA 应用安全认证

laravel sanctum 是一个 laravel 框架官方推荐的轻量级用户认证库,它旨在为单页面应用程序(spa)和移动应用程序提供简单而现代的身份验证。本文将介绍如何使用 laravel sanctum 实现 spa 应用的安全认证。
一、安装 laravel
首先需要安装 laravel,可以通过 composer 安装最新版本的 laravel:
composer create-project --prefer-dist laravel/laravel your-project-name
二、配置 sanctum
安装好 laravel 之后需要进行 sanctum 的配置,请先执行以下命令:
composer require laravel/sanctum
在 laravel 5.5 以下版本中,需要在 config/app.php 文件中添加服务提供者和门面:
'providers' => [
...laravelsanctumsanctumserviceprovider::class,
],
'aliases' => [
...'sanctum' => laravelsanctumsanctum::class,
],
在 laravel 5.5 及以上版本中,无需手动添加服务提供者或门面。
接着需要执行数据库迁移以创建 sanctum 所需的表:
php artisan migrate
如果您的应用程序需要使用 spa 身份验证,则应在 config/cors.php 文件中添加您的应用程序域和信任的域。在下面的示例中,我们假设您正在构建一个具有前端应用程序的后端 api:
'paths' => ['api/*', 'sanctum/csrf-cookie'],
'allowed_methods' => ['*'],
'allowed_origins' => ['http://your-app-url.com'],
'allowed_origins_patterns' => [],
'allowed_headers' => ['*'],
'exposed_headers' => false,
'max_age' => false,
'supports_credentials' => true,
三、创建 api 和认证控制器
在 resources/views 中创建一个 index.blade.php 文件,用于显示 spa 界面。
在 routes/api.php 中编写 api 路由。我们这里创建一个测试路由,返回当前认证用户的用户信息:
route::middleware('auth:sanctum')->get('/user', function (request $request) {
return $request->user();

});
接下来,我们需要添加一个特定于 spa 应用程序的控制器,以创建和管理 sanctum 令牌。这个控制器负责创建令牌并为用户签发身份验证 cookie。
首先在 app/http/controllers 文件夹中创建一个 api 控制器,例如 authcontroller:
php artisan make:controller api/authcontroller
然后在 authcontroller 中添加 register 和 login 方法:
public function register(request $request)
{
$request->validate([ 'name' => 'required|string|max:255', 'email' => 'required|string|email|unique:users|max:255', 'password' => 'required|string|min:8|confirmed']);$user = new user([ 'name' => $request->name, 'email' => $request->email, 'password' => hash::make($request->password)]);$user->save();return response()->json([ 'message' => 'successfully registered'], 201);
}
public function login(request $request)
{
$request->validate([ 'email' => 'required|string|email', 'password' => 'required|string', 'remember_me' => 'boolean']);$credentials = request(['email', 'password']);if (!auth::attempt($credentials)) { return response()->json([ 'message' => 'unauthorized' ], 401);}$user = $request->user();$tokenresult = $user->createtoken('personal access token');$token = $tokenresult->token;if ($request->remember_me) { $token->expires_at = carbon::now()->addweeks(1);}$token->save();return response()->json([ 'access_token' => $tokenresult->accesstoken, 'token_type' => 'bearer', 'expires_at' => carbon::parse( $tokenresult->token->expires_at )->todatetimestring()]);
}
四、处理身份验证
现在,您已经拥有了创建 token、用户注册和用户登录的所有必要代码,下面我们将开始构建身份验证过程。
spa 应用程序使用 sanctum 发送 post 请求,通过 email 和 password 参数验证用户凭据。如果验证成功,则应用程序将接收到 oauth token。
使用 spa 应用程序时,在 headers 中添加 authorization: bearer <token>,可以通过应用程序路由访问受保护的 api。
完成身份验证后,您可以通过 sanctum 使用身份验证路由获得当前身份验证用户的信息。例如,我们可以使用以下代码检索当前身份验证用户的名称:
route::middleware('auth:sanctum')->get('/user', function (request $request) {
return $request->user()->name;
});
五、创建相关页面和组件
务必确保您的 laravel 入口点文件中包含必要的 javascript 库(这里使用 vue.js、vue router 和 axios)。在 resources/js/app.js 文件中,定义 vue 组件:
require('./bootstrap');
import vue from 'vue';
import app from './views/app';
import router from './router';
import store from './store';
vue.component('app', app);
const app = new vue({
el: '#app',router,store
});
创建资源文件夹 views 和 views/app.vue,添加必要的组件(登录表单、注册表单等)。在 views 文件夹中创建需要的所有页面组件。
这里为了演示方便,代码量略多,请自行查阅 laravel 官方文档。
六、重构 api 路由和 ackcontroller
更新 api 路由,将 spa 路由映射到 ackcontroller,同时确保中间件将使用 sanctum 配置:
route::middleware('auth:sanctum')->get('/user', function (request $request) {
return $request->user();

});
route::post('/register', 'apiauthcontroller@register');
route::post('/login', 'apiauthcontroller@login');
route::middleware('auth:sanctum')->get('/spa/{any}', function () {
return view('index');
})->where('any', '.*');
我们在 ackcontroller 中添加 forgotpassword 及 resetpassword 方法,用于处理用户忘记密码以及响应密码重置链接的请求:
public function forgotpassword(request $request)
{
$request->validate(['email' => 'required|email']);$user = user::where('email', $request->email)->first();if (!$user) { return response()->json([ 'message' => 'we could not find your account' ], 404);} else { $user->sendpasswordresetnotification($request->email);}return response()->json([ 'message' => 'we have e-mailed your password reset link!']);
}
public function resetpassword(request $request)
{
$request->validate([ 'email' => 'required|email', 'token' => 'required|string', 'password' => 'required|string|confirmed|min:8']);$resetpasswordstatus = password::reset($request->only('email', 'password', 'password_confirmation', 'token'), function ($user, $password) { $user->forcefill([ 'password' => hash::make($password) ])->save();});if ($resetpasswordstatus === password::invalid_token) { return response()->json(['message' => 'the reset token is invalid']);}return response()->json(['message' => 'your password has been updated']);
}
七、添加路由
在 laravel sanctum 中,需要配置路由以启用身份验证、csrf 保护和差错保护,使用 groban/laravel-livewire 实现 spa 应用的路由。
八、运行 spa 应用程序
完成以上步骤后,我们可以使用以下命令运行 spa 应用程序:
npm run dev
在浏览器中打开运行的设备上的主机 ip 地址或 url 来查看 spa 应用程序。
最后,我们已经成功地使用 laravel sanctum 实现了spa应用的安全认证。通过这种方法,可以确保应用程序数据的安全,防止未经授权的访问和保护私有信息。
以上就是php开发:使用 laravel sanctum 实现 spa 应用安全认证的详细内容。
其它类似信息

推荐信息