Isokey 开源项目使用教程

Isokey 开源项目使用教程

isokeySelf-contained API keys via cryptographic signatures项目地址:https://gitcode.com/gh_mirrors/is/isokey

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

Isokey 项目的目录结构如下：

isokey/
├── README.md
├── go.mod
├── go.sum
├── isokey.go
├── isokey_test.go
├── LICENSE
└── examples/
    ├── example1.go
    ├── example2.go
    └── ...

目录结构介绍

• README.md: 项目的主要介绍文件，包含项目的概述、安装方法、使用示例等信息。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖关系。
• isokey.go: 项目的主要源代码文件，包含 API 密钥生成和验证的核心逻辑。
• isokey_test.go: 项目的测试文件，包含对 isokey.go 中函数的单元测试。
• LICENSE: 项目的开源许可证文件，通常为 MIT 许可证。
• examples/: 包含多个示例文件，展示了如何使用 Isokey 生成和验证 API 密钥。

2. 项目的启动文件介绍

Isokey 项目的主要启动文件是 isokey.go。该文件包含了项目的核心功能，包括：

• SymKeyService: 用于创建和管理对称密钥的服务。
• AsymKeySigner 和 AsymKeyVerifier: 用于创建和管理非对称密钥的服务。
• Digest 和 Verify: 用于生成和验证 API 密钥的函数。

主要函数介绍

• SymKeyService:

  ks := SymKeyService{
      Secret: []byte("super_secure111"),
  }
  

  用于创建一个对称密钥服务，Secret 是用于生成和验证密钥的密钥。

• Digest:

  key := &Key{
      UserID: 1,
      Expires: time.Now().AddDate(0, 1, 0),
  }
  digest, err := ks.Digest(key)
  

  用于生成 API 密钥的摘要。

• Verify:

  key, err = ks.Verify(digest)
  

  用于验证 API 密钥的摘要。

3. 项目的配置文件介绍

Isokey 项目没有传统的配置文件，所有的配置信息都通过代码进行设置。主要的配置项包括：

• Secret: 用于生成和验证 API 密钥的密钥。
• UserID: 用户的唯一标识符。
• Expires: API 密钥的过期时间。

配置示例

ks := SymKeyService{
    Secret: []byte("super_secure111"),
}

key := &Key{
    UserID: 1,
    Expires: time.Now().AddDate(0, 1, 0),
}

在这个示例中，Secret 被设置为 "super_secure111"，UserID 为 1，Expires 设置为当前时间的一个月后。

通过这种方式，Isokey 项目实现了无数据库的 API 密钥生成和验证，所有的配置和逻辑都在代码中完成。

isokeySelf-contained API keys via cryptographic signatures项目地址:https://gitcode.com/gh_mirrors/is/isokey