TOTP Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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.

Password Property (TOTP Class)

The Time-Based One Time Password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksauth_totp_getpassword(void* lpObj);
int ipworksauth_totp_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

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.

Data Type

String

Secret Property (TOTP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecret();
int SetSecret(const char* lpszSecret);

Unicode (Windows)
LPWSTR GetSecret();
INT SetSecret(LPCWSTR lpszSecret);

char* ipworksauth_totp_getsecret(void* lpObj);
int ipworksauth_totp_setsecret(void* lpObj, const char* lpszSecret);

QString GetSecret();
int SetSecret(QString qsSecret);

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.

Data Type

String

TimeStep Property (TOTP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeStep();
int SetTimeStep(int iTimeStep);

Unicode (Windows)
INT GetTimeStep();
INT SetTimeStep(INT iTimeStep);

int ipworksauth_totp_gettimestep(void* lpObj);
int ipworksauth_totp_settimestep(void* lpObj, int iTimeStep);

int GetTimeStep();
int SetTimeStep(int iTimeStep);

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.

Data Type

Integer

ValidityTime Property (TOTP Class)

The validity time of the created password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetValidityTime();

Unicode (Windows)
INT GetValidityTime();

int ipworksauth_totp_getvaliditytime(void* lpObj);

int GetValidityTime();

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.

Data Type

Integer

Config Method (TOTP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksauth_totp_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreatePassword Method (TOTP Class)

Creates a Time-Based One Time Password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreatePassword();

Unicode (Windows)
INT CreatePassword();

int ipworksauth_totp_createpassword(void* lpObj);

int CreatePassword();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (TOTP Class)

Reset the variables to default value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksauth_totp_reset(void* lpObj);

int Reset();

Remarks

This method will reset the variables to default value.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ValidatePassword Method (TOTP Class)

Validates a Time-Based One Time Password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ValidatePassword();

Unicode (Windows)
INT ValidatePassword();

int ipworksauth_totp_validatepassword(void* lpObj);

bool ValidatePassword();

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.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Error Event (TOTP Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(TOTPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} TOTPErrorEventParams;


Unicode (Windows)
virtual INT FireError(TOTPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} TOTPErrorEventParams;

#define EID_TOTP_ERROR 1

virtual INT IPWORKSAUTH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class TOTPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(TOTPErrorEventParams *e);

// Or, subclass TOTP and override this emitter function.
virtual int FireError(TOTPErrorEventParams *e) {...}

Remarks

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

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 (TOTP Class)

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 (TOTP Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

TOTP Errors