CertificateStorage Component

Properties   Methods   Events   Config Settings   Errors  

The CertificateStorage component works with collections of certificates.

Syntax

TsbxCertificateStorage

Remarks

CertificateStorage can work with certificates residing on a variety of media. Among others, it can access certificates residing in files, Windows and macOS system stores, and PKCS#11 devices. All such kinds of media can be accessed via a simple, unified interface, which makes CertificateStorage a handy certificate access option. Most users of SecureBlackbox use this component to access certificates residing on hardware devices. CertificateStorage is also a good alternative to CertificateManager where the certificate file contains more than one certificate.

To access certificates stored on certain type of media, start with the Open method. Provide the location of your certificates via a uniform URI-like specifier. Once the storage has been opened, you can access the certificates contained in it via the Certificates property.

Iterate over certificates by using the Certificates property, or use filtering facilities such as Select and SelectChain. You can add certificates to the storage with the Add, AddFromFile, and AddPinned methods. In the latter case please assign the certificate object to be imported to the PinnedCert property.

Use CreateNew method to create a new storage. Note that not all storage kinds can be created.

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

Certain types of stores must be kept open for the certificates to continue to be usable. This means that while you can copy a certificate to a different storage, or assign it to a different component, you still must keep the storage it originates from open for as long as you intend to use that certificate in your code. This is because the storage is often a bridge between a certificate and its private key, and by closing the storage early you are destroying this bridge prematurely. See the code example below: // This code, although syntactically correct, will fail because the storage is closed too early: storage.Open("pkcs11://user:12345@localhost/C:/Windows/System32/asepkcs.dll"); pdfSigner.SigningCertificate = storage.Certificates[0]; storage.Close(false); // the private key of the SigningCertificate gets lost after this call pdfSigner.Sign(); // returns an error // This code will work as expected storage.Open("pkcs11://user:12345@localhost/C:/Windows/System32/asepkcs.dll"); pdfSigner.SigningCertificate = storage.Certificates[0]; pdfSigner.Sign(); storage.Close(false);

Property List


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

CertCountThe number of records in the Cert arrays.
CertBytesReturns raw certificate data in DER format.
CertCAIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
CertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
CertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
CertCurveSpecifies the elliptic curve of the EC public key.
CertFingerprintContains the fingerprint (a hash imprint) of this certificate.
CertFriendlyNameContains an associated alias (friendly name) of the certificate.
CertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
CertHashAlgorithmSpecifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .
CertIssuerThe common name of the certificate issuer (CA), typically a company name.
CertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
CertKeyAlgorithmSpecifies the public key algorithm of this certificate.
CertKeyBitsReturns the length of the public key.
CertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
CertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
CertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
CertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
CertOCSPNoCheckAccessor to the value of the certificates ocsp-no-check extension.
CertOriginReturns the origin of this certificate.
CertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
CertPrivateKeyBytesContains the certificate's private key.
CertPrivateKeyExistsIndicates whether the certificate has an associated private key.
CertPrivateKeyExtractableIndicates whether the private key is extractable.
CertPublicKeyBytesContains the certificate's public key in DER format.
CertQualifiedStatementsReturns the qualified status of the certificate.
CertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
CertSerialNumberReturns the certificate's serial number.
CertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
CertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
CertSubjectAlternativeNameReturns or sets the value of the Subject Alternative Name extension of the certificate.
CertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
CertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
CertValidFromThe time point at which the certificate becomes valid, in UTC.
CertValidToThe time point at which the certificate expires, in UTC.
FIPSModeReserved.
OpenedIndicates whether the storage is in the open state.
PinnedCertBytesReturns raw certificate data in DER format.
PinnedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedCertCountThe number of records in the SelectedCert arrays.
SelectedCertBytesReturns raw certificate data in DER format.
SelectedCertCAIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
SelectedCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
SelectedCertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
SelectedCertCurveSpecifies the elliptic curve of the EC public key.
SelectedCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
SelectedCertFriendlyNameContains an associated alias (friendly name) of the certificate.
SelectedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedCertHashAlgorithmSpecifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .
SelectedCertIssuerThe common name of the certificate issuer (CA), typically a company name.
SelectedCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
SelectedCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
SelectedCertKeyBitsReturns the length of the public key.
SelectedCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
SelectedCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
SelectedCertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
SelectedCertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
SelectedCertOCSPNoCheckAccessor to the value of the certificates ocsp-no-check extension.
SelectedCertOriginReturns the origin of this certificate.
SelectedCertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
SelectedCertPrivateKeyBytesContains the certificate's private key.
SelectedCertPrivateKeyExistsIndicates whether the certificate has an associated private key.
SelectedCertPrivateKeyExtractableIndicates whether the private key is extractable.
SelectedCertPublicKeyBytesContains the certificate's public key in DER format.
SelectedCertQualifiedStatementsReturns the qualified status of the certificate.
SelectedCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
SelectedCertSerialNumberReturns the certificate's serial number.
SelectedCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
SelectedCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
SelectedCertSubjectAlternativeNameReturns or sets the value of the Subject Alternative Name extension of the certificate.
SelectedCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
SelectedCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
SelectedCertValidFromThe time point at which the certificate becomes valid, in UTC.
SelectedCertValidToThe time point at which the certificate expires, in UTC.
StorageIDA unique identifier of this storage.
StorageLocationSpecifies the location of the currently opened storage.

Method List


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

AddAdds a certificate to the storage.
AddFromFileAdds a certificate to the storage.
AddPinnedAdds the pinned certificate to the storage.
ClearRemoves all certificates from the storage.
CloseCloses the certificate storage.
ConfigSets or retrieves a configuration setting.
CreateNewCreates a new storage.
DoActionPerforms an additional action.
ExportBytesExports the certificates in the chosen format.
ExportToFileExports the certificates to a file.
GetStoragePropertyReturns the value of a custom certificate storage property.
ImportBytesImports a certificates.
ImportFromFileLoads a certificates from a file.
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 certificate from the storage.
SelectAllows the selection of certificates from the system store.
SelectChainSelects a chain of certificates given its index.
SetStoragePropertySets the value of a custom certificate storage property.

Event List


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

ErrorInformation about errors during certificate loading or saving.
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 component with short descriptions. Click on the links for further details.

AuthAttemptsThe number of auth/login attempts to try.
PKCS11ActiveSlotThe index of the slot that the component is working with.
PKCS11NewPINChanges the current user's PIN.
PKCS11NewUserPINRegisters a new user PIN.
PKCS11PINSets the operation PIN.
PKCS11SlotCountThe number of slots exposed in the storage.
PKCS11SlotDescription[i]A human-readable description of the slot.
PKCS11SlotLoggedIn[i]Whether slot i has an active session associated with it.
PKCS11SlotPinNeeded[i]Whether slot i requires you to provide a PIN to log in or sign.
PKCS11SlotReadOnly[i]Whether slot i only supports read-only access.
PKCS11SlotTokenLabel[i]The label assigned to the token.
PKCS11SlotTokenModel[i]The token model.
PKCS11SlotTokenPresent[i]Indicates whether there is a token in the slot.
PKCS11SlotTokenSerial[i]The serial number of the token.
PKCS11SlotTokenVendorID[i]The manufacturer ID of the inserted token.
PKCS11SlotVendorID[i]Returns the manufacturer ID of the slot.
TempPathPath for storing temporary files.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component.
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 components 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.

CertCount Property (CertificateStorage Component)

The number of records in the Cert arrays.

Syntax

__property int CertCount = { read=FCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

CertBytes Property (CertificateStorage Component)

Returns raw certificate data in DER format.

Syntax

__property DynamicArray CertBytes[int CertIndex] = { read=FCertBytes };

Remarks

Returns raw certificate data in DER format.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertCA Property (CertificateStorage Component)

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

Syntax

__property bool CertCA[int CertIndex] = { read=FCertCA };

Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Boolean

CertCAKeyID Property (CertificateStorage Component)

A unique identifier (fingerprint) of the CA certificate's private key.

Syntax

__property DynamicArray CertCAKeyID[int CertIndex] = { read=FCertCAKeyID };

Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertCRLDistributionPoints Property (CertificateStorage Component)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

__property String CertCRLDistributionPoints[int CertIndex] = { read=FCertCRLDistributionPoints };

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertCurve Property (CertificateStorage Component)

Specifies the elliptic curve of the EC public key.

Syntax

__property String CertCurve[int CertIndex] = { read=FCertCurve };

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertFingerprint Property (CertificateStorage Component)

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

Syntax

__property DynamicArray CertFingerprint[int CertIndex] = { read=FCertFingerprint };

Remarks

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertFriendlyName Property (CertificateStorage Component)

Contains an associated alias (friendly name) of the certificate.

Syntax

__property String CertFriendlyName[int CertIndex] = { read=FCertFriendlyName };

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertHandle Property (CertificateStorage Component)

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

Syntax

__property __int64 CertHandle[int CertIndex] = { read=FCertHandle };

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 CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Long64

CertHashAlgorithm Property (CertificateStorage Component)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .

Syntax

__property String CertHashAlgorithm[int CertIndex] = { read=FCertHashAlgorithm };

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

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 CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertIssuer Property (CertificateStorage Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

__property String CertIssuer[int CertIndex] = { read=FCertIssuer };

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertIssuerRDN Property (CertificateStorage Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

__property String CertIssuerRDN[int CertIndex] = { read=FCertIssuerRDN };

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertKeyAlgorithm Property (CertificateStorage Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String CertKeyAlgorithm[int CertIndex] = { read=FCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertKeyBits Property (CertificateStorage Component)

Returns the length of the public key.

Syntax

__property int CertKeyBits[int CertIndex] = { read=FCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Integer

CertKeyFingerprint Property (CertificateStorage Component)

Returns a fingerprint of the public key contained in the certificate.

Syntax

__property DynamicArray CertKeyFingerprint[int CertIndex] = { read=FCertKeyFingerprint };

Remarks

Returns a fingerprint of the public key contained in the certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertKeyUsage Property (CertificateStorage Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

__property int CertKeyUsage[int CertIndex] = { read=FCertKeyUsage };

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Integer

CertKeyValid Property (CertificateStorage Component)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

__property bool CertKeyValid[int CertIndex] = { read=FCertKeyValid };

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Boolean

CertOCSPLocations Property (CertificateStorage Component)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

__property String CertOCSPLocations[int CertIndex] = { read=FCertOCSPLocations };

Default Value

""

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertOCSPNoCheck Property (CertificateStorage Component)

Accessor to the value of the certificates ocsp-no-check extension.

Syntax

__property bool CertOCSPNoCheck[int CertIndex] = { read=FCertOCSPNoCheck };

Default Value

false

Remarks

Accessor to the value of the certificates ocsp-no-check extension.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Boolean

CertOrigin Property (CertificateStorage Component)

Returns the origin of this certificate.

Syntax

__property int CertOrigin[int CertIndex] = { read=FCertOrigin };

Default Value

0

Remarks

Returns the origin of this certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Integer

CertPolicyIDs Property (CertificateStorage Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String CertPolicyIDs[int CertIndex] = { read=FCertPolicyIDs };

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertPrivateKeyBytes Property (CertificateStorage Component)

Contains the certificate's private key.

Syntax

__property DynamicArray CertPrivateKeyBytes[int CertIndex] = { read=FCertPrivateKeyBytes };

Remarks

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertPrivateKeyExists Property (CertificateStorage Component)

Indicates whether the certificate has an associated private key.

Syntax

__property bool CertPrivateKeyExists[int CertIndex] = { read=FCertPrivateKeyExists };

Default Value

false

Remarks

Indicates whether the certificate has an associated private key.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Boolean

CertPrivateKeyExtractable Property (CertificateStorage Component)

Indicates whether the private key is extractable.

Syntax

__property bool CertPrivateKeyExtractable[int CertIndex] = { read=FCertPrivateKeyExtractable };

Default Value

false

Remarks

Indicates whether the private key is extractable

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Boolean

CertPublicKeyBytes Property (CertificateStorage Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray CertPublicKeyBytes[int CertIndex] = { read=FCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertQualifiedStatements Property (CertificateStorage Component)

Returns the qualified status of the certificate.

Syntax

__property TsbxCertificateStorageCertQualifiedStatements CertQualifiedStatements[int CertIndex] = { read=FCertQualifiedStatements };
enum TsbxCertificateStorageCertQualifiedStatements { qstNonQualified=0, qstQualifiedHardware=1, qstQualifiedSoftware=2 };

Default Value

qstNonQualified

Remarks

Returns the qualified status of the certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Integer

CertSelfSigned Property (CertificateStorage Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

__property bool CertSelfSigned[int CertIndex] = { read=FCertSelfSigned };

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Boolean

CertSerialNumber Property (CertificateStorage Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray CertSerialNumber[int CertIndex] = { read=FCertSerialNumber };

Remarks

Returns the certificate's serial number.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertSigAlgorithm Property (CertificateStorage Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

__property String CertSigAlgorithm[int CertIndex] = { read=FCertSigAlgorithm };

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertSubject Property (CertificateStorage Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

__property String CertSubject[int CertIndex] = { read=FCertSubject };

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertSubjectAlternativeName Property (CertificateStorage Component)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

__property String CertSubjectAlternativeName[int CertIndex] = { read=FCertSubjectAlternativeName };

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertSubjectKeyID Property (CertificateStorage Component)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

__property DynamicArray CertSubjectKeyID[int CertIndex] = { read=FCertSubjectKeyID };

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

Byte Array

CertSubjectRDN Property (CertificateStorage Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

__property String CertSubjectRDN[int CertIndex] = { read=FCertSubjectRDN };

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertValidFrom Property (CertificateStorage Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

__property String CertValidFrom[int CertIndex] = { read=FCertValidFrom };

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

CertValidTo Property (CertificateStorage Component)

The time point at which the certificate expires, in UTC.

Syntax

__property String CertValidTo[int CertIndex] = { read=FCertValidTo };

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

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

Data Type

String

FIPSMode Property (CertificateStorage Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Opened Property (CertificateStorage Component)

Indicates whether the storage is in the open state.

Syntax

__property bool Opened = { read=FOpened };

Default Value

false

Remarks

Use this property to check if the storage has been 'opened.' Different kinds of certificate 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

PinnedCertBytes Property (CertificateStorage Component)

Returns raw certificate data in DER format.

Syntax

__property DynamicArray PinnedCertBytes = { read=FPinnedCertBytes };

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

PinnedCertHandle Property (CertificateStorage Component)

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

Syntax

__property __int64 PinnedCertHandle = { read=FPinnedCertHandle, write=FSetPinnedCertHandle };

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

SelectedCertCount Property (CertificateStorage Component)

The number of records in the SelectedCert arrays.

Syntax

__property int SelectedCertCount = { read=FSelectedCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

SelectedCertBytes Property (CertificateStorage Component)

Returns raw certificate data in DER format.

Syntax

__property DynamicArray SelectedCertBytes[int SelectedCertIndex] = { read=FSelectedCertBytes };

Remarks

Returns raw certificate data in DER format.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Byte Array

SelectedCertCA Property (CertificateStorage Component)

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

Syntax

__property bool SelectedCertCA[int SelectedCertIndex] = { read=FSelectedCertCA };

Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Boolean

SelectedCertCAKeyID Property (CertificateStorage Component)

A unique identifier (fingerprint) of the CA certificate's private key.

Syntax

__property DynamicArray SelectedCertCAKeyID[int SelectedCertIndex] = { read=FSelectedCertCAKeyID };

Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Byte Array

SelectedCertCRLDistributionPoints Property (CertificateStorage Component)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

__property String SelectedCertCRLDistributionPoints[int SelectedCertIndex] = { read=FSelectedCertCRLDistributionPoints };

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertCurve Property (CertificateStorage Component)

Specifies the elliptic curve of the EC public key.

Syntax

__property String SelectedCertCurve[int SelectedCertIndex] = { read=FSelectedCertCurve };

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertFingerprint Property (CertificateStorage Component)

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

Syntax

__property DynamicArray SelectedCertFingerprint[int SelectedCertIndex] = { read=FSelectedCertFingerprint };

Remarks

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

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Byte Array

SelectedCertFriendlyName Property (CertificateStorage Component)

Contains an associated alias (friendly name) of the certificate.

Syntax

__property String SelectedCertFriendlyName[int SelectedCertIndex] = { read=FSelectedCertFriendlyName };

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertHandle Property (CertificateStorage Component)

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

Syntax

__property __int64 SelectedCertHandle[int SelectedCertIndex] = { read=FSelectedCertHandle };

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 SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Long64

SelectedCertHashAlgorithm Property (CertificateStorage Component)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .

Syntax

__property String SelectedCertHashAlgorithm[int SelectedCertIndex] = { read=FSelectedCertHashAlgorithm };

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

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 SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertIssuer Property (CertificateStorage Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

__property String SelectedCertIssuer[int SelectedCertIndex] = { read=FSelectedCertIssuer };

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertIssuerRDN Property (CertificateStorage Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

__property String SelectedCertIssuerRDN[int SelectedCertIndex] = { read=FSelectedCertIssuerRDN };

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertKeyAlgorithm Property (CertificateStorage Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String SelectedCertKeyAlgorithm[int SelectedCertIndex] = { read=FSelectedCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertKeyBits Property (CertificateStorage Component)

Returns the length of the public key.

Syntax

__property int SelectedCertKeyBits[int SelectedCertIndex] = { read=FSelectedCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Integer

SelectedCertKeyFingerprint Property (CertificateStorage Component)

Returns a fingerprint of the public key contained in the certificate.

Syntax

__property DynamicArray SelectedCertKeyFingerprint[int SelectedCertIndex] = { read=FSelectedCertKeyFingerprint };

Remarks

Returns a fingerprint of the public key contained in the certificate.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Byte Array

SelectedCertKeyUsage Property (CertificateStorage Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

__property int SelectedCertKeyUsage[int SelectedCertIndex] = { read=FSelectedCertKeyUsage };

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Integer

SelectedCertKeyValid Property (CertificateStorage Component)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

__property bool SelectedCertKeyValid[int SelectedCertIndex] = { read=FSelectedCertKeyValid };

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Boolean

SelectedCertOCSPLocations Property (CertificateStorage Component)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

__property String SelectedCertOCSPLocations[int SelectedCertIndex] = { read=FSelectedCertOCSPLocations };

Default Value

""

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertOCSPNoCheck Property (CertificateStorage Component)

Accessor to the value of the certificates ocsp-no-check extension.

Syntax

__property bool SelectedCertOCSPNoCheck[int SelectedCertIndex] = { read=FSelectedCertOCSPNoCheck };

Default Value

false

Remarks

Accessor to the value of the certificates ocsp-no-check extension.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Boolean

SelectedCertOrigin Property (CertificateStorage Component)

Returns the origin of this certificate.

Syntax

__property int SelectedCertOrigin[int SelectedCertIndex] = { read=FSelectedCertOrigin };

Default Value

0

Remarks

Returns the origin of this certificate.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Integer

SelectedCertPolicyIDs Property (CertificateStorage Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String SelectedCertPolicyIDs[int SelectedCertIndex] = { read=FSelectedCertPolicyIDs };

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertPrivateKeyBytes Property (CertificateStorage Component)

Contains the certificate's private key.

Syntax

__property DynamicArray SelectedCertPrivateKeyBytes[int SelectedCertIndex] = { read=FSelectedCertPrivateKeyBytes };

Remarks

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Byte Array

SelectedCertPrivateKeyExists Property (CertificateStorage Component)

Indicates whether the certificate has an associated private key.

Syntax

__property bool SelectedCertPrivateKeyExists[int SelectedCertIndex] = { read=FSelectedCertPrivateKeyExists };

Default Value

false

Remarks

Indicates whether the certificate has an associated private key.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Boolean

SelectedCertPrivateKeyExtractable Property (CertificateStorage Component)

Indicates whether the private key is extractable.

Syntax

__property bool SelectedCertPrivateKeyExtractable[int SelectedCertIndex] = { read=FSelectedCertPrivateKeyExtractable };

Default Value

false

Remarks

Indicates whether the private key is extractable

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Boolean

SelectedCertPublicKeyBytes Property (CertificateStorage Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray SelectedCertPublicKeyBytes[int SelectedCertIndex] = { read=FSelectedCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Byte Array

SelectedCertQualifiedStatements Property (CertificateStorage Component)

Returns the qualified status of the certificate.

Syntax

__property TsbxCertificateStorageSelectedCertQualifiedStatements SelectedCertQualifiedStatements[int SelectedCertIndex] = { read=FSelectedCertQualifiedStatements };
enum TsbxCertificateStorageSelectedCertQualifiedStatements { qstNonQualified=0, qstQualifiedHardware=1, qstQualifiedSoftware=2 };

Default Value

qstNonQualified

Remarks

Returns the qualified status of the certificate.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Integer

SelectedCertSelfSigned Property (CertificateStorage Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

__property bool SelectedCertSelfSigned[int SelectedCertIndex] = { read=FSelectedCertSelfSigned };

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Boolean

SelectedCertSerialNumber Property (CertificateStorage Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray SelectedCertSerialNumber[int SelectedCertIndex] = { read=FSelectedCertSerialNumber };

Remarks

Returns the certificate's serial number.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Byte Array

SelectedCertSigAlgorithm Property (CertificateStorage Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

__property String SelectedCertSigAlgorithm[int SelectedCertIndex] = { read=FSelectedCertSigAlgorithm };

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertSubject Property (CertificateStorage Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

__property String SelectedCertSubject[int SelectedCertIndex] = { read=FSelectedCertSubject };

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertSubjectAlternativeName Property (CertificateStorage Component)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

__property String SelectedCertSubjectAlternativeName[int SelectedCertIndex] = { read=FSelectedCertSubjectAlternativeName };

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertSubjectKeyID Property (CertificateStorage Component)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

__property DynamicArray SelectedCertSubjectKeyID[int SelectedCertIndex] = { read=FSelectedCertSubjectKeyID };

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

Byte Array

SelectedCertSubjectRDN Property (CertificateStorage Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

__property String SelectedCertSubjectRDN[int SelectedCertIndex] = { read=FSelectedCertSubjectRDN };

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertValidFrom Property (CertificateStorage Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

__property String SelectedCertValidFrom[int SelectedCertIndex] = { read=FSelectedCertValidFrom };

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

SelectedCertValidTo Property (CertificateStorage Component)

The time point at which the certificate expires, in UTC.

Syntax

__property String SelectedCertValidTo[int SelectedCertIndex] = { read=FSelectedCertValidTo };

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The SelectedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedCertCount property.

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

Data Type

String

StorageID Property (CertificateStorage Component)

A unique identifier of this storage.

Syntax

__property String StorageID = { read=FStorageID };

Default Value

""

Remarks

Use this property to get a unique ID of this storage. The format of ID may differ for different kinds of certificate 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 (CertificateStorage Component)

Specifies the location of the currently opened storage.

Syntax

__property String StorageLocation = { read=FStorageLocation };

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

Add Method (CertificateStorage Component)

Adds a certificate to the storage.

Syntax

void __fastcall Add(DynamicArray<Byte> Data);

Remarks

Use this method to add a certificate supplied in its raw DER representation via the Data parameter.

AddFromFile Method (CertificateStorage Component)

Adds a certificate to the storage.

Syntax

void __fastcall AddFromFile(String Filename);

Remarks

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

AddPinned Method (CertificateStorage Component)

Adds the pinned certificate to the storage.

Syntax

void __fastcall AddPinned();

Remarks

This method adds a certificate attached to the PinnedCert property to the storage. This method is a handy way of adding certificates generated/returned by other components.

Clear Method (CertificateStorage Component)

Removes all certificates from the storage.

Syntax

void __fastcall Clear();

Remarks

Use this method to empty the storage.

Close Method (CertificateStorage Component)

Closes the certificate storage.

Syntax

void __fastcall Close(bool Save);

Remarks

Use this method to close the storage component and clean up any resources associated with it.

This method releases all memory objects and handles associated with the certificates contained in the storage. Any certificate objects originating from the storage become invalid as soon as the storage is closed, and should not be used.

Save parameter only applies to certain types of stores, such as file stores. Set it to True to commit any changes to the underlying media. Note that PKCS#11 and Win32 storage types are of transactional nature and commit any changes immediately, so the value of the Save parameter does not make any difference with them.

Config Method (CertificateStorage Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateNew Method (CertificateStorage Component)

Creates a new storage.

Syntax

void __fastcall CreateNew(String StorageLocation, String StorageID);

Remarks

Use this method to create new certificate 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 (CertificateStorage Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insencitive) 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;....

ExportBytes Method (CertificateStorage Component)

Exports the certificates in the chosen format.

Syntax

DynamicArray<Byte> __fastcall ExportBytes(String Password, int Format);

Remarks

Use this method to save the certificates in one of the formats defined below.

Pass the encryption password via the Password parameter if needed.

cfmUnknown0Unknown certificate format

cfmDER1DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported

cfmPEM2PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys.

cfmPFX3PFX/PKCS#12 file format. Applicable to certificates. Encryption supported.

cfmSPC4SPC file format. Applicable to certificates. Encryption not supported.

cfmPVK5PVK file format. Applicable to private keys. Encryption not supported.

cfmPKCS86PKCS#8 file format. Applicable to private keys. Encryption supported.

cfmNET7NET file format. Applicable to private keys. Encryption not supported.

Note that not all formats support encryption, and some (like PEM) only support partial encryption (key only). Keep this in mind when considering which format to choose for storing your certificates.

ExportToFile Method (CertificateStorage Component)

Exports the certificates to a file.

Syntax

void __fastcall ExportToFile(String CertFile, String Password, int Format);

Remarks

Use this method to save the certificates to a file in one of the formats given below. Pass the encryption password via the Password parameter.

cfmUnknown0Unknown certificate format

cfmDER1DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported

cfmPEM2PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys.

cfmPFX3PFX/PKCS#12 file format. Applicable to certificates. Encryption supported.

cfmSPC4SPC file format. Applicable to certificates. Encryption not supported.

cfmPVK5PVK file format. Applicable to private keys. Encryption not supported.

cfmPKCS86PKCS#8 file format. Applicable to private keys. Encryption supported.

cfmNET7NET file format. Applicable to private keys. Encryption not supported.

Note that not all formats support encryption, and some (like PEM) only support partial encryption (key only). Keep this in mind when considering which format to choose for storing your certificates.

GetStorageProperty Method (CertificateStorage Component)

Returns the value of a custom certificate storage property.

Syntax

String __fastcall GetStorageProperty(String Name);

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.

The following certificate storage properties can be read using this method:

PKCS11SlotCountReturns the number of slots available in an opened PKCS#11 storage.
PKCS11ActiveSlotReturns the index of the PKCS#11 slot that is currently being accessed.
PKCS11PINThe PIN for the storage and/or operation, previously set with SetStorageProperty call.
PKCS11TextEncodingModeThe string encoding mode to apply to the PIN when passing it to C_Login() method. This can be changed by passing the relevant setting to SetStorageProperty.
PKCS11SlotThe slot number to open, set previously with SetStorageProperty.
PKCS11LoginThe user account to sign in with, set previously with SetStorageProperty
PKCS11SlotLoggedIn[i]Returns true if there is an active session associated with slot number i.
PKCS11SlotPinNeeded[i]Returns true if you need to provide a PIN to sign in to the session for slot i.
PKCS11SlotReadOnly[i]Returns the availability of the slot for write operations.
PKCS11SlotVendorID[i]Returns the manufacturer name associated with the slot.
PKCS11SlotDescription[i]A human-readable description of the slot.
PKCS11SlotTokenPresent[i]Indicates whether there is a token in the slot.
PKCS11SlotTokenVendorID[i]The manufacturer ID of the inserted token.
PKCS11SlotTokenLabel[i]The label assigned to the token.
PKCS11SlotTokenModel[i]The token model.
PKCS11SlotTokenSerial[i]The serial number of the token.
PKCS11SlotTokenFlags[i]The value of the PKCS#11 token flags parameter.

ImportBytes Method (CertificateStorage Component)

Imports a certificates.

Syntax

void __fastcall ImportBytes(DynamicArray<Byte> CertBytes, String Password, bool Clear);

Remarks

Use this method to load a certificates from a byte array. Provide the password via the Password parameter. This method supports certificates in DER, PEM, PFX, and SPC formats.

ImportFromFile Method (CertificateStorage Component)

Loads a certificates from a file.

Syntax

void __fastcall ImportFromFile(String Path, String Password, bool Clear);

Remarks

This method can load certificates saved in one of the following formats: DER, PEM, PFX, SPC.

Use the Path parameter to provide a path to the certificate, and Password to specify the password.

ListStores Method (CertificateStorage Component)

Returns a list of individual stores available within the storage.

Syntax

String __fastcall ListStores();

Remarks

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

The contents of the list depends on the type of the store used and the parameters it is opened with. For system (CryptoAPI) stores the method returns a list of available system stores for the chosen access type, as returned by Windows (e.g. MY, ADDRESSBOOK, CA). For PKCS#11 stores the method returns a list of slot descriptions for all slots published by the driver.

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

Login Method (CertificateStorage Component)

Signs in to a session or elevates the session rights.

Syntax

void __fastcall Login(int SessionType, String Pin, bool ReadOnly);

Remarks

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

stUnauthenticated0
stUser1
stAdministrator2

Logout Method (CertificateStorage Component)

Signs out of an opened session.

Syntax

void __fastcall Logout(bool CloseSesion);

Remarks

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

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

Open Method (CertificateStorage Component)

Opens existing storage or creates one in memory.

Syntax

void __fastcall Open(String StorageID);

Remarks

Use this method to open the storage with the given StorageID. Certificate 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\certs.pem
  • file://C:/Certs/certs.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; typically it's either "user" or "admin".

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. If set to -1, no session will be opened.
  • readonly, whether to access the device with only read permissions. Use 0 for false, and 1 for true.
  • login, whether to sign in to the device with a PIN. Use 0 or no to avoid signing in, or 1 or yes to enforce it. When not specified, the yes mode is used.
Example: pkcs11://user:1234@/c:/windows/system32/asepkcs.dll?slot=0&readonly=1

macOS

A keychain can be opened on macOS using this syntax: macos://:{password}@/{keychain}?{params}

This is the right way to perform cryptographic operations using private keys, including non-exportable private keys. By now, only certificates with RSA keys are supported, other certificates are not listed and are not used.

keychain is the path to a keychain file. If no keychain specified, the default keychain is opened.

password is the keychain access password. If no password is provided, it will be asked by macOS UI if necessary. To access a keychain in readonly mode, no password is needed usually.

params are chosen from this list:

  • readonly, whether to access the keychain with only read permissions. Use 0 for false, and 1 for true.
Example: macos://:f00Keys@/Users/test/Documents/test.keychain?readonly=0

iOS

A keychain can be opened on iOS using this syntax: ios:///?{params}

iOS doesn't support keychains located in files. By now, only certificates with RSA keys are supported, other certificates are not listed and are not used.

params are chosen from this list:

  • readonly, whether to access the keychain with only read permissions. Use 0 for false, and 1 for true.
Example: ios:///?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

Apple

A storage can be opened on macOS using this syntax: apple:///{path}/?{params}

This is a legacy way to work with keychains on macOS and iOS.

path is the path for storage file.

params are chosen from this list:

  • keychainindex, key chain index. If not provided, one will be set to 0.
  • readonly, whether to access the storage with only read permissions. Use 0 for false, and 1 for true.
Example: apple:///Users/test/Documents/test.storage?readonly=1 A storage can be opened on iOS using this syntax: apple:///?{params}

params are chosen from this list:

  • readonly, whether to access the storage with only read permissions. Use 0 for false, and 1 for true.
Example: apple:///?readonly=1

In Xamarin projects for iOS keychain support should be enabled manually. To do this: 1. Double click on Entitlements.plist file, go to "Entitlements" tab and turn "Enable Keychain" option on. 2. Go to project options, select "iOS Bundle Signing", choose correct configuration and platform and set "Custom Entitlements" to "Entitlements.plist" value.

Azure Key Vault

A storage can be opened from the Azure Key Vault service using this syntax: vault://{clientid}:{clientsecret}@{vaultname}.{vaulthost}/

clientid is the client id obtained from Azure Portal when registering an app.

clientsecret is the client secret obtained from Azure Portal when registering an app.

vaultname is the name of the vault to connect to.

vaulthost is the Cloud environment where the vault is located; supported environments are:

Cloud environmentvaulthost
Azure Cloudvault.azure.net
Azure China Cloudvault.azure.cn
Azure US Governmentvault.usgovcloudapi.net
Azure German Cloudvault.microsoftazure.de
Example: vault://xxxx:yyyy@myvault.vault.azure.net/

Refresh Method (CertificateStorage Component)

Refreshes all storage keychains.

Syntax

void __fastcall Refresh();

Remarks

Call this method to refresh the storage.

Remove Method (CertificateStorage Component)

Removes a certificate from the storage.

Syntax

void __fastcall Remove(int Index);

Remarks

Use this method to remove the certificate from the storage given its index.

Select Method (CertificateStorage Component)

Allows the selection of certificates from the system store.

Syntax

void __fastcall Select(String Filter, bool PrivateKeyNeeded, int MaxCount);

Remarks

This function allows the user to select certificates from the system store by Filter and save them to SelectedCertificates. PrivateKeyNeeded specifies whether the method only should consider certificates having associated private keys. MaxCount limits the number of certificates selected.

The supported filters are listed below. Split the name and value of a specific filter with colon (:). Use | separator to pass more than one filter. During the search, the filters are joined using OR logic.

  • subjectkeyid: the subject key identifier, in hexadecimal format.
  • cakeyid: the key identifier of the issuing certificate, in hexadecimal format.
  • serialnumber: the serial number of the certificate, in hexadecimal format.
  • keyusage: certificate key usage flags. Use bitwise OR to specify several key usage flags using the values shown below.
  • fingerprint: certificate fingerprint in hexadecimal format. MD5, SHA1, SHA256, and SHA512 fingerprints are supported.
  • email: the e-mail parameter of the certificate subject.
  • subject: the subject of the certificate, either as an RDN, or as its common name parameter.
  • issuer: the issuer of the certificate, either as an RDN or a common name.
  • ui (Windows system stores only): whether to use UI dialog to select a certificate. Supported values: true, false, 1, 0. All other filters are ignored if this filter is specified.
  • * (asterisk): selects all certificates. This filter should always be used as a single character, not as a name:value pair.

Examples of filters

ui:1 - use Windows certificate selection dialog to let the user select a certificate visually.

* - select all certificates.

email:user@server.com - select all certificates with subject RDNs containing this e-mail address.

fingerprint:0a1b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d - select all certificates with this SHA1 fingerprint.

subject:/C=US/O=Big Company Inc/CN=Signing Certificate - select all certificates with the specified subject RDN.

keyusage:3|email:user@server.com - select all certificates with key usages of Digital Signature or Non-Repudiation, or those having this e-mail address in their subject.

Key usage flags

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

SelectChain Method (CertificateStorage Component)

Selects a chain of certificates given its index.

Syntax

void __fastcall SelectChain(int Index);

Remarks

Use this method to select a certificate chain given its index.

SetStorageProperty Method (CertificateStorage Component)

Sets the value of a custom certificate storage property.

Syntax

void __fastcall SetStorageProperty(String Name, String Value);

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.

The following certificate storage properties can be read using this method:

PKCS11PINUse this property to provide your PIN on the fly for an operation requiring the private key (e.g. signing). This may be useful if the PIN was not provided on the Open stage.
PKCS11NewUserPINSetting this property will register a new PIN to the HSM user account. This property is the way to administratively reset the user's PIN, and can only be set from under the 'admin' session.
PKCS11NewPINSetting this property will change the current users's PIN to the provided value. Most HSMs require the user to be signed in to perform this operation. This is the way to change your own PIN, either for admin or regular user accounts.
PKCS11TextEncodingModeThe string encoding mode to apply to the PIN when passing it to C_Login() method. This can be changed by passing the relevant setting to SetStorageProperty.
PKCS11SlotSpecifies the slot number to open, from 0 to (PKCS11SlotCount - 1). Use the 'auto' value to let the component pick the slot automatically, or -1 to stop the component from opening any slots.
PKCS11LoginProvides a PKCS#11 user ID to sign in with. The following options are available: 'user' (normal user), 'so' (security officer), or 'no' (do not sign in).

Error Event (CertificateStorage Component)

Information about errors during certificate loading or saving.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxCertificateStorageErrorEventParams;
typedef void __fastcall (__closure *TsbxCertificateStorageErrorEvent)(System::TObject* Sender, TsbxCertificateStorageErrorEventParams *e);
__property TsbxCertificateStorageErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

Reports exceptional conditions during certificate loading or exporting.

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

Notification Event (CertificateStorage Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxCertificateStorageNotificationEventParams;
typedef void __fastcall (__closure *TsbxCertificateStorageNotificationEvent)(System::TObject* Sender, TsbxCertificateStorageNotificationEventParams *e);
__property TsbxCertificateStorageNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

PasswordNeeded Event (CertificateStorage Component)

This event is fired when a decryption password is needed.

Syntax

typedef struct {
  String NeededFor;
  String Password;
  bool Cancel;
} TsbxCertificateStoragePasswordNeededEventParams;
typedef void __fastcall (__closure *TsbxCertificateStoragePasswordNeededEvent)(System::TObject* Sender, TsbxCertificateStoragePasswordNeededEventParams *e);
__property TsbxCertificateStoragePasswordNeededEvent OnPasswordNeeded = { read=FOnPasswordNeeded, write=FOnPasswordNeeded };

Remarks

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

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

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

Config Settings (CertificateStorage Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

CertificateStorage Config Settings

AuthAttempts:   The number of auth/login attempts to try.

Specifies the number of tries to authenticate to the storage (the default is 3). The control will fire PasswordNeeded event after each unsuccessful attempt. Applicable to: PKCS11.

PKCS11ActiveSlot:   The index of the slot that the component is working with.

Returns the index of the PKCS#11 slot that is currently being accessed.

PKCS11NewPIN:   Changes the current user's PIN.

Setting this property will change the current users's PIN to the provided value. Most HSMs require the user to be signed in to perform this operation. This is the way to change your own PIN, either for admin or regular user accounts.

PKCS11NewUserPIN:   Registers a new user PIN.

Setting this property will register a new PIN to the HSM user account. This property is the way to administratively reset the user's PIN, and can only be set from under the 'admin' session.

PKCS11PIN:   Sets the operation PIN.

Use this property to provide your PIN on the fly for an operation requiring the private key (e.g. signing). This may be useful if the PIN was not provided on the Open stage.

PKCS11SlotCount:   The number of slots exposed in the storage.

Returns the number of slots available in an opened PKCS#11 storage.

PKCS11SlotDescription[i]:   A human-readable description of the slot.

Returns a human-readable description of slot i.

PKCS11SlotLoggedIn[i]:   Whether slot i has an active session associated with it.

Returns true if there is an active session associated with slot number i.

PKCS11SlotPinNeeded[i]:   Whether slot i requires you to provide a PIN to log in or sign.

Returns true if you need to provide a PIN to sign in to the session for slot i.

PKCS11SlotReadOnly[i]:   Whether slot i only supports read-only access.

Returns the availability of the slot for write operations.

PKCS11SlotTokenLabel[i]:   The label assigned to the token.

Returns the label assigned to the token.

PKCS11SlotTokenModel[i]:   The token model.

Returns the model of the token as provided by the driver.

PKCS11SlotTokenPresent[i]:   Indicates whether there is a token in the slot.

Returns true if slot number i has a token inserted.

PKCS11SlotTokenSerial[i]:   The serial number of the token.

Returns the serial number of the token.

PKCS11SlotTokenVendorID[i]:   The manufacturer ID of the inserted token.

Returns vendor ID string for slot number i.

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

Returns the manufacturer name associated with the slot.

TempPath:   Path for storing temporary files.

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

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

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the component.

Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components.

LogDestination:   Specifies the debug log destination.

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

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

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

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the component. 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 component) 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 component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component 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 components.

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

CertificateStorage Errors

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