CryptoKeyStorage Module

Properties Methods Events Config Settings Errors

The CryptoKeyStorage module provides access to key stores of various types.

Syntax

SecureBlackbox.CryptoKeyStorage

Remarks

CryptoKeyStorage allows you to load and access cryptographic keys stored on different media, such as memory buffers, files, operating system, and hardware security modules.

To access keys stored on certain type of media, start with the Open method. Provide the location of your certificates via a uniform URI-like specifier. Once the storage has been opened, you can access the certificates contained in it via the Keys property. KeyStorage.Open("pkcs11://user:12345@localhost/C:/Windows/system32/asepkcs.dll?slot=0");

Iterate over the keys by using the Keys property, or use filtering facilities provided by the Select method. You can add keys to the storage with the ImportBytes, ImportFromFile, and ImportPinned methods. In the latter case please assign the key object to be imported to the PinnedKey property.

Use CreateNew method to create a new storage. Note that not all storage kinds can be created. KeyStorage.CreateNew("file", StorageFile);

When you have finished working with the certificate storage, close it with the Close method.

Property List

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


FIPSMode	Reserved.
Keys	An accessor to the collection of keys contained in the storage.
Opened	Indicates whether the storage is in the open state.
PinnedKey	A pinned key.
SelectedKeys	A collection of selected keys.
StorageID	A unique identifier of this storage.
StorageLocation	Specifies the location of the currently opened storage.

Method List

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


AddPinned	Adds the pinned key to the storage.
Clear	Removes all existing keys from the storage.
Close	Closes the logical storage.
Config	Sets or retrieves a configuration setting.
CreateNew	Creates a new storage.
DoAction	Performs an additional action.
GetStorageProperty	Returns the value of a custom key storage property.
ImportBytes	Imports a key to the storage.
ImportFromFile	Imports a key to the storage.
ListStores	Returns a list of individual stores available within the storage.
Login	Signs in to a session or elevates the session rights.
Logout	Signs out of an opened session.
Open	Opens existing storage or creates one in memory.
Refresh	Refreshes all storage keychains.
Remove	Removes a key from the storage.
Reset	Resets the module settings.
Select	Allows the selection of keys from the store.
SetStorageProperty	Sets the value of a custom key storage property.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.


Error	Fires when an errors happens during a key storage operation.
Notification	This event notifies the application about an underlying control flow event.
PasswordNeeded	This event is fired when a decryption password is needed.

Config Settings

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


AuthAttempts	The number of auth/login attempts to try.
PKCS11ActiveSlot	The index of the slot that the module is working with.
PKCS11AutoDetectStructAlignment	TBD.
PKCS11AutoGenerateKeyIDs	TBD.
PKCS11CreatePublicKeyObjects	TBD.
PKCS11DelayedPublicKeyImport	TBD.
PKCS11ForceUseForIndirectHashingOperations	TBD.
PKCS11IgnoreReportedSupportedAlgorithms	TBD.
PKCS11NewPIN	Changes the current user's PIN.
PKCS11NewUserPIN	Registers a new user PIN.
PKCS11NormalizeSourceLength	TBD.
PKCS11PIN	Sets the operation PIN.
PKCS11Slot	Controls the number of a PKCS#11 slot to be opened.
PKCS11SlotCount	The number of slots exposed in the storage.
PKCS11SlotDescription[i]	A human-readable description of the slot.
PKCS11SlotLoggedIn[i]	Whether slot i has an active session associated with it.
PKCS11SlotLoginRequired[i]	Specifies whether the token expects the user to sign in.
PKCS11SlotPinNeeded[i]	Whether slot i requires you to provide a PIN to log in or sign.
PKCS11SlotReadOnly[i]	Whether slot i only supports read-only access.
PKCS11SlotTokenFlags[i]	The capabilities flags of the inserted token.
PKCS11SlotTokenLabel[i]	The label assigned to the token.
PKCS11SlotTokenModel[i]	The token model.
PKCS11SlotTokenPresent[i]	Indicates whether there is a token in the slot.
PKCS11SlotTokenSerial[i]	The serial number of the token.
PKCS11SlotTokenVendorID[i]	The manufacturer ID of the inserted token.
PKCS11SlotVendorID[i]	Returns the manufacturer ID of the slot.
PKCS11SmartKeyImport	TBD.
PKCS11StoreKeys	TBD.
PKCS11TextEncodingMode	The encoding mode to apply to non-ASCII text strings.
PKCS11ThreadSafe	TBD.
PKCS11UseForHashingOperations	TBD.
PKCS11UseForNonPrivateOperations	TBD.
PKCS11UseForPublicKeyOperations	TBD.
PKCS11UseForSymmetricKeyOperations	TBD.
TempPath	Path for storing temporary files.
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 module.
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 modules 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.
PKICache	Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePath	Specifies the file system path where cached PKI data is stored.
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.
UseCRLObjectCaching	Specifies whether reuse of loaded CRL objects is enabled.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOCSPResponseObjectCaching	Specifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolver	Specifies whether the client modules 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.
XMLRDNDescriptorName[OID]	Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]	Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrder	Specifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparator	Specifies the separator used between descriptors in RDN.

FIPSMode Property (CryptoKeyStorage Module)

Reserved.

public var fipsMode: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

Keys Property (CryptoKeyStorage Module)

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

Syntax

Swift
Objective-C

public var keys: Array<CryptoKey> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=keyCount) int keyCount;

- (int)keyCount;

- (NSString*)keyAlgorithm:(int)keyIndex;

- (int)keyBits:(int)keyIndex;

- (NSString*)keyCurve:(int)keyIndex;

- (BOOL)keyExportable:(int)keyIndex;

- (NSString*)keyFingerprint:(int)keyIndex;

- (long long)keyHandle:(int)keyIndex;

- (NSData*)keyID:(int)keyIndex;

- (NSData*)keyIV:(int)keyIndex;

- (NSData*)keyKey:(int)keyIndex;

- (NSData*)keyNonce:(int)keyIndex;

- (BOOL)keyPrivate:(int)keyIndex;

- (BOOL)keyPublic:(int)keyIndex;

- (NSData*)keySubject:(int)keyIndex;

- (BOOL)keySymmetric:(int)keyIndex;

- (BOOL)keyValid:(int)keyIndex;

Default Value

Remarks

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

This property is read-only.

Opened Property (CryptoKeyStorage Module)

Indicates whether the storage is in the open state.

Syntax

Swift
Objective-C

public var opened: Bool {
  get {...}
}


@property (nonatomic,readonly,assign,getter=opened) BOOL opened;

- (BOOL)opened;

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.

PinnedKey Property (CryptoKeyStorage Module)

A pinned key.

Syntax

Swift
Objective-C

public var pinnedKey: CryptoKey {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=pinnedKeyHandle,setter=setPinnedKeyHandle:) long long pinnedKeyHandle;

- (long long)pinnedKeyHandle;
- (void)setPinnedKeyHandle :(long long)newPinnedKeyHandle;

Default Value

Remarks

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

This property is read-only.

SelectedKeys Property (CryptoKeyStorage Module)

A collection of selected keys.

Syntax

Swift
Objective-C

public var selectedKeys: Array<CryptoKey> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=selectedKeyCount) int selectedKeyCount;

- (int)selectedKeyCount;

- (NSString*)selectedKeyAlgorithm:(int)selectedKeyIndex;

- (int)selectedKeyBits:(int)selectedKeyIndex;

- (NSString*)selectedKeyCurve:(int)selectedKeyIndex;

- (BOOL)selectedKeyExportable:(int)selectedKeyIndex;

- (NSString*)selectedKeyFingerprint:(int)selectedKeyIndex;

- (long long)selectedKeyHandle:(int)selectedKeyIndex;

- (NSData*)selectedKeyID:(int)selectedKeyIndex;

- (NSData*)selectedKeyIV:(int)selectedKeyIndex;

- (NSData*)selectedKeyKey:(int)selectedKeyIndex;

- (NSData*)selectedKeyNonce:(int)selectedKeyIndex;

- (BOOL)selectedKeyPrivate:(int)selectedKeyIndex;

- (BOOL)selectedKeyPublic:(int)selectedKeyIndex;

- (NSData*)selectedKeySubject:(int)selectedKeyIndex;

- (BOOL)selectedKeySymmetric:(int)selectedKeyIndex;

- (BOOL)selectedKeyValid:(int)selectedKeyIndex;

Default Value

Remarks

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

This property is read-only.

StorageID Property (CryptoKeyStorage Module)

A unique identifier of this storage.

Syntax

Swift
Objective-C

public var storageID: String {
  get {...}
}


@property (nonatomic,readonly,assign,getter=storageID) NSString* storageID;

- (NSString*)storageID;

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

Specifies the location of the currently opened storage.

Syntax

Swift
Objective-C

public var storageLocation: String {
  get {...}
}


@property (nonatomic,readonly,assign,getter=storageLocation) NSString* storageLocation;

- (NSString*)storageLocation;

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


cslUnspecified	`unspecified`
cslMemory	`memory`	in-memory storage
cslFile	`file`	file storage
cslSystem	`system`	OS-specific certificate storage (e.g. CryptoAPI)
cslPKCS11	`pkcs11`	PKCS#11 compatible device
cslKMIP	`kmip`
cslApple	`apple`	Apple certificates storage (macOS and iOS only)
cslJava	`java`	java key storage

This property is read-only.

AddPinned Method (CryptoKeyStorage Module)

Adds the pinned key to the storage.

Syntax

Swift
Objective-C

public func addPinned() throws -> Void

- (void)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 Module)

Removes all existing keys from the storage.

Syntax

Swift
Objective-C

public func clear() throws -> Void

- (void)clear;

Remarks

Use this method to empty the storage.

Close Method (CryptoKeyStorage Module)

Closes the logical storage.

Syntax

Swift
Objective-C

public func close(save: Bool) throws -> Void

- (void)close:(BOOL)save;

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

Sets or retrieves a configuration setting.

Syntax

Swift
Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

CreateNew Method (CryptoKeyStorage Module)

Creates a new storage.

Syntax

Swift
Objective-C

public func createNew(storageLocation: String, storageID: String) throws -> Void

- (void)createNew:(NSString*)storageLocation :(NSString*)storageID;

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.


cslUnspecified	`unspecified`
cslMemory	`memory`	in-memory storage
cslFile	`file`	file storage
cslSystem	`system`	OS-specific certificate storage (e.g. CryptoAPI)
cslPKCS11	`pkcs11`	PKCS#11 compatible device
cslKMIP	`kmip`
cslApple	`apple`	Apple certificates storage (macOS and iOS only)
cslJava	`java`	java key storage

DoAction Method (CryptoKeyStorage Module)

Performs an additional action.

Syntax

Swift
Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;

Remarks

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

GetStorageProperty Method (CryptoKeyStorage Module)

Returns the value of a custom key storage property.

Syntax

Swift
Objective-C

public func getStorageProperty(propName: String) throws -> String

- (NSString*)getStorageProperty:(NSString*)propName;

Remarks

This method, together with SetStorageProperty, provides an extensible way of managing the certificate storage's settings that are not available through the primary properties of the component. The list of settings may be extended in future, in response to emergence of new storage variants and recognition of non-obvious storage usage scenarios.

Currently no custom properties are available for this component.

ImportBytes Method (CryptoKeyStorage Module)

Imports a key to the storage.

Syntax

Swift
Objective-C

public func importBytes(value: Data, format: Int32, keyAlgorithm: String, scheme: String, schemeParams: String, keyType: Int32, password: String) throws -> Void

- (void)importBytes:(NSData*)value :(int)format :(NSString*)keyAlgorithm :(NSString*)scheme :(NSString*)schemeParams :(int)keyType :(NSString*)password;

Remarks

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


kffUnknown	`0`	The key format was not recognized as one of the known formats.
kffAuto	`1`	The default format in current circumstances. This depends on the key being loaded or saved.
kffDER	`2`	DER (binary) format
kffPEM	`3`	PEM format (base64-encoded with headers)
kffJSON	`4`	JSON key format


ktAuto	`0`	The default key type in current circumstances. This depends on the operation, the file content, and the storage type.
ktPublic	`1`	The operation should be performed on a public key.
ktSecret	`2`	The operation should be performed on a private or secret key

ImportFromFile Method (CryptoKeyStorage Module)

Imports a key to the storage.

Syntax

Swift
Objective-C

public func importFromFile(fileName: String, format: Int32, keyAlgorithm: String, scheme: String, schemeParams: String, keyType: Int32, password: String) throws -> Void

- (void)importFromFile:(NSString*)fileName :(int)format :(NSString*)keyAlgorithm :(NSString*)scheme :(NSString*)schemeParams :(int)keyType :(NSString*)password;

Remarks

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


kffUnknown	`0`	The key format was not recognized as one of the known formats.
kffAuto	`1`	The default format in current circumstances. This depends on the key being loaded or saved.
kffDER	`2`	DER (binary) format
kffPEM	`3`	PEM format (base64-encoded with headers)
kffJSON	`4`	JSON key format


ktAuto	`0`	The default key type in current circumstances. This depends on the operation, the file content, and the storage type.
ktPublic	`1`	The operation should be performed on a public key.
ktSecret	`2`	The operation should be performed on a private or secret key

ListStores Method (CryptoKeyStorage Module)

Returns a list of individual stores available within the storage.

Syntax

Swift
Objective-C

public func listStores() throws -> String

- (NSString*)listStores;

Remarks

Use this method to query a list of individual stores available in the opened storage.

The contents of the list depends on the type of the store used and the parameters it is opened with. For PKCS#11 stores the method returns a list of slot descriptions for all slots published by the driver.

The store identifiers are separated from each other with a CRLF sequence.

Login Method (CryptoKeyStorage Module)

Signs in to a session or elevates the session rights.

Syntax

Swift
Objective-C

public func login(sessionType: Int32, pin: String, readOnly: Bool) throws -> Void

- (void)login:(int)sessionType :(NSString*)pin :(BOOL)readOnly;

Remarks

Use this method to sign in to a session with a required access type. Note that in some cases you may call this method more than one time for a specific session to elevate your access rights, for example: // open an unauthenticated session storage.Login(stUnauthenticated, "", false); // elevate the access rights for the session storage.Login(stUser, "password", false); Sessions are currently supported for PKCS#11 storage types only.


stUnauthenticated	`0`
stUser	`1`
stAdministrator	`2`

Logout Method (CryptoKeyStorage Module)

Signs out of an opened session.

Syntax

Swift
Objective-C

public func logout(closeSesion: Bool) throws -> Void

- (void)logout:(BOOL)closeSesion;

Remarks

Use this method to sign out of a session. Pass true to CloseSession to shut the session down altogether.

This method is currently support for PKCS#11 storage type only.

Open Method (CryptoKeyStorage Module)

Opens existing storage or creates one in memory.

Syntax

Swift
Objective-C

public func open(storageID: String) throws -> Void

- (void)open:(NSString*)storageID;

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

Refresh Method (CryptoKeyStorage Module)

Refreshes all storage keychains.

Syntax

Swift
Objective-C

public func refresh() throws -> Void

- (void)refresh;

Remarks

Call this method to refresh the storage.

Remove Method (CryptoKeyStorage Module)

Removes a key from the storage.

Syntax

Swift
Objective-C

public func remove(index: Int32) throws -> Void

- (void)remove:(int)index;

Remarks

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

Reset Method (CryptoKeyStorage Module)

Resets the component settings.

Syntax

Swift
Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

Select Method (CryptoKeyStorage Module)

Allows the selection of keys from the store.

Syntax

Swift
Objective-C

public func select(filter: String, privateKeyNeeded: Bool, maxCount: Int32) throws -> Void

- (void)select:(NSString*)filter :(BOOL)privateKeyNeeded :(int)maxCount;

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

Sets the value of a custom key storage property.

Syntax

Swift
Objective-C

public func setStorageProperty(propName: String, propValue: String) throws -> Void

- (void)setStorageProperty:(NSString*)propName :(NSString*)propValue;

Remarks

This method, together with GetStorageProperty, provides an extensible way of managing the certificate storage's settings that are not available through the primary properties of the component. The list of settings may be extended in future, in response to emergence of new storage variants and recognition of non-obvious storage usage scenarios.

Currently no custom properties are available for this component.

Error Event (CryptoKeyStorage Module)

Fires when an errors happens during a key storage operation.

Syntax

Swift
Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

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

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

Syntax

Swift
Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

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.

PasswordNeeded Event (CryptoKeyStorage Module)

This event is fired when a decryption password is needed.

Syntax

Swift
Objective-C

func onPasswordNeeded(neededFor: String, password: inout String, cancel: inout Bool)

- (void)onPasswordNeeded:(NSString*)neededFor :(NSString**)password :(int*)cancel;

Remarks

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

The following fields are available:

Fields

algorithm
String
Default Value: ""

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_RC4	`RC4`
SB_SYMMETRIC_ALGORITHM_DES	`DES`
SB_SYMMETRIC_ALGORITHM_3DES	`3DES`
SB_SYMMETRIC_ALGORITHM_RC2	`RC2`
SB_SYMMETRIC_ALGORITHM_AES128	`AES128`
SB_SYMMETRIC_ALGORITHM_AES192	`AES192`
SB_SYMMETRIC_ALGORITHM_AES256	`AES256`
SB_SYMMETRIC_ALGORITHM_IDENTITY	`Identity`
SB_SYMMETRIC_ALGORITHM_BLOWFISH	`Blowfish`
SB_SYMMETRIC_ALGORITHM_CAST128	`CAST128`
SB_SYMMETRIC_ALGORITHM_IDEA	`IDEA`
SB_SYMMETRIC_ALGORITHM_TWOFISH	`Twofish`
SB_SYMMETRIC_ALGORITHM_TWOFISH128	`Twofish128`
SB_SYMMETRIC_ALGORITHM_TWOFISH192	`Twofish192`
SB_SYMMETRIC_ALGORITHM_TWOFISH256	`Twofish256`
SB_SYMMETRIC_ALGORITHM_CAMELLIA	`Camellia`
SB_SYMMETRIC_ALGORITHM_CAMELLIA128	`Camellia128`
SB_SYMMETRIC_ALGORITHM_CAMELLIA192	`Camellia192`
SB_SYMMETRIC_ALGORITHM_CAMELLIA256	`Camellia256`
SB_SYMMETRIC_ALGORITHM_SERPENT	`Serpent`
SB_SYMMETRIC_ALGORITHM_SERPENT128	`Serpent128`
SB_SYMMETRIC_ALGORITHM_SERPENT192	`Serpent192`
SB_SYMMETRIC_ALGORITHM_SERPENT256	`Serpent256`
SB_SYMMETRIC_ALGORITHM_SEED	`SEED`
SB_SYMMETRIC_ALGORITHM_RABBIT	`Rabbit`
SB_SYMMETRIC_ALGORITHM_SYMMETRIC	`Generic`
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989	`GOST-28147-1989`
SB_SYMMETRIC_ALGORITHM_CHACHA20	`ChaCha20`


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

bits
Int32 (read-only)
Default Value: 0

The length of the key in bits.

curve
String
Default Value: ""

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

exportable
Bool (read-only)
Default Value: False

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

fingerprint
String (read-only)
Default Value: ""

Contains the fingerprint (a hash imprint) of this key.

handle
Int64
Default Value: 0

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

id
Data
Default Value: ""

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
Data
Default Value: ""

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
Data (read-only)
Default Value: ""

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

nonce
Data
Default Value: ""

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

private_
Bool (read-only)
Default Value: False

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

public_
Bool (read-only)
Default Value: False

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

subject
Data
Default Value: ""

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

symmetric
Bool (read-only)
Default Value: False

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

valid
Bool (read-only)
Default Value: False

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

Creates an empty crypto key object.

Config Settings (CryptoKeyStorage Module)

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

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

PKCS11AutoDetectStructAlignment: TBD.

TBD

PKCS11AutoGenerateKeyIDs: TBD.

TBD

PKCS11CreatePublicKeyObjects: TBD.

TBD

PKCS11DelayedPublicKeyImport: TBD.

TBD

PKCS11ForceUseForIndirectHashingOperations: TBD.

TBD

PKCS11IgnoreReportedSupportedAlgorithms: TBD.

TBD

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.

PKCS11NormalizeSourceLength: TBD.

TBD

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.

PKCS11Slot: Controls the number of a PKCS#11 slot to be opened.

Use this property to set the number of slot to be opened late into the process (after the storage has been opened). Use the auto placeholder to tell the component to select the slot automatically.

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.

PKCS11SlotLoginRequired[i]: Specifies whether the token expects the user to sign in.

Specifies whether the token in the slot #i expects the user to sign in to perform further operations with the token.

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.

PKCS11SlotTokenFlags[i]: The capabilities flags of the inserted token.

Returns the capabilities flags for the token inserted into slot number i.

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 vendor ID string for slot number i.

PKCS11SlotVendorID[i]: Returns the manufacturer ID of the slot.

Returns the manufacturer name associated with the slot.

PKCS11SmartKeyImport: TBD.

TBD

PKCS11StoreKeys: TBD.

TBD

PKCS11TextEncodingMode: The encoding mode to apply to non-ASCII text strings.

Specifies the method to approach strings (e.g. PINs) containing international characters when accessing PKCS#11 devices. The following options are available:

standard: use UTF8, as instructed by the PKCS#11 specification.
ansi: use Ansi (local) code page to convert text to the byte arrays that are passed over to the driver.
smart: if the standard approach fails, try the ansi approach automatically

PKCS11ThreadSafe: TBD.

TBD

PKCS11UseForHashingOperations: TBD.

TBD

PKCS11UseForNonPrivateOperations: TBD.

TBD

PKCS11UseForPublicKeyOperations: TBD.

TBD

PKCS11UseForSymmetricKeyOperations: TBD.

TBD

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

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.

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: auto, enable, or disable.

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): 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: 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 devided 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 chached 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: 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: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: 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.

Trappable Errors (CryptoKeyStorage Module)

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