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

随着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
包容的幻想:解决偏远工作中的孤立和孤独感包容的幻想:解决偏远工作中的孤立和孤独感Apr 25, 2025 am 12:28 AM

Tocombatisolationandlonelinessinremotework,companiesshouldimplementregular,meaningfulinteractions,provideequalgrowthopportunities,andusetechnologyeffectively.1)Fostergenuineconnectionsthroughvirtualcoffeebreaksandpersonalsharing.2)Ensureremoteworkers

Laravel用于全堆栈开发:综合指南Laravel用于全堆栈开发:综合指南Apr 25, 2025 am 12:27 AM

laravelispularfullull-stackDevelopmentBecapeitOffersAsAseAseAseAseBlendOfbackendEdpoperandPowerandForterFlexibility.1)ITSbackEndCapaPabilities,sightifyDatabaseInteractions.2)thebladeTemplatingEngingEngineAllolowsLows

视频会议摊牌:为远程会议选择正确的平台视频会议摊牌:为远程会议选择正确的平台Apr 25, 2025 am 12:26 AM

选择视频会议平台的关键因素包括用户界面、安全性和功能。1)用户界面应直观,如Zoom。2)安全性需重视,MicrosoftTeams提供端到端加密。3)功能需匹配需求,GoogleMeet适合简短会议,CiscoWebex提供高级协作工具。

哪些数据库版本与最新的Laravel兼容?哪些数据库版本与最新的Laravel兼容?Apr 25, 2025 am 12:25 AM

最新版本的Laravel10与MySQL5.7及以上、PostgreSQL9.6及以上、SQLite3.8.8及以上、SQLServer2017及以上兼容。这些版本选择是因为它们支持Laravel的ORM功能,如MySQL5.7的JSON数据类型,提升了查询和存储效率。

将Laravel用作全栈框架的好处将Laravel用作全栈框架的好处Apr 25, 2025 am 12:24 AM

laravelisanexceltentchoiceforfull-stackdevelopmentduetoitsRobustFeaturesAndEsofuse.1)ITSImplifiesComplexComplextaskSwithitSmodernphpsyNtaxandToolSandToolSlikeBlikeforFront-Endandeloquentormquentormquentormforback-end.2)

Laravel的最新版本是什么?Laravel的最新版本是什么?Apr 24, 2025 pm 05:17 PM

Laravel10,releasedonFebruary7,2023,isthelatestversion.Itfeatures:1)Improvederrorhandlingwithanewreportmethodintheexceptionhandler,2)EnhancedsupportforPHP8.1featureslikeenums,and3)AnewLaravel\Promptspackageforinteractivecommand-lineprompts.

最新的Laravel版本如何简化开发?最新的Laravel版本如何简化开发?Apr 24, 2025 pm 05:01 PM

thelatestlaravelververversionenhancesdevelopmentwith:1)简化的inimpliticmodelbinding,2)增强EnhancedeloquentcapabibilitionswithNewqueryMethods和3)改善了supportorfortormodernphpfortornphpforternphpfeatureserslikenamedargenamedArgonedArgonsemandArgoctess,makecodingMoreftermeforefterMealiteFficeAndEnjoyaigaigaigaigaigaiganigaborabilyaboipaigyAndenjoyaigobyabory。

在哪里可以找到最新的Laravel版本的发行说明?在哪里可以找到最新的Laravel版本的发行说明?Apr 24, 2025 pm 04:53 PM

你可以在laravel.com/docs找到最新Laravel版本的发布说明。1)发布说明提供了新功能、错误修复和改进的详细信息。2)它们包含示例和解释,帮助理解新功能的应用。3)注意新功能的潜在复杂性和向后兼容性问题。4)定期审查发布说明可以保持更新并激发创新。

See all articles

热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

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

热工具

WebStorm Mac版

WebStorm Mac版

好用的JavaScript开发工具

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

适用于 Eclipse 的 SAP NetWeaver 服务器适配器

适用于 Eclipse 的 SAP NetWeaver 服务器适配器

将Eclipse与SAP NetWeaver应用服务器集成。

EditPlus 中文破解版

EditPlus 中文破解版

体积小,语法高亮,不支持代码提示功能

安全考试浏览器

安全考试浏览器

Safe Exam Browser是一个安全的浏览器环境,用于安全地进行在线考试。该软件将任何计算机变成一个安全的工作站。它控制对任何实用工具的访问,并防止学生使用未经授权的资源。