OTPClient Class
Properties Methods Events Config Settings Errors
The OTPClient class generates one-time passwords.
Syntax
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.
BaseTime | Specifies the TOTP client's base time. |
FIPSMode | Reserved. |
KeySecret | The OTP key secret. |
PasswordLength | Specifies the length of the password to generate. |
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. |
DoAction | Performs an additional action. |
GenerateHOTPPassword | Generates a new hash-based one-time password. |
GenerateTOTPPassword | Generates a new time-based one-time password. |
Reset | Resets the class settings. |
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.
Error | Reports errors during one-time password (OTP) generation. |
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.
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
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. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
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. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
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. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
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. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
BaseTime Property (OTPClient Class)
Specifies the TOTP client's base time.
Syntax
ANSI (Cross Platform) char* GetBaseTime();
int SetBaseTime(const char* lpszBaseTime); Unicode (Windows) LPWSTR GetBaseTime();
INT SetBaseTime(LPCWSTR lpszBaseTime);
char* secureblackbox_otpclient_getbasetime(void* lpObj);
int secureblackbox_otpclient_setbasetime(void* lpObj, const char* lpszBaseTime);
QString GetBaseTime();
int SetBaseTime(QString qsBaseTime);
Default Value
""
Remarks
Use this property to provide the TOTP (Time-based OTP, RFC 6238) client's base time parameter.
Data Type
String
FIPSMode Property (OTPClient Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_otpclient_getfipsmode(void* lpObj);
int secureblackbox_otpclient_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
KeySecret Property (OTPClient Class)
The OTP key secret.
Syntax
ANSI (Cross Platform) int GetKeySecret(char* &lpKeySecret, int &lenKeySecret);
int SetKeySecret(const char* lpKeySecret, int lenKeySecret); Unicode (Windows) INT GetKeySecret(LPSTR &lpKeySecret, INT &lenKeySecret);
INT SetKeySecret(LPCSTR lpKeySecret, INT lenKeySecret);
int secureblackbox_otpclient_getkeysecret(void* lpObj, char** lpKeySecret, int* lenKeySecret);
int secureblackbox_otpclient_setkeysecret(void* lpObj, const char* lpKeySecret, int lenKeySecret);
QByteArray GetKeySecret();
int SetKeySecret(QByteArray qbaKeySecret);
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 Class)
Specifies the length of the password to generate.
Syntax
ANSI (Cross Platform) int GetPasswordLength();
int SetPasswordLength(int iPasswordLength); Unicode (Windows) INT GetPasswordLength();
INT SetPasswordLength(INT iPasswordLength);
int secureblackbox_otpclient_getpasswordlength(void* lpObj);
int secureblackbox_otpclient_setpasswordlength(void* lpObj, int iPasswordLength);
int GetPasswordLength();
int SetPasswordLength(int iPasswordLength);
Default Value
8
Remarks
Use this property to set the length of the one-time password to generate.
Data Type
Integer
Config Method (OTPClient Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_otpclient_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 (OTPClient 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_otpclient_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 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;....
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.
GenerateHOTPPassword Method (OTPClient Class)
Generates a new hash-based one-time password.
Syntax
ANSI (Cross Platform) char* GenerateHOTPPassword(int iCounter); Unicode (Windows) LPWSTR GenerateHOTPPassword(INT iCounter);
char* secureblackbox_otpclient_generatehotppassword(void* lpObj, int iCounter);
QString GenerateHOTPPassword(int iCounter);
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.
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.
GenerateTOTPPassword Method (OTPClient Class)
Generates a new time-based one-time password.
Syntax
ANSI (Cross Platform) char* GenerateTOTPPassword(int iTimeInterval, const char* lpszHashAlgorithm); Unicode (Windows) LPWSTR GenerateTOTPPassword(INT iTimeInterval, LPCWSTR lpszHashAlgorithm);
char* secureblackbox_otpclient_generatetotppassword(void* lpObj, int iTimeInterval, const char* lpszHashAlgorithm);
QString GenerateTOTPPassword(int iTimeInterval, const QString& qsHashAlgorithm);
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:
SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
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.
Reset Method (OTPClient Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_otpclient_reset(void* lpObj);
int Reset();
Remarks
Reset is a generic method available in every class.
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.)
Error Event (OTPClient Class)
Reports errors during one-time password (OTP) generation.
Syntax
ANSI (Cross Platform) virtual int FireError(OTPClientErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } OTPClientErrorEventParams;
Unicode (Windows) virtual INT FireError(OTPClientErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } OTPClientErrorEventParams;
#define EID_OTPCLIENT_ERROR 1 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class OTPClientErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(OTPClientErrorEventParams *e);
// Or, subclass OTPClient and override this emitter function. virtual int FireError(OTPClientErrorEventParams *e) {...}
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 Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(OTPClientNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } OTPClientNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(OTPClientNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } OTPClientNotificationEventParams;
#define EID_OTPCLIENT_NOTIFICATION 2 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class OTPClientNotificationEventParams { 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(OTPClientNotificationEventParams *e);
// Or, subclass OTPClient and override this emitter function. virtual int FireNotification(OTPClientNotificationEventParams *e) {...}
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.
Config Settings (OTPClient 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.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.
Trappable Errors (OTPClient 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.
OTPClient Errors
1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
1048585 | General error (SB_ERROR_GENERAL_ERROR) |
25165825 | User not found (SB_ERROR_OTP_USER_NOT_FOUND) |