CertificateStorage ConfigurationThe 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 method.
CertificateStorage Configuration Settings
|AuthAttempts: The number of auth/login attempts to try.Specifies the number of tries to authenticate to the storage (the default is 3). The control will fire PasswordNeeded event after each unsuccessful attempt. Applicable to: PKCS11.|
|PKCS11ActiveSlot: The index of the slot that the component is working with.Returns the index of the PKCS#11 slot that is currently being accessed.|
|PKCS11NewPIN: Changes the current user's PIN.Setting this property will change the current users's PIN to the provided value. Most HSMs require the user to be signed in to perform this operation. This is the way to change your own PIN, either for admin or regular user accounts.|
|PKCS11NewUserPIN: Registers a new user PIN.Setting this property will register a new PIN to the HSM user account. This property is the way to administratively reset the user's PIN, and can only be set from under the 'admin' session.|
|PKCS11PIN: Sets the operation PIN.Use this property to provide your PIN on the fly for an operation requiring the private key (e.g. signing). This may be useful if the PIN was not provided on the Open stage.|
|PKCS11SlotCount: The number of slots exposed in the storage.Returns the number of slots available in an opened PKCS#11 storage.|
|PKCS11SlotDescription[i]: A human-readable description of the slot.Returns a human-readable description of slot i.|
|PKCS11SlotLoggedIn[i]: Whether slot i has an active session associated with it.Returns true if there is an active session associated with slot number i.|
|PKCS11SlotPinNeeded[i]: Whether slot i requires you to provide a PIN to log in or sign.Returns true if you need to provide a PIN to sign in to the session for slot i.|
|PKCS11SlotReadOnly[i]: Whether slot i only supports read-only access.Returns the availability of the slot for write operations.|
|PKCS11SlotTokenLabel[i]: The label assigned to the token.Returns the label assigned to the token.|
|PKCS11SlotTokenModel[i]: The token model.Returns the model of the token as provided by the driver.|
|PKCS11SlotTokenPresent[i]: Indicates whether there is a token in the slot.Returns true if slot number i has a token inserted.|
|PKCS11SlotTokenSerial[i]: The serial number of the token.Returns the serial number of the token.|
|PKCS11SlotTokenVendorID[i]: The manufacturer ID of the inserted token.Returns true if there is an active session associated with slot number i.|
|PKCS11SlotVendorID[i]: Returns the manufacturer ID of the slot.Returns the manufacturer name associated with the slot.|
|TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored.|
Base Configuration Settings
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.
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:
|Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).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.|
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.
|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".|
|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.|
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
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:
|LogFile: Specifies the debug log filename.Use this property to provide a path to the log file.|
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
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.
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|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.|
|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.|
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.|