CryptoKeyStorage Class
Properties Methods Events Configuration Settings Errors
The CryptoKeyStorage class offers key storage functionality for a variety of key store types.
Syntax
CryptoKeyStorage
Remarks
CryptoKeyStorage provides access to many types of key stores, such as files or PKCS#11.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| FIPSMode | Reserved. |
| KeyCount | The number of records in the Key arrays. |
| KeyAlgorithm | The algorithm of the cryptographic key. |
| KeyBits | The length of the key in bits. |
| KeyCurve | This property specifies the name of the curve the EC key is built on. |
| KeyExportable | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
| KeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| KeyID | Provides access to a storage-specific key identifier. |
| KeyIV | The initialization vector (IV) of a symmetric key. |
| KeyKey | The byte array representation of the key. |
| KeyNonce | A nonce value associated with a key. |
| KeyPrivate | Returns True if the object hosts a private key, and False otherwise. |
| KeyPublic | Returns True if the object hosts a public key, and False otherwise. |
| KeySubject | Returns the key subject. |
| KeySymmetric | Returns True if the object contains a symmetric key, and False otherwise. |
| KeyValid | Returns True if this key is valid. |
| Opened | Indicates whether the storage is in the open state. |
| PinnedKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SelectedKeyCount | The number of records in the SelectedKey arrays. |
| SelectedKeyAlgorithm | The algorithm of the cryptographic key. |
| SelectedKeyBits | The length of the key in bits. |
| SelectedKeyCurve | This property specifies the name of the curve the EC key is built on. |
| SelectedKeyExportable | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
| SelectedKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SelectedKeyID | Provides access to a storage-specific key identifier. |
| SelectedKeyIV | The initialization vector (IV) of a symmetric key. |
| SelectedKeyKey | The byte array representation of the key. |
| SelectedKeyNonce | A nonce value associated with a key. |
| SelectedKeyPrivate | Returns True if the object hosts a private key, and False otherwise. |
| SelectedKeyPublic | Returns True if the object hosts a public key, and False otherwise. |
| SelectedKeySubject | Returns the key subject. |
| SelectedKeySymmetric | Returns True if the object contains a symmetric key, and False otherwise. |
| SelectedKeyValid | Returns True if this key is valid. |
| 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 class 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 | TBD. |
| ImportBytes | Adds a key to the storage. |
| ImportFromFile | Adds a key to the storage. |
| ListStores | TBD. |
| Login | TBD. |
| Logout | TBD. |
| Open | Opens existing storage or creates one in memory. |
| Refresh | Refreshes all storage keychains. |
| Remove | Removes a key from the storage. |
| Select | Allows the selection of keys from the store. |
| SetStorageProperty | TBD. |
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.
| 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. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| TempPath | Path for storing temporary files. |
| 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 class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| 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. |
| Tag | Allows to store any custom data. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
FIPSMode Property (CryptoKeyStorage Class)
Reserved.
Syntax
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
KeyCount Property (CryptoKeyStorage Class)
The number of records in the Key arrays.
Syntax
int GetKeyCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- KeyAlgorithm
- KeyBits
- KeyCurve
- KeyExportable
- KeyHandle
- KeyID
- KeyIV
- KeyKey
- KeyNonce
- KeyPrivate
- KeyPublic
- KeySubject
- KeySymmetric
- KeyValid
This property is read-only and not available at design time.
Data Type
Integer
KeyAlgorithm Property (CryptoKeyStorage Class)
The algorithm of the cryptographic key.
Syntax
QString GetKeyAlgorithm(int iKeyIndex);
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_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 |
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 (CryptoKeyStorage Class)
The length of the key in bits.
Syntax
int GetKeyBits(int iKeyIndex);
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 (CryptoKeyStorage Class)
This property specifies the name of the curve the EC key is built on.
Syntax
QString GetKeyCurve(int iKeyIndex);
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 (CryptoKeyStorage Class)
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
Syntax
bool GetKeyExportable(int iKeyIndex);
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 (CryptoKeyStorage Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetKeyHandle(int iKeyIndex);
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 (CryptoKeyStorage Class)
Provides access to a storage-specific key identifier.
Syntax
QByteArray GetKeyID(int iKeyIndex);
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 (CryptoKeyStorage Class)
The initialization vector (IV) of a symmetric key.
Syntax
QByteArray GetKeyIV(int iKeyIndex);
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 (CryptoKeyStorage Class)
The byte array representation of the key.
Syntax
QByteArray GetKeyKey(int iKeyIndex);
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 (CryptoKeyStorage Class)
A nonce value associated with a key.
Syntax
QByteArray GetKeyNonce(int iKeyIndex);
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 (CryptoKeyStorage Class)
Returns True if the object hosts a private key, and False otherwise.
Syntax
bool GetKeyPrivate(int iKeyIndex);
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 (CryptoKeyStorage Class)
Returns True if the object hosts a public key, and False otherwise.
Syntax
bool GetKeyPublic(int iKeyIndex);
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 (CryptoKeyStorage Class)
Returns the key subject.
Syntax
QByteArray GetKeySubject(int iKeyIndex);
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 (CryptoKeyStorage Class)
Returns True if the object contains a symmetric key, and False otherwise.
Syntax
bool GetKeySymmetric(int iKeyIndex);
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 (CryptoKeyStorage Class)
Returns True if this key is valid.
Syntax
bool GetKeyValid(int iKeyIndex);
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 (CryptoKeyStorage Class)
Indicates whether the storage is in the open state.
Syntax
bool GetOpened();
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 (CryptoKeyStorage Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetPinnedKeyHandle();
int SetPinnedKeyHandle(qint64 lPinnedKeyHandle);
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 (CryptoKeyStorage Class)
The number of records in the SelectedKey arrays.
Syntax
int GetSelectedKeyCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- SelectedKeyAlgorithm
- SelectedKeyBits
- SelectedKeyCurve
- SelectedKeyExportable
- SelectedKeyHandle
- SelectedKeyID
- SelectedKeyIV
- SelectedKeyKey
- SelectedKeyNonce
- SelectedKeyPrivate
- SelectedKeyPublic
- SelectedKeySubject
- SelectedKeySymmetric
- SelectedKeyValid
This property is read-only and not available at design time.
Data Type
Integer
SelectedKeyAlgorithm Property (CryptoKeyStorage Class)
The algorithm of the cryptographic key.
Syntax
QString GetSelectedKeyAlgorithm(int iSelectedKeyIndex);
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_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 |
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 (CryptoKeyStorage Class)
The length of the key in bits.
Syntax
int GetSelectedKeyBits(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
This property specifies the name of the curve the EC key is built on.
Syntax
QString GetSelectedKeyCurve(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
Syntax
bool GetSelectedKeyExportable(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSelectedKeyHandle(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
Provides access to a storage-specific key identifier.
Syntax
QByteArray GetSelectedKeyID(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
The initialization vector (IV) of a symmetric key.
Syntax
QByteArray GetSelectedKeyIV(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
The byte array representation of the key.
Syntax
QByteArray GetSelectedKeyKey(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
A nonce value associated with a key.
Syntax
QByteArray GetSelectedKeyNonce(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
Returns True if the object hosts a private key, and False otherwise.
Syntax
bool GetSelectedKeyPrivate(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
Returns True if the object hosts a public key, and False otherwise.
Syntax
bool GetSelectedKeyPublic(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
Returns the key subject.
Syntax
QByteArray GetSelectedKeySubject(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
Returns True if the object contains a symmetric key, and False otherwise.
Syntax
bool GetSelectedKeySymmetric(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
Returns True if this key is valid.
Syntax
bool GetSelectedKeyValid(int iSelectedKeyIndex);
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 (CryptoKeyStorage Class)
A unique identifier of this storage.
Syntax
QString GetStorageID();
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 (CryptoKeyStorage Class)
Specifies the location of the currently opened storage.
Syntax
QString GetStorageLocation();
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) |
This property is read-only.
Data Type
String
AddPinned Method (CryptoKeyStorage Class)
Adds the pinned key to the storage.
Syntax
int 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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Clear Method (CryptoKeyStorage Class)
Removes all existing keys from the storage.
Syntax
int Clear();
Remarks
Use this method to empty the storage.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Close Method (CryptoKeyStorage Class)
Closes the logical storage.
Syntax
int Close(bool bSave);
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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (CryptoKeyStorage Class)
Sets or retrieves a configuration setting.
Syntax
QString Config(const QString& qsConfigurationString);
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.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
CreateNew Method (CryptoKeyStorage Class)
Creates a new storage.
Syntax
int CreateNew(const QString& qsStorageLocation, const QString& qsStorageID);
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) |
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoAction Method (CryptoKeyStorage Class)
Performs an additional action.
Syntax
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetStorageProperty Method (CryptoKeyStorage Class)
TBD.
Syntax
QString GetStorageProperty(const QString& qsPropName);
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ImportBytes Method (CryptoKeyStorage Class)
Adds a key to the storage.
Syntax
int ImportBytes(QByteArray qbaValue, int iFormat, const QString& qsKeyAlgorithm, const QString& qsScheme, const QString& qsSchemeParams, int iKeyType);
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 |
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ImportFromFile Method (CryptoKeyStorage Class)
Adds a key to the storage.
Syntax
int ImportFromFile(const QString& qsFilename, int iFormat, const QString& qsKeyAlgorithm, const QString& qsScheme, const QString& qsSchemeParams, int iKeyType);
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 |
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListStores Method (CryptoKeyStorage Class)
TBD.
Syntax
QString ListStores();
Remarks
TBD
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Login Method (CryptoKeyStorage Class)
TBD.
Syntax
int Login(int iSessionType, const QString& qsPin, bool bReadOnly);
Remarks
SessionType is a type of longing. Possible values:
| stUnauthenticated | 0 | |
| stUser | 1 | |
| stSecurityOfficer | 2 |
TBD
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Logout Method (CryptoKeyStorage Class)
TBD.
Syntax
int Logout(bool bCloseSesion);
Remarks
TBD
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Open Method (CryptoKeyStorage Class)
Opens existing storage or creates one in memory.
Syntax
int Open(const QString& qsStorageID);
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
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.
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.
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)
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Refresh Method (CryptoKeyStorage Class)
Refreshes all storage keychains.
Syntax
int Refresh();
Remarks
Call this method to refresh the storage.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Remove Method (CryptoKeyStorage Class)
Removes a key from the storage.
Syntax
int Remove(int iIndex);
Remarks
Use this method to remove a key from the storage by its index.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Select Method (CryptoKeyStorage Class)
Allows the selection of keys from the store.
Syntax
int Select(const QString& qsFilter, bool bPrivateKeyNeeded, int iMaxCount);
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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetStorageProperty Method (CryptoKeyStorage Class)
TBD.
Syntax
int SetStorageProperty(const QString& qsPropName, const QString& qsPropValue);
Remarks
TBD
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (CryptoKeyStorage Class)
Fires when an errors happens during a key storage operation.
Syntax
class CryptoKeyStorageErrorEventParams {
public:
int ErrorCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Error(CryptoKeyStorageErrorEventParams *e);
// Or, subclass CryptoKeyStorage and override this emitter function.
virtual int FireError(CryptoKeyStorageErrorEventParams *e) {...}
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 Class)
This event notifies the application about an underlying control flow event.
Syntax
class CryptoKeyStorageNotificationEventParams {
public:
const QString &EventID();
const QString &EventParam();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Notification(CryptoKeyStorageNotificationEventParams *e);
// Or, subclass CryptoKeyStorage and override this emitter function.
virtual int FireNotification(CryptoKeyStorageNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
PasswordNeeded Event (CryptoKeyStorage Class)
This event is fired when a decryption password is needed.
Syntax
class CryptoKeyStoragePasswordNeededEventParams {
public:
const QString &NeededFor();
const QString &Password();
void SetPassword(const QString &qsPassword);
bool Cancel();
void SetCancel(bool bCancel);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void PasswordNeeded(CryptoKeyStoragePasswordNeededEventParams *e);
// Or, subclass CryptoKeyStorage and override this emitter function.
virtual int FirePasswordNeeded(CryptoKeyStoragePasswordNeededEventParams *e) {...}
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.
Configuration 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 Configuration Settings | ||||||||||||||||||||||||||||||
| TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (CryptoKeyStorage 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) |