coolaj86/botp.js
1
0
Fork 0
Code Issues Pull Requests Releases Activity

README markdown formatting

Browse Source
This commit is contained in:
Roman Shtylman 2012-06-03 18:29:06 -04:00
parent 10381a3a88
commit 6ad05c5a7c
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Readme.md
View File

@ -59,12 +59,12 @@ Returns null if token is not valid for given key and options.
Returns an object `{delta: #}` if the token is valid. `delta` is the count skew between client and server. Returns an object `{delta: #}` if the token is valid. `delta` is the count skew between client and server.
### opt ### opt
** window ** **window**
> The allowable margin for the counter. The function will check `window` codes in the future against the provided token. > The allowable margin for the counter. The function will check `window` codes in the future against the provided token.
> i.e. if `window = 100` and `counter = 5` all tokens between 5 and 105 will be checked against the supplied token > i.e. if `window = 100` and `counter = 5` all tokens between 5 and 105 will be checked against the supplied token
> Default - 50 > Default - 50
** counter ** **counter**
> Counter value. This should be stored by the application on a per user basis. It is up to the application to track and increment this value as needed. It is also up to the application to increment this value if there is a skew between the client and server (`delta`) > Counter value. This should be stored by the application on a per user basis. It is up to the application to track and increment this value as needed. It is also up to the application to increment this value if there is a skew between the client and server (`delta`)
##totp.verify(token, key, opt) ##totp.verify(token, key, opt)
@ -76,12 +76,12 @@ Returns null if token is not valid for given key and options.
Returns an object `{delta: #}` if the token is valid. `delta` is the count skew between client and server. Returns an object `{delta: #}` if the token is valid. `delta` is the count skew between client and server.
### opt ### opt
** window ** **window**
> The allowable margin for the counter. The function will check `window` codes in the future against the provided token. > The allowable margin for the counter. The function will check `window` codes in the future against the provided token.
> i.e. if `window = 5` and `counter = 1000` all tokens between 995 and 1005 will be checked against the supplied token > i.e. if `window = 5` and `counter = 1000` all tokens between 995 and 1005 will be checked against the supplied token
> Default - 6 > Default - 6
** time ** **time**
> The time step of the counter. This must be the same for every request and is used to calculate C. > The time step of the counter. This must be the same for every request and is used to calculate C.
> Default - 30 > Default - 30
@ -90,7 +90,7 @@ Returns an object `{delta: #}` if the token is valid. `delta` is the count skew
Return a counter based one time password Return a counter based one time password
### opt ### opt
** counter ** **counter**
> Counter value. This should be stored by the application, must be user specific, and be incremented for each request. > Counter value. This should be stored by the application, must be user specific, and be incremented for each request.
##totp.gen(key, opt) ##totp.gen(key, opt)
@ -98,7 +98,7 @@ Return a counter based one time password
Return a time based one time password Return a time based one time password
### opt ### opt
** time ** **time**
> The time step of the counter. This must be the same for every request and is used to calculate C. > The time step of the counter. This must be the same for every request and is used to calculate C.
> Default - 30 > Default - 30