npm 包 wak-jwks 使用教程

简介

wak-jwks 是一个适用于前端的 npm 包，它可以帮助开发者获取 JSON Web Key Set 并验证 JWT （JSON Web Token）。

JSON Web Key Set 是一组公钥，用于验证由私钥签名的 JWT 的真实性。JWT 是目前流行的用于验证身份和访问权限的令牌。

wak-jwks 可以从指定的 URL 获取 JWKS 中的公钥，并根据 JWT 进行验证。它非常适合作为前端的 JWT 验证解决方案。

安装

在项目目录下，使用以下命令安装 wak-jwks：

npm install wak-jwks --save

使用方法

初始化

以下是使用 wak-jwks 初始化的示例代码：

import JWKS from 'wak-jwks';

const jwks = new JWKS({
  url: 'https://example.com/.well-known/jwks.json',
});

url 是指向 JWKS 文件的 URL 地址，它包括公私钥对以及其他信息。

验证 JWT

使用以下方法验证 JWT：

const jwt = 'eyJhbGciOiJ...';

const payload = jwks.verify(jwt);

console.log(payload);
// { sub: '1234567890', name: 'John Doe' }

verify() 方法将验证 JWT 的真实性。如果验证成功，它将返回 JWT 有效载荷中的数据。

配置

以下是 wak-jwks 的配置选项：

• url: string，JWKS 文件的 URL 地址；

• timeout: number，请求 JWKS 的超时时间，默认为 10000 毫秒；

• cache: boolean，是否启用缓存，默认为 true；

• cacheMaxAge: number，缓存的最大时间（秒），默认为 86400 秒（24 小时）；

• cacheMaxEntries: number，缓存的最大数量，超过该数量将删除最旧的缓存，默认为 1000 个。

用法示例：

const jwks = new JWKS({
  url: 'https://example.com/.well-known/jwks.json',
  timeout: 5000,
  cache: true,
  cacheMaxAge: 86400,
  cacheMaxEntries: 1000,
});

结语

wak-jwks 是一个非常实用的前端 JWT 验证解决方案。通过对其配置和使用的理解，您可以更好地掌握 JWT 在前端中的使用方法，保障应用及用户的安全。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600560aa81e8991b448dee94