IP*Works! Auth V9 - Online Help
IP*Works! Auth V9
Questions / Feedback?

TOTP Component

Properties   Methods   Events   Configuration Settings   Errors  

The TOTP component allows creation of Time-Based One-Time passwords.

Syntax

nsoftware.IPWorksAuth.Totp

Remarks

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

PasswordThe Time-Based One Time 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.
ValidityTimeThe validity time of the created password.

Method List


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

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

Event List


The following is the full list of the events fired by the component 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 component with short descriptions. Click on the links for further details.

CurrentTimeThe current time in milliseconds.
ValidityTimeThe validity time of the created TOTP password.
SecretLengthThe length of secret to generated.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0