首页 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脱衣机

AI Hentai Generator

AI Hentai Generator

免费生成ai无尽的。

热门文章

R.E.P.O.能量晶体解释及其做什么(黄色晶体)
2 周前 By 尊渡假赌尊渡假赌尊渡假赌
仓库:如何复兴队友
1 个月前 By 尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island冒险:如何获得巨型种子
4 周前 By 尊渡假赌尊渡假赌尊渡假赌

热工具

记事本++7.3.1

记事本++7.3.1

好用且免费的代码编辑器

SublimeText3汉化版

SublimeText3汉化版

中文版,非常好用

禅工作室 13.0.1

禅工作室 13.0.1

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

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

SublimeText3 Mac版

SublimeText3 Mac版

神级代码编辑软件(SublimeText3)

PHP 与 Flutter 的比较:移动端开发的最佳选择 PHP 与 Flutter 的比较:移动端开发的最佳选择 May 06, 2024 pm 10:45 PM

PHP和Flutter是移动端开发的流行技术。Flutter胜在跨平台能力、性能和用户界面,适合需要高性能、跨平台和自定义UI的应用程序。PHP则适用于性能较低、不跨平台的服务器端应用程序。

PHP中如何使用对象-关系映射(ORM)简化数据库操作? PHP中如何使用对象-关系映射(ORM)简化数据库操作? May 07, 2024 am 08:39 AM

使用ORM可简化PHP中的数据库操作,它将对象映射到关系数据库中。Laravel中的EloquentORM允许使用面向对象的语法与数据库交互,可通过定义模型类、使用Eloquent方法或在实战中构建博客系统等方式来使用ORM。

PHP 单元测试工具的优缺点分析 PHP 单元测试工具的优缺点分析 May 06, 2024 pm 10:51 PM

PHP单元测试工具分析:PHPUnit:适用于大型项目,提供全面功能,易于安装,但可能冗长且速度较慢。PHPUnitWrapper:适合小型项目,易于使用,针对Lumen/Laravel优化,但功能受限,不提供代码覆盖率分析,社区支持有限。

Laravel - Artisan 命令 Laravel - Artisan 命令 Aug 27, 2024 am 10:51 AM

Laravel - Artisan 命令 - Laravel 5.7 提供了处理和测试新命令的新方法。它包括测试 artisan 命令的新功能,下面提到了演示?

Laravel和CodeIgniter的最新版本对比 Laravel和CodeIgniter的最新版本对比 Jun 05, 2024 pm 05:29 PM

Laravel9和CodeIgniter4的最新版本提供了更新的特性和改进。Laravel9采用MVC架构,提供数据库迁移、身份验证和模板引擎等功能。CodeIgniter4采用HMVC架构,提供路由、ORM和缓存。在性能方面,Laravel9的基于服务提供者设计模式和CodeIgniter4的轻量级框架使其具有出色的性能。在实际应用中,Laravel9适用于需要灵活性和强大功能的复杂项目,而CodeIgniter4适用于快速开发和小型应用程序。

Laravel 和 CodeIgniter 中数据处理能力的比较如何? Laravel 和 CodeIgniter 中数据处理能力的比较如何? Jun 01, 2024 pm 01:34 PM

比较Laravel和CodeIgniter的数据处理能力:ORM:Laravel使用EloquentORM,提供类对象关系映射,而CodeIgniter使用ActiveRecord,将数据库模型表示为PHP类的子类。查询构建器:Laravel具有灵活的链式查询API,而CodeIgniter的查询构建器更简单,基于数组。数据验证:Laravel提供了一个Validator类,支持自定义验证规则,而CodeIgniter的验证功能内置较少,需要手动编码自定义规则。实战案例:用户注册示例展示了Lar

PHP 代码单元测试与集成测试 PHP 代码单元测试与集成测试 May 07, 2024 am 08:00 AM

PHP单元和集成测试指南单元测试:关注单个代码单元或函数,使用PHPUnit创建测试用例类进行验证。集成测试:关注多个代码单元协同工作的情况,使用PHPUnit的setUp()和tearDown()方法设置和清理测试环境。实战案例:使用PHPUnit在Laravel应用中进行单元和集成测试,包括创建数据库、启动服务器以及编写测试代码。

Laravel 和 CodeIgniter 对于初学者来说哪一个更友好? Laravel 和 CodeIgniter 对于初学者来说哪一个更友好? Jun 05, 2024 pm 07:50 PM

对于初学者来说,CodeIgniter的学习曲线更平缓,功能较少,但涵盖了基本需求。Laravel提供了更广泛的功能集,但学习曲线稍陡。在性能方面,Laravel和CodeIgniter都表现出色。Laravel具有更广泛的文档和活跃的社区支持,而CodeIgniter更简单、轻量级,具有强大的安全功能。在建立博客应用程序的实战案例中,Laravel的EloquentORM简化了数据操作,而CodeIgniter需要更多的手动配置。

See all articles