首页 php框架 Laravel Laravel开发:如何使用Laravel Passport实现API OAuth2身份验证?

Laravel开发:如何使用Laravel Passport实现API OAuth2身份验证?

Jun 13, 2023 pm 11:13 PM
laravel oauth passport

随着API的使用逐渐普及,保护API的安全性和可扩展性变得越来越关键。而OAuth2已经成为了一种广泛采用的API安全协议,它允许应用程序通过授权来访问受保护的资源。为了实现OAuth2身份验证,Laravel Passport提供了一种简单、灵活的方式。在本篇文章中,我们将学习如何使用Laravel Passport实现API OAuth2身份验证。

Laravel Passport是官方提供的一个OAuth2服务器库,可以轻松地添加OAuth2身份验证到您的Laravel应用程序中。它针对Laravel框架的客户端提供了API身份验证,通过token来保护API并限制资源的访问。通过很少的配置步骤,你可以创建一个安全的OAuth2服务器并为你的API提供身份验证和授权。

为了开始使用Laravel Passport,你需要安装它。你可以通过Composer包管理器安装它:

composer require laravel/passport
登录后复制

一旦你安装了Laravel Passport,你需要运行migrations来创建必要的数据库表:

php artisan migrate
登录后复制

为了启用Laravel Passport,你需要注册ServiceProvider和中间件。在config/app.php文件中添加以下ServiceProvider和中间件:

'providers' => [
    // ...
    LaravelPassportPassportServiceProvider::class,
],

'middleware' => [
    // ...
    LaravelPassportHttpMiddlewareCreateFreshApiToken::class,
],
登录后复制

Laravel Passport需要一个用于发行access token和refresh token的“keys”表。运行以下命令将生成此表:

php artisan passport:install
登录后复制

这会创建一个加密的RSA秘钥对用于签署和验证tokens,以及一个名为“personal_access_client”的客户端和一个名为“password_client”的客户端。这两个客户端用于创建不同类型的tokens。第一个客户端用于生成个人访问tokens,这些tokens允许客户端访问任何以OAuth2身份验证方式保护的API端点。第二个客户端用于创建密码授权tokens,这些tokens允许客户端通过用户名和密码获取access token。

在这个过程中,你还需要在你的config/auth.php文件中配置Laravel Passport。你需要将passport驱动器添加到API守卫,以便Laravel Passport来处理一切与OAuth2相关的东西。示例如下:

'guards' => [
    // ...
    'api' => [
        'driver' => 'passport',
        'provider' => 'users',
    ],
],
登录后复制

现在我们已经完成了设置,我们可以开始创建API路由和控制器了。

首先,你需要定义API路由。例如,假设你有一个API端点来获取一个任务列表:

Route::get('/tasks', 'TaskController@index')->middleware('auth:api');
登录后复制

接下来,你需要创建一个控制器来处理请求并响应任务:

class TaskController extends Controller
{
    public function index()
    {
        $tasks = Task::all();

        return response()->json([
            'tasks' => $tasks,
        ]);
    }
}
登录后复制

在middleware方法中加入“auth:api”参数以指示我们使用API守卫来保护路由。

现在让我们看看如何执行OAuth2身份验证并获得access token。你需要创建一个客户端,该客户端将使用密码授权OAuth2 flow来获得access token。这样你就可以通过API请求在API端点上进行身份验证了。

你可以在Laravel Passport的客户端列表中创建一个新客户端,或者在你的代码中使用Passport::client()方法为客户端生成一个随机的client id和client secret。你可以将client id和client secret保存在你的.env文件或你可以在你的Passport::client()方法中直接提供它们。此方法将创建一个新的客户端,并返回client id和client secret:

use LaravelPassportClient;
use IlluminateSupportFacadesDB;

$client = $this->createClient();

public function createClient()
{
    $client = Client::forceCreate([
        'user_id' => null,
        'name' => 'Test Client',
        'secret' => str_random(40),
        'redirect' => '',
        'personal_access_client' => false,
        'password_client' => true,
        'revoked' => false,
    ]);

    DB::table('oauth_client_grants')->insert([
        'client_id' => $client->id,
        'grant_id' => 1,
    ]);

    return $client;
}
登录后复制

现在我们已经有了一个客户端,我们需要在控制器中使用Laravel Passport来获取access token并使用它来访问受保护的API端点。我们需要使用以下代码在控制器中实现OAuth2身份验证:

use IlluminateSupportFacadesAuth;
use LaravelPassportClientRepository;

class TaskController extends Controller
{
    protected $clients;
    
    public function __construct(ClientRepository $clients)
    {
        $this->clients = $clients;
    }

    public function index()
    {
        $client = $this->clients->find(2);

        $response = $this->actingAsClient($client, function () {
            return $this->get('/api/tasks');
        });

        return $response->getContent();
    }

    protected function actingAsClient($client, $callback, $scopes = [])
    {
        $proxy = new LaravelPassportHttpControllersAccessTokenController();

        $token = $proxy->issueToken(
            $this->getPersonalAccessTokenRequest($client, $scopes)
        );

        Auth::guard('web')->loginUsingId($client->user_id);

        $callback($token);

        return $this->app->make(IlluminateHttpRequest::class);
    }

    protected function getPersonalAccessTokenRequest($client, $scopes = [])
    {
        $data = [
            'grant_type' => 'client_credentials',
            'client_id' => $client->id,
            'client_secret' => $client->secret,
            'scope' => implode(' ', $scopes),
        ];

        return IlluminateHttpRequest::create('/oauth/token', 'POST', $data);
    }
}
登录后复制

使用actingAsClient()方法,我们可以模拟以客户端身份运行请求,控制器中的任何方法都可以使用该方法进行OAuth2身份验证。我们需要传递一个客户端对象,一个回调函数以执行API请求,并可选地传递添加到请求中的权限。

现在我们已经完成了Laravel Passport的OAuth2身份验证配置,通过使用上述代码模式,我们可以轻松地在我们的API端点上实现安全的OAuth2身份验证。 Passport是一个相对较新的项目。但是,它是与Laravel完美集成的,并且提供了多种OAuth2身份验证服务,使您能够轻松地向您的API添加身份验证和授权。如果你在运行一个Laravel应用程序并需要添加OAuth2身份验证,Laravel Passport是实现此目的的理想选择。

以上是Laravel开发:如何使用Laravel Passport实现API OAuth2身份验证?的详细内容。更多信息请关注PHP中文网其他相关文章!

本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Clothoff.io

Clothoff.io

AI脱衣机

Video Face Swap

Video Face Swap

使用我们完全免费的人工智能换脸工具轻松在任何视频中换脸!

热工具

记事本++7.3.1

记事本++7.3.1

好用且免费的代码编辑器

SublimeText3汉化版

SublimeText3汉化版

中文版,非常好用

禅工作室 13.0.1

禅工作室 13.0.1

功能强大的PHP集成开发环境

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

SublimeText3 Mac版

SublimeText3 Mac版

神级代码编辑软件(SublimeText3)

在Laravel中如何获取邮件发送失败时的退信代码? 在Laravel中如何获取邮件发送失败时的退信代码? Apr 01, 2025 pm 02:45 PM

Laravel邮件发送失败时的退信代码获取方法在使用Laravel开发应用时,经常会遇到需要发送验证码的情况。而在实�...

Laravel计划任务不执行:schedule:run命令后任务未运行怎么办? Laravel计划任务不执行:schedule:run命令后任务未运行怎么办? Mar 31, 2025 pm 11:24 PM

Laravel计划任务运行无响应排查在使用Laravel的计划任务调度时,不少开发者会遇到这样的问题:schedule:run...

在 Laravel 中,如何处理邮件发送验证码失败的情况? 在 Laravel 中,如何处理邮件发送验证码失败的情况? Mar 31, 2025 pm 11:48 PM

Laravel邮件发送验证码失败时的处理方法在使用Laravel...

在dcat admin中如何实现点击添加数据的自定义表格功能? 在dcat admin中如何实现点击添加数据的自定义表格功能? Apr 01, 2025 am 07:09 AM

在dcatadmin(laravel-admin)中如何实现自定义点击添加数据的表格功能在使用dcat...

Laravel - 转储服务器 Laravel - 转储服务器 Aug 27, 2024 am 10:51 AM

Laravel - 转储服务器 - Laravel 转储服务器随 Laravel 5.7 版本一起提供。以前的版本不包括任何转储服务器。转储服务器将成为 laravel/laravel Composer 文件中的开发依赖项。

Laravel Redis连接共享:为何select方法会影响其他连接? Laravel Redis连接共享:为何select方法会影响其他连接? Apr 01, 2025 am 07:45 AM

Laravel框架中Redis连接的共享与select方法的影响在使用Laravel框架和Redis时,开发者可能会遇到一个问题:通过配置...

Laravel多租户扩展stancl/tenancy:如何自定义租户数据库连接的主机地址? Laravel多租户扩展stancl/tenancy:如何自定义租户数据库连接的主机地址? Apr 01, 2025 am 09:09 AM

在Laravel多租户扩展包stancl/tenancy中自定义租户数据库连接使用Laravel多租户扩展包stancl/tenancy构建多租户应用时,...

Laravel - 操作 URL Laravel - 操作 URL Aug 27, 2024 am 10:51 AM

Laravel - Action URL - Laravel 5.7 引入了一项名为“可调用操作 URL”的新功能。此功能类似于 Laravel 5.6 中的功能,即在操作方法中接受字符串。 Laravel 5.7 引入新语法的主要目的是直接

See all articles