CertificateStorage Class

Properties   Methods   Events   Config Settings   Errors  

The CertificateStorage class works with collections of certificates.

Class Name

SecureBlackbox_CertificateStorage

Procedural Interface

 secureblackbox_certificatestorage_open();
 secureblackbox_certificatestorage_close($res);
 secureblackbox_certificatestorage_register_callback($res, $id, $function);
 secureblackbox_certificatestorage_get_last_error($res);
 secureblackbox_certificatestorage_get_last_error_code($res);
 secureblackbox_certificatestorage_set($res, $id, $index, $value);
 secureblackbox_certificatestorage_get($res, $id, $index);
 secureblackbox_certificatestorage_do_add($res, $data);
 secureblackbox_certificatestorage_do_addfromfile($res, $filename);
 secureblackbox_certificatestorage_do_addpinned($res);
 secureblackbox_certificatestorage_do_clear($res);
 secureblackbox_certificatestorage_do_close($res, $save);
 secureblackbox_certificatestorage_do_config($res, $configurationstring);
 secureblackbox_certificatestorage_do_createnew($res, $storagelocation, $storageid);
 secureblackbox_certificatestorage_do_doaction($res, $actionid, $actionparams);
 secureblackbox_certificatestorage_do_exportbytes($res, $password, $format);
 secureblackbox_certificatestorage_do_exporttofile($res, $certfile, $password, $format);
 secureblackbox_certificatestorage_do_getstorageproperty($res, $name);
 secureblackbox_certificatestorage_do_importbytes($res, $certbytes, $password, $clear);
 secureblackbox_certificatestorage_do_importfromfile($res, $path, $password, $clear);
 secureblackbox_certificatestorage_do_liststores($res);
 secureblackbox_certificatestorage_do_login($res, $sessiontype, $pin, $readonly);
 secureblackbox_certificatestorage_do_logout($res, $closesesion);
 secureblackbox_certificatestorage_do_open($res, $storageid);
 secureblackbox_certificatestorage_do_refresh($res);
 secureblackbox_certificatestorage_do_remove($res, $index);
 secureblackbox_certificatestorage_do_select($res, $filter, $privatekeyneeded, $maxcount);
 secureblackbox_certificatestorage_do_selectchain($res, $index);
 secureblackbox_certificatestorage_do_setstorageproperty($res, $name, $value);

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

Method List

---

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

Event List

---

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

Config Settings

---

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

CertCount Property (SecureBlackbox_CertificateStorage Class)

The number of records in the Cert arrays.

Object Oriented Interface

public function getCertCount();

Procedural Interface

secureblackbox_certificatestorage_get($res, 1 );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 2 , $certindex);

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

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

Object Oriented Interface

public function getCertCA($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 3 , $certindex);

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

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

Object Oriented Interface

public function getCertCAKeyID($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 4 , $certindex);

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

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

Object Oriented Interface

public function getCertCRLDistributionPoints($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 5 , $certindex);

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

Specifies the elliptic curve of the EC public key.

Object Oriented Interface

public function getCertCurve($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 6 , $certindex);

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

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

Object Oriented Interface

public function getCertFingerprint($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 7 , $certindex);

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

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

Object Oriented Interface

public function getCertFriendlyName($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 8 , $certindex);

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

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

Object Oriented Interface

public function getCertHandle($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 9 , $certindex);

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

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 .

Object Oriented Interface

public function getCertHashAlgorithm($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 10 , $certindex);

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

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

Object Oriented Interface

public function getCertIssuer($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 11 , $certindex);

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

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

Object Oriented Interface

public function getCertIssuerRDN($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 12 , $certindex);

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

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getCertKeyAlgorithm($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 13 , $certindex);

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

Returns the length of the public key.

Object Oriented Interface

public function getCertKeyBits($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 14 , $certindex);

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

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

Object Oriented Interface

public function getCertKeyFingerprint($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 15 , $certindex);

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

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

Object Oriented Interface

public function getCertKeyUsage($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 16 , $certindex);

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

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

Object Oriented Interface

public function getCertKeyValid($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 17 , $certindex);

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

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

Object Oriented Interface

public function getCertOCSPLocations($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 18 , $certindex);

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

Accessor to the value of the certificate's ocsp-no-check extension.

Object Oriented Interface

public function getCertOCSPNoCheck($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 19 , $certindex);

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

Returns the origin of this certificate.

Object Oriented Interface

public function getCertOrigin($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 20 , $certindex);

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

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getCertPolicyIDs($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 21 , $certindex);

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

Contains the certificate's private key.

Object Oriented Interface

public function getCertPrivateKeyBytes($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 22 , $certindex);

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

Indicates whether the certificate has an associated private key.

Object Oriented Interface

public function getCertPrivateKeyExists($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 23 , $certindex);

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

Indicates whether the private key is extractable.

Object Oriented Interface

public function getCertPrivateKeyExtractable($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 24 , $certindex);

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

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getCertPublicKeyBytes($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 25 , $certindex);

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

Returns the qualified status of the certificate.

Object Oriented Interface

public function getCertQualifiedStatements($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 26 , $certindex);

Default Value

0

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

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

Object Oriented Interface

public function getCertSelfSigned($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 27 , $certindex);

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

Returns the certificate's serial number.

Object Oriented Interface

public function getCertSerialNumber($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 28 , $certindex);

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

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

Object Oriented Interface

public function getCertSigAlgorithm($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 29 , $certindex);

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

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

Object Oriented Interface

public function getCertSubject($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 30 , $certindex);

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

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

Object Oriented Interface

public function getCertSubjectAlternativeName($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 31 , $certindex);

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

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

Object Oriented Interface

public function getCertSubjectKeyID($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 32 , $certindex);

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

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

Object Oriented Interface

public function getCertSubjectRDN($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 33 , $certindex);

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

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

Object Oriented Interface

public function getCertValidFrom($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 34 , $certindex);

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

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

Object Oriented Interface

public function getCertValidTo($certindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 35 , $certindex);

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

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_certificatestorage_get($res, 36 );


secureblackbox_certificatestorage_set($res, 36, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Opened Property (SecureBlackbox_CertificateStorage Class)

Indicates whether the storage is in the open state.

Object Oriented Interface

public function getOpened();

Procedural Interface

secureblackbox_certificatestorage_get($res, 37 );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getPinnedCertBytes();

Procedural Interface

secureblackbox_certificatestorage_get($res, 38 );

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

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

Object Oriented Interface

public function getPinnedCertHandle();


public function setPinnedCertHandle($value);

Procedural Interface

secureblackbox_certificatestorage_get($res, 45 );


secureblackbox_certificatestorage_set($res, 45, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SelectedCertCount Property (SecureBlackbox_CertificateStorage Class)

The number of records in the SelectedCert arrays.

Object Oriented Interface

public function getSelectedCertCount();

Procedural Interface

secureblackbox_certificatestorage_get($res, 72 );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSelectedCertBytes($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 73 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertCA($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 74 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertCAKeyID($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 75 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertCRLDistributionPoints($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 76 , $selectedcertindex);

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

Specifies the elliptic curve of the EC public key.

Object Oriented Interface

public function getSelectedCertCurve($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 77 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertFingerprint($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 78 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertFriendlyName($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 79 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertHandle($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 80 , $selectedcertindex);

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

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 .

Object Oriented Interface

public function getSelectedCertHashAlgorithm($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 81 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertIssuer($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 82 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertIssuerRDN($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 83 , $selectedcertindex);

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

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getSelectedCertKeyAlgorithm($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 84 , $selectedcertindex);

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

Returns the length of the public key.

Object Oriented Interface

public function getSelectedCertKeyBits($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 85 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertKeyFingerprint($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 86 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertKeyUsage($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 87 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertKeyValid($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 88 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertOCSPLocations($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 89 , $selectedcertindex);

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

Accessor to the value of the certificate's ocsp-no-check extension.

Object Oriented Interface

public function getSelectedCertOCSPNoCheck($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 90 , $selectedcertindex);

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

Returns the origin of this certificate.

Object Oriented Interface

public function getSelectedCertOrigin($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 91 , $selectedcertindex);

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

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getSelectedCertPolicyIDs($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 92 , $selectedcertindex);

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

Contains the certificate's private key.

Object Oriented Interface

public function getSelectedCertPrivateKeyBytes($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 93 , $selectedcertindex);

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

Indicates whether the certificate has an associated private key.

Object Oriented Interface

public function getSelectedCertPrivateKeyExists($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 94 , $selectedcertindex);

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

Indicates whether the private key is extractable.

Object Oriented Interface

public function getSelectedCertPrivateKeyExtractable($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 95 , $selectedcertindex);

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

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getSelectedCertPublicKeyBytes($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 96 , $selectedcertindex);

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

Returns the qualified status of the certificate.

Object Oriented Interface

public function getSelectedCertQualifiedStatements($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 97 , $selectedcertindex);

Default Value

0

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

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

Object Oriented Interface

public function getSelectedCertSelfSigned($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 98 , $selectedcertindex);

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

Returns the certificate's serial number.

Object Oriented Interface

public function getSelectedCertSerialNumber($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 99 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertSigAlgorithm($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 100 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertSubject($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 101 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertSubjectAlternativeName($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 102 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertSubjectKeyID($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 103 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertSubjectRDN($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 104 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertValidFrom($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 105 , $selectedcertindex);

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

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

Object Oriented Interface

public function getSelectedCertValidTo($selectedcertindex);

Procedural Interface

secureblackbox_certificatestorage_get($res, 106 , $selectedcertindex);

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

A unique identifier of this storage.

Object Oriented Interface

public function getStorageID();

Procedural Interface

secureblackbox_certificatestorage_get($res, 107 );

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

Specifies the location of the currently opened storage.

Object Oriented Interface

public function getStorageLocation();

Procedural Interface

secureblackbox_certificatestorage_get($res, 108 );

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

Adds a certificate to the storage.

Object Oriented Interface

public function doAdd($data);

Procedural Interface

secureblackbox_certificatestorage_do_add($res, $data);

Remarks

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

AddFromFile Method (SecureBlackbox_CertificateStorage Class)

Adds a certificate to the storage.

Object Oriented Interface

public function doAddFromFile($filename);

Procedural Interface

secureblackbox_certificatestorage_do_addfromfile($res, $filename);

Remarks

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

AddPinned Method (SecureBlackbox_CertificateStorage Class)

Adds the pinned certificate to the storage.

Object Oriented Interface

public function doAddPinned();

Procedural Interface

secureblackbox_certificatestorage_do_addpinned($res);

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

Removes all certificates from the storage.

Object Oriented Interface

public function doClear();

Procedural Interface

secureblackbox_certificatestorage_do_clear($res);

Remarks

Use this method to empty the storage.

Close Method (SecureBlackbox_CertificateStorage Class)

Closes the certificate storage.

Object Oriented Interface

public function doClose($save);

Procedural Interface

secureblackbox_certificatestorage_do_close($res, $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 (SecureBlackbox_CertificateStorage Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_certificatestorage_do_config($res, $configurationstring);

Remarks

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

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

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

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

CreateNew Method (SecureBlackbox_CertificateStorage Class)

Creates a new storage.

Object Oriented Interface

public function doCreateNew($storagelocation, $storageid);

Procedural Interface

secureblackbox_certificatestorage_do_createnew($res, $storagelocation, $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 (SecureBlackbox_CertificateStorage Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_certificatestorage_do_doaction($res, $actionid, $actionparams);

Remarks

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

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

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

ExportBytes Method (SecureBlackbox_CertificateStorage Class)

Exports the certificates in the chosen format.

Object Oriented Interface

public function doExportBytes($password, $format);

Procedural Interface

secureblackbox_certificatestorage_do_exportbytes($res, $password, $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 (SecureBlackbox_CertificateStorage Class)

Exports the certificates to a file.

Object Oriented Interface

public function doExportToFile($certfile, $password, $format);

Procedural Interface

secureblackbox_certificatestorage_do_exporttofile($res, $certfile, $password, $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 (SecureBlackbox_CertificateStorage Class)

Returns the value of a custom certificate storage property.

Object Oriented Interface

public function doGetStorageProperty($name);

Procedural Interface

secureblackbox_certificatestorage_do_getstorageproperty($res, $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 (SecureBlackbox_CertificateStorage Class)

Imports a certificates.

Object Oriented Interface

public function doImportBytes($certbytes, $password, $clear);

Procedural Interface

secureblackbox_certificatestorage_do_importbytes($res, $certbytes, $password, $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 (SecureBlackbox_CertificateStorage Class)

Loads a certificates from a file.

Object Oriented Interface

public function doImportFromFile($path, $password, $clear);

Procedural Interface

secureblackbox_certificatestorage_do_importfromfile($res, $path, $password, $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 (SecureBlackbox_CertificateStorage Class)

Returns a list of individual stores available within the storage.

Object Oriented Interface

public function doListStores();

Procedural Interface

secureblackbox_certificatestorage_do_liststores($res);

Remarks

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

The contents of the list depends on the type of the store used and the parameters it is opened with. For 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 (SecureBlackbox_CertificateStorage Class)

Signs in to a session or elevates the session rights.

Object Oriented Interface

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

Procedural Interface

secureblackbox_certificatestorage_do_login($res, $sessiontype, $pin, $readonly);

Remarks

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

Logout Method (SecureBlackbox_CertificateStorage Class)

Signs out of an opened session.

Object Oriented Interface

public function doLogout($closesesion);

Procedural Interface

secureblackbox_certificatestorage_do_logout($res, $closesesion);

Remarks

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

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

Open Method (SecureBlackbox_CertificateStorage Class)

Opens existing storage or creates one in memory.

Object Oriented Interface

public function doOpen($storageid);

Procedural Interface

secureblackbox_certificatestorage_do_open($res, $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 (SecureBlackbox_CertificateStorage Class)

Refreshes all storage keychains.

Object Oriented Interface

public function doRefresh();

Procedural Interface

secureblackbox_certificatestorage_do_refresh($res);

Remarks

Call this method to refresh the storage.

Remove Method (SecureBlackbox_CertificateStorage Class)

Removes a certificate from the storage.

Object Oriented Interface

public function doRemove($index);

Procedural Interface

secureblackbox_certificatestorage_do_remove($res, $index);

Remarks

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

Select Method (SecureBlackbox_CertificateStorage Class)

Allows the selection of certificates from the system store.

Object Oriented Interface

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

Procedural Interface

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

Selects a chain of certificates given its index.

Object Oriented Interface

public function doSelectChain($index);

Procedural Interface

secureblackbox_certificatestorage_do_selectchain($res, $index);

Remarks

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

SetStorageProperty Method (SecureBlackbox_CertificateStorage Class)

Sets the value of a custom certificate storage property.

Object Oriented Interface

public function doSetStorageProperty($name, $value);

Procedural Interface

secureblackbox_certificatestorage_do_setstorageproperty($res, $name, $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 (SecureBlackbox_CertificateStorage Class)

Information about errors during certificate loading or saving.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

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

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

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

Parameter List

 'eventid'
 'eventparam'

Remarks

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

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

PasswordNeeded Event (SecureBlackbox_CertificateStorage Class)

This event is fired when a decryption password is needed.

Object Oriented Interface

public function firePasswordNeeded($param);

Procedural Interface

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

Parameter List

 'neededfor'
 'password'
 'cancel'

Remarks

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

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

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

Config Settings (CertificateStorage Class)

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

CertificateStorage Config Settings

Base Config Settings

Trappable Errors (CertificateStorage Class)

CertificateStorage Errors

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