IPWorks Auth 2020 JavaScript Edition

Questions / Feedback?

OneTimePassword Class

Properties   Methods   Events   Configuration Settings   Errors  

The OneTimePassword class allows creation of single use passwords.

Syntax

ipworksauth.onetimepassword()

Remarks

The OneTimePassword class implements the HOTP algorithm defined in RFC 4226 (HMAC-Based One-Time Password) and the TOTP algorithm defined in RFC 6238 (Time-Based One-Time Password). These types of passwords are commonly used as a second factor of authentication in multi-factor authentication scenarios.

To begin decide which algorithm you wish to use and set PasswordAlgorithm. Specify the shared secret in the Secret property.

Next, depending on the algorithm chosen you may set Counter (HOTP) or TimeStep (TOTP). If these properties are not set, the class will use a default value.

To create the password call CreatePassword. The Password property will be populated with the new password.

To validate a password set the Password property and call ValidatePassword. The method will return True or False to indicate success or failure.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

CounterThe counter used for HMAC-Based One Time Password creation or validation.
PasswordThe HMAC-Based or Time-Based One Time Password.
PasswordAlgorithmThe algorithm used to create or validate the password.
SecretThe Base32 encoded shared secret used when creating and validating a password.
TimeStepThe time step (in seconds) used for Time-Based One Time Password creation or validation.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
CreatePasswordCreates a Time-Based or HMAC-Based One Time Password.
ResetReset the variables to default value.
ValidatePasswordValidates a Time-Based or HMAC-Based One Time Password.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

CurrentTimeThe current time in milliseconds.
FuturePasswordsAcceptedThe number of future passwords to accept.
HashAlgorithmThe hash algorithm used to sign the password.
PasswordLengthThe length of the generated password.
PreviousPasswordsAcceptedThe number of previous passwords to accept.
SecretLengthThe length of secret to generate.
ValidityTimeThe validity time of the created TOTP password.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks Auth 2020 JavaScript Edition - Version 20.0 [Build 7721]