The OneTimePassword class allows creation of single use passwords.
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.
The following is the full list of the properties of the class 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.|
|password_algorithm||The algorithm used to create or validate the password.|
|secret||The Base32 encoded shared secret used when creating and validating a password.|
|time_step||The time step (in seconds) used for Time-Based One Time Password creation or validation.|
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
|config||Sets or retrieves a configuration setting.|
|create_password||Creates a Time-Based or HMAC-Based One Time Password.|
|reset||Reset the variables to default value.|
|validate_password||Validates a Time-Based or HMAC-Based One Time Password.|
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
|on_error||Information about errors during data delivery.|
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
|CurrentTime||The current time in milliseconds.|
|FuturePasswordsAccepted||The number of future passwords to accept.|
|HashAlgorithm||The hash algorithm used to sign the password.|
|PasswordLength||The length of the generated password.|
|PreviousPasswordsAccepted||The number of previous passwords to accept.|
|SecretLength||The length of secret to generate.|
|ValidityTime||The validity time of the created TOTP password.|
|BuildInfo||Information about the product's build.|
|CodePage||The system code page used for Unicode to Multibyte translations.|
|LicenseInfo||Information about the current license.|
|ProcessIdleEvents||Whether the class uses its internal event loop to process events when the main thread is idle.|
|SelectWaitMillis||The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.|
|UseInternalSecurityAPI||Tells the class whether or not to use the system security libraries or an internal implementation.|