OTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The OTPClient class generates one-time passwords.

Syntax

class secureblackbox.OTPClient

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

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

key_secret Property

The OTP key secret.

Syntax

def get_key_secret() -> bytes: ...
def set_key_secret(value: bytes) -> None: ...

key_secret = property(get_key_secret, set_key_secret)

Remarks

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

password_length Property

Specifies the length of the password to generate.

Syntax

def get_password_length() -> int: ...
def set_password_length(value: int) -> None: ...

password_length = property(get_password_length, set_password_length)

Default Value

8

Remarks

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

do_action is a generic method available in every class. 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;....

generate_hotp_password Method

Generates a new hash-based one-time password.

Syntax

def generate_hotp_password(counter: int) -> str: ...

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.

generate_totp_password Method

Generates a new time-based one-time password.

Syntax

def generate_totp_password(time_interval: int, hash_algorithm: str) -> str: ...

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 class what hash algorithm to use. Supported hash algorithms:

on_error Event

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

Syntax

class OTPClientErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class OTPClient:
@property
def on_error() -> Callable[[OTPClientErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[OTPClientErrorEventParams], None]) -> None: ...

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.

on_notification Event

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

Syntax

class OTPClientNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class OTPClient:
@property
def on_notification() -> Callable[[OTPClientNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[OTPClientNotificationEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.

OTPClient Config Settings

The class 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 class, access to these internal properties is provided through the config method.

OTPClient Config Settings

Base Config Settings

OTPClient Errors

OTPClient Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class 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)