# UserManager Class

The UserManager class stores information about user accounts.

## Syntax

```text
class secureblackbox.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 [create_new](#create_new-method) method.
- By importing an existing user database with [import_from_file](#import_from_file-method) (or [import_bytes](#import_bytes-method)) 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 [add_user](#add_user-method) 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 [export_to_file](#export_to_file-method) (or [export_bytes](#export_bytes-method)) 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.*

|  |  |
| --- | --- |
| [fips_mode](#fips_mode-property) | Reserved. |
| [user_count](#user_count-property) | The number of records in the User arrays. |
| [user_associated_data](#user_associated_data-property) | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. |
| [user_base_path](#user_base_path-property) | Base path for this user in the server's file system. |
| [user_certificate](#user_certificate-property) | Contains the user's certificate. |
| [user_data](#user_data-property) | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. |
| [user_email](#user_email-property) | The user's email address. |
| [user_handle](#user_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [user_hash_algorithm](#user_hash_algorithm-property) | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. |
| [user_incoming_speed_limit](#user_incoming_speed_limit-property) | Specifies the incoming speed limit for this user. |
| [user_otp_algorithm](#user_otp_algorithm-property) | The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). |
| [user_otp_len](#user_otp_len-property) | Specifies the length of the user's OTP password. |
| [user_otp_value](#user_otp_value-property) | The user's time interval (TOTP) or Counter (HOTP). |
| [user_outgoing_speed_limit](#user_outgoing_speed_limit-property) | Specifies the outgoing speed limit for this user. |
| [user_password](#user_password-property) | The user's authentication password. |
| [user_shared_secret](#user_shared_secret-property) | Contains the user's secret key, which is essentially a shared secret between the client and server. |
| [user_ssh_key](#user_ssh_key-property) | Contains the user's SSH key. |
| [username](#username-property) | The registered name (login) of the user. |

## Method List

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

|  |  |
| --- | --- |
| [add_user](#add_user-method) | Creates a new user account and adds it to the Users list. |
| [config](#config-method) | Sets or retrieves a configuration setting. |
| [create_new](#create_new-method) | Creates a new user account database. |
| [do_action](#do_action-method) | Performs an additional action. |
| [export_bytes](#export_bytes-method) | Saves the user database to a byte array. |
| [export_to_file](#export_to_file-method) | Saves the user database to a file. |
| [export_user](#export_user-method) | Saves the user details to a string. |
| [import_bytes](#import_bytes-method) | Loads a user database from a byte array. |
| [import_from_file](#import_from_file-method) | Loads a user database from a file. |
| [import_user](#import_user-method) | Loads a user from a string. |
| [reset](#reset-method) | Resets the class settings. |
| [verify_user](#verify_user-method) | Verifies the correctness of the user credentials. |
| [verify_user_key](#verify_user_key-method) | 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.*

|  |  |
| --- | --- |
| [on_error](#on_error-event) | Reports error information during its work. |
| [on_notification](#on_notification-event) | 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](#AuthRealm) | Specifies authentication realm for digest and NTLM authentication. |
| [TempPath](#TempPath) | Path for storing temporary files. |
| [UniqueUsernames](#UniqueUsernames) | Allows just one user entry per username. |
| [UseSaltedPasswords](#UseSaltedPasswords) | Enables or disables the use of salted passwords. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the class. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# fips_mode property

Reserved.

## Syntax

```text
def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...
fips_mode = property(get_fips_mode, set_fips_mode)
```

## Default Value

FALSE

## Remarks

This property is reserved for future use.

# user_count property

The number of records in the User arrays.

## Syntax

```text
def get_user_count() -> int: ...
def set_user_count(value: int) -> None: ...
user_count = property(get_user_count, set_user_count)
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [user_associated_data](#user_associated_data-property)
- [user_base_path](#user_base_path-property)
- [user_certificate](#user_certificate-property)
- [user_data](#user_data-property)
- [user_email](#user_email-property)
- [user_handle](#user_handle-property)
- [user_hash_algorithm](#user_hash_algorithm-property)
- [user_incoming_speed_limit](#user_incoming_speed_limit-property)
- [username](#username-property)
- [user_otp_algorithm](#user_otp_algorithm-property)
- [user_otp_len](#user_otp_len-property)
- [user_otp_value](#user_otp_value-property)
- [user_outgoing_speed_limit](#user_outgoing_speed_limit-property)
- [user_password](#user_password-property)
- [user_shared_secret](#user_shared_secret-property)
- [user_ssh_key](#user_ssh_key-property)

The array indices start at *0* and end at *user_count - 1*.

# user_associated_data property

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

## Syntax

```text
def get_user_associated_data(user_index: int) -> bytes: ...
def set_user_associated_data(user_index: int, value: bytes) -> None: ...
```

## Remarks

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

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_base_path property

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

## Syntax

```text
def get_user_base_path(user_index: int) -> str: ...
def set_user_base_path(user_index: int, value: str) -> None: ...
```

## Default Value

""

## Remarks

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

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_certificate property

Contains the user's certificate.

## Syntax

```text
def get_user_certificate(user_index: int) -> bytes: ...
def set_user_certificate(user_index: int, value: bytes) -> None: ...
```

## Remarks

Contains the user's certificate.

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_data property

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

## Syntax

```text
def get_user_data(user_index: int) -> str: ...
def set_user_data(user_index: int, value: str) -> None: ...
```

## Default Value

""

## Remarks

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

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_email property

The user's email address.

## Syntax

```text
def get_user_email(user_index: int) -> str: ...
def set_user_email(user_index: int, value: str) -> None: ...
```

## Default Value

""

## Remarks

The user's email address.

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_handle property

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

## Syntax

```text
def get_user_handle(user_index: int) -> int: ...
def set_user_handle(user_index: int, value: int) -> None: ...
```

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

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_hash_algorithm property

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

## Syntax

```text
def get_user_hash_algorithm(user_index: int) -> str: ...
def set_user_hash_algorithm(user_index: int, value: str) -> None: ...
```

## Default Value

""

## Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

|  |  |  |
| --- | --- | --- |
| SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 |  |
| SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 |  |
| SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |  |

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_incoming_speed_limit property

Specifies the incoming speed limit for this user.

## Syntax

```text
def get_user_incoming_speed_limit(user_index: int) -> int: ...
def set_user_incoming_speed_limit(user_index: int, value: int) -> None: ...
```

## Default Value

0

## Remarks

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

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_otp_algorithm property

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

## Syntax

```text
def get_user_otp_algorithm(user_index: int) -> int: ...
def set_user_otp_algorithm(user_index: int, value: int) -> None: ...
```

## Possible Values

```text
0   # None1   # Hmac2   # Time
```

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

|  |  |  |
| --- | --- | --- |
| oaHmac | 0 |  |
| oaTime | 1 |  |

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_otp_len property

Specifies the length of the user's OTP password.

## Syntax

```text
def get_user_otp_len(user_index: int) -> int: ...
def set_user_otp_len(user_index: int, value: int) -> None: ...
```

## Default Value

0

## Remarks

Specifies the length of the user's OTP password.

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_otp_value property

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

## Syntax

```text
def get_user_otp_value(user_index: int) -> int: ...
def set_user_otp_value(user_index: int, value: int) -> None: ...
```

## Default Value

0

## Remarks

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

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_outgoing_speed_limit property

Specifies the outgoing speed limit for this user.

## Syntax

```text
def get_user_outgoing_speed_limit(user_index: int) -> int: ...
def set_user_outgoing_speed_limit(user_index: int, value: int) -> None: ...
```

## Default Value

0

## Remarks

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

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_password property

The user's authentication password.

## Syntax

```text
def get_user_password(user_index: int) -> str: ...
def set_user_password(user_index: int, value: str) -> None: ...
```

## Default Value

""

## Remarks

The user's authentication password.

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_shared_secret property

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

## Syntax

```text
def get_user_shared_secret(user_index: int) -> bytes: ...
def set_user_shared_secret(user_index: int, value: bytes) -> None: ...
```

## 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 *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# user_ssh_key property

Contains the user's SSH key.

## Syntax

```text
def get_user_ssh_key(user_index: int) -> bytes: ...
def set_user_ssh_key(user_index: int, value: bytes) -> None: ...
```

## Remarks

Contains the user's SSH key.

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# username property

The registered name (login) of the user.

## Syntax

```text
def get_username(user_index: int) -> str: ...
def set_username(user_index: int, value: str) -> None: ...
```

## Default Value

""

## Remarks

The registered name (login) of the user.

The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property.

# add_user method

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

## Syntax

```text
def add_user(username: str) -> int: ...
```

## Remarks

Use this method to create a new user record.

# config method

Sets or retrieves a configuration setting.

## Syntax

```text
def config(configuration_string: str) -> str: ...
```

## Remarks

config is a generic method available in every class. It is used to set and retrieve [configuration settings](#usermanager-config-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](#usermanager-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string.

# create_new method

Creates a new user account database.

## Syntax

```text
def create_new() -> None: ...
```

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

# do_action method

Performs an additional action.

## Syntax

```text
def do_action(action_id: str, action_params: str) -> str: ...
```

## Remarks

do_action 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:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

# export_bytes method

Saves the user database to a byte array.

## Syntax

```text
def export_bytes(password: str) -> bytes: ...
```

## Remarks

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

Use a non-empty *Password* to protect the database.

# export_to_file method

Saves the user database to a file.

## Syntax

```text
def export_to_file(file_name: str, password: str) -> None: ...
```

## Remarks

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

Use a non-empty *Password* to protect the database.

# export_user method

Saves the user details to a string.

## Syntax

```text
def export_user(index: int) -> str: ...
```

## Remarks

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

# import_bytes method

Loads a user database from a byte array.

## Syntax

```text
def import_bytes(user_bytes: bytes, password: str, clear: bool) -> None: ...
```

## Remarks

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

# import_from_file method

Loads a user database from a file.

## Syntax

```text
def import_from_file(file_name: str, password: str, clear: bool) -> None: ...
```

## Remarks

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

# import_user method

Loads a user from a string.

## Syntax

```text
def import_user(data: str) -> int: ...
```

## Remarks

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

# reset method

Resets the class settings.

## Syntax

```text
def reset() -> None: ...
```

## Remarks

reset is a generic method available in every class.

# verify_user method

Verifies the correctness of the user credentials.

## Syntax

```text
def verify_user(username: str, password: str) -> bool: ...
```

## Remarks

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

# verify_user_key method

Verifies the correctness of the user credentials.

## Syntax

```text
def verify_user_key(username: str, key: bytes) -> bool: ...
```

## Remarks

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

# on_error event

Reports error information during its work.

## Syntax

```text
class UserManagerErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class UserManager:
@property
def on_error() -> Callable[[UserManagerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[UserManagerErrorEventParams], None]) -> None: ...
```

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

# on_notification event

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

## Syntax

```text
class UserManagerNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class UserManager:
@property
def on_notification() -> Callable[[UserManagerNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[UserManagerNotificationEventParams], None]) -> None: ...
```

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

# UserManager Config Settings

 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](#config-method) method.

### UserManager Config Settings

**AuthRealm**: Specifies authentication realm for digest and NTLM authentication.Specifies authentication realm for digest and NTLM authentication types.

**TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply.

**UniqueUsernames**: Allows just one user entry per username.Set this property to disallow multiple entries registered for the same username.

**UseSaltedPasswords**: Enables or disables the use of salted passwords.Use this property to enable or disable the use of salts when storing passwords.

### Base Config Settings

**ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it.

**AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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

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

**CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

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

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

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

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

**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

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

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

|  |  |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |

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

**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

**IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

**ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

|  |  |  |
| --- | --- | --- |
| file |  | File |
| console |  | Console |
| systemlog |  | System Log (supported for Android only) |
| debugger |  | Debugger (supported for VCL for Windows and .Net) |

**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

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

**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.

**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

|  |  |  |
| --- | --- | --- |
| exclude-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 |

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

|  |  |  |
| --- | --- | --- |
| none |  | No flush (caching only) |
| immediate |  | Immediate flush (real-time logging) |
| maxcount |  | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |

**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.

Supported values are:

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

**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

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

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

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

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

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

**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

**PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
PKICache=certificate,crl,ocsp
```

 In this example, the component caches certificates, CRLs, and OCSP responses.

**PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example:

```text
PKICachePath=C:\Temp\cache
```

 In this example, the cached PKI data is stored in the C:\Temp\cache directory.

**ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

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

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

**Tag**: Allows to store any custom data.Use this config property to store any custom data.

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

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

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.

**UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

**UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

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

**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.

**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.

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

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

**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax:

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

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

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

**XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

**XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

**XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

# UserManager Errors

### UserManager Errors

|  |  |
| --- | --- |
| 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) |
| 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) |
| 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) |
| 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) |
| 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) |
| 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) |
| 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) |
| 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) |
| 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |