UserManager Class
Properties Methods Events Config Settings Errors
The UserManager class stores information about user accounts.
Syntax
UserManager
Remarks
UserManager is responsible for storing, importing, and exporting information about users. It is primarily used with the server components.
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.
AddUser | Creates a new user account and adds it to the Users list. |
Config | Sets or retrieves a configuration setting. |
CreateNew | Creates a new user account database. |
DoAction | Performs an additional action. |
ExportBytes | Saves the user database to a byte array. |
ExportToFile | Saves the user database to a file. |
ExportToStream | Saves the user database to a stream. |
ExportUser | Saves the user details to a string. |
ImportBytes | Loads a user database from a byte array. |
ImportFromFile | Loads a user database from a file. |
ImportFromStream | Loads a user database from a stream. |
ImportUser | Loads a user from a string. |
Reset | Resets the class settings. |
VerifyUser | Verifies the correctness of the user credentials. |
VerifyUserKey | Verifies the correctness of the user credentials. |
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 error information during its work. |
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.
AuthRealm | Specifies authentication realm for digest and NTLM authentication. |
TempPath | Path for storing temporary files. |
UniqueUsernames | Allows just one user entry per username. |
UseSaltedPasswords | Enables or disables the use of salted passwords. |
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. |
FIPSMode Property (UserManager Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_usermanager_getfipsmode(void* lpObj);
int secureblackbox_usermanager_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
Users Property (UserManager Class)
A collection of known users along with their connection settings.
Syntax
SecureBlackboxList<SecureBlackboxUserAccount>* GetUsers(); int SetUsers(SecureBlackboxList<SecureBlackboxUserAccount>* val);
int secureblackbox_usermanager_getusercount(void* lpObj);
int secureblackbox_usermanager_setusercount(void* lpObj, int iUserCount);
int secureblackbox_usermanager_getuserassociateddata(void* lpObj, int userindex, char** lpUserAssociatedData, int* lenUserAssociatedData);
int secureblackbox_usermanager_setuserassociateddata(void* lpObj, int userindex, const char* lpUserAssociatedData, int lenUserAssociatedData);
char* secureblackbox_usermanager_getuserbasepath(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserbasepath(void* lpObj, int userindex, const char* lpszUserBasePath);
int secureblackbox_usermanager_getusercertificate(void* lpObj, int userindex, char** lpUserCertificate, int* lenUserCertificate);
int secureblackbox_usermanager_setusercertificate(void* lpObj, int userindex, const char* lpUserCertificate, int lenUserCertificate);
char* secureblackbox_usermanager_getuserdata(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserdata(void* lpObj, int userindex, const char* lpszUserData);
char* secureblackbox_usermanager_getuseremail(void* lpObj, int userindex);
int secureblackbox_usermanager_setuseremail(void* lpObj, int userindex, const char* lpszUserEmail);
int64 secureblackbox_usermanager_getuserhandle(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserhandle(void* lpObj, int userindex, int64 lUserHandle);
char* secureblackbox_usermanager_getuserhashalgorithm(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserhashalgorithm(void* lpObj, int userindex, const char* lpszUserHashAlgorithm);
int secureblackbox_usermanager_getuserincomingspeedlimit(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserincomingspeedlimit(void* lpObj, int userindex, int iUserIncomingSpeedLimit);
int secureblackbox_usermanager_getuserotpalgorithm(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserotpalgorithm(void* lpObj, int userindex, int iUserOtpAlgorithm);
int secureblackbox_usermanager_getuserotplen(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserotplen(void* lpObj, int userindex, int iUserOTPLen);
int secureblackbox_usermanager_getuserotpvalue(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserotpvalue(void* lpObj, int userindex, int iUserOtpValue);
int secureblackbox_usermanager_getuseroutgoingspeedlimit(void* lpObj, int userindex);
int secureblackbox_usermanager_setuseroutgoingspeedlimit(void* lpObj, int userindex, int iUserOutgoingSpeedLimit);
char* secureblackbox_usermanager_getuserpassword(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserpassword(void* lpObj, int userindex, const char* lpszUserPassword);
int secureblackbox_usermanager_getusersharedsecret(void* lpObj, int userindex, char** lpUserSharedSecret, int* lenUserSharedSecret);
int secureblackbox_usermanager_setusersharedsecret(void* lpObj, int userindex, const char* lpUserSharedSecret, int lenUserSharedSecret);
int secureblackbox_usermanager_getusersshkey(void* lpObj, int userindex, char** lpUserSSHKey, int* lenUserSSHKey);
int secureblackbox_usermanager_setusersshkey(void* lpObj, int userindex, const char* lpUserSSHKey, int lenUserSSHKey);
char* secureblackbox_usermanager_getuserusername(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserusername(void* lpObj, int userindex, const char* lpszUserUsername);
int GetUserCount();
int SetUserCount(int iUserCount); QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData); QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath); QByteArray GetUserCertificate(int iUserIndex);
int SetUserCertificate(int iUserIndex, QByteArray qbaUserCertificate); QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData); QString GetUserEmail(int iUserIndex);
int SetUserEmail(int iUserIndex, QString qsUserEmail); qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle); QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm); int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit); int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm); int GetUserOTPLen(int iUserIndex);
int SetUserOTPLen(int iUserIndex, int iUserOTPLen); int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue); int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit); QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword); QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret); QByteArray GetUserSSHKey(int iUserIndex);
int SetUserSSHKey(int iUserIndex, QByteArray qbaUserSSHKey); QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);
Remarks
Use this property to access the collection of known users and their details.
This property is not available at design time.
Data Type
AddUser Method (UserManager Class)
Creates a new user account and adds it to the Users list.
Syntax
ANSI (Cross Platform) int AddUser(const char* lpszUsername); Unicode (Windows) INT AddUser(LPCWSTR lpszUsername);
int secureblackbox_usermanager_adduser(void* lpObj, const char* lpszUsername);
int AddUser(const QString& qsUsername);
Remarks
Use this method to create a new user record.
Error Handling (C++)
This method returns an Integer 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.
Config Method (UserManager Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_usermanager_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.
CreateNew Method (UserManager Class)
Creates a new user account database.
Syntax
ANSI (Cross Platform) int CreateNew(); Unicode (Windows) INT CreateNew();
int secureblackbox_usermanager_createnew(void* lpObj);
int CreateNew();
Remarks
Use this method to create a new user database. The method empties the Users collection and makes the component ready for editing the new database.
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.)
DoAction Method (UserManager 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_usermanager_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.
ExportBytes Method (UserManager Class)
Saves the user database to a byte array.
Syntax
ANSI (Cross Platform) char* ExportBytes(const char* lpszPassword, int *lpSize = NULL); Unicode (Windows) LPSTR ExportBytes(LPCWSTR lpszPassword, LPINT lpSize = NULL);
char* secureblackbox_usermanager_exportbytes(void* lpObj, const char* lpszPassword, int *lpSize);
QByteArray ExportBytes(const QString& qsPassword);
Remarks
Use this method to save the settings of all users to a byte array.
Use a non-empty Password to protect the database.
Error Handling (C++)
This method returns a Byte Array value (with length lpSize); 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.
ExportToFile Method (UserManager Class)
Saves the user database to a file.
Syntax
ANSI (Cross Platform) int ExportToFile(const char* lpszFileName, const char* lpszPassword); Unicode (Windows) INT ExportToFile(LPCWSTR lpszFileName, LPCWSTR lpszPassword);
int secureblackbox_usermanager_exporttofile(void* lpObj, const char* lpszFileName, const char* lpszPassword);
int ExportToFile(const QString& qsFileName, const QString& qsPassword);
Remarks
Use this method to save the settings of all users to a file.
Use a non-empty Password to protect the database.
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.)
ExportToStream Method (UserManager Class)
Saves the user database to a stream.
Syntax
ANSI (Cross Platform) int ExportToStream(SecureBlackboxStream* sOutputStream, const char* lpszPassword); Unicode (Windows) INT ExportToStream(SecureBlackboxStream* sOutputStream, LPCWSTR lpszPassword);
int secureblackbox_usermanager_exporttostream(void* lpObj, SecureBlackboxStream* sOutputStream, const char* lpszPassword);
int ExportToStream(SecureBlackboxStream* sOutputStream, const QString& qsPassword);
Remarks
Use this method to save the settings of all users in a stream.
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.)
ExportUser Method (UserManager Class)
Saves the user details to a string.
Syntax
ANSI (Cross Platform) char* ExportUser(int iIndex); Unicode (Windows) LPWSTR ExportUser(INT iIndex);
char* secureblackbox_usermanager_exportuser(void* lpObj, int iIndex);
QString ExportUser(int iIndex);
Remarks
Use this method to save the details of the user to a string blob.
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.
ImportBytes Method (UserManager Class)
Loads a user database from a byte array.
Syntax
ANSI (Cross Platform) int ImportBytes(const char* lpUserBytes, int lenUserBytes, const char* lpszPassword, int bClear); Unicode (Windows) INT ImportBytes(LPCSTR lpUserBytes, INT lenUserBytes, LPCWSTR lpszPassword, BOOL bClear);
int secureblackbox_usermanager_importbytes(void* lpObj, const char* lpUserBytes, int lenUserBytes, const char* lpszPassword, int bClear);
int ImportBytes(QByteArray qbaUserBytes, const QString& qsPassword, bool bClear);
Remarks
Use this method to load user information from a byte array specified by UserBytes parameter. Provide a Password to decrypt the user information.
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.)
ImportFromFile Method (UserManager Class)
Loads a user database from a file.
Syntax
ANSI (Cross Platform) int ImportFromFile(const char* lpszFileName, const char* lpszPassword, int bClear); Unicode (Windows) INT ImportFromFile(LPCWSTR lpszFileName, LPCWSTR lpszPassword, BOOL bClear);
int secureblackbox_usermanager_importfromfile(void* lpObj, const char* lpszFileName, const char* lpszPassword, int bClear);
int ImportFromFile(const QString& qsFileName, const QString& qsPassword, bool bClear);
Remarks
Use this method to load user information from a file specified by FileName. Provide a Password to decrypt the user information.
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.)
ImportFromStream Method (UserManager Class)
Loads a user database from a stream.
Syntax
ANSI (Cross Platform) int ImportFromStream(SecureBlackboxStream* sInputStream, const char* lpszPassword, int bClear); Unicode (Windows) INT ImportFromStream(SecureBlackboxStream* sInputStream, LPCWSTR lpszPassword, BOOL bClear);
int secureblackbox_usermanager_importfromstream(void* lpObj, SecureBlackboxStream* sInputStream, const char* lpszPassword, int bClear);
int ImportFromStream(SecureBlackboxStream* sInputStream, const QString& qsPassword, bool bClear);
Remarks
Use this method to load the user information from InputStream. Provide a Password to decrypt the user information.
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.)
ImportUser Method (UserManager Class)
Loads a user from a string.
Syntax
ANSI (Cross Platform) int ImportUser(const char* lpszData); Unicode (Windows) INT ImportUser(LPCWSTR lpszData);
int secureblackbox_usermanager_importuser(void* lpObj, const char* lpszData);
int ImportUser(const QString& qsData);
Remarks
Use this method to load user information from a string specified by Data parameter.
Error Handling (C++)
This method returns an Integer 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 (UserManager Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_usermanager_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.)
VerifyUser Method (UserManager Class)
Verifies the correctness of the user credentials.
Syntax
ANSI (Cross Platform) bool VerifyUser(const char* lpszUsername, const char* lpszPassword); Unicode (Windows) INT VerifyUser(LPCWSTR lpszUsername, LPCWSTR lpszPassword);
bool secureblackbox_usermanager_verifyuser(void* lpObj, const char* lpszUsername, const char* lpszPassword);
bool VerifyUser(const QString& qsUsername, const QString& qsPassword);
Remarks
Use this method to establish the correctness of the supplied username and password.
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.
VerifyUserKey Method (UserManager Class)
Verifies the correctness of the user credentials.
Syntax
ANSI (Cross Platform) bool VerifyUserKey(const char* lpszUsername, const char* lpKey, int lenKey); Unicode (Windows) INT VerifyUserKey(LPCWSTR lpszUsername, LPCSTR lpKey, INT lenKey);
bool secureblackbox_usermanager_verifyuserkey(void* lpObj, const char* lpszUsername, const char* lpKey, int lenKey);
bool VerifyUserKey(const QString& qsUsername, QByteArray qbaKey);
Remarks
Use this method to establish the correctness of the supplied username and key.
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 (UserManager Class)
Reports error information during its work.
Syntax
ANSI (Cross Platform) virtual int FireError(UserManagerErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } UserManagerErrorEventParams;
Unicode (Windows) virtual INT FireError(UserManagerErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } UserManagerErrorEventParams;
#define EID_USERMANAGER_ERROR 1 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class UserManagerErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(UserManagerErrorEventParams *e);
// Or, subclass UserManager and override this emitter function. virtual int FireError(UserManagerErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during user management operations.
ErrorCode contains an error code and Description contains a textual description of the error.
Notification Event (UserManager Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(UserManagerNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } UserManagerNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(UserManagerNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } UserManagerNotificationEventParams;
#define EID_USERMANAGER_NOTIFICATION 2 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class UserManagerNotificationEventParams { 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(UserManagerNotificationEventParams *e);
// Or, subclass UserManager and override this emitter function. virtual int FireNotification(UserManagerNotificationEventParams *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.
UserAccount Type
A container for user account information.
Syntax
SecureBlackboxUserAccount (declared in secureblackbox.h)
Remarks
UserAccount objects are used to store user account information, such as logins and passwords.
Fields
AssociatedData
char*
Default Value:
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
BasePath
char*
Default Value: ""
Base path for this user in the server's file system.
Certificate
char*
Default Value:
Contains the user's certificate.
Data
char*
Default Value: ""
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
Email
char*
Default Value: ""
The user's email address.
Handle
int64
Default Value: 0
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());
HashAlgorithm
char*
Default Value: ""
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 |
IncomingSpeedLimit
int
Default Value: 0
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".
OtpAlgorithm
int
Default Value: 0
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 |
OTPLen
int
Default Value: 0
Specifies the length of the user's OTP password.
OtpValue
int
Default Value: 0
The user's time interval (TOTP) or Counter (HOTP).
OutgoingSpeedLimit
int
Default Value: 0
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".
Password
char*
Default Value: ""
The user's authentication password.
SharedSecret
char*
Default Value:
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.
SSHKey
char*
Default Value:
Contains the user's SSH key.
Username
char*
Default Value: ""
The registered name (login) of the user.
Constructors
UserAccount()
Creates a new UserAccount object
SecureBlackboxList Type
Syntax
SecureBlackboxList<T> (declared in secureblackbox.h)
Remarks
SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the UserManager class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount(int count) {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
SecureBlackboxStream Type
Syntax
SecureBlackboxStream (declared in secureblackbox.h)
Remarks
The UserManager class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the UserManager class an instance of that concrete class.
When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Properties | |
CanRead |
Whether the stream supports reading.
bool CanRead() { return true; } |
CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; } |
CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; } |
Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {} This method is called automatically when a SecureBlackboxStream object is deleted. |
Flush |
Forces all data held by the stream's buffers to be written out to storage.
int Flush() { return 0; } Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
int Read(void* buffer, int count) = 0; Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
Seek |
Sets the current position within the stream based on a particular point of origin.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
int Write(const void* buffer, int count) = 0; Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
Config Settings (UserManager 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.UserManager 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.
Trappable Errors (UserManager 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.
UserManager 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) |