Node One Time Password 库技术文档

1. 安装指南

要安装 notp 库，请在终端中运行以下命令：

npm install notp

2. 项目使用说明

notp 是一个简单易用、快速且无依赖的 Node.js 库，用于生成和验证基于计数器（HOTP）和基于时间（TOTP）的一次性密码。它完全符合 HOTP 和 TOTP 标准。

2.1 基本使用

以下是一个简单的示例，展示如何使用 notp 库验证基于时间的 OTP（TOTP）：

var notp = require('notp');

// 用户密钥，可以存储在数据库中
var key = 'secret key for user... could be stored in DB';

// 用户提供的一次性密码
var token = 'user supplied one time use token';

// 验证 TOTP
var login = notp.totp.verify(token, key);

// 如果验证失败
if (!login) {
    return console.log('Token invalid');
}

// 验证成功
console.log('Token valid, sync value is %s', login.delta);

2.2 与 Google Authenticator 集成

Google Authenticator 要求密钥在使用前进行 base32 编码。可以使用 thirty-two 模块来完成此操作：

var base32 = require('thirty-two');

var key = 'secret key for the user';

// 对密钥进行 base32 编码
var encoded = base32.encode(key);

// Google Authenticator 不接受等号
var encodedForGoogle = encoded.toString().replace(/=/g,'');

// 创建用于二维码的 URI
var uri = 'otpauth://totp/somelabel?secret=' + encodedForGoogle;

3. 项目 API 使用文档

3.1 hotp.verify(token, key, opt)

验证基于计数器的一次性密码（HOTP）。

• 参数:

  • token: 用户提供的一次性密码。
  • key: 用户的密钥。
  • opt: 可选参数对象，包含以下字段：
    • window: 允许的计数器偏差范围，默认值为 50。
    • counter: 计数器值，应由应用程序存储和管理。

• 返回值:

  • 如果验证失败，返回 null。
  • 如果验证成功，返回一个对象 {delta: #}，其中 delta 是客户端和服务器之间的计数器偏差。

3.2 totp.verify(token, key, opt)

验证基于时间的一次性密码（TOTP）。

• 参数:

  • token: 用户提供的一次性密码。
  • key: 用户的密钥。
  • opt: 可选参数对象，包含以下字段：
    • window: 允许的计数器偏差范围，默认值为 6。
    • time: 时间步长，默认值为 30。

• 返回值:

  • 如果验证失败，返回 null。
  • 如果验证成功，返回一个对象 {delta: #}，其中 delta 是客户端和服务器之间的时间偏差。

3.3 hotp.gen(key, opt)

生成基于计数器的一次性密码（HOTP）。

• 参数:

  • key: 用户的密钥。
  • opt: 可选参数对象，包含以下字段：
    • counter: 计数器值，应由应用程序存储和管理。

• 返回值:

  • 返回生成的 OTP。

3.4 totp.gen(key, opt)

生成基于时间的一次性密码（TOTP）。

• 参数:

  • key: 用户的密钥。
  • opt: 可选参数对象，包含以下字段：
    • time: 时间步长，默认值为 30。

• 返回值:

  • 返回生成的 OTP。

4. 项目安装方式

通过 npm 安装 notp 库：

npm install notp

安装完成后，可以在项目中通过 require('notp') 引入并使用该库。