TOTP Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworksauth.totp()

Remarks

The TOTP class 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 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.

Method List

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

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.

Config Settings

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

TOTP.Password Property

The Time-Based One Time Password.

Syntax

getPassword(): string;
setPassword(password: string): void;

Default Value

""

Remarks

This property holds the Time-Based One Time Password. This property is populated after calling CreatePassword. This property must be set before calling ValidatePassword.

TOTP.Secret Property

The Base32 encoded shared secret used when creating and validating a password.

Syntax

getSecret(): string;
setSecret(secret: string): void;

Default Value

""

Remarks

This property specifies the Base32 encoded shared secret used when creating and validating a password. This should be set before calling CreatePassword or ValidatePassword.

If this is not set before calling CreatePassword a random secret will be automatically generated. This functionality provides an easy way to create new secret values. The length of the secret is defined by SecretLength.

TOTP.TimeStep Property

The time step (in seconds) used for Time-Based One Time Password creation or validation.

Syntax

getTimeStep(): number;
setTimeStep(timeStep: number): void;

Default Value

30

Remarks

This property specifies the time step (in seconds) used for Time-Based One Time Password creation or validation. This value must be specified before calling CreatePassword or ValidatePassword.

The default value is 30.

TOTP.ValidityTime Property

The validity time of the created password.

Syntax

getValidityTime(): number;

Default Value

0

Remarks

This property returns the remaining validity time in seconds of the created password. After calling CreatePassword this property may be queried to determine for how many more seconds the password will be valid. If the password is no longer valid this property returns 0.

This property is read-only.

TOTP.config Method

Sets or retrieves a configuration setting.

Syntax

async totp.config(configurationString : string): Promise<string>

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

TOTP.createPassword Method

Creates a Time-Based One Time Password.

Syntax

async totp.createPassword(): Promise<void>

Remarks

This method creates a Time-Based One Time Password.

The following properties are applicable when calling CreatePassword.

• Secret
• TimeStep

Calling CreatePassword populates the Password property with the created password.

If Secret is not specified before calling this method a random secret will be automatically generated.

TOTP.reset Method

Reset the variables to default value.

Syntax

async totp.reset(): Promise<void>

Remarks

This method will reset the variables to default value.

TOTP.validatePassword Method

Validates a Time-Based One Time Password.

Syntax

async totp.validatePassword(): Promise<boolean>

Remarks

This method validates a Time-Based One Time Password.

The following properties are applicable when calling ValidatePassword.

• Password (required)
• Secret (required)
• TimeStep

The method will return True if the password is validated, False otherwise.

TOTP.Error Event

Information about errors during data delivery.

Syntax

totp.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Config Settings (class ipworksauth.totp)

TOTP Config Settings

//TOTP
otpauth://totp/MyServiceName:account@company.com?secret=JBSWY3DPEHPK3PXP&digits=6&period=30

//HOTP
otpauth://hotp/MyServiceName:account@company.com?secret=JBSWY3DPEHPK3PXP&digits=6&counter=0

Base Config Settings

Trappable Errors (class ipworksauth.totp)

TOTP Errors