UserOtpAlgorithm Property
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).
Syntax
sftpserver.getUserOtpAlgorithm(index, [callback]) sftpserver.setUserOtpAlgorithm(index, userOtpAlgorithm, [callback])
Possible Values
0 (oaNone), 1 (oaHmac), 2 (oaTime)
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 getUserOtpAlgorithm([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 setUserOtpAlgorithm([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
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.
oaHmac | 0 | |
oaTime | 1 |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer