rooty/yubikey-val
1
0
Fork 0
mirror of https://github.com/Yubico/yubikey-val.git synced 2024-12-01 15:24:16 +01:00
Code Issues Projects Releases Wiki Activity

Update ValidationProtocolV20.adoc

Browse Source
This commit is contained in:
Henrik Stråth 2014-08-11 16:08:14 +02:00
parent f819f2d2c9
commit 799a480121
1 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/ValidationProtocolV20.adoc
View File

@ -71,23 +71,17 @@ http://api.yubico.com/wsapi/2.0/verify
with the following parameters (note that this request need not be signed):
{|
! parameter !! type !! required !! purpose
|-
| id || string || Yes || Specifies the requestor so that the end-point can retrieve correct shared secret for signing the response.
|-
|otp || string || Yes || The OTP from the !YubiKey.
|-
| h || string || No || The optional HMAC-SHA1 signature for the request.
|-
| timestamp || string || No || Timestamp=1 requests timestamp and session counter information in the response
|-
| nonce || string || Yes || A 16 to 40 character long string with random unique data
|-
| sl || string || No || A value 0 to 100 indicating percentage of syncing required by client, or strings "fast" or "secure" to use server-configured values; if absent, let the server decide
|-
| timeout || integer || No || Number of seconds to wait for sync responses; if absent, let the server decide
|}
[options="header"]
==========================================
| parameter | type | required | purpose
| id | string | Yes | Specifies the requestor so that the end-point can retrieve correct shared secret for signing the response.
|otp | string | Yes | The OTP from the !YubiKey.
| h | string | No | The optional HMAC-SHA1 signature for the request.
| timestamp | string | No | Timestamp=1 requests timestamp and session counter information in the response
| nonce | string | Yes | A 16 to 40 character long string with random unique data
| sl | string | No | A value 0 to 100 indicating percentage of syncing required by client, or strings "fast" or "secure" to use server-configured values; if absent, let the server decide
| timeout | integer | No | Number of seconds to wait for sync responses; if absent, let the server decide
|=========================================
An example request:
@ -107,6 +101,7 @@ http://api.yubico.com/wsapi/2.0/verify?id=87&otp=vvvvvvcucrlcietctckflvnncdgckub
The verification response tells you whether the OTP is valid. The
response has the following values:
[options="header"]
|===========================
| parameter | type | purpose
| otp | string | The OTP from the !YubiKey, from request.