OneTimePassword Bean

Properties Methods Events Configuration Settings Errors

The OneTimePassword component allows creation of single use passwords.

Syntax

IPWorksEncrypt.Onetimepassword

Remarks

The OneTimePassword bean 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 bean 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 bean with short descriptions. Click on the links for further details.


Counter	The counter used for HMAC-Based One Time Password creation or validation.
Password	The HMAC-Based or Time-Based One Time Password.
PasswordAlgorithm	The algorithm used to create or validate the password.
Secret	The Base32 encoded shared secret used when creating and validating a password.
TimeStep	The 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 bean with short descriptions. Click on the links for further details.


config	Sets or retrieves a configuration setting .
createPassword	Creates a Time-Based or HMAC-Based One Time Password.
reset	Reset the variables to default value.
validatePassword	Validates a Time-Based or HMAC-Based One Time Password.

Event List

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


Error	Information about errors during data delivery.

Configuration Settings

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


CurrentTime	The current time in milliseconds.
ValidityTime	The validity time of the created TOTP password.
SecretLength	The length of secret to generated.
CodePage	The system code page used for Unicode to Multibyte translations.