README

JWT-AUTH

thinkphp的jwt（JSON Web Token）身份验证包。支持Header、Cookie、Param等多种传参方式。包含：验证、验证并且自动刷新等多种中间件。

环境要求

php >= 7.4
thinkphp ^5.0

说明

目前支持如下三大类型加密方式：RSA,HASH,DSA。再各分256、384、512位。默认是HS256，即hash 256位加密。

需要修改加密方式，请修改参数：ALGO，参数选项：

HS256

备注：hash 256位
HS384

备注：hash 384位
HS512

备注：hash 512位
RS256

备注：rsa 256位
RS384

备注：rsa 384位
RS512

备注：rsa 512位
ES256

备注：dsa 256位
ES384

备注：dsa 384位
ES512

备注：dsa 512位

重要：RSA和DSA 都是非对称加密方式，除了修改参数ALGO外，需要配置：PUBLIC_KEY、PRIVATE_KEY两个参数，这两个参数支持文本（不要开头、结尾和换行）或密钥文件路径。如果密钥设置了密码，请配置好参数：PASSWORD

env文件不支持内容有等于号，遇到这种情况： 1、使用路径 2、生成没有等于号的密钥。

安装

第一步:

$ composer require oswin/tp-jwt-auth

第二步:

$ php think jwt:create

-m 系统模块 默认全局配置,指定则在对应模块生成jwt配置

此举将生成jwt.php和.env配置文件。不推荐直接修改jwt.php 同时，env中会随机生成secret。请不要随意更新secret，也请保障secret安全。

使用方式

示例：

use jwt\facade\JWTAuth;

$token = JWTAuth::builder(['uid' => 1]);//参数为用户认证的信息，请自行添加

JWTAuth::auth();//token验证

JWTAuth::refresh();//刷新token，会将旧token加入黑名单

$tokenStr = JWTAuth::token()->get(); //可以获取请求中的完整token字符串

$payload = JWTAuth::auth(); //可验证token, 并获取token中的payload部分
$uid = $payload['uid']->getValue(); //可以继而获取payload里自定义的字段，比如uid

token刷新说明：

token默认有效期为60秒，如果需要修改请修改env文件。 refresh_ttl为刷新token有效期参数，单位为分钟。默认有效期14天。 token过期后，旧token将会被加入黑名单。如果需要自动刷新，请使用中间件 thans\jwt\middleware\JWTAuthAndRefresh::class, 自动刷新后会通过header返回，请保存好。（注意，此中间件过期后第一次访问正常，第二次进入黑名单。）

token传参方式如下：

可通过jwt.php配置文件内token_mode参数来调整参数接收方式及优先级 token_mode默认值为['header', 'cookie', 'param'];

在某些前后端分离的情况下可选择取消cookie接收方式来避免token冲突

将token加入到url中作为参数。键名为token
将token加入到cookie。键名为token
将token加入header，如下：Authorization:bearer token值
以上三种方式，任选其一即可。推荐加入header中。

其他操作

拉黑Token JWTAuth::invalidate($token);
查询Token是否黑名单 JWTAuth::validate($token);

参考与借鉴

https://github.com/QThans/jwt-auth/

感谢

jwt-auth
php
lcobucci/jwt
thinkphp

下一步

支持动态配置

License

MIT

oswin / tp-jwt-auth

Maintainers

Details