Docs

SecureBlackbox 2022 .NET Edition

Version 22.0 [Build 8174]

CryptoKeyStorage Component

Properties   Methods   Events   Configuration Settings   Errors  

The CryptoKeyStorage component offers key storage functionality for a variety of key store types.

Syntax

nsoftware.SecureBlackbox.Cryptokeystorage

Remarks

CryptoKeyStorage provides access to many types of key stores, such as files or PKCS#11.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

FIPSModeReserved.
KeysAn accessor to the collection of keys contained in the storage.
OpenedIndicates whether the storage is in the open state.
PinnedKeyA pinned key.
SelectedKeysA collection of selected keys.
StorageIDA unique identifier of this storage.
StorageLocationSpecifies the location of the currently opened storage.

Method List


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

AddPinnedAdds the pinned key to the storage.
ClearRemoves all existing keys from the storage.
CloseCloses the logical storage.
ConfigSets or retrieves a configuration setting.
CreateNewCreates a new storage.
DoActionPerforms an additional action.
GetStoragePropertyTBD
ImportBytesAdds a key to the storage.
ImportFromFileAdds a key to the storage.
ImportFromStreamAdds a key to the storage.
ListStoresTBD
LoginTBD.
LogoutTBD.
OpenOpens existing storage or creates one in memory.
RefreshRefreshes all storage keychains.
RemoveRemoves a key from the storage.
SelectAllows the selection of keys from the store.
SetStoragePropertyTBD

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.

ErrorFires when an errors happens during a key storage operation.
NotificationThis event notifies the application about an underlying control flow event.
PasswordNeededThis event is fired when a decryption password is needed.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

TempPathPath for storing temporary files.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
TagAllows to store any custom data.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

FIPSMode Property (CryptoKeyStorage Component)

Reserved.

Syntax

public bool FIPSMode { get; set; }
Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

Keys Property (CryptoKeyStorage Component)

An accessor to the collection of keys contained in the storage.

Syntax

public CryptoKeyList Keys { get; }
Public ReadOnly Property Keys As CryptoKeyList

Remarks

Use this property to access, browse, or iterate over keys contained in the storage.

This property is read-only and not available at design time.

Opened Property (CryptoKeyStorage Component)

Indicates whether the storage is in the open state.

Syntax

public bool Opened { get; }
Public ReadOnly Property Opened As Boolean

Default Value

False

Remarks

Use this property to check if the storage has been 'opened.' Different kinds of key storages imply different meanings for 'being opened', but generally a storage is open if it is available for operations.

Use Open method to open a storage.

This property is read-only and not available at design time.

PinnedKey Property (CryptoKeyStorage Component)

A pinned key.

Syntax

public CryptoKey PinnedKey { get; set; }
Public Property PinnedKey As CryptoKey

Remarks

Use this property to pin a key before adding it to the storage with AddPinned method.

This property is not available at design time.

SelectedKeys Property (CryptoKeyStorage Component)

A collection of selected keys.

Syntax

public CryptoKeyList SelectedKeys { get; }
Public ReadOnly Property SelectedKeys As CryptoKeyList

Remarks

This property contains a list of keys returned by Select method.

This property is read-only and not available at design time.

StorageID Property (CryptoKeyStorage Component)

A unique identifier of this storage.

Syntax

public string StorageID { get; }
Public ReadOnly Property StorageID As String

Default Value

""

Remarks

Use this property to get a unique ID of this storage. The format of ID may differ for different kinds of key storages, and may range from a file path for a file storage, to a URI-like ID for a PKCS#11 storage, to an empty value for an in-memory storage.

This property is read-only.

StorageLocation Property (CryptoKeyStorage Component)

Specifies the location of the currently opened storage.

Syntax

public string StorageLocation { get; }
Public ReadOnly Property StorageLocation As String

Default Value

""

Remarks

Use this property to get the location of the active storage. The location indicates the nature of the storage and can be assigned with one of the below values (more values may be added in future):

cslUnspecifiedunspecified
cslMemorymemoryin-memory storage

cslFilefilefile storage

cslSystemsystemOS-specific certificate storage (e.g. CryptoAPI)

cslPKCS11pkcs11PKCS#11 compatible device

cslKMIPkmip
cslAppleappleApple certificates storage (macOS and iOS only)

This property is read-only.

AddPinned Method (CryptoKeyStorage Component)

Adds the pinned key to the storage.

Syntax

public void AddPinned();
Public Sub AddPinned()

Remarks

This method adds a key attached to the PinnedKey property to the storage. This method is a handy way of adding keys generated/returned by other components.

Clear Method (CryptoKeyStorage Component)

Removes all existing keys from the storage.

Syntax

public void Clear();
Public Sub Clear()

Remarks

Use this method to empty the storage.

Close Method (CryptoKeyStorage Component)

Closes the logical storage.

Syntax

public void Close(bool save);
Public Sub Close(ByVal Save As Boolean)

Remarks

Use this method to close logical storages connected to PKCS#11-compliant hardware security modules, or storages of similar persistent kinds. Closing a persistent storage with this method is important, as unused but unclosed storages consume extra resources and may result in eventual key locks.

Config Method (CryptoKeyStorage Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);
Public Function Config(ByVal ConfigurationString As String) As String

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

Creates a new storage.

Syntax

public void CreateNew(string storageLocation, string storageID);
Public Sub CreateNew(ByVal StorageLocation As String, ByVal StorageID As String)

Remarks

Use this method to create new key storage.

StorageLocation specifies where the new storage should be created, and StorageID contains a unique storage identifier.

cslUnspecifiedunspecified
cslMemorymemoryin-memory storage

cslFilefilefile storage

cslSystemsystemOS-specific certificate storage (e.g. CryptoAPI)

cslPKCS11pkcs11PKCS#11 compatible device

cslKMIPkmip
cslAppleappleApple certificates storage (macOS and iOS only)

DoAction Method (CryptoKeyStorage Component)

Performs an additional action.

Syntax

public string DoAction(string actionID, string actionParams);
Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetStorageProperty Method (CryptoKeyStorage Component)

TBD

Syntax

public string GetStorageProperty(string propName);
Public Function GetStorageProperty(ByVal PropName As String) As String

Remarks

TBD

ImportBytes Method (CryptoKeyStorage Component)

Adds a key to the storage.

Syntax

public void ImportBytes(byte[] value, int format, string keyAlgorithm, string scheme, string schemeParams, int keyType);
Public Sub ImportBytes(ByVal Value As Byte(), ByVal Format As Integer, ByVal KeyAlgorithm As String, ByVal Scheme As String, ByVal SchemeParams As String, ByVal KeyType As Integer)

Remarks

Use this method to add a key from a byte array.

kffUnknown0The key format was not recognized as one of the known formats.

kffAuto1The default format in current circumstances. This depends on the key being loaded or saved.

kffDER2DER (binary) format

kffPEM3PEM format (base64-encoded with headers)

kffJSON4JSON key format

ktAuto0The default key type in current circumstances. This depends on the operation, the file content, and the storage type.

ktPublic1The operation should be performed on a public key.

ktSecret2The operation should be performed on a private or secret key

ImportFromFile Method (CryptoKeyStorage Component)

Adds a key to the storage.

Syntax

public void ImportFromFile(string filename, int format, string keyAlgorithm, string scheme, string schemeParams, int keyType);
Public Sub ImportFromFile(ByVal Filename As String, ByVal Format As Integer, ByVal KeyAlgorithm As String, ByVal Scheme As String, ByVal SchemeParams As String, ByVal KeyType As Integer)

Remarks

Use this method to add a key stored in a file.

kffUnknown0The key format was not recognized as one of the known formats.

kffAuto1The default format in current circumstances. This depends on the key being loaded or saved.

kffDER2DER (binary) format

kffPEM3PEM format (base64-encoded with headers)

kffJSON4JSON key format

ktAuto0The default key type in current circumstances. This depends on the operation, the file content, and the storage type.

ktPublic1The operation should be performed on a public key.

ktSecret2The operation should be performed on a private or secret key

ImportFromStream Method (CryptoKeyStorage Component)

Adds a key to the storage.

Syntax

public void ImportFromStream(System.IO.Stream stream, int format, string keyAlgorithm, string scheme, string schemeParams, int keyType);
Public Sub ImportFromStream(ByVal Stream As System.IO.Stream, ByVal Format As Integer, ByVal KeyAlgorithm As String, ByVal Scheme As String, ByVal SchemeParams As String, ByVal KeyType As Integer)

Remarks

Use this method to add a key contained in a stream.

kffUnknown0The key format was not recognized as one of the known formats.

kffAuto1The default format in current circumstances. This depends on the key being loaded or saved.

kffDER2DER (binary) format

kffPEM3PEM format (base64-encoded with headers)

kffJSON4JSON key format

ktAuto0The default key type in current circumstances. This depends on the operation, the file content, and the storage type.

ktPublic1The operation should be performed on a public key.

ktSecret2The operation should be performed on a private or secret key

ListStores Method (CryptoKeyStorage Component)

TBD

Syntax

public string ListStores();
Public Function ListStores() As String

Remarks

TBD

Login Method (CryptoKeyStorage Component)

TBD.

Syntax

public void Login(int sessionType, string pin, bool readOnly);
Public Sub Login(ByVal SessionType As Integer, ByVal Pin As String, ByVal ReadOnly As Boolean)

Remarks

SessionType is a type of longing. Possible values:

stUnauthenticated0
stUser1
stSecurityOfficer2

TBD

Logout Method (CryptoKeyStorage Component)

TBD.

Syntax

public void Logout(bool closeSesion);
Public Sub Logout(ByVal CloseSesion As Boolean)

Remarks

TBD

Open Method (CryptoKeyStorage Component)

Opens existing storage or creates one in memory.

Syntax

public void Open(string storageID);
Public Sub Open(ByVal StorageID As String)

Remarks

Use this method to open the storage with the given StorageID. Key storages can come from several different locations, detailed below.

Memory

A storage can be created in memory by passing an empty string ("").

File

A storage can be opened from a file using one of two syntaxes:

  • C:\Certs\keys.pem
  • file://C:/Certs/keys.pem

Windows System

A storage can be opened from the Windows System using this syntax: system://{user}@{host}/?{params}

user is one of these values:

  • currentuser
  • localmachine
  • currentservice
host is either "localhost", an IP address, or FQDN.

params are chosen from this list:

  • store (required), is the name of the Windows store to access (e.g. "MY")
  • readonly, whether to access the store with only read permissions. Use 0 for false, and 1 for true.
Example: system://currentuser@localhost/?store=MY&readonly=1

PKCS#11 Device

A storage can be opened from a PKCS#11 device using this syntax: pkcs11://{user}:{pin}@/{driverpath}?{params}

user is the username used to access the device.

pin is the pin code used to access the device.

driverpath is the path to the driver used to access the device.

params are chosen from this list:

  • slot, the token slot to access on the device. If not provided, one will be chosen automatically.
  • readonly, whether to access the device with only read permissions. Use 0 for false, and 1 for true.
Example: pkcs11://john.doe:1234@/c:/windows/system32/asepkcs.dll?slot=0&readonly=1

KMIP Server

A storage can be opened from a KMIP server using this syntax: mailto:{password}@{remotehost}:{remoteport}/?{params}

password is the password use to authenticate to the server.

remotehost is the FQDN to the server.

remoteport is the server port to connect to.

params are chosen from this list:

  • encoder, the message encoding used to communicate with the server. Possible values are:
    • 1 (XML)
    • 2 (JSON)
    • 3 (TTLV)
Example: mailto:password@kmip.website.com:5696/?encoder=1 TBD: add information specific to crypto key storage

Refresh Method (CryptoKeyStorage Component)

Refreshes all storage keychains.

Syntax

public void Refresh();
Public Sub Refresh()

Remarks

Call this method to refresh the storage.

Remove Method (CryptoKeyStorage Component)

Removes a key from the storage.

Syntax

public void Remove(int index);
Public Sub Remove(ByVal Index As Integer)

Remarks

Use this method to remove a key from the storage by its index.

Select Method (CryptoKeyStorage Component)

Allows the selection of keys from the store.

Syntax

public void Select(string filter, bool privateKeyNeeded, int maxCount);
Public Sub Select(ByVal Filter As String, ByVal PrivateKeyNeeded As Boolean, ByVal MaxCount As Integer)

Remarks

This function allows the user to select keys from the storage by applying a Filter. PrivateKeyNeeded specifies whether only private keys should be selected. MaxCount limits the number of certificates selected.

SetStorageProperty Method (CryptoKeyStorage Component)

TBD

Syntax

public void SetStorageProperty(string propName, string propValue);
Public Sub SetStorageProperty(ByVal PropName As String, ByVal PropValue As String)

Remarks

TBD

Error Event (CryptoKeyStorage Component)

Fires when an errors happens during a key storage operation.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, CryptokeystorageErrorEventArgs e);

public class CryptokeystorageErrorEventArgs : EventArgs {
  public int ErrorCode { get; }

  public string Description { get; }

}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As CryptokeystorageErrorEventArgs)

Public Class CryptokeystorageErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer

  Public ReadOnly Property Description As String

End Class

Remarks

This event reports an exceptional situation during a key storage operation.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (CryptoKeyStorage Component)

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

Syntax

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, CryptokeystorageNotificationEventArgs e);

public class CryptokeystorageNotificationEventArgs : EventArgs {
  public string EventID { get; }

  public string EventParam { get; }

}
Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As CryptokeystorageNotificationEventArgs)

Public Class CryptokeystorageNotificationEventArgs 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 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.

PasswordNeeded Event (CryptoKeyStorage Component)

This event is fired when a decryption password is needed.

Syntax

public event OnPasswordNeededHandler OnPasswordNeeded;

public delegate void OnPasswordNeededHandler(object sender, CryptokeystoragePasswordNeededEventArgs e);

public class CryptokeystoragePasswordNeededEventArgs : EventArgs {
  public string NeededFor { get; }

  public string Password { get; set; }

  public bool Cancel { get; set; }

}
Public Event OnPasswordNeeded As OnPasswordNeededHandler

Public Delegate Sub OnPasswordNeededHandler(sender As Object, e As CryptokeystoragePasswordNeededEventArgs)

Public Class CryptokeystoragePasswordNeededEventArgs Inherits EventArgs
  Public ReadOnly Property NeededFor As String

  Public Property Password As String

  Public Property Cancel As Boolean

End Class

Remarks

The component fires this event when a password is needed to decrypt a certificate or a private key.

In the handler of this event, assign the password to the Password parameter, or set Cancel to true to abort the operation.

The NeededFor parameter identifies the key or certificate for which the password is requested.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Algorithm
String

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.

SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_DESDES
SB_SYMMETRIC_ALGORITHM_3DES3DES
SB_SYMMETRIC_ALGORITHM_RC2RC2
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES192AES192
SB_SYMMETRIC_ALGORITHM_AES256AES256
SB_SYMMETRIC_ALGORITHM_IDENTITYIdentity
SB_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish
SB_SYMMETRIC_ALGORITHM_CAST128CAST128
SB_SYMMETRIC_ALGORITHM_IDEAIDEA
SB_SYMMETRIC_ALGORITHM_TWOFISHTwofish
SB_SYMMETRIC_ALGORITHM_TWOFISH128Twofish128
SB_SYMMETRIC_ALGORITHM_TWOFISH192Twofish192
SB_SYMMETRIC_ALGORITHM_TWOFISH256Twofish256
SB_SYMMETRIC_ALGORITHM_CAMELLIACamellia
SB_SYMMETRIC_ALGORITHM_CAMELLIA128Camellia128
SB_SYMMETRIC_ALGORITHM_CAMELLIA192Camellia192
SB_SYMMETRIC_ALGORITHM_CAMELLIA256Camellia256
SB_SYMMETRIC_ALGORITHM_SERPENTSerpent
SB_SYMMETRIC_ALGORITHM_SERPENT128Serpent128
SB_SYMMETRIC_ALGORITHM_SERPENT192Serpent192
SB_SYMMETRIC_ALGORITHM_SERPENT256Serpent256
SB_SYMMETRIC_ALGORITHM_SEEDSEED
SB_SYMMETRIC_ALGORITHM_RABBITRabbit
SB_SYMMETRIC_ALGORITHM_SYMMETRICGeneric
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989GOST-28147-1989
SB_SYMMETRIC_ALGORITHM_CHACHA20ChaCha20

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

Bits
Integer

The length of the key in bits.

Curve
String

This property specifies the name of the curve the EC key is built on.

Exportable
Boolean

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

ID
Byte()

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

IV
Byte()

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

Key
Byte()

The byte array representation of the key. This may not be available for non-Exportable keys.

Nonce
Byte()

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

Private
Boolean

Returns True if the object hosts a private key, and False otherwise.

Public
Boolean

Returns True if the object hosts a public key, and False otherwise.

Subject
Byte()

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

Symmetric
Boolean

Returns True if the object contains a symmetric key, and False otherwise.

Valid
Boolean

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

Constructors

public CryptoKey();
Public CryptoKey()

Creates an empty crypto key object.

Configuration Settings (CryptoKeyStorage 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.

CryptoKeyStorage Configuration Settings

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

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

Supported values are:

offNo caching (default)
localLocal caching (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

Cookies:   Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the component 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.

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.

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

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

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.

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.

Trappable Errors (CryptoKeyStorage Component)

CryptoKeyStorage Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2022 .NET Edition - Version 22.0 [Build 8174]