UserManager Class

Properties   Methods   Events   Config Settings   Errors  

The UserManager class stores information about user accounts.

Syntax

UserManager

Remarks

The purpose of UserManager is storing, importing, and exporting information about users of some service. It is primarily used alongside server and SAML components to manage user account information - for example, to load it from a file or other media.

You start working with UserManager in one of two ways:

• By creating a new user database using CreateNew method.
• By importing an existing user database with ImportFromFile (or ImportBytes) method.

Having loaded or created a user database, you can access the user list via Users list. Use the properties of individual elements of this collection to access the details of a particular user.

Use AddUser method to add blank user accounts to the user list. Use the returned index to locate the user object in the Users list and adjust the settings as required.

If you made changes to the user list, use ExportToFile (or ExportBytes) method to save the updated user database.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

FIPSMode Property (UserManager Class)

Reserved.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

SecureBlackboxUserAccount

AddUser Method (UserManager Class)

Creates a new user account and adds it to the Users list.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

Common ActionIDs:

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

ANSI (Cross Platform)
bool VerifyUser(const char* lpszUsername, const char* lpszPassword);

Unicode (Windows)
bool 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

• C++
• C
• Qt

ANSI (Cross Platform)
bool VerifyUserKey(const char* lpszUsername, const char* lpKey, int lenKey);

Unicode (Windows)
bool 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

• C++
• C
• Qt

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

• C++
• C
• Qt

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.

• AssociatedData
• BasePath
• Certificate
• Data
• Email
• Handle
• HashAlgorithm
• IncomingSpeedLimit
• OtpAlgorithm
• OTPLen
• OtpValue
• OutgoingSpeedLimit
• Password
• SharedSecret
• SSHKey
• Username

Fields

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Constructors

UserAccount()

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.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

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.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (UserManager Class)

UserManager Config Settings

Base Config Settings

 
 Copy
PKICache=certificate,crl,ocsp

 
 Copy
PKICachePath=C:\Temp\cache

 
 Copy
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

 
 Copy
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

 
 Copy
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

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