当前位置:

首页 > 编程开发 > Laravel验证JWT RS256与JWKS教程

Laravel验证JWT RS256与JWKS教程

本教程将指导您如何在Laravel应用中验证来自外部身份提供商的RS256签名JWT。我们将利用tymondesigns/jwt-auth包,通过配置JWKS获取的公钥、实现自定义认证守卫(Guard)来处理令牌解析与签名验证,并将其无缝集成到Laravel的认证体系中,从而确保API请求的安全性。

本文目录

    在Laravel中验证第三方JWT(RS256 & JWKS)的教程

    本教程将指导您如何在Laravel应用中验证来自外部身份提供商的RS256签名JWT。我们将利用tymondesigns/jwt-auth包,通过配置JWKS获取的公钥、实现自定义认证守卫(Guard)来处理令牌解析与签名验证,并将其无缝集成到Laravel的认证体系中,从而确保API请求的安全性。

    在现代微服务架构和单页应用(SPA)中,使用外部身份提供商(IdP)进行用户认证已成为常见模式。用户通过IdP认证后会获得一个Access Token(通常是JWT),后端API服务需要验证这个JWT以授权访问。本教程将详细介绍如何在Laravel应用中,利用tymondesigns/jwt-auth包以及自定义认证守卫,高效且安全地验证来自第三方IdP的RS256签名的JWT。

    1. 获取并配置JWT公钥

    验证RS256签名的JWT需要对应的公钥。外部身份提供商通常会通过一个JWKS(JSON Web Key Set)URL(例如 https://{domain}/.well-known/jwks.json)公开其公钥。您需要从这个JWKS URL获取相应的公钥,并将其保存为PEM格式的文件。

    步骤:

    1. 从JWKS URL获取公钥: 访问您的IdP提供的JWKS URL。通常,JWKS是一个JSON数组,包含一个或多个JSON Web Key (JWK) 对象。您需要根据JWT头部的kid(Key ID)或其他标识符找到匹配的公钥。将JWK中的n(modulus)和e(exponent)字段转换为PEM格式的RSA公钥。市面上有一些工具或库可以帮助您完成这个转换,例如PHP的phpseclib或在线JWK转PEM工具。

    2. 保存公钥文件: 将转换后的PEM格式公钥保存到Laravel项目的安全位置,例如 storage/jwt/public.pem。

    3. 配置tymondesigns/jwt-auth: 修改config/jwt.php配置文件,指定公钥文件的路径和签名算法。

      // config/jwt.php
      
      return [
          // ...
          'keys' => [
              'public' => 'file://' . storage_path('jwt/public.pem'),
              'private' => null, // 如果只验证,不需要私钥
              'passphrase' => null,
          ],
      
          'algo' => 'RS256', // 确保与您的IdP使用的算法一致
          // ...
      ];

      请确保storage/jwt目录存在且可读。

    2. 实现自定义JWT认证守卫 (Guard)

    Laravel的认证系统允许您定义自定义的认证守卫。我们将创建一个JWTGuard来封装JWT的验证逻辑,包括解析令牌、检查签名和提取用户信息。

    创建守卫文件: 在app/Guard目录下创建JWTGuard.php文件(如果目录不存在,请先创建)。

    jwt = $jwt;
            $this->request = $request;
        }
    
        /**
         * 获取当前认证用户。
         *
         * @return \Illuminate\Contracts\Auth\Authenticatable|null
         */
        public function user()
        {
            if (!is_null($this->user)) {
                return $this->user;
            }
    
            // 尝试从请求中获取JWT,并检查其有效性
            if ($this->jwt->setRequest($this->request)->getToken() && $this->jwt->check()) {
                // 从JWT payload中获取用户标识(通常是'sub' claim)
                $id = $this->jwt->payload()->get('sub');
    
                // 根据IdP返回的用户信息创建或查找本地用户实例
                // 这里我们创建一个简单的User实例,您可以根据需要从数据库查找或设置更多自定义属性
                $this->user = new User();
                $this->user->id = $id;
                // 如果需要,可以从JWT payload中提取更多自定义声明并设置到用户模型
                // $this->user->email = $this->jwt->payload()->get('email');
    
                return $this->user;
            }
    
            return null;
        }
    
        /**
         * 验证用户凭据(在本场景中不使用,因为我们通过JWT验证)。
         *
         * @param array $credentials
         * @return bool
         */
        public function validate(array $credentials = [])
        {
            // 对于JWT验证,此方法通常留空或返回false
            return false;
        }
    }

    自定义用户模型: 为了让JWTGuard能够返回一个Authenticatable的用户实例,您可能需要创建一个简单的User模型,或者确保您现有的User模型实现了Illuminate\Contracts\Auth\Authenticatable接口。

    id;
        }
    
        /**
         * Get the password for the user.
         *
         * @return string
         */
        public function getAuthPassword()
        {
            return ''; // 对于JWT认证,密码通常不直接存储或使用
        }
    
        /**
         * Get the "remember me" token value.
         *
         * @return string
         */
        public function getRememberToken()
        {
            return null; // 对于无状态JWT认证,不需要remember token
        }
    
        /**
         * Set the "remember me" token value.
         *
         * @param  string  $value
         * @return void
         */
        public function setRememberToken($value)
        {
            //
        }
    
        /**
         * Get the column name for the "remember me" token.
         *
         * @return string
         */
        public function getRememberTokenName()
        {
            return '';
        }
    }

    3. 注册并激活自定义守卫

    完成JWTGuard的创建后,需要将其注册到Laravel的认证系统中,并在config/auth.php中配置使用。

    在AuthServiceProvider中注册: 修改app/Providers/AuthServiceProvider.php的boot方法。

     'App\Policies\ModelPolicy',
        ];
    
        /**
         * Register any authentication / authorization services.
         *
         * @return void
         */
        public function boot()
        {
            $this->registerPolicies();
    
            // 扩展Laravel的认证系统,注册自定义的'jwt-auth'守卫
            $this->app['auth']->extend(
                'jwt-auth', // 守卫的驱动名称
                function ($app, $name, array $config) {
                    $guard = new JWTGuard(
                        $app['tymon.jwt'], // 获取tymon.jwt实例
                        $app['request']    // 获取当前请求实例
                    );
    
                    // 确保每次请求时,守卫都能获取到最新的请求实例
                    $app->refresh('request', $guard, 'setRequest');
    
                    return $guard;
                }
            );
        }
    }

    在config/auth.php中配置: 将新的jwt守卫添加到guards配置项中。

     [
            'guard' => 'web', // 默认守卫,可以根据需要调整
            'passwords' => 'users',
        ],
    
        'guards' => [
            'web' => [
                'driver' => 'session',
                'provider' => 'users',
            ],
            // ... 其他守卫
    
            'jwt' => [ // 定义您的JWT守卫
                'driver' => 'jwt-auth', // 对应AuthServiceProvider中extend的驱动名称
                'provider' => 'users'   // 可以是任何有效的provider,这里我们使用默认的users
            ],
        ],
    
        'providers' => [
            'users' => [
                'driver' => 'eloquent',
                'model' => App\Models\User::class,
            ],
            // ...
        ],
        // ...
    ];

    4. 在路由中使用认证守卫

    现在,您可以通过Laravel的路由中间件来保护您的API端点,确保只有携带有效JWT的请求才能访问。

    get('/user', function () {
        // 只有携带有效JWT并成功通过'jwt'守卫认证的请求才能到达这里
        return Auth::user(); // 返回当前认证用户实例
    });
    
    // 您也可以在控制器构造函数中使用
    // public function __construct()
    // {
    //     $this->middleware('auth:jwt');
    // }

    当请求到达/user路由时,auth:jwt中间件会激活JWTGuard。如果请求头中包含有效的Bearer Token,JWTGuard将对其进行解析、签名验证,并根据sub声明设置认证用户。

    5. 扩展与注意事项

    • 声明和范围验证: JWTGuard中的$this->jwt->check()会验证JWT的格式、签名和基本的标准声明(如过期时间exp)。如果需要验证更具体的声明(如iss、aud、nbf)或自定义的应用程序权限(scopes),您可以在JWTGuard的user()方法中,在$this->jwt->check()之后,通过$this->jwt->payload()获取所有声明,然后添加额外的逻辑进行验证。对于Scopes,通常会创建一个独立的中间件来处理。
    • 错误处理: 当前的实现在JWT验证失败时会返回null用户,导致Laravel抛出未经认证的HTTP响应(401 Unauthorized)。您可以根据需要捕获tymon/jwt-auth抛出的异常(例如TokenExpiredException, TokenInvalidException等),并返回更详细的错误信息。
    • 公钥管理: 如果您的IdP会定期轮换JWKS中的公钥,您需要建立一个机制来自动或手动更新storage/jwt/public.pem文件。例如,可以编写一个Artisan命令,定期从JWKS URL获取最新的公钥并更新本地文件。
    • 性能考量: 每次请求都从磁盘读取公钥文件可能会有轻微的性能开销。在生产环境中,可以考虑将公钥内容缓存到内存或OPcache中,以减少文件I/O。

    通过以上步骤,您已经成功地在Laravel应用中构建了一个健壮的机制,用于验证来自外部身份提供商的RS256签名的JWT。这不仅增强了API的安全性,也使其能够与复杂的身份认证生态系统无缝集成。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    QQ影音怎么加速播放视频课程
    QQ影音怎么加速播放视频课程

    播放时右键选播放速度,或点控制条倍速,1.25 到 1.5 倍看课最舒服;公式代码类内容别超过 1.25 倍。

    企业微信创建企业提示失败怎么办 实名与填写检查
    企业微信创建企业提示失败怎么办 实名与填写检查

    先看提示属于哪类:名称占用就加后缀,实名不一致就重填本人信息,证件不清晰就重拍。统一社会信用代码逐位核对,连续三次失败别改材料重投,直接联系客服人工核。

    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?
    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?

    说明源码提交对字符串、生成器和数组的识别边界,以及扫描命令与发行包核验限制。

    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?
    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?

    0.170.0 的语音更新限于终端通话协商能力的明确新增,同名工具服务器跨环境支持仍标注实验性质;连接部分则修复大请求回退、认证竞态和云端重连等具体问题。这份正式版公告不足以证明所有账户、所有客户端都已具备完整语音功能。

    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?
    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?

    了解Hy4 flash、FP8与base的适用任务,阅读官方安装及图文代码,并核对资源和MaaS许可条件。

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化
    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化。说明已核实的更新范围、类型兼容性和本地版本确认方法。

    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?
    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?

    OpenAI Java SDK 4.108.0 面向 Live MCP 工具接入与 Managed Agents 预算状态处理,说明新增模型、事件含义、正式发布范围和适用限制。

    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?
    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?

    Free Claude Code 6.19.37 在自动搜索时保留客户端工具及选择条件,代理执行搜索后仍返回普通调用。说明适用场景、历史信息保留、请求约束与第三方项目的版本边界。

    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?
    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?

    Google GenAI Go SDK 1.78.0 将 Gemini Developer API 默认改为 v1,可用 HTTPOptions.APIVersion 或环境变量保留 v1beta,Vertex AI 默认值不变。

    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?
    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?

    解释实验性实时支持、环境检查与生产评估中需要验证的条件。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。