CryptoKeyStorage Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_CryptoKeyStorage

Procedural Interface

 secureblackbox_cryptokeystorage_open();
 secureblackbox_cryptokeystorage_close($res);
 secureblackbox_cryptokeystorage_register_callback($res, $id, $function);
 secureblackbox_cryptokeystorage_get_last_error($res);
 secureblackbox_cryptokeystorage_get_last_error_code($res);
 secureblackbox_cryptokeystorage_set($res, $id, $index, $value);
 secureblackbox_cryptokeystorage_get($res, $id, $index);
 secureblackbox_cryptokeystorage_do_addpinned($res);
 secureblackbox_cryptokeystorage_do_clear($res);
 secureblackbox_cryptokeystorage_do_close($res, $save);
 secureblackbox_cryptokeystorage_do_config($res, $configurationstring);
 secureblackbox_cryptokeystorage_do_createnew($res, $storagelocation, $storageid);
 secureblackbox_cryptokeystorage_do_doaction($res, $actionid, $actionparams);
 secureblackbox_cryptokeystorage_do_getstorageproperty($res, $propname);
 secureblackbox_cryptokeystorage_do_importbytes($res, $value, $format, $keyalgorithm, $scheme, $schemeparams, $keytype);
 secureblackbox_cryptokeystorage_do_importfromfile($res, $filename, $format, $keyalgorithm, $scheme, $schemeparams, $keytype);
 secureblackbox_cryptokeystorage_do_liststores($res);
 secureblackbox_cryptokeystorage_do_login($res, $sessiontype, $pin, $readonly);
 secureblackbox_cryptokeystorage_do_logout($res, $closesesion);
 secureblackbox_cryptokeystorage_do_open($res, $storageid);
 secureblackbox_cryptokeystorage_do_refresh($res);
 secureblackbox_cryptokeystorage_do_remove($res, $index);
 secureblackbox_cryptokeystorage_do_select($res, $filter, $privatekeyneeded, $maxcount);
 secureblackbox_cryptokeystorage_do_setstorageproperty($res, $propname, $propvalue);

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 class with short descriptions. Click on the links for further details.

FIPSModeReserved.
KeyCountThe number of records in the Key arrays.
KeyAlgorithmThe algorithm of the cryptographic key.
KeyBitsThe length of the key in bits.
KeyCurveThis property specifies the name of the curve the EC key is built on.
KeyExportableReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
KeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KeyIDProvides access to a storage-specific key identifier.
KeyIVThe initialization vector (IV) of a symmetric key.
KeyKeyThe byte array representation of the key.
KeyNonceA nonce value associated with a key.
KeyPrivateReturns True if the object hosts a private key, and False otherwise.
KeyPublicReturns True if the object hosts a public key, and False otherwise.
KeySubjectReturns the key subject.
KeySymmetricReturns True if the object contains a symmetric key, and False otherwise.
KeyValidReturns True if this key is valid.
OpenedIndicates whether the storage is in the open state.
PinnedKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedKeyCountThe number of records in the SelectedKey arrays.
SelectedKeyAlgorithmThe algorithm of the cryptographic key.
SelectedKeyBitsThe length of the key in bits.
SelectedKeyCurveThis property specifies the name of the curve the EC key is built on.
SelectedKeyExportableReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
SelectedKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedKeyIDProvides access to a storage-specific key identifier.
SelectedKeyIVThe initialization vector (IV) of a symmetric key.
SelectedKeyKeyThe byte array representation of the key.
SelectedKeyNonceA nonce value associated with a key.
SelectedKeyPrivateReturns True if the object hosts a private key, and False otherwise.
SelectedKeyPublicReturns True if the object hosts a public key, and False otherwise.
SelectedKeySubjectReturns the key subject.
SelectedKeySymmetricReturns True if the object contains a symmetric key, and False otherwise.
SelectedKeyValidReturns True if this key is valid.
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 class 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.
GetStoragePropertyReturns the value of a custom key storage property.
ImportBytesAdds a key to the storage.
ImportFromFileAdds a key to the storage.
ListStoresReturns a list of individual stores available within the storage.
LoginSigns in to a session or elevates the session rights.
LogoutSigns out of an opened session.
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.
SetStoragePropertySets the value of a custom key storage property.

Event List


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

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.

Config Settings


The following is a list of config settings for the class 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 class.
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.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
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 (SecureBlackbox_CryptoKeyStorage Class)

Reserved.

Object Oriented Interface


public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface


secureblackbox_cryptokeystorage_get($res, 1 );


secureblackbox_cryptokeystorage_set($res, 1, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KeyCount Property (SecureBlackbox_CryptoKeyStorage Class)

The number of records in the Key arrays.

Object Oriented Interface


public function getKeyCount();


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 2 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at KeyCount - 1.

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

Data Type

Integer

KeyAlgorithm Property (SecureBlackbox_CryptoKeyStorage Class)

The algorithm of the cryptographic key.

Object Oriented Interface


public function getKeyAlgorithm($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 3 , $keyindex);


Default Value

''

Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyBits Property (SecureBlackbox_CryptoKeyStorage Class)

The length of the key in bits.

Object Oriented Interface


public function getKeyBits($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 4 , $keyindex);


Default Value

0

Remarks

The length of the key in bits.

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Integer

KeyCurve Property (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface


public function getKeyCurve($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 5 , $keyindex);


Default Value

''

Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyExportable Property (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface


public function getKeyExportable($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 6 , $keyindex);


Default Value

false

Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyHandle Property (SecureBlackbox_CryptoKeyStorage Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getKeyHandle($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 7 , $keyindex);


Default Value

0

Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Long64

KeyID Property (SecureBlackbox_CryptoKeyStorage Class)

Provides access to a storage-specific key identifier.

Object Oriented Interface


public function getKeyID($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 8 , $keyindex);


Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Byte Array

KeyIV Property (SecureBlackbox_CryptoKeyStorage Class)

The initialization vector (IV) of a symmetric key.

Object Oriented Interface


public function getKeyIV($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 9 , $keyindex);


Remarks

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.

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Byte Array

KeyKey Property (SecureBlackbox_CryptoKeyStorage Class)

The byte array representation of the key.

Object Oriented Interface


public function getKeyKey($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 10 , $keyindex);


Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Byte Array

KeyNonce Property (SecureBlackbox_CryptoKeyStorage Class)

A nonce value associated with a key.

Object Oriented Interface


public function getKeyNonce($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 11 , $keyindex);


Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Byte Array

KeyPrivate Property (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface


public function getKeyPrivate($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 12 , $keyindex);


Default Value

false

Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyPublic Property (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface


public function getKeyPublic($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 13 , $keyindex);


Default Value

false

Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeySubject Property (SecureBlackbox_CryptoKeyStorage Class)

Returns the key subject.

Object Oriented Interface


public function getKeySubject($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 14 , $keyindex);


Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Byte Array

KeySymmetric Property (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface


public function getKeySymmetric($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 15 , $keyindex);


Default Value

false

Remarks

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

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyValid Property (SecureBlackbox_CryptoKeyStorage Class)

Returns True if this key is valid.

Object Oriented Interface


public function getKeyValid($keyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 16 , $keyindex);


Default Value

false

Remarks

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.

The $keyindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

Opened Property (SecureBlackbox_CryptoKeyStorage Class)

Indicates whether the storage is in the open state.

Object Oriented Interface


public function getOpened();


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 17 );


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.

Data Type

Boolean

PinnedKeyHandle Property (SecureBlackbox_CryptoKeyStorage Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getPinnedKeyHandle();


public function setPinnedKeyHandle($value);

Procedural Interface


secureblackbox_cryptokeystorage_get($res, 22 );


secureblackbox_cryptokeystorage_set($res, 22, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Long64

SelectedKeyCount Property (SecureBlackbox_CryptoKeyStorage Class)

The number of records in the SelectedKey arrays.

Object Oriented Interface


public function getSelectedKeyCount();


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 32 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SelectedKeyCount - 1.

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

Data Type

Integer

SelectedKeyAlgorithm Property (SecureBlackbox_CryptoKeyStorage Class)

The algorithm of the cryptographic key.

Object Oriented Interface


public function getSelectedKeyAlgorithm($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 33 , $selectedkeyindex);


Default Value

''

Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyBits Property (SecureBlackbox_CryptoKeyStorage Class)

The length of the key in bits.

Object Oriented Interface


public function getSelectedKeyBits($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 34 , $selectedkeyindex);


Default Value

0

Remarks

The length of the key in bits.

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Integer

SelectedKeyCurve Property (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface


public function getSelectedKeyCurve($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 35 , $selectedkeyindex);


Default Value

''

Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyExportable Property (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface


public function getSelectedKeyExportable($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 36 , $selectedkeyindex);


Default Value

false

Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeyHandle Property (SecureBlackbox_CryptoKeyStorage Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getSelectedKeyHandle($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 37 , $selectedkeyindex);


Default Value

0

Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Long64

SelectedKeyID Property (SecureBlackbox_CryptoKeyStorage Class)

Provides access to a storage-specific key identifier.

Object Oriented Interface


public function getSelectedKeyID($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 38 , $selectedkeyindex);


Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Byte Array

SelectedKeyIV Property (SecureBlackbox_CryptoKeyStorage Class)

The initialization vector (IV) of a symmetric key.

Object Oriented Interface


public function getSelectedKeyIV($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 39 , $selectedkeyindex);


Remarks

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.

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Byte Array

SelectedKeyKey Property (SecureBlackbox_CryptoKeyStorage Class)

The byte array representation of the key.

Object Oriented Interface


public function getSelectedKeyKey($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 40 , $selectedkeyindex);


Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Byte Array

SelectedKeyNonce Property (SecureBlackbox_CryptoKeyStorage Class)

A nonce value associated with a key.

Object Oriented Interface


public function getSelectedKeyNonce($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 41 , $selectedkeyindex);


Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Byte Array

SelectedKeyPrivate Property (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface


public function getSelectedKeyPrivate($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 42 , $selectedkeyindex);


Default Value

false

Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeyPublic Property (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface


public function getSelectedKeyPublic($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 43 , $selectedkeyindex);


Default Value

false

Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeySubject Property (SecureBlackbox_CryptoKeyStorage Class)

Returns the key subject.

Object Oriented Interface


public function getSelectedKeySubject($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 44 , $selectedkeyindex);


Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Byte Array

SelectedKeySymmetric Property (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface


public function getSelectedKeySymmetric($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 45 , $selectedkeyindex);


Default Value

false

Remarks

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

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeyValid Property (SecureBlackbox_CryptoKeyStorage Class)

Returns True if this key is valid.

Object Oriented Interface


public function getSelectedKeyValid($selectedkeyindex);


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 46 , $selectedkeyindex);


Default Value

false

Remarks

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.

The $selectedkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

StorageID Property (SecureBlackbox_CryptoKeyStorage Class)

A unique identifier of this storage.

Object Oriented Interface


public function getStorageID();


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 47 );


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.

Data Type

String

StorageLocation Property (SecureBlackbox_CryptoKeyStorage Class)

Specifies the location of the currently opened storage.

Object Oriented Interface


public function getStorageLocation();


Procedural Interface


secureblackbox_cryptokeystorage_get($res, 48 );


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)

cslJavajavajava key storage

This property is read-only.

Data Type

String

AddPinned Method (SecureBlackbox_CryptoKeyStorage Class)

Adds the pinned key to the storage.

Object Oriented Interface

public function doAddPinned();

Procedural Interface

secureblackbox_cryptokeystorage_do_addpinned($res);

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 (SecureBlackbox_CryptoKeyStorage Class)

Removes all existing keys from the storage.

Object Oriented Interface

public function doClear();

Procedural Interface

secureblackbox_cryptokeystorage_do_clear($res);

Remarks

Use this method to empty the storage.

Close Method (SecureBlackbox_CryptoKeyStorage Class)

Closes the logical storage.

Object Oriented Interface

public function doClose($save);

Procedural Interface

secureblackbox_cryptokeystorage_do_close($res, $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 (SecureBlackbox_CryptoKeyStorage Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_cryptokeystorage_do_config($res, $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 (SecureBlackbox_CryptoKeyStorage Class)

Creates a new storage.

Object Oriented Interface

public function doCreateNew($storagelocation, $storageid);

Procedural Interface

secureblackbox_cryptokeystorage_do_createnew($res, $storagelocation, $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.

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)

cslJavajavajava key storage

DoAction Method (SecureBlackbox_CryptoKeyStorage Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_cryptokeystorage_do_doaction($res, $actionid, $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;....

GetStorageProperty Method (SecureBlackbox_CryptoKeyStorage Class)

Returns the value of a custom key storage property.

Object Oriented Interface

public function doGetStorageProperty($propname);

Procedural Interface

secureblackbox_cryptokeystorage_do_getstorageproperty($res, $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 (SecureBlackbox_CryptoKeyStorage Class)

Adds a key to the storage.

Object Oriented Interface

public function doImportBytes($value, $format, $keyalgorithm, $scheme, $schemeparams, $keytype);

Procedural Interface

secureblackbox_cryptokeystorage_do_importbytes($res, $value, $format, $keyalgorithm, $scheme, $schemeparams, $keytype);

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 (SecureBlackbox_CryptoKeyStorage Class)

Adds a key to the storage.

Object Oriented Interface

public function doImportFromFile($filename, $format, $keyalgorithm, $scheme, $schemeparams, $keytype);

Procedural Interface

secureblackbox_cryptokeystorage_do_importfromfile($res, $filename, $format, $keyalgorithm, $scheme, $schemeparams, $keytype);

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

ListStores Method (SecureBlackbox_CryptoKeyStorage Class)

Returns a list of individual stores available within the storage.

Object Oriented Interface

public function doListStores();

Procedural Interface

secureblackbox_cryptokeystorage_do_liststores($res);

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 (SecureBlackbox_CryptoKeyStorage Class)

Signs in to a session or elevates the session rights.

Object Oriented Interface

public function doLogin($sessiontype, $pin, $readonly);

Procedural Interface

secureblackbox_cryptokeystorage_do_login($res, $sessiontype, $pin, $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.

stUnauthenticated0
stUser1
stAdministrator2

Logout Method (SecureBlackbox_CryptoKeyStorage Class)

Signs out of an opened session.

Object Oriented Interface

public function doLogout($closesesion);

Procedural Interface

secureblackbox_cryptokeystorage_do_logout($res, $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 (SecureBlackbox_CryptoKeyStorage Class)

Opens existing storage or creates one in memory.

Object Oriented Interface

public function doOpen($storageid);

Procedural Interface

secureblackbox_cryptokeystorage_do_open($res, $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 (SecureBlackbox_CryptoKeyStorage Class)

Refreshes all storage keychains.

Object Oriented Interface

public function doRefresh();

Procedural Interface

secureblackbox_cryptokeystorage_do_refresh($res);

Remarks

Call this method to refresh the storage.

Remove Method (SecureBlackbox_CryptoKeyStorage Class)

Removes a key from the storage.

Object Oriented Interface

public function doRemove($index);

Procedural Interface

secureblackbox_cryptokeystorage_do_remove($res, $index);

Remarks

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

Select Method (SecureBlackbox_CryptoKeyStorage Class)

Allows the selection of keys from the store.

Object Oriented Interface

public function doSelect($filter, $privatekeyneeded, $maxcount);

Procedural Interface

secureblackbox_cryptokeystorage_do_select($res, $filter, $privatekeyneeded, $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 (SecureBlackbox_CryptoKeyStorage Class)

Sets the value of a custom key storage property.

Object Oriented Interface

public function doSetStorageProperty($propname, $propvalue);

Procedural Interface

secureblackbox_cryptokeystorage_do_setstorageproperty($res, $propname, $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 (SecureBlackbox_CryptoKeyStorage Class)

Fires when an errors happens during a key storage operation.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_cryptokeystorage_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
'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 (SecureBlackbox_CryptoKeyStorage Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_cryptokeystorage_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
'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 (SecureBlackbox_CryptoKeyStorage Class)

This event is fired when a decryption password is needed.

Object Oriented Interface

public function firePasswordNeeded($param);

Procedural Interface

secureblackbox_cryptokeystorage_register_callback($res, 3, array($this, 'firePasswordNeeded'));

Parameter List

 'neededfor'
'password'
'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.

Config Settings (CryptoKeyStorage Class)

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

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

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:

offNo caching (default)
localLocal caching
globalGlobal 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.

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

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.

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.

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:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal 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).

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.

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

CryptoKeyStorage Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class 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)