TOTP Control
Properties Methods Events Configuration Settings Errors
The TOTP component allows creation of Time-Based One-Time passwords.
Syntax
TOTP
Remarks
The TOTP control implements 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 specify the shared secret in the Secret property.
Next, you may set TimeStep. If this property is not set, the control 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 control with short descriptions. Click on the links for further details.
| Password | The Time-Based One Time 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. |
| ValidityTime | The validity time of the created password. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| CreatePassword | Creates a Time-Based One Time Password. |
| Reset | Reset the variables to default value. |
| ValidatePassword | Validates a Time-Based One Time Password. |
Event List
The following is the full list of the events fired by the control 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 control 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. |