github/jsotp
4
0
Fork 1
mirror of https://github.com/LanceGin/jsotp.git synced 2026-05-05 00:00:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

upd: README

Browse Source
This commit is contained in:
lancegin
2017-07-10 12:26:13 +08:00
parent 62c23f4208
commit 92ad356f73
2 changed files with 56 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+28 -2
View File
@@ -87,8 +87,13 @@ let b32_secret = jsotp.Base32.random_gen();
return: String return: String
desc: the length of random base32 encoded string. desc: the length of random base32 encoded string.
#### • <del>jsotp.Util.url_gen()</del> #### • [jsotp.TOTP(secret)](https://github.com/LanceGin/jsotp/blob/master/src/jsotp.js#L48)
param: secret
type: string
return: TOTP
desc: generate TOTP instance.
#### • [jsotp.TOTP.now()](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L38) #### • [jsotp.TOTP.now()](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L38)
return: String return: String
@@ -100,7 +105,21 @@ let b32_secret = jsotp.Base32.random_gen();
type: string type: string
return: Boolean return: Boolean
desc: verify the totp code. desc: verify the totp code.
#### • [jsotp.TOTP.url_gen(issuer)](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L94)
param: issuer
type: string
return: string
desc: generate url with TOTP instance
#### • [jsotp.HOTP(secret)](https://github.com/LanceGin/jsotp/blob/master/src/jsotp.js#L47)
param: secret
type: string
return: HOTP
desc: generate HOTP instance.
#### • [jsotp.HOTP.at(counter)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L24) #### • [jsotp.HOTP.at(counter)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L24)
param: counter param: counter
@@ -117,6 +136,13 @@ let b32_secret = jsotp.Base32.random_gen();
return: Boolean return: Boolean
desc: verify the hotp code. desc: verify the hotp code.
#### • [jsotp.HOTP.url_gen(issuer)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L69)
param: issuer
type: string
return: string
desc: generate url with HOTP instance
### Contribute ### Contribute
* Clone repo and install dependencies * Clone repo and install dependencies
docs/README_zh.md
+28 -2
View File
@@ -87,8 +87,13 @@ let b32_secret = jsotp.Base32.random_gen();
return: String return: String
desc: the length of random base32 encoded string. desc: the length of random base32 encoded string.
#### • <del>jsotp.Util.url_gen()</del> #### • [jsotp.TOTP(secret)](https://github.com/LanceGin/jsotp/blob/master/src/jsotp.js#L48)
param: secret
type: string
return: TOTP
desc: generate TOTP instance.
#### • [jsotp.TOTP.now()](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L38) #### • [jsotp.TOTP.now()](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L38)
return: String return: String
@@ -100,7 +105,21 @@ let b32_secret = jsotp.Base32.random_gen();
type: string type: string
return: Boolean return: Boolean
desc: verify the totp code. desc: verify the totp code.
#### • [jsotp.TOTP.url_gen(issuer)](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L94)
param: issuer
type: string
return: string
desc: generate url with TOTP instance
#### • [jsotp.HOTP(secret)](https://github.com/LanceGin/jsotp/blob/master/src/jsotp.js#L47)
param: secret
type: string
return: HOTP
desc: generate HOTP instance.
#### • [jsotp.HOTP.at(counter)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L24) #### • [jsotp.HOTP.at(counter)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L24)
param: counter param: counter
@@ -117,6 +136,13 @@ let b32_secret = jsotp.Base32.random_gen();
return: Boolean return: Boolean
desc: verify the hotp code. desc: verify the hotp code.
#### • [jsotp.HOTP.url_gen(issuer)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L69)
param: issuer
type: string
return: string
desc: generate url with HOTP instance
### 开发 ### 开发
* 克隆代码并安装依赖 * 克隆代码并安装依赖