jsotp/docs/README_zh.md
2017-06-30 15:47:20 +08:00

3.1 KiB
Raw Blame History

jsotp

jsotp是一个用来生成用来生成及验证一次性密码的js模块一次性密码通常用来在web应用或者其他登录系统中作为二步验证或多步验证使用。

该模块基于 RFC4226 HOTP基于计数器的一次性密码算法RFC6238TOTP基于时间的一次性密码算法实现

功能

  • 随机生成base32加密的字符串
  • 将base32加密后的字符串生成otpauth链接可用来生成二维码
  • 创建可验证的HOTP对象
  • 验证HOTP密码
  • 创建可验证的TOTP对象
  • 验证TOTP密码

安装

npm install jsotp

模块

全部模块支持:

let jsotp = require('jsotp');

Base32 模块支持:

let jsotp = require('jsotp/base32');

HOTP 模块支持:

let jsotp = require('jsotp/hotp');

TOTP 模块支持:

let jsotp = require('jsotp/totp');

使用

基于时间的OTP

// import
let jsotp = require('jsotp');

// Create TOTP object
let totp = jsotp.TOTP('BASE32ENCODEDSECRET');
totp.now(); // => 432143

// Verify for current time
totp.verify(432143); // => true

// Verify after 30s
totp.verify(432143); // => false

基于计数器的OTP

// import
let jsotp = require('jsotp');

// Create HOTP object
let hotp = jsotp.HOTP('BASE32ENCODEDSECRET');
hotp.at(0); // => 432143
hotp.at(1); // => 231434
hotp.at(2132); // => 242432

// Verify with a counter
hotp.verify(242432, 2132); // => true
hotp.verify(242432, 2133); // => false

生成随机base32加密字符串

// import
let jsotp = require('jsotp');

// Generate
let b32_secret = jsotp.Base32.random_gen();

接口

jsotp.Base32.random_gen(length)

param: length
type: int
default: 16
return: String
desc: the length of random base32 encoded string.

jsotp.Util.url_gen()

jsotp.TOTP.now()

return: String
desc: get the one-time password with current time.

jsotp.TOTP.verify(totp)

param: totp
type: string
return: Boolean
desc: verify the totp code.

jsotp.HOTP.at(counter)

param: counter
type: int
return: String
desc: generate one-time password with counter.

jsotp.HOTP.verify(hotp, count)

param: hotp
type: string
param: count
type: int
return: Boolean
desc: verify the hotp code.

开发

  • 克隆代码并安装依赖
git clone git@github.com:LanceGin/jsotp.git
npm install
  • src/文件夹中进行源码编写执行下面命令将es6代码编译成es2015命令会生成一个lib/本地文件夹。
npm run build
  • 单元测试
npm test

README