UserManager Class

Properties   Methods   Events   Config Settings   Errors  

The UserManager class stores information about user accounts.

Class Name

SecureBlackbox_UserManager

Procedural Interface

 secureblackbox_usermanager_open();
 secureblackbox_usermanager_close($res);
 secureblackbox_usermanager_register_callback($res, $id, $function);
 secureblackbox_usermanager_get_last_error($res);
 secureblackbox_usermanager_get_last_error_code($res);
 secureblackbox_usermanager_set($res, $id, $index, $value);
 secureblackbox_usermanager_get($res, $id, $index);
 secureblackbox_usermanager_do_adduser($res, $username);
 secureblackbox_usermanager_do_config($res, $configurationstring);
 secureblackbox_usermanager_do_createnew($res);
 secureblackbox_usermanager_do_doaction($res, $actionid, $actionparams);
 secureblackbox_usermanager_do_exportbytes($res, $password);
 secureblackbox_usermanager_do_exporttofile($res, $filename, $password);
 secureblackbox_usermanager_do_exportuser($res, $index);
 secureblackbox_usermanager_do_importbytes($res, $userbytes, $password, $clear);
 secureblackbox_usermanager_do_importfromfile($res, $filename, $password, $clear);
 secureblackbox_usermanager_do_importuser($res, $data);
 secureblackbox_usermanager_do_reset($res);
 secureblackbox_usermanager_do_verifyuser($res, $username, $password);
 secureblackbox_usermanager_do_verifyuserkey($res, $username, $key);

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

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_usermanager_get($res, 1 );
secureblackbox_usermanager_set($res, 1, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

UserCount Property (SecureBlackbox_UserManager Class)

The number of records in the User arrays.

Object Oriented Interface

public function getUserCount();
public function setUserCount($value);

Procedural Interface

secureblackbox_usermanager_get($res, 2 );
secureblackbox_usermanager_set($res, 2, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserCertificate
• UserData
• UserEmail
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOtpAlgorithm
• UserOTPLen
• UserOtpValue
• UserOutgoingSpeedLimit
• UserPassword
• UserSharedSecret
• UserSSHKey
• UserUsername

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

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (SecureBlackbox_UserManager Class)

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

Object Oriented Interface

public function getUserAssociatedData($userindex);
public function setUserAssociatedData($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 3 , $userindex);
secureblackbox_usermanager_set($res, 3, $value , $userindex);

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

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

Object Oriented Interface

public function getUserBasePath($userindex);
public function setUserBasePath($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 4 , $userindex);
secureblackbox_usermanager_set($res, 4, $value , $userindex);

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

UserCertificate Property (SecureBlackbox_UserManager Class)

Contains the user's certificate.

Object Oriented Interface

public function getUserCertificate($userindex);
public function setUserCertificate($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 5 , $userindex);
secureblackbox_usermanager_set($res, 5, $value , $userindex);

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

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

Object Oriented Interface

public function getUserData($userindex);
public function setUserData($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 6 , $userindex);
secureblackbox_usermanager_set($res, 6, $value , $userindex);

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

UserEmail Property (SecureBlackbox_UserManager Class)

The user's email address.

Object Oriented Interface

public function getUserEmail($userindex);
public function setUserEmail($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 7 , $userindex);
secureblackbox_usermanager_set($res, 7, $value , $userindex);

Default Value

''

Remarks

The user's email address.

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

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

Object Oriented Interface

public function getUserHandle($userindex);
public function setUserHandle($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 8 , $userindex);
secureblackbox_usermanager_set($res, 8, $value , $userindex);

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.

 
 Copy
  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 (SecureBlackbox_UserManager Class)

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

Object Oriented Interface

public function getUserHashAlgorithm($userindex);
public function setUserHashAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 9 , $userindex);
secureblackbox_usermanager_set($res, 9, $value , $userindex);

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:

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

Specifies the incoming speed limit for this user.

Object Oriented Interface

public function getUserIncomingSpeedLimit($userindex);
public function setUserIncomingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 10 , $userindex);
secureblackbox_usermanager_set($res, 10, $value , $userindex);

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

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

Object Oriented Interface

public function getUserOtpAlgorithm($userindex);
public function setUserOtpAlgorithm($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 11 , $userindex);
secureblackbox_usermanager_set($res, 11, $value , $userindex);

Possible Values

USERMANAGER_USEROTPALGORITHM_NONE(0), 
USERMANAGER_USEROTPALGORITHM_HMAC(1), 
USERMANAGER_USEROTPALGORITHM_TIME(2)

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.

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

UserOTPLen Property (SecureBlackbox_UserManager Class)

Specifies the length of the user's OTP password.

Object Oriented Interface

public function getUserOTPLen($userindex);
public function setUserOTPLen($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 12 , $userindex);
secureblackbox_usermanager_set($res, 12, $value , $userindex);

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

UserOtpValue Property (SecureBlackbox_UserManager Class)

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

Object Oriented Interface

public function getUserOtpValue($userindex);
public function setUserOtpValue($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 13 , $userindex);
secureblackbox_usermanager_set($res, 13, $value , $userindex);

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

Specifies the outgoing speed limit for this user.

Object Oriented Interface

public function getUserOutgoingSpeedLimit($userindex);
public function setUserOutgoingSpeedLimit($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 14 , $userindex);
secureblackbox_usermanager_set($res, 14, $value , $userindex);

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

The user's authentication password.

Object Oriented Interface

public function getUserPassword($userindex);
public function setUserPassword($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 15 , $userindex);
secureblackbox_usermanager_set($res, 15, $value , $userindex);

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

UserSharedSecret Property (SecureBlackbox_UserManager Class)

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

Object Oriented Interface

public function getUserSharedSecret($userindex);
public function setUserSharedSecret($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 16 , $userindex);
secureblackbox_usermanager_set($res, 16, $value , $userindex);

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

Contains the user's SSH key.

Object Oriented Interface

public function getUserSSHKey($userindex);
public function setUserSSHKey($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 17 , $userindex);
secureblackbox_usermanager_set($res, 17, $value , $userindex);

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

The registered name (login) of the user.

Object Oriented Interface

public function getUserUsername($userindex);
public function setUserUsername($userindex, $value);

Procedural Interface

secureblackbox_usermanager_get($res, 18 , $userindex);
secureblackbox_usermanager_set($res, 18, $value , $userindex);

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

AddUser Method (SecureBlackbox_UserManager Class)

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

Object Oriented Interface

public function doAddUser($username);

Procedural Interface

secureblackbox_usermanager_do_adduser($res, $username);

Remarks

Use this method to create a new user record.

Config Method (SecureBlackbox_UserManager Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_usermanager_do_config($res, $configurationstring);

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.

CreateNew Method (SecureBlackbox_UserManager Class)

Creates a new user account database.

Object Oriented Interface

public function doCreateNew();

Procedural Interface

secureblackbox_usermanager_do_createnew($res);

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.

DoAction Method (SecureBlackbox_UserManager Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_usermanager_do_doaction($res, $actionid, $actionparams);

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:

ExportBytes Method (SecureBlackbox_UserManager Class)

Saves the user database to a byte array.

Object Oriented Interface

public function doExportBytes($password);

Procedural Interface

secureblackbox_usermanager_do_exportbytes($res, $password);

Remarks

Use this method to save the settings of all users to a byte array.

Use a non-empty Password to protect the database.

ExportToFile Method (SecureBlackbox_UserManager Class)

Saves the user database to a file.

Object Oriented Interface

public function doExportToFile($filename, $password);

Procedural Interface

secureblackbox_usermanager_do_exporttofile($res, $filename, $password);

Remarks

Use this method to save the settings of all users to a file.

Use a non-empty Password to protect the database.

ExportUser Method (SecureBlackbox_UserManager Class)

Saves the user details to a string.

Object Oriented Interface

public function doExportUser($index);

Procedural Interface

secureblackbox_usermanager_do_exportuser($res, $index);

Remarks

Use this method to save the details of the user to a string blob.

ImportBytes Method (SecureBlackbox_UserManager Class)

Loads a user database from a byte array.

Object Oriented Interface

public function doImportBytes($userbytes, $password, $clear);

Procedural Interface

secureblackbox_usermanager_do_importbytes($res, $userbytes, $password, $clear);

Remarks

Use this method to load user information from a byte array specified by UserBytes parameter. Provide a Password to decrypt the user information.

ImportFromFile Method (SecureBlackbox_UserManager Class)

Loads a user database from a file.

Object Oriented Interface

public function doImportFromFile($filename, $password, $clear);

Procedural Interface

secureblackbox_usermanager_do_importfromfile($res, $filename, $password, $clear);

Remarks

Use this method to load user information from a file specified by FileName. Provide a Password to decrypt the user information.

ImportUser Method (SecureBlackbox_UserManager Class)

Loads a user from a string.

Object Oriented Interface

public function doImportUser($data);

Procedural Interface

secureblackbox_usermanager_do_importuser($res, $data);

Remarks

Use this method to load user information from a string specified by Data parameter.

Reset Method (SecureBlackbox_UserManager Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_usermanager_do_reset($res);

Remarks

Reset is a generic method available in every class.

VerifyUser Method (SecureBlackbox_UserManager Class)

Verifies the correctness of the user credentials.

Object Oriented Interface

public function doVerifyUser($username, $password);

Procedural Interface

secureblackbox_usermanager_do_verifyuser($res, $username, $password);

Remarks

Use this method to establish the correctness of the supplied username and password.

VerifyUserKey Method (SecureBlackbox_UserManager Class)

Verifies the correctness of the user credentials.

Object Oriented Interface

public function doVerifyUserKey($username, $key);

Procedural Interface

secureblackbox_usermanager_do_verifyuserkey($res, $username, $key);

Remarks

Use this method to establish the correctness of the supplied username and key.

Error Event (SecureBlackbox_UserManager Class)

Reports error information during its work.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_usermanager_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_usermanager_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

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

UserManager Errors