OTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The OTPServer class checks the validity of one-time passwords.

Syntax

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.

FIPSModeReserved.
UserCountThe number of records in the User arrays.
UserAssociatedDataContains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
UserBasePathBase path for this user in the server's file system.
UserCertContains the user's certificate.
UserDataContains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
UserHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
UserHashAlgorithmSpecifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
UserIncomingSpeedLimitSpecifies the incoming speed limit for this user.
UserOtpAlgorithmThe algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).
UserOtpValueThe user's time interval (TOTP) or Counter (HOTP).
UserOutgoingSpeedLimitSpecifies the outgoing speed limit for this user.
UserPasswordThe user's authentication password.
UserPasswordLenSpecifies the length of the user's OTP password.
UserSharedSecretContains the user's secret key, which is essentially a shared secret between the client and server.
UserSSHKeyContains the user's SSH key.
UserUsernameThe 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.

ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
IsHOTPPasswordValidValidates a hash-based one-time password.
IsPasswordValidValidates an OTP password for a user.
IsTOTPPasswordValidValidates 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.

ErrorInformation about errors during one-time password (OTP) processing.
NotificationThis 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.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

FIPSMode Property (OTPServer Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_otpserver_getfipsmode(void* lpObj);
int secureblackbox_otpserver_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

UserCount Property (OTPServer Class)

The number of records in the User arrays.

Syntax

ANSI (Cross Platform)
int GetUserCount();
int SetUserCount(int iUserCount); Unicode (Windows) INT GetUserCount();
INT SetUserCount(INT iUserCount);
int secureblackbox_otpserver_getusercount(void* lpObj);
int secureblackbox_otpserver_setusercount(void* lpObj, int iUserCount);
int GetUserCount();
int SetUserCount(int iUserCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at UserCount - 1.

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (OTPServer Class)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

ANSI (Cross Platform)
int GetUserAssociatedData(int iUserIndex, char* &lpUserAssociatedData, int &lenUserAssociatedData);
int SetUserAssociatedData(int iUserIndex, const char* lpUserAssociatedData, int lenUserAssociatedData); Unicode (Windows) INT GetUserAssociatedData(INT iUserIndex, LPSTR &lpUserAssociatedData, INT &lenUserAssociatedData);
INT SetUserAssociatedData(INT iUserIndex, LPCSTR lpUserAssociatedData, INT lenUserAssociatedData);
int secureblackbox_otpserver_getuserassociateddata(void* lpObj, int userindex, char** lpUserAssociatedData, int* lenUserAssociatedData);
int secureblackbox_otpserver_setuserassociateddata(void* lpObj, int userindex, const char* lpUserAssociatedData, int lenUserAssociatedData);
QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData);

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (OTPServer Class)

Base path for this user in the server's file system.

Syntax

ANSI (Cross Platform)
char* GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, const char* lpszUserBasePath); Unicode (Windows) LPWSTR GetUserBasePath(INT iUserIndex);
INT SetUserBasePath(INT iUserIndex, LPCWSTR lpszUserBasePath);
char* secureblackbox_otpserver_getuserbasepath(void* lpObj, int userindex);
int secureblackbox_otpserver_setuserbasepath(void* lpObj, int userindex, const char* lpszUserBasePath);
QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath);

Default Value

""

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserCert Property (OTPServer Class)

Contains the user's certificate.

Syntax

ANSI (Cross Platform)
int GetUserCert(int iUserIndex, char* &lpUserCert, int &lenUserCert);
int SetUserCert(int iUserIndex, const char* lpUserCert, int lenUserCert); Unicode (Windows) INT GetUserCert(INT iUserIndex, LPSTR &lpUserCert, INT &lenUserCert);
INT SetUserCert(INT iUserIndex, LPCSTR lpUserCert, INT lenUserCert);
int secureblackbox_otpserver_getusercert(void* lpObj, int userindex, char** lpUserCert, int* lenUserCert);
int secureblackbox_otpserver_setusercert(void* lpObj, int userindex, const char* lpUserCert, int lenUserCert);
QByteArray GetUserCert(int iUserIndex);
int SetUserCert(int iUserIndex, QByteArray qbaUserCert);

Remarks

Contains the user's certificate.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserData Property (OTPServer Class)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

ANSI (Cross Platform)
char* GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, const char* lpszUserData); Unicode (Windows) LPWSTR GetUserData(INT iUserIndex);
INT SetUserData(INT iUserIndex, LPCWSTR lpszUserData);
char* secureblackbox_otpserver_getuserdata(void* lpObj, int userindex);
int secureblackbox_otpserver_setuserdata(void* lpObj, int userindex, const char* lpszUserData);
QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData);

Default Value

""

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserHandle Property (OTPServer Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, int64 lUserHandle); Unicode (Windows) LONG64 GetUserHandle(INT iUserIndex);
INT SetUserHandle(INT iUserIndex, LONG64 lUserHandle);
int64 secureblackbox_otpserver_getuserhandle(void* lpObj, int userindex);
int secureblackbox_otpserver_setuserhandle(void* lpObj, int userindex, int64 lUserHandle);
qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle);

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 UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (OTPServer Class)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

ANSI (Cross Platform)
char* GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, const char* lpszUserHashAlgorithm); Unicode (Windows) LPWSTR GetUserHashAlgorithm(INT iUserIndex);
INT SetUserHashAlgorithm(INT iUserIndex, LPCWSTR lpszUserHashAlgorithm);
char* secureblackbox_otpserver_getuserhashalgorithm(void* lpObj, int userindex);
int secureblackbox_otpserver_setuserhashalgorithm(void* lpObj, int userindex, const char* lpszUserHashAlgorithm);
QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm);

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_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (OTPServer Class)

Specifies the incoming speed limit for this user.

Syntax

ANSI (Cross Platform)
int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit); Unicode (Windows) INT GetUserIncomingSpeedLimit(INT iUserIndex);
INT SetUserIncomingSpeedLimit(INT iUserIndex, INT iUserIncomingSpeedLimit);
int secureblackbox_otpserver_getuserincomingspeedlimit(void* lpObj, int userindex);
int secureblackbox_otpserver_setuserincomingspeedlimit(void* lpObj, int userindex, int iUserIncomingSpeedLimit);
int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit);

Default Value

0

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOtpAlgorithm Property (OTPServer Class)

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Syntax

ANSI (Cross Platform)
int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm); Unicode (Windows) INT GetUserOtpAlgorithm(INT iUserIndex);
INT SetUserOtpAlgorithm(INT iUserIndex, INT iUserOtpAlgorithm);

Possible Values

OA_NONE(0), 
OA_HMAC(1),
OA_TIME(2)
int secureblackbox_otpserver_getuserotpalgorithm(void* lpObj, int userindex);
int secureblackbox_otpserver_setuserotpalgorithm(void* lpObj, int userindex, int iUserOtpAlgorithm);
int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm);

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.

oaHmac0
oaTime1

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOtpValue Property (OTPServer Class)

The user's time interval (TOTP) or Counter (HOTP).

Syntax

ANSI (Cross Platform)
int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue); Unicode (Windows) INT GetUserOtpValue(INT iUserIndex);
INT SetUserOtpValue(INT iUserIndex, INT iUserOtpValue);
int secureblackbox_otpserver_getuserotpvalue(void* lpObj, int userindex);
int secureblackbox_otpserver_setuserotpvalue(void* lpObj, int userindex, int iUserOtpValue);
int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue);

Default Value

0

Remarks

The user's time interval (TOTP) or Counter (HOTP).

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (OTPServer Class)

Specifies the outgoing speed limit for this user.

Syntax

ANSI (Cross Platform)
int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit); Unicode (Windows) INT GetUserOutgoingSpeedLimit(INT iUserIndex);
INT SetUserOutgoingSpeedLimit(INT iUserIndex, INT iUserOutgoingSpeedLimit);
int secureblackbox_otpserver_getuseroutgoingspeedlimit(void* lpObj, int userindex);
int secureblackbox_otpserver_setuseroutgoingspeedlimit(void* lpObj, int userindex, int iUserOutgoingSpeedLimit);
int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit);

Default Value

0

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserPassword Property (OTPServer Class)

The user's authentication password.

Syntax

ANSI (Cross Platform)
char* GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, const char* lpszUserPassword); Unicode (Windows) LPWSTR GetUserPassword(INT iUserIndex);
INT SetUserPassword(INT iUserIndex, LPCWSTR lpszUserPassword);
char* secureblackbox_otpserver_getuserpassword(void* lpObj, int userindex);
int secureblackbox_otpserver_setuserpassword(void* lpObj, int userindex, const char* lpszUserPassword);
QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword);

Default Value

""

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserPasswordLen Property (OTPServer Class)

Specifies the length of the user's OTP password.

Syntax

ANSI (Cross Platform)
int GetUserPasswordLen(int iUserIndex);
int SetUserPasswordLen(int iUserIndex, int iUserPasswordLen); Unicode (Windows) INT GetUserPasswordLen(INT iUserIndex);
INT SetUserPasswordLen(INT iUserIndex, INT iUserPasswordLen);
int secureblackbox_otpserver_getuserpasswordlen(void* lpObj, int userindex);
int secureblackbox_otpserver_setuserpasswordlen(void* lpObj, int userindex, int iUserPasswordLen);
int GetUserPasswordLen(int iUserIndex);
int SetUserPasswordLen(int iUserIndex, int iUserPasswordLen);

Default Value

0

Remarks

Specifies the length of the user's OTP password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserSharedSecret Property (OTPServer Class)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

ANSI (Cross Platform)
int GetUserSharedSecret(int iUserIndex, char* &lpUserSharedSecret, int &lenUserSharedSecret);
int SetUserSharedSecret(int iUserIndex, const char* lpUserSharedSecret, int lenUserSharedSecret); Unicode (Windows) INT GetUserSharedSecret(INT iUserIndex, LPSTR &lpUserSharedSecret, INT &lenUserSharedSecret);
INT SetUserSharedSecret(INT iUserIndex, LPCSTR lpUserSharedSecret, INT lenUserSharedSecret);
int secureblackbox_otpserver_getusersharedsecret(void* lpObj, int userindex, char** lpUserSharedSecret, int* lenUserSharedSecret);
int secureblackbox_otpserver_setusersharedsecret(void* lpObj, int userindex, const char* lpUserSharedSecret, int lenUserSharedSecret);
QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret);

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 UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserSSHKey Property (OTPServer Class)

Contains the user's SSH key.

Syntax

ANSI (Cross Platform)
int GetUserSSHKey(int iUserIndex, char* &lpUserSSHKey, int &lenUserSSHKey);
int SetUserSSHKey(int iUserIndex, const char* lpUserSSHKey, int lenUserSSHKey); Unicode (Windows) INT GetUserSSHKey(INT iUserIndex, LPSTR &lpUserSSHKey, INT &lenUserSSHKey);
INT SetUserSSHKey(INT iUserIndex, LPCSTR lpUserSSHKey, INT lenUserSSHKey);
int secureblackbox_otpserver_getusersshkey(void* lpObj, int userindex, char** lpUserSSHKey, int* lenUserSSHKey);
int secureblackbox_otpserver_setusersshkey(void* lpObj, int userindex, const char* lpUserSSHKey, int lenUserSSHKey);
QByteArray GetUserSSHKey(int iUserIndex);
int SetUserSSHKey(int iUserIndex, QByteArray qbaUserSSHKey);

Remarks

Contains the user's SSH key.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (OTPServer Class)

The registered name (login) of the user.

Syntax

ANSI (Cross Platform)
char* GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, const char* lpszUserUsername); Unicode (Windows) LPWSTR GetUserUsername(INT iUserIndex);
INT SetUserUsername(INT iUserIndex, LPCWSTR lpszUserUsername);
char* secureblackbox_otpserver_getuserusername(void* lpObj, int userindex);
int secureblackbox_otpserver_setuserusername(void* lpObj, int userindex, const char* lpszUserUsername);
QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);

Default Value

""

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

Config Method (OTPServer Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_otpserver_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.

DoAction Method (OTPServer Class)

Performs an additional action.

Syntax

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_otpserver_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction 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;....

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.

IsHOTPPasswordValid Method (OTPServer Class)

Validates a hash-based one-time password.

Syntax

ANSI (Cross Platform)
int IsHOTPPasswordValid(const char* lpKeySecret, int lenKeySecret, int iPasswordLength, int iCounter, const char* lpszPassword);

Unicode (Windows)
INT IsHOTPPasswordValid(LPCSTR lpKeySecret, INT lenKeySecret, INT iPasswordLength, INT iCounter, LPCWSTR lpszPassword);
int secureblackbox_otpserver_ishotppasswordvalid(void* lpObj, const char* lpKeySecret, int lenKeySecret, int iPasswordLength, int iCounter, const char* lpszPassword);
bool IsHOTPPasswordValid(QByteArray qbaKeySecret, int iPasswordLength, int iCounter, const QString& qsPassword);

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.

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.

IsPasswordValid Method (OTPServer Class)

Validates an OTP password for a user.

Syntax

ANSI (Cross Platform)
int IsPasswordValid(const char* lpszUsername, const char* lpszPassword);

Unicode (Windows)
INT IsPasswordValid(LPCWSTR lpszUsername, LPCWSTR lpszPassword);
int secureblackbox_otpserver_ispasswordvalid(void* lpObj, const char* lpszUsername, const char* lpszPassword);
bool IsPasswordValid(const QString& qsUsername, const QString& qsPassword);

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.

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.

IsTOTPPasswordValid Method (OTPServer Class)

Validates a time-based one-time password.

Syntax

ANSI (Cross Platform)
int IsTOTPPasswordValid(const char* lpKeySecret, int lenKeySecret, int iPasswordLength, int iTimeInterval, const char* lpszHashAlgorithm, const char* lpszPassword);

Unicode (Windows)
INT IsTOTPPasswordValid(LPCSTR lpKeySecret, INT lenKeySecret, INT iPasswordLength, INT iTimeInterval, LPCWSTR lpszHashAlgorithm, LPCWSTR lpszPassword);
int secureblackbox_otpserver_istotppasswordvalid(void* lpObj, const char* lpKeySecret, int lenKeySecret, int iPasswordLength, int iTimeInterval, const char* lpszHashAlgorithm, const char* lpszPassword);
bool IsTOTPPasswordValid(QByteArray qbaKeySecret, int iPasswordLength, int iTimeInterval, const QString& qsHashAlgorithm, const QString& qsPassword);

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_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

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

Information about errors during one-time password (OTP) processing.

Syntax

ANSI (Cross Platform)
virtual int FireError(OTPServerErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } OTPServerErrorEventParams;
Unicode (Windows) virtual INT FireError(OTPServerErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } OTPServerErrorEventParams;
#define EID_OTPSERVER_ERROR 1

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class OTPServerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(OTPServerErrorEventParams *e);
// Or, subclass OTPServer and override this emitter function. virtual int FireError(OTPServerErrorEventParams *e) {...}

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.

Notification Event (OTPServer Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireNotification(OTPServerNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } OTPServerNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(OTPServerNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } OTPServerNotificationEventParams;
#define EID_OTPSERVER_NOTIFICATION 2

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class OTPServerNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Notification(OTPServerNotificationEventParams *e);
// Or, subclass OTPServer and override this emitter function. virtual int FireNotification(OTPServerNotificationEventParams *e) {...}

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.

Config Settings (OTPServer Class)

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

BaseTime:   .

Defines the Time-based OTP (TOTP) server's base time.

Delta:   .

Specifies the resynchronization limit. This property is used to overcome the asynchronicity between the one-time password (OTP) client and server. For HOTP servers (HMAC-based OTP, RFC 4226), Delta defines the maximum possible deviation of the client's counter value. For TOTP servers (Time-based OTP, RFC 6238), Delta contains the maximum number of time steps the client can be out of synch.

Base Config Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (OTPServer 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.

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)