UserManager Component
Properties Methods Events Config Settings Errors
The UserManager component stores information about user accounts.
Syntax
nsoftware.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 component with short descriptions. Click on the links for further details.
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddUser | Creates a new user account and adds it to the Users list. |
Config | Sets or retrieves a configuration setting. |
CreateNew | Creates a new user account database. |
DoAction | Performs an additional action. |
ExportBytes | Saves the user database to a byte array. |
ExportToFile | Saves the user database to a file. |
ExportToStream | Saves the user database to a stream. |
ExportUser | Saves the user details to a string. |
ImportBytes | Loads a user database from a byte array. |
ImportFromFile | Loads a user database from a file. |
ImportFromStream | Loads a user database from a stream. |
ImportUser | Loads a user from a string. |
Reset | Resets the component settings. |
VerifyUser | Verifies the correctness of the user credentials. |
VerifyUserKey | Verifies the correctness of the user credentials. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Error | Reports error information during its work. |
Notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AuthRealm | Specifies authentication realm for digest and NTLM authentication. |
TempPath | Path for storing temporary files. |
UniqueUsernames | Allows just one user entry per username. |
UseSaltedPasswords | Enables or disables the use of salted passwords. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the component. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client components created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
FIPSMode Property (UserManager Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
Users Property (UserManager Component)
A collection of known users along with their connection settings.
Syntax
public UserAccountList Users { get; }
Public Property Users As UserAccountList
Remarks
Use this property to access the collection of known users and their details.
This property is not available at design time.
Please refer to the UserAccount type for a complete list of fields.AddUser Method (UserManager Component)
Creates a new user account and adds it to the Users list.
Syntax
Remarks
Use this method to create a new user record.
Config Method (UserManager Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (UserManager Component)
Creates a new user account database.
Syntax
public void CreateNew();
Public Sub 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.
DoAction Method (UserManager Component)
Performs an additional action.
Syntax
Remarks
DoAction is a generic method available in every component. 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;....
ExportBytes Method (UserManager Component)
Saves the user database to a byte array.
Syntax
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 (UserManager Component)
Saves the user database to a file.
Syntax
Remarks
Use this method to save the settings of all users to a file.
Use a non-empty Password to protect the database.
ExportToStream Method (UserManager Component)
Saves the user database to a stream.
Syntax
public void ExportToStream(System.IO.Stream outputStream, string password);
Public Sub ExportToStream(ByVal OutputStream As System.IO.Stream, ByVal Password As String)
Remarks
Use this method to save the settings of all users in a stream.
ExportUser Method (UserManager Component)
Saves the user details to a string.
Syntax
Remarks
Use this method to save the details of the user to a string blob.
ImportBytes Method (UserManager Component)
Loads a user database from a byte array.
Syntax
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 (UserManager Component)
Loads a user database from a file.
Syntax
Remarks
Use this method to load user information from a file specified by FileName. Provide a Password to decrypt the user information.
ImportFromStream Method (UserManager Component)
Loads a user database from a stream.
Syntax
public void ImportFromStream(System.IO.Stream inputStream, string password, bool clear);
Public Sub ImportFromStream(ByVal InputStream As System.IO.Stream, ByVal Password As String, ByVal Clear As Boolean)
Remarks
Use this method to load the user information from InputStream. Provide a Password to decrypt the user information.
ImportUser Method (UserManager Component)
Loads a user from a string.
Syntax
Remarks
Use this method to load user information from a string specified by Data parameter.
Reset Method (UserManager Component)
Resets the component settings.
Syntax
public void Reset();
Public Sub Reset()
Remarks
Reset is a generic method available in every component.
VerifyUser Method (UserManager Component)
Verifies the correctness of the user credentials.
Syntax
Remarks
Use this method to establish the correctness of the supplied username and password.
VerifyUserKey Method (UserManager Component)
Verifies the correctness of the user credentials.
Syntax
Remarks
Use this method to establish the correctness of the supplied username and key.
Error Event (UserManager Component)
Reports error information during its work.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, UserManagerErrorEventArgs e); public class UserManagerErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As UserManagerErrorEventArgs) Public Class UserManagerErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
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 Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, UserManagerNotificationEventArgs e); public class UserManagerNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As UserManagerNotificationEventArgs) Public Class UserManagerNotificationEventArgs Inherits EventArgs Public ReadOnly Property EventID As String Public ReadOnly Property EventParam As String End Class
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, 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.
Remarks
UserAccount objects are used to store user account information, such as logins and passwords.
Fields
AssociatedData
byte[]
Default: ""
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
BasePath
string
Default: ""
Base path for this user in the server's file system.
Certificate
byte[]
Default: ""
Contains the user's certificate.
Data
string
Default: ""
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
Email
string
Default: ""
The user's email address.
HashAlgorithm
string
Default: ""
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:
SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
IncomingSpeedLimit
int
Default: 0
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".
OtpAlgorithm
OTPAlgorithms
Default: 0
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.
oaHmac | 0 | |
oaTime | 1 |
OTPLen
int
Default: 0
Specifies the length of the user's OTP password.
OtpValue
int
Default: 0
The user's time interval (TOTP) or Counter (HOTP).
OutgoingSpeedLimit
int
Default: 0
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".
Password
string
Default: ""
The user's authentication password.
SharedSecret
byte[]
Default: ""
Contains the user's secret key, which is essentially a shared secret between the client and server.
Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.
SSHKey
byte[]
Default: ""
Contains the user's SSH key.
Username
string
Default: ""
The registered name (login) of the user.
Constructors
public UserAccount();
Public UserAccount()
Creates a new UserAccount object
Config Settings (UserManager Component)
The component 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 component, access to these internal properties is provided through the Config method.UserManager Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (UserManager Component)
UserManager Errors
1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
1048585 | General error (SB_ERROR_GENERAL_ERROR) |