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

37402023-06-13 23:24:49

随着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是实现此目的的理想选择。