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.

Method List

---

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

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.

Config Settings

---

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

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:

• CertBytes
• CertCA
• CertCAKeyID
• CertCRLDistributionPoints
• CertCurve
• CertFingerprint
• CertFriendlyName
• CertHandle
• CertHashAlgorithm
• CertIssuer
• CertIssuerRDN
• CertKeyAlgorithm
• CertKeyBits
• CertKeyFingerprint
• CertKeyUsage
• CertKeyValid
• CertOCSPLocations
• CertOCSPNoCheck
• CertOrigin
• CertPolicyIDs
• CertPrivateKeyBytes
• CertPrivateKeyExists
• CertPrivateKeyExtractable
• CertPublicKeyBytes
• CertQualifiedStatements
• CertSelfSigned
• CertSerialNumber
• CertSigAlgorithm
• CertSubject
• CertSubjectAlternativeName
• CertSubjectKeyID
• CertSubjectRDN
• CertValidFrom
• CertValidTo

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 the raw certificate data in DER format.

Syntax

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

Remarks

Returns the 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 the 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 the 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.

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)

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.

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:

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 certificate's ocsp-no-check extension.

Syntax

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

Default Value

false

Remarks

Accessor to the value of the certificate's 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 the raw certificate data in DER format.

Syntax

__property DynamicArray PinnedCertBytes = { read=FPinnedCertBytes };

Remarks

Returns the 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:

• SelectedCertBytes
• SelectedCertCA
• SelectedCertCAKeyID
• SelectedCertCRLDistributionPoints
• SelectedCertCurve
• SelectedCertFingerprint
• SelectedCertFriendlyName
• SelectedCertHandle
• SelectedCertHashAlgorithm
• SelectedCertIssuer
• SelectedCertIssuerRDN
• SelectedCertKeyAlgorithm
• SelectedCertKeyBits
• SelectedCertKeyFingerprint
• SelectedCertKeyUsage
• SelectedCertKeyValid
• SelectedCertOCSPLocations
• SelectedCertOCSPNoCheck
• SelectedCertOrigin
• SelectedCertPolicyIDs
• SelectedCertPrivateKeyBytes
• SelectedCertPrivateKeyExists
• SelectedCertPrivateKeyExtractable
• SelectedCertPublicKeyBytes
• SelectedCertQualifiedStatements
• SelectedCertSelfSigned
• SelectedCertSerialNumber
• SelectedCertSigAlgorithm
• SelectedCertSubject
• SelectedCertSubjectAlternativeName
• SelectedCertSubjectKeyID
• SelectedCertSubjectRDN
• SelectedCertValidFrom
• SelectedCertValidTo

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 the raw certificate data in DER format.

Syntax

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

Remarks

Returns the 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 the 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 the 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.

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)

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.

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:

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 certificate's ocsp-no-check extension.

Syntax

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

Default Value

false

Remarks

Accessor to the value of the certificate's 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):

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.

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 insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

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.

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.

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:

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.

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:

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

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:

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 the 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

Base Config Settings

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)