OTPClient Component

Properties   Methods   Events   Config Settings   Errors  

The OTPClient component generates one-time passwords.

Syntax

TsbxOTPClient

Remarks

A One-Time Password (OTP) is a password that is valid for only one session or transaction. OTPs were designed to overcome the weaknesses of traditional static passwords, such as vulnerability to replay attacks. The OTPClient component can generate HMAC-Based One-Time Passwords (HOTP) and Time-Based One-Time Passwords (TOTP), in accordance with Requests For Comments RFC 4226 and RFC 6238.

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

FIPSMode Property (OTPClient Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KeySecret Property (OTPClient Component)

The OTP key secret.

Syntax

__property DynamicArray KeySecret = { read=FKeySecret, write=FSetKeySecret };

Remarks

Specifies the secret key shared by the parties and used for one-time password generation.

This property is not available at design time.

Data Type

Byte Array

PasswordLength Property (OTPClient Component)

Specifies the length of the password to generate.

Syntax

__property int PasswordLength = { read=FPasswordLength, write=FSetPasswordLength };

Default Value

8

Remarks

Use this property to set the length of the one-time password to generate.

Data Type

Integer

Config Method (OTPClient Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

DoAction Method (OTPClient Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GenerateHOTPPassword Method (OTPClient Component)

Generates a new hash-based one-time password.

Syntax

String __fastcall GenerateHOTPPassword(int Counter);

Remarks

Call this method to generate a new hash-based one-time password (HOTP).

Use Counter to specify the counter setting to which the password should correspond.

GenerateTOTPPassword Method (OTPClient Component)

Generates a new time-based one-time password.

Syntax

String __fastcall GenerateTOTPPassword(int TimeInterval, String HashAlgorithm);

Remarks

Call this method to generate a new time-based one-time password (TOTP).

Use TimeInterval to specify the index of the time step for which the password is needed, and HashAlgorithm to instruct component what hash algorithm to use. Supported hash algorithms:

Error Event (OTPClient Component)

Reports errors during one-time password (OTP) generation.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxOTPClientErrorEventParams;
typedef void __fastcall (__closure *TsbxOTPClientErrorEvent)(System::TObject* Sender, TsbxOTPClientErrorEventParams *e);
__property TsbxOTPClientErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

This event is fired in case of exceptional conditions during generation of one-time passwords.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (OTPClient Component)

This event notifies the application about an underlying control flow event.

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxOTPClientNotificationEventParams;
typedef void __fastcall (__closure *TsbxOTPClientNotificationEvent)(System::TObject* Sender, TsbxOTPClientNotificationEventParams *e);
__property TsbxOTPClientNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (OTPClient Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

OTPClient Config Settings

Base Config Settings

Trappable Errors (OTPClient Component)

OTPClient Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
	25165825   User not found (SB_ERROR_OTP_USER_NOT_FOUND)