Keygrip 项目技术文档

1. 安装指南

Keygrip 是一个用于签名和验证数据的 Node.js 模块，支持通过旋转凭证系统来管理密钥，确保新密钥的添加和老密钥的移除不会使客户端凭证失效。

安装步骤

1. 确保已安装 Node.js：Keygrip 依赖于 Node.js 环境，请确保你的系统上已安装 Node.js。
2. 使用 npm 安装 Keygrip：

   npm install keygrip
   

2. 项目的使用说明

创建 Keygrip 实例

Keygrip 模块提供了多种方式来创建实例。你可以通过以下方式创建一个 Keygrip 实例：

const Keygrip = require("keygrip");

// 使用默认参数创建 Keygrip 实例
const keys = new Keygrip(["SEKRIT2", "SEKRIT1"]);

// 或者省略 'new' 操作符
const keys = Keygrip(["SEKRIT2", "SEKRIT1"]);

// 自定义 HMAC 算法和编码
const keys = Keygrip(["SEKRIT2", "SEKRIT1"], 'sha256', 'hex');

签名数据

使用 keys.sign(data) 方法对数据进行签名：

const hash = keys.sign("bieberschnitzel");
console.log(hash); // 输出一个 27 字节的 URL 安全 base64 编码的 SHA1 HMAC

验证数据

使用 keys.verify(data, digest) 方法验证数据的完整性：

const isValid = keys.verify("bieberschnitzel", hash);
console.log(isValid); // 输出 true 或 false

获取匹配的密钥索引

使用 keys.index(data, digest) 方法获取匹配的密钥索引：

const index = keys.index("bieberschnitzel", hash);
console.log(index); // 输出匹配的密钥索引，如果不匹配则返回 -1

3. 项目 API 使用文档

keys = new Keygrip([keylist], [hmacAlgorithm], [encoding])

• 参数说明：
  • keylist：必填，一个包含密钥的数组，密钥按新鲜度降序排列。
  • hmacAlgorithm：可选，默认值为 'sha1'，指定 HMAC 算法。
  • encoding：可选，默认值为 'base64'，指定输出编码格式。

keys.sign(data)

• 功能：对数据进行签名，返回一个 27 字节的 URL 安全 base64 编码的 SHA1 HMAC。
• 参数：
  • data：需要签名的数据。

keys.index(data, digest)

• 功能：返回匹配的密钥索引，如果未匹配则返回 -1。
• 参数：
  • data：需要验证的数据。
  • digest：需要匹配的签名。

keys.verify(data, digest)

• 功能：验证数据是否匹配，返回 true 或 false。
• 参数：
  • data：需要验证的数据。
  • digest：需要匹配的签名。

4. 项目安装方式

Keygrip 可以通过 npm 进行安装：

npm install keygrip

安装完成后，你可以在项目中通过 require("keygrip") 引入并使用 Keygrip 模块。