
最近,我在为一个新项目构建认证服务时,就遇到了这样的困境。我们需要在现有的Laravel Passport基础上,增加OpenID Connect的支持,以便我们的前端应用能够通过标准的OIDC流程获取用户信息,并实现更灵活的身份验证。最初,我考虑自己手动扩展Laravel Passport,但很快意识到这会是一个巨大的工程,不仅要深入理解OIDC的每一个细节,还要确保与OAuth2服务器的兼容性,并妥善处理密钥管理和安全问题。这无疑会大大拖慢开发进度,并增加潜在的风险。
正当我为此感到头疼时,我发现了 ronvanderheijden/openid-connect 这个Composer包。它简直是为解决我的问题量身定制的!这个库专门为 thephpleague/oauth2-server 提供了OpenID Connect的支持,并且完美兼容Laravel Passport,这让我眼前一亮。
ronvanderheijden/openid-connect 的魅力ronvanderheijden/openid-connect 的核心价值在于,它将OpenID Connect的复杂性封装起来,让我们可以像搭积木一样,在已有的OAuth2服务器上轻松添加OIDC功能。它通过扩展 league/oauth2-server 的 ResponseType 机制,在OAuth2授权流程中注入了生成和返回 id_token 的能力。
安装过程简单直接,只需一行Composer命令:
立即学习“PHP免费学习笔记(深入)”;
<code class="bash">composer require ronvanderheijden/openid-connect</code>
安装完成后,接下来就是配置密钥。OpenID Connect中的 id_token 是一个JSON Web Token (JWT),它需要使用私钥进行签名,并提供公钥供客户端验证。这个库对此也有清晰的指引:
<pre class="brush:php;toolbar:false;">mkdir -m 700 -p tmp openssl genrsa -out tmp/private.key 2048 openssl rsa -in tmp/private.key -pubout -out tmp/public.key chmod 600 tmp/private.key chmod 644 tmp/public.key
这些命令会生成一个2048位的RSA私钥和对应的公钥,并将它们保存在 tmp 目录下。私钥用于签名 id_token,公钥则用于客户端验证签名的合法性。
league/oauth2-server 为例)如果你直接使用 league/oauth2-server,集成过程也很直观:
<pre class="brush:php;toolbar:false;">use OpenIDConnect\Entities\IdentityRepository;
use OpenIDConnect\Grant\AuthCodeGrant;
use OpenIDConnect\IdTokenResponse;
use OpenIDConnect\Claims\ClaimExtractor;
use Lcobucci\JWT\Configuration;
use Lcobucci\JWT\Signer\Key\InMemory;
use Lcobucci\JWT\Signer\Rsa\Sha256;
use League\OAuth2\Server\AuthorizationServer;
use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
use League\OAuth2\Server\Repositories\ScopeRepositoryInterface;
use Nyholm\Psr7\Factory\ServerRequestFactory;
use OpenIDConnect\Services\CurrentRequestService;
// ... (你的其他仓库和密钥配置) ...
$privateKeyPath = 'tmp/private.key';
$encryptionKey = 'def00000e700b08088b90b9b3921588669e4695027581b0a85233e7920786520b22a075308696d07e9d7240f9599554a9d7240f9599554a9'; // 示例加密密钥
$currentRequestService = new CurrentRequestService();
$currentRequestService->setRequest(ServerRequestFactory::fromGlobals());
// 创建 OpenID Connect 响应类型
$responseType = new IdTokenResponse(
new IdentityRepository(), // 你的 Identity 仓库
new ClaimExtractor(),
Configuration::forSymmetricSigner(
new Sha256(),
InMemory::file($privateKeyPath),
),
$currentRequestService,
$encryptionKey,
);
$server = new AuthorizationServer(
$clientRepository,
$accessTokenRepository,
$scopeRepository,
$privateKeyPath, // 用于 OAuth2 的私钥路径
$encryptionKey, // 用于 OAuth2 的加密密钥
$responseType // 注入 OpenID Connect 响应类型
);
// 如果需要 Nonce 支持,记得使用 OpenIDConnect\Grant\AuthCodeGrant
$server->enableGrantType(new AuthCodeGrant($userRepository, $authCodeRepository, $this->app->make(IdentityRepository::class), new \DateInterval('PT10M')), new \DateInterval('PT1H'));现在,当客户端在授权请求中包含 openid scope时,服务器就会在响应中返回一个 id_token。如果你还提供了 profile 或 email 等其他OIDC标准scope,id_token 中还会包含相应的声明(claims),如用户的姓名、邮箱等。
对于广大的Laravel开发者来说,这个库的集成更是无缝。它提供了专门的Laravel服务提供者,大大简化了配置:
1. 添加服务提供者:
在 config/app.php 中添加:
<pre class="brush:php;toolbar:false;">// config/app.php
'providers' => [
// ... 其他服务提供者
OpenIDConnect\Laravel\PassportServiceProvider::class,
],2. 创建身份实体:
为了让 id_token 包含用户的额外信息(如邮箱),你需要创建一个 IdentityEntity 类,用于从你的 User 模型中收集这些“声明”(claims)。
<pre class="brush:php;toolbar:false;">// app/Entities/IdentityEntity.php
namespace App\Entities;
use App\Models\User; // 假设你的用户模型是 App\Models\User
use League\OAuth2\Server\Entities\Traits\EntityTrait;
use OpenIDConnect\Claims\Traits\WithClaims;
use OpenIDConnect\Interfaces\IdentityEntityInterface;
class IdentityEntity implements IdentityEntityInterface
{
use EntityTrait;
use WithClaims;
protected User $user;
public function setIdentifier($identifier): void
{
$this->identifier = $identifier;
$this->user = User::findOrFail($identifier);
}
public function getClaims(): array
{
return [
'email' => $this->user->email,
'name' => $this->user->name, // 示例:添加用户姓名
// ... 其他你希望包含在 id_token 中的声明
];
}
}通过 php artisan vendor:publish --tag=openid 命令,你还可以发布配置文件,进一步定制scope、claim集或仓库。
更棒的是,这个包还自动为Laravel Passport提供了OpenID Connect的 发现(Discovery) 和 JWKS(JSON Web Key Set) 端点,这对于OIDC客户端来说是至关重要的,它们可以通过这些端点自动获取认证服务器的信息和公钥,实现自动配置。
/.well-known/openid-configuration
/oauth/jwks
使用 ronvanderheijden/openid-connect 解决OIDC集成问题,带来了诸多显著优势:
通过集成 ronvanderheijden/openid-connect,我们的项目不仅成功实现了OpenID Connect认证,还显著提升了开发效率和系统的安全性。它让我们能够轻松地为用户提供更现代、更安全的认证体验。如果你也在为PHP应用集成OpenID Connect而烦恼,强烈推荐你尝试这个强大的Composer包!
以上就是如何为PHP应用快速集成OpenIDConnect?使用ronvanderheijden/openid-connect和Composer轻松实现安全认证。的详细内容,更多请关注php中文网其它相关文章!
PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号