public/jsotp-ts
public/jsotp-ts
9
0
Fork 0
forked from github/jsotp
Code Issues Pull Requests Packages Projects Releases Wiki Activity

upd: README

Browse Source
This commit is contained in:
lancegin 2017-06-30 15:47:20 +08:00
parent 9f20c956fe
commit 944890c89f
2 changed files with 65 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -93,19 +93,45 @@ let b32_secret = jsotp.Base32.random_gen();
### Api
#### • jsotp.Base32.random_gen()
#### • [jsotp.Base32.random_gen(length)](https://github.com/LanceGin/jsotp/blob/master/src/base32.js#L32)
#### • jsotp.Util.url_gen
param: length
type: int
default: 16
return: String
desc: the length of random base32 encoded string.
#### • jsotp.TOTP.now()
#### • <del>jsotp.Util.url_gen()</del>
#### • jsotp.TOTP.verify()
#### • [jsotp.TOTP.now()](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L38)
return: String
desc: get the one-time password with current time.
#### • jsotp.HOTP.at()
#### • [jsotp.TOTP.verify(totp)](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L70)
#### • jsotp.HOTP.verify()
param: totp
type: string
return: Boolean
desc: verify the totp code.
### Develop
#### • [jsotp.HOTP.at(counter)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L24)
param: counter
type: int
return: String
desc: generate one-time password with counter.
#### • [jsotp.HOTP.verify(hotp, count)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L50)
param: hotp
type: string
param: count
type: int
return: Boolean
desc: verify the hotp code.
### Contribute
* Clone repo and install dependencies

38
docs/README_zh.md
View File

@ -93,17 +93,43 @@ let b32_secret = jsotp.Base32.random_gen();
### 接口
#### • jsotp.Base32.random_gen()
#### • [jsotp.Base32.random_gen(length)](https://github.com/LanceGin/jsotp/blob/master/src/base32.js#L32)
#### • jsotp.Util.url_gen
param: length
type: int
default: 16
return: String
desc: the length of random base32 encoded string.
#### • jsotp.TOTP.now()
#### • <del>jsotp.Util.url_gen()</del>
#### • jsotp.TOTP.verify()
#### • [jsotp.TOTP.now()](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L38)
return: String
desc: get the one-time password with current time.
#### • jsotp.HOTP.at()
#### • [jsotp.TOTP.verify(totp)](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L70)
#### • jsotp.HOTP.verify()
param: totp
type: string
return: Boolean
desc: verify the totp code.
#### • [jsotp.HOTP.at(counter)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L24)
param: counter
type: int
return: String
desc: generate one-time password with counter.
#### • [jsotp.HOTP.verify(hotp, count)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L50)
param: hotp
type: string
param: count
type: int
return: Boolean
desc: verify the hotp code.
### 开发