LCobucci JWT 教程

LCobucci JWT 教程

jwtA simple library to work with JSON Web Token and JSON Web Signature项目地址:https://gitcode.com/gh_mirrors/jw/jwt

1. 项目目录结构及介绍

LCobucci JWT 是一个流行的 PHP 库，用于创建、验证 JSON Web Tokens (JWT)。以下是项目的基本目录结构：

lcobucci/jwt
├── src                # 包含所有核心类库代码
│   ├── Builder.php    # JWT 创建者，用于构建令牌
│   ├── Encoder.php    # 编码器，将 JWT 转换为字符串
│   ├── Parser.php     # 解析器，从字符串解析 JWT
│   ├── Signer.php     # 签名处理器，处理签名算法
│   └── Validation.php # 验证工具，进行有效性检查
├── tests              # 测试用例
├── examples           # 示例代码
└── composer.json       # 依赖管理文件，定义项目依赖和其他元数据

2. 项目启动文件介绍

LCobucci JWT 不提供传统的启动文件，因为它是一个库而非独立的应用程序。不过，在你的应用中引入这个库后，你可以使用以下步骤来创建或验证 JWT：

// 引入 Composer 自动加载
require_once 'vendor/autoload.php';

use Lcobucci\JWT\Builder;
use Lcobucci\JWT\Signer\Key;
use Lcobucci\JWT\Signer\Hmac\Sha256;

// 创建 JWT
$signer = new Sha256();
$key = file_get_contents('path/to/your/key.pem');
$token = (new Builder())->setIssuer('http://example.com') // 设置发行者
                         ->setAudience('http://example.com') // 设置接收方
                         ->setId('1234567890', true) // 设置唯一标识符
                         ->setIssuedAt(time()) // 当前时间作为发行时间
                         ->setNotBefore(time() + 60) // 在此时间之前不可用
                         ->setExpiration(time() + 3600) // 过期时间
                         ->sign($signer, $key) // 使用密钥签名
                         ->getToken(); // 返回已编码的 JWT

// 输出编码后的 JWT
echo $token->__toString();

// 验证 JWT
$validator = function ($payload, $signature, $key) {
    // 在这里放置自定义验证逻辑
};

try {
    $parsedToken = (new Parser())->parse((string) $token); // 解析 JWT 字符串
    $parsedToken->verify($signer, $key); // 使用相同密钥验证签名
    $parsedToken->assert($validator); // 执行自定义验证
    
    echo "JWT 验证成功";
} catch (\Exception $e) {
    echo "JWT 验证失败: " . $e->getMessage();
}

3. 项目的配置文件介绍

LCobucci JWT 并没有特定的配置文件，因为它的核心功能通过编程方式设置。然而，在你的应用中使用 JWT，你可能需要在自己的配置文件中设置一些参数，例如密钥路径、默认签发者和接收者等。下面是一个示例配置文件，展示了如何存储这些信息：

return [
    'jwt' => [
        'issuer' => 'http://example.com',
        'audience' => 'http://example.com',
        'key_path' => '/path/to/your/key.pem',
        'algorithm' => 'HS256', // 或其他支持的签名算法
    ],
];

然后在你的代码中，可以这样读取配置并使用：

$config = require 'path/to/config.php'; // 加载配置
$issuer = $config['jwt']['issuer'];
$audience = $config['jwt']['audience'];
$keyPath = $config['jwt']['key_path'];
$algorithm = $config['jwt']['algorithm'];

// 接下来使用这些配置值创建或验证 JWT

务必根据实际情况替换配置中的值，确保与实际环境相匹配。

jwtA simple library to work with JSON Web Token and JSON Web Signature项目地址:https://gitcode.com/gh_mirrors/jw/jwt