开源项目 `jose` 使用教程

开源项目 jose 使用教程

jose:closed_lock_with_key: JSON Object Signing and Encryption Framework (JWT, JWS, JWE, JWA, JWK, JWKSet and more)项目地址:https://gitcode.com/gh_mirrors/jose1/jose

1. 项目的目录结构及介绍

jose/
├── composer.json
├── composer.lock
├── LICENSE
├── README.md
├── src/
│   ├── Algorithm/
│   ├── JWK/
│   ├── JWS/
│   ├── JWE/
│   ├── Exception/
│   └── Util/
├── tests/
│   ├── Algorithm/
│   ├── JWK/
│   ├── JWS/
│   ├── JWE/
│   ├── Exception/
│   └── Util/
└── vendor/

• composer.json 和 composer.lock：Composer 依赖管理文件。
• LICENSE：项目许可证文件。
• README.md：项目说明文档。
• src/：源代码目录，包含算法、密钥、签名、加密等相关模块。
• tests/：测试代码目录，与 src/ 目录结构对应，包含各个模块的测试用例。
• vendor/：Composer 自动生成的第三方依赖库目录。

2. 项目的启动文件介绍

jose 项目没有传统意义上的“启动文件”，因为它是一个库，需要集成到其他 PHP 项目中使用。通常，开发者会在自己的项目中通过 Composer 引入 jose，并在需要的地方调用其提供的类和方法。

例如，在项目中引入 jose：

{
    "require": {
        "spomky-labs/jose": "^8.0"
    }
}

然后在代码中使用：

require 'vendor/autoload.php';

use Jose\Component\Core\JWK;
use Jose\Component\Signature\JWSBuilder;
use Jose\Component\Signature\Serializer\CompactSerializer;

// 创建密钥
$jwk = new JWK([
    'kty' => 'oct',
    'k' => 'your-secret-key',
]);

// 创建 JWS Builder
$jwsBuilder = new JWSBuilder();

// 创建 JWS
$jws = $jwsBuilder
    ->create()
    ->withPayload('{"sub":"1234567890","name":"John Doe","iat":1516239022}')
    ->addSignature($jwk, ['alg' => 'HS256'])
    ->build();

// 序列化 JWS
$serializer = new CompactSerializer();
$token = $serializer->serialize($jws, 0);

echo $token;

3. 项目的配置文件介绍

jose 项目本身没有特定的配置文件，因为它是一个库，配置通常在调用代码中完成。开发者可以根据需要配置密钥、算法、签名和加密参数等。

例如，配置密钥和算法：

use Jose\Component\Core\JWK;

// 配置密钥
$jwk = new JWK([
    'kty' => 'oct',
    'k' => 'your-secret-key',
]);

// 配置算法
$jwsBuilder = new JWSBuilder();
$jws = $jwsBuilder
    ->create()
    ->withPayload('{"sub":"1234567890","name":"John Doe","iat":1516239022}')
    ->addSignature($jwk, ['alg' => 'HS256'])
    ->build();

通过以上代码，开发者可以灵活配置 jose 库的各项参数，以满足不同的需求。

jose:closed_lock_with_key: JSON Object Signing and Encryption Framework (JWT, JWS, JWE, JWA, JWK, JWKSet and more)项目地址:https://gitcode.com/gh_mirrors/jose1/jose