OTPServer Class
Properties Methods Events Config Settings Errors
The OTPServer class checks the validity of one-time passwords.
Syntax
class secureblackbox.OTPServer
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 OTPServer class can check the validity of HMAC-Based One-Time Passwords (HOTP) and Time-Based One-Time Passwords (TOTP).
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| fips_mode | Reserved. |
| user_count | The number of records in the User arrays. |
| user_associated_data | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. |
| user_base_path | Base path for this user in the server's file system. |
| user_cert | Contains the user's certificate. |
| user_data | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. |
| user_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| user_hash_algorithm | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. |
| user_incoming_speed_limit | Specifies the incoming speed limit for this user. |
| user_otp_algorithm | The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). |
| user_otp_value | The user's time interval (TOTP) or Counter (HOTP). |
| user_outgoing_speed_limit | Specifies the outgoing speed limit for this user. |
| user_password | The user's authentication password. |
| user_password_len | Specifies the length of the user's OTP password. |
| user_shared_secret | Contains the user's secret key, which is essentially a shared secret between the client and server. |
| user_ssh_key | Contains the user's SSH key. |
| user_username | The registered name (login) of the user. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| do_action | Performs an additional action. |
| is_hotp_password_valid | Validates a hash-based one-time password. |
| is_password_valid | Validates an OTP password for a user. |
| is_totp_password_valid | Validates a time-based one-time password. |
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.
| on_error | Information about errors during one-time password (OTP) processing. |
| on_notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| BaseTime | . |
| Delta | . |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
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.
user_count Property
The number of records in the User arrays.
Syntax
def get_user_count() -> int: ... def set_user_count(value: int) -> None: ...
user_count = property(get_user_count, set_user_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
- user_associated_data
- user_base_path
- user_cert
- user_data
- user_handle
- user_hash_algorithm
- user_incoming_speed_limit
- user_otp_algorithm
- user_otp_value
- user_outgoing_speed_limit
- user_password
- user_password_len
- user_shared_secret
- user_ssh_key
- user_username
user_associated_data Property
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
Syntax
def get_user_associated_data(user_index: int) -> bytes: ... def set_user_associated_data(user_index: int, value: bytes) -> None: ...
Remarks
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_base_path Property
Base path for this user in the server's file system.
Syntax
def get_user_base_path(user_index: int) -> str: ... def set_user_base_path(user_index: int, value: str) -> None: ...
Default Value
""
Remarks
Base path for this user in the server's file system.
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_cert Property
Contains the user's certificate.
Syntax
def get_user_cert(user_index: int) -> bytes: ... def set_user_cert(user_index: int, value: bytes) -> None: ...
Remarks
Contains the user's certificate.
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_data Property
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
Syntax
def get_user_data(user_index: int) -> str: ... def set_user_data(user_index: int, value: str) -> None: ...
Default Value
""
Remarks
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_user_handle(user_index: int) -> int: ... def set_user_handle(user_index: int, value: int) -> None: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_hash_algorithm Property
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
Syntax
def get_user_hash_algorithm(user_index: int) -> str: ... def set_user_hash_algorithm(user_index: int, value: str) -> None: ...
Default Value
""
Remarks
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:
| SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
| SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
| SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_incoming_speed_limit Property
Specifies the incoming speed limit for this user.
Syntax
def get_user_incoming_speed_limit(user_index: int) -> int: ... def set_user_incoming_speed_limit(user_index: int, value: int) -> None: ...
Default Value
0
Remarks
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_otp_algorithm Property
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).
Syntax
def get_user_otp_algorithm(user_index: int) -> int: ... def set_user_otp_algorithm(user_index: int, value: int) -> None: ...
Default Value
0
Remarks
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.
| oaHmac | 0 | |
| oaTime | 1 |
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_otp_value Property
The user's time interval (TOTP) or Counter (HOTP).
Syntax
def get_user_otp_value(user_index: int) -> int: ... def set_user_otp_value(user_index: int, value: int) -> None: ...
Default Value
0
Remarks
The user's time interval (TOTP) or Counter (HOTP).
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_outgoing_speed_limit Property
Specifies the outgoing speed limit for this user.
Syntax
def get_user_outgoing_speed_limit(user_index: int) -> int: ... def set_user_outgoing_speed_limit(user_index: int, value: int) -> None: ...
Default Value
0
Remarks
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_password Property
The user's authentication password.
Syntax
def get_user_password(user_index: int) -> str: ... def set_user_password(user_index: int, value: str) -> None: ...
Default Value
""
Remarks
The user's authentication password.
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_password_len Property
Specifies the length of the user's OTP password.
Syntax
def get_user_password_len(user_index: int) -> int: ... def set_user_password_len(user_index: int, value: int) -> None: ...
Default Value
0
Remarks
Specifies the length of the user's OTP password.
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_shared_secret Property
Contains the user's secret key, which is essentially a shared secret between the client and server.
Syntax
def get_user_shared_secret(user_index: int) -> bytes: ... def set_user_shared_secret(user_index: int, value: bytes) -> None: ...
Remarks
Contains the user's secret key, which is essentially a shared secret between the client and server.
Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_ssh_key Property
Contains the user's SSH key.
Syntax
def get_user_ssh_key(user_index: int) -> bytes: ... def set_user_ssh_key(user_index: int, value: bytes) -> None: ...
Remarks
Contains the user's SSH key.
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
user_username Property
The registered name (login) of the user.
Syntax
def get_user_username(user_index: int) -> str: ... def set_user_username(user_index: int, value: str) -> None: ...
Default Value
""
Remarks
The registered name (login) of the user.
The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.
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 insencitive) 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;....
is_hotp_password_valid Method
Validates a hash-based one-time password.
Syntax
def is_hotp_password_valid(key_secret: bytes, password_length: int, counter: int, password: str) -> bool: ...
Remarks
Use this method to validate a hash-based one-time password (HOTP) by using explicit HOTP parameters. For this method to work, no user details need to be provided in users collection.
is_password_valid Method
Validates an OTP password for a user.
Syntax
def is_password_valid(username: str, password: str) -> bool: ...
Remarks
Use this method to check a one-time Password for a user specified by UserID. The known users' details need to be provided in users list.
is_totp_password_valid Method
Validates a time-based one-time password.
Syntax
def is_totp_password_valid(key_secret: bytes, password_length: int, time_interval: int, hash_algorithm: str, password: str) -> bool: ...
Remarks
Use this method to validate a time-based one-time password (TOTP) by using explicit TOTP parameters. For this method to work, no user details need to be provided in users collection.
Supported hash algorithms:
| SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
| SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
| SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
on_error Event
Information about errors during one-time password (OTP) processing.
Syntax
class OTPServerErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class OTPServer: @property def on_error() -> Callable[[OTPServerErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[OTPServerErrorEventParams], None]) -> None: ...
Remarks
This event is fired in case of exceptional conditions during OTP checks.
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 OTPServerNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class OTPServer: @property def on_notification() -> Callable[[OTPServerNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[OTPServerNotificationEventParams], None]) -> None: ...
Remarks
The class 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 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.
OTPServer 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.OTPServer Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
| time | Current time | |
| level | Level | |
| package | Package name | |
| module | Module name | |
| class | Class name | |
| method | Method name | |
| threadid | Thread Id | |
| contenttype | Content type | |
| content | Content | |
| all | All details |
Supported filter names are:
| exclude-package | Exclude a package specified in the value | |
| exclude-module | Exclude a module specified in the value | |
| exclude-class | Exclude a class specified in the value | |
| exclude-method | Exclude a method specified in the value | |
| include-package | Include a package specified in the value | |
| include-module | Include a module specified in the value | |
| include-class | Include a class specified in the value | |
| include-method | Include a method specified in the value |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
| none | None (by default) | |
| fatal | Severe errors that cause premature termination. | |
| error | Other runtime errors or unexpected conditions. | |
| warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
| info | Interesting runtime events (startup/shutdown). | |
| debug | Detailed information on flow of through the system. | |
| trace | More detailed information. |
The default value of this setting is 100.
| none | No rotation | |
| deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
| keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
OTPServer Errors
OTPServer 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) |