UserManager Class
Properties Methods Events Configuration Settings Errors
The UserManager class stores information about user accounts.
Syntax
class secureblackbox.UserManager
Remarks
UserManager is responsible for storing, importing, and exporting information about users. It is primarily used with the server components.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
user_count | The number of records in the User arrays. |
user_associated_data | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. |
user_base_path | Base path for this user in the server's file system. |
user_cert | Contains the user's certificate. |
user_data | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. |
user_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
user_hash_algorithm | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. |
user_incoming_speed_limit | Specifies the incoming speed limit for this user. |
user_otp_algorithm | The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). |
user_otp_value | The user's time interval (TOTP) or Counter (HOTP). |
user_outgoing_speed_limit | Specifies the outgoing speed limit for this user. |
user_password | The user's authentication password. |
user_password_len | Specifies the length of the user's OTP password. |
user_shared_secret | Contains the user's secret key, which is essentially a shared secret between the client and server. |
user_ssh_key | Contains the user's SSH key. |
user_username | 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.
config | Sets or retrieves a configuration setting. |
load | Loads a user database from a file. |
load_user | Imports the settings of the current user from a file. |
save | Saves the user database to a file. |
save_user | Saves the settings of the current user to a file. |
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 | Reports error information during its work. |
on_notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
TempPath | Path for storing temporary files. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |