JWT

JSON Web Token(JWT)是目前最流行的跨域身份验证解决方案。 随着技术的发展,分布式web应用的普及,通过session管理用户登录状态成本越来越高,因此慢慢发展成为token的方式做登录身份校验,然后通过token去取redis中的缓存的用户信息,随着之后jwt的出现,校验方式更加简单便捷化,无需通过redis缓存,而是直接根据token取出保存的用户信息,以及对token可用性校验,单点登录更为简单。

JWT令牌 - 图1

建议阅读一下

组件要求

  • php: >=7.1.0
  • ext-openssl: >=1.0.0
  • easyswoole/spl: ^1.2
  • easyswoole/utility: ^1.1

安装方法

composer require easyswoole/jwt

仓库地址

easyswoole/jwt

核心类库方法

编码相关

设置加密方式,默认HMACSHA256

  1. function algMethod(string $method):Jwt

设置秘钥,默认Easyswoole

  1. function setSecretKey(string $key):Jwt

初始化一个没有附带信息的token的JwtObject

  1. public function publish():JwtObject

设置加密方式, 默认HMACSHA256

  1. public function setAlg($alg): self

设置用户

  1. public function setAud($aud): self

设置过期时间

  1. public function setExp($exp): self

设置发布时间

  1. public function setIat($iat): self

设置发行人

  1. public function setIss(string $iss): self

设置jwt-id,用于标识该jwt

  1. public function setJti($jti): self

在此之前不可用

  1. public function setNbf($nbf): self

设置主题

  1. public function setSub($sub): self

设置其他数据

  1. public function setData($data): self

获取token

  1. function __toString()

解码相关

解码

  1. public function decode(?string $raw):?JwtObject

获取解码状态, 1:通过, -1:无效, -2:token过期

  1. public function getStatus(): int

获取加密方式

  1. public function getAlg()

获取用户

  1. public function getAud()

获取过期时间

  1. public function getExp()

获取发布时间

  1. public function getIat()

获取发行人

  1. public function getIss(): string

获取jwt-id

  1. public function getJti()

获取生效时间

  1. public function setNbf($nbf): void

获取主题

  1. public function getSub()

获取自定义数据

  1. public function getData()

获取签名

  1. public function getSignature()

通过key获取相关数据

  1. final public function getProperty($name)

基本使用

生成token

  1. use EasySwoole\Jwt\Jwt;
  2. $jwtObject = Jwt::getInstance()
  3. ->setSecretKey('easyswoole') // 秘钥
  4. ->publish();
  5. $jwtObject->setAlg('HMACSHA256'); // 加密方式
  6. $jwtObject->setAud('user'); // 用户
  7. $jwtObject->setExp(time()+3600); // 过期时间
  8. $jwtObject->setIat(time()); // 发布时间
  9. $jwtObject->setIss('easyswoole'); // 发行人
  10. $jwtObject->setJti(md5(time())); // jwt id 用于标识该jwt
  11. $jwtObject->setNbf(time()+60*5); // 在此之前不可用
  12. $jwtObject->setSub('主题'); // 主题
  13. // 自定义数据
  14. $jwtObject->setData([
  15. 'other_info'
  16. ]);
  17. // 最终生成的token
  18. $token = $jwtObject->__toString();

解析token

  1. use EasySwoole\Jwt\Jwt;
  2. $token = "eyJhbGciOiJITUFDU0hBMjU2IiwiaXNzIjoiZWFzeXN3b29sZSIsImV4cCI6MTU3MzgzNTIxMSwic3ViIjoi5Li76aKYIiwibmJmIjoxNTczODMxOTExLCJhdWQiOiJ1c2VyIiwiaWF0IjoxNTczODMxNjExLCJqdGkiOiJjYWJhZmNiMWIxZTkxNTU3YzIxMDUxYTZiYTQ0MTliMiIsInNpZ25hdHVyZSI6IjZlNTI1ZjJkOTFjZGYzMjBmODE1NmEwMzE1MDhiNmU0ZDQ0YzhkNGFhYzZjNmU1YzMzMTNjMDIyMGJjYjJhZjQiLCJzdGF0dXMiOjEsImRhdGEiOlsib3RoZXJfaW5mbyJdfQ%3D%3D";
  3. try {
  4. $jwtObject = Jwt::getInstance()->decode($token);
  5. $status = $jwtObject->getStatus();
  6. // 如果encode设置了秘钥,decode 的时候要指定
  7. // $status = $jwt->setSecretKey('easyswoole')->decode($token)
  8. switch ($status)
  9. {
  10. case 1:
  11. echo '验证通过';
  12. $jwtObject->getAlg();
  13. $jwtObject->getAud();
  14. $jwtObject->getData();
  15. $jwtObject->getExp();
  16. $jwtObject->getIat();
  17. $jwtObject->getIss();
  18. $jwtObject->getNbf();
  19. $jwtObject->getJti();
  20. $jwtObject->getSub();
  21. $jwtObject->getSignature();
  22. $jwtObject->getProperty('alg');
  23. break;
  24. case -1:
  25. echo '无效';
  26. break;
  27. case -2:
  28. echo 'token过期';
  29. break;
  30. }
  31. } catch (\EasySwoole\Jwt\Exception $e) {
  32. }