Counter Property

The counter used for HMAC-Based One Time Password creation or validation.

Syntax

 onetimepassword.getCounter([callback])
 onetimepassword.setCounter( counter, [callback])

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getCounter([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setCounter([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property holds the counter value used for HMAC-Based One Time Password creation or validation. When PasswordAlgorithm is set to paHOTP this value must be specified before calling CreatePassword or ValidatePassword. The value should be incremented each time a password is created.

The default value is 0.

This property is not applicable when using the Time-Based One Time Password algorithm.

Data Type

Long64