Speakeasy 项目技术文档

1. 安装指南

Speakeasy 是一个用于生成一次性密码的库，适用于两步验证（Two-Factor Authentication, 2FA）。它支持 Google Authenticator 和其他两步验证设备。以下是安装步骤：

1.1 使用 npm 安装

npm install --save speakeasy

1.2 安装依赖

如果你需要生成 QR 码，可以使用 qrcode 库：

npm install --save qrcode

2. 项目使用说明

2.1 生成密钥

首先，使用 Speakeasy 生成一个密钥：

var secret = speakeasy.generateSecret();
// 返回一个包含 secret.ascii, secret.hex, secret.base32 的对象

2.2 显示 QR 码

生成密钥后，可以使用 QR 码模块生成一个 QR 码，用户可以通过扫描该 QR 码将密钥添加到他们的两步验证应用中：

var QRCode = require('qrcode');

QRCode.toDataURL(secret.otpauth_url, function(err, data_url) {
  console.log(data_url);
  // 将 data_url 显示在网页的 <img> 标签中
});

2.3 验证令牌

用户扫描 QR 码后，输入他们从应用中获得的令牌，你可以使用以下代码验证令牌：

var userToken = '132890'; // 用户输入的令牌
var verified = speakeasy.totp.verify({
  secret: secret.base32,
  encoding: 'base32',
  token: userToken
});

if (verified) {
  console.log('令牌验证成功');
} else {
  console.log('令牌验证失败');
}

3. 项目 API 使用文档

3.1 生成密钥

var secret = speakeasy.generateSecret({length: 20});
// 返回一个包含 secret.ascii, secret.hex, secret.base32 的对象

3.2 生成时间戳令牌

var token = speakeasy.totp({
  secret: secret.base32,
  encoding: 'base32'
});
// 返回当前时间戳的令牌

3.3 验证令牌

var tokenValidates = speakeasy.totp.verify({
  secret: secret.base32,
  encoding: 'base32',
  token: '123456',
  window: 6
});
// 返回 true 如果令牌匹配

3.4 计算时间戳令牌的偏移量

var tokenDelta = speakeasy.totp.verifyDelta({
  secret: secret.base32,
  encoding: 'base32',
  token: '123456',
  window: 2,
  step: 60
});
// 返回 {delta: 0} 表示令牌与当前时间的偏移量

3.5 生成计数器令牌

var token = speakeasy.hotp({
  secret: secret.base32,
  encoding: 'base32',
  counter: 123
});
// 返回计数器为 123 的令牌

3.6 验证计数器令牌

var tokenValidates = speakeasy.hotp.verify({
  secret: secret.base32,
  encoding: 'base32',
  token: '123456',
  counter: 123
});
// 返回 true 如果令牌匹配

4. 项目安装方式

4.1 使用 npm 安装

npm install --save speakeasy

4.2 安装依赖

如果你需要生成 QR 码，可以使用 qrcode 库：

npm install --save qrcode

通过以上步骤，你可以成功安装并使用 Speakeasy 项目进行两步验证的开发。