CertificateManager Class

Properties   Methods   Events   Config Settings   Errors  

The CertificateManager class supports importing, exporting, and generating X.509 certificates.

Syntax

CertificateManager

Remarks

Usage of this class includes importing and exporting certificates and keys in various formats, as well as certificate generation.

Loading certificates

To load a certificate from a file, use the ImportFromFile method. This method supports all existing certificate formats, including PFX, PEM, DER, and P7B. Note that keys contained in PFX and PEM certificates are often encrypted with a password, so you will likely need to provide one for the certificate to be loaded correctly. You can either provide the password via the method's parameter, or provide it on-demand by subscribing to the PasswordNeeded event.

Alternatively, you can use ImportCert to load a certificate from a different type of media, such as a database.

If your certificate and its private key are stored in separate files or buffers - which is often the case where PEM or DER format is used - please load the certificate with the ImportFromFile method first, and then add the key to it with a separate call to the ImportKeyFromFile method. You can mix and match the certificate and key formats in this case; CertificateManager will handle this automatically.

Note that CertificateManager can only keep one certificate at a time. If your PFX or PEM file contains more than one certificate, use CertificateStorage component to load it instead.

Generating certificates

• set all the needed certificate properties - for example, its subject, serial number, and validity period - via the Certificate property.
• load the CA certificate to a different CertificateManager object, and assign it to the CACertificate property. Note that the CA certificate should have an associated private key. Alternatively, the CA certificate can be loaded using a CertificateStorage object, which allows to import it from a hardware device or a system store.

  Note: you do not need to load and set the CA certificate if generating a self-signed certificate.

• Call Generate to generate a new keypair and wrap it into a certificate.
• Save the certificate using ExportToFile or ExportCert methods.

  Note: take care to choose a format that supports storing private keys. If you do not save the new private key at this stage, you won't be able to recover it later.

  Note: you can save the private key separately using the ExportKey method.

Generating certificate requests

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.

CACertBytes Property (CertificateManager Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCACertBytes(char* &lpCACertBytes, int &lenCACertBytes);

Unicode (Windows)
INT GetCACertBytes(LPSTR &lpCACertBytes, INT &lenCACertBytes);

int secureblackbox_certificatemanager_getcacertbytes(void* lpObj, char** lpCACertBytes, int* lenCACertBytes);

QByteArray GetCACertBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CACertHandle Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCACertHandle();
int SetCACertHandle(int64 lCACertHandle);

Unicode (Windows)
LONG64 GetCACertHandle();
INT SetCACertHandle(LONG64 lCACertHandle);

int64 secureblackbox_certificatemanager_getcacerthandle(void* lpObj);
int secureblackbox_certificatemanager_setcacerthandle(void* lpObj, int64 lCACertHandle);

qint64 GetCACertHandle();
int SetCACertHandle(qint64 lCACertHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

CertBytes Property (CertificateManager Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertBytes(char* &lpCertBytes, int &lenCertBytes);

Unicode (Windows)
INT GetCertBytes(LPSTR &lpCertBytes, INT &lenCertBytes);

int secureblackbox_certificatemanager_getcertbytes(void* lpObj, char** lpCertBytes, int* lenCertBytes);

QByteArray GetCertBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CertCA Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertCA();
int SetCertCA(int bCertCA);

Unicode (Windows)
BOOL GetCertCA();
INT SetCertCA(BOOL bCertCA);

int secureblackbox_certificatemanager_getcertca(void* lpObj);
int secureblackbox_certificatemanager_setcertca(void* lpObj, int bCertCA);

bool GetCertCA();
int SetCertCA(bool bCertCA);

Default Value

FALSE

Remarks

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

This property is not available at design time.

Data Type

Boolean

CertCAKeyID Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertCAKeyID(char* &lpCertCAKeyID, int &lenCertCAKeyID);

Unicode (Windows)
INT GetCertCAKeyID(LPSTR &lpCertCAKeyID, INT &lenCertCAKeyID);

int secureblackbox_certificatemanager_getcertcakeyid(void* lpObj, char** lpCertCAKeyID, int* lenCertCAKeyID);

QByteArray GetCertCAKeyID();

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.

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

Data Type

Byte Array

CertCRLDistributionPoints Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertCRLDistributionPoints();
int SetCertCRLDistributionPoints(const char* lpszCertCRLDistributionPoints);

Unicode (Windows)
LPWSTR GetCertCRLDistributionPoints();
INT SetCertCRLDistributionPoints(LPCWSTR lpszCertCRLDistributionPoints);

char* secureblackbox_certificatemanager_getcertcrldistributionpoints(void* lpObj);
int secureblackbox_certificatemanager_setcertcrldistributionpoints(void* lpObj, const char* lpszCertCRLDistributionPoints);

QString GetCertCRLDistributionPoints();
int SetCertCRLDistributionPoints(QString qsCertCRLDistributionPoints);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

CertCurve Property (CertificateManager Class)

Specifies the elliptic curve of the EC public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertCurve();
int SetCertCurve(const char* lpszCertCurve);

Unicode (Windows)
LPWSTR GetCertCurve();
INT SetCertCurve(LPCWSTR lpszCertCurve);

char* secureblackbox_certificatemanager_getcertcurve(void* lpObj);
int secureblackbox_certificatemanager_setcertcurve(void* lpObj, const char* lpszCertCurve);

QString GetCertCurve();
int SetCertCurve(QString qsCertCurve);

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

This property is not available at design time.

Data Type

String

CertFingerprint Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertFingerprint(char* &lpCertFingerprint, int &lenCertFingerprint);

Unicode (Windows)
INT GetCertFingerprint(LPSTR &lpCertFingerprint, INT &lenCertFingerprint);

int secureblackbox_certificatemanager_getcertfingerprint(void* lpObj, char** lpCertFingerprint, int* lenCertFingerprint);

QByteArray GetCertFingerprint();

Remarks

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

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

Data Type

Byte Array

CertFriendlyName Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertFriendlyName();

Unicode (Windows)
LPWSTR GetCertFriendlyName();

char* secureblackbox_certificatemanager_getcertfriendlyname(void* lpObj);

QString GetCertFriendlyName();

Default Value

""

Remarks

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

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

Data Type

String

CertHandle Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCertHandle();
int SetCertHandle(int64 lCertHandle);

Unicode (Windows)
LONG64 GetCertHandle();
INT SetCertHandle(LONG64 lCertHandle);

int64 secureblackbox_certificatemanager_getcerthandle(void* lpObj);
int secureblackbox_certificatemanager_setcerthandle(void* lpObj, int64 lCertHandle);

qint64 GetCertHandle();
int SetCertHandle(qint64 lCertHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

CertHashAlgorithm Property (CertificateManager 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 .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertHashAlgorithm();
int SetCertHashAlgorithm(const char* lpszCertHashAlgorithm);

Unicode (Windows)
LPWSTR GetCertHashAlgorithm();
INT SetCertHashAlgorithm(LPCWSTR lpszCertHashAlgorithm);

char* secureblackbox_certificatemanager_getcerthashalgorithm(void* lpObj);
int secureblackbox_certificatemanager_setcerthashalgorithm(void* lpObj, const char* lpszCertHashAlgorithm);

QString GetCertHashAlgorithm();
int SetCertHashAlgorithm(QString qsCertHashAlgorithm);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

CertIssuer Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertIssuer();

Unicode (Windows)
LPWSTR GetCertIssuer();

char* secureblackbox_certificatemanager_getcertissuer(void* lpObj);

QString GetCertIssuer();

Default Value

""

Remarks

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

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

Data Type

String

CertIssuerRDN Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertIssuerRDN();
int SetCertIssuerRDN(const char* lpszCertIssuerRDN);

Unicode (Windows)
LPWSTR GetCertIssuerRDN();
INT SetCertIssuerRDN(LPCWSTR lpszCertIssuerRDN);

char* secureblackbox_certificatemanager_getcertissuerrdn(void* lpObj);
int secureblackbox_certificatemanager_setcertissuerrdn(void* lpObj, const char* lpszCertIssuerRDN);

QString GetCertIssuerRDN();
int SetCertIssuerRDN(QString qsCertIssuerRDN);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

CertKeyAlgorithm Property (CertificateManager Class)

Specifies the public key algorithm of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertKeyAlgorithm();
int SetCertKeyAlgorithm(const char* lpszCertKeyAlgorithm);

Unicode (Windows)
LPWSTR GetCertKeyAlgorithm();
INT SetCertKeyAlgorithm(LPCWSTR lpszCertKeyAlgorithm);

char* secureblackbox_certificatemanager_getcertkeyalgorithm(void* lpObj);
int secureblackbox_certificatemanager_setcertkeyalgorithm(void* lpObj, const char* lpszCertKeyAlgorithm);

QString GetCertKeyAlgorithm();
int SetCertKeyAlgorithm(QString qsCertKeyAlgorithm);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

This property is not available at design time.

Data Type

String

CertKeyBits Property (CertificateManager Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyBits();

Unicode (Windows)
INT GetCertKeyBits();

int secureblackbox_certificatemanager_getcertkeybits(void* lpObj);

int GetCertKeyBits();

Default Value

0

Remarks

Returns the length of the public key.

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

Data Type

Integer

CertKeyFingerprint Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyFingerprint(char* &lpCertKeyFingerprint, int &lenCertKeyFingerprint);

Unicode (Windows)
INT GetCertKeyFingerprint(LPSTR &lpCertKeyFingerprint, INT &lenCertKeyFingerprint);

int secureblackbox_certificatemanager_getcertkeyfingerprint(void* lpObj, char** lpCertKeyFingerprint, int* lenCertKeyFingerprint);

QByteArray GetCertKeyFingerprint();

Remarks

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

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

Data Type

Byte Array

CertKeyUsage Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyUsage();
int SetCertKeyUsage(int iCertKeyUsage);

Unicode (Windows)
INT GetCertKeyUsage();
INT SetCertKeyUsage(INT iCertKeyUsage);

int secureblackbox_certificatemanager_getcertkeyusage(void* lpObj);
int secureblackbox_certificatemanager_setcertkeyusage(void* lpObj, int iCertKeyUsage);

int GetCertKeyUsage();
int SetCertKeyUsage(int iCertKeyUsage);

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:

This property is not available at design time.

Data Type

Integer

CertKeyValid Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyValid();

Unicode (Windows)
BOOL GetCertKeyValid();

int secureblackbox_certificatemanager_getcertkeyvalid(void* lpObj);

bool GetCertKeyValid();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

CertOCSPLocations Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertOCSPLocations();
int SetCertOCSPLocations(const char* lpszCertOCSPLocations);

Unicode (Windows)
LPWSTR GetCertOCSPLocations();
INT SetCertOCSPLocations(LPCWSTR lpszCertOCSPLocations);

char* secureblackbox_certificatemanager_getcertocsplocations(void* lpObj);
int secureblackbox_certificatemanager_setcertocsplocations(void* lpObj, const char* lpszCertOCSPLocations);

QString GetCertOCSPLocations();
int SetCertOCSPLocations(QString qsCertOCSPLocations);

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.

This property is not available at design time.

Data Type

String

CertOCSPNoCheck Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertOCSPNoCheck();
int SetCertOCSPNoCheck(int bCertOCSPNoCheck);

Unicode (Windows)
BOOL GetCertOCSPNoCheck();
INT SetCertOCSPNoCheck(BOOL bCertOCSPNoCheck);

int secureblackbox_certificatemanager_getcertocspnocheck(void* lpObj);
int secureblackbox_certificatemanager_setcertocspnocheck(void* lpObj, int bCertOCSPNoCheck);

bool GetCertOCSPNoCheck();
int SetCertOCSPNoCheck(bool bCertOCSPNoCheck);

Default Value

FALSE

Remarks

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

This property is not available at design time.

Data Type

Boolean

CertOrigin Property (CertificateManager Class)

Returns the origin of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertOrigin();

Unicode (Windows)
INT GetCertOrigin();

int secureblackbox_certificatemanager_getcertorigin(void* lpObj);

int GetCertOrigin();

Default Value

0

Remarks

Returns the origin of this certificate.

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

Data Type

Integer

CertPolicyIDs Property (CertificateManager Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertPolicyIDs();
int SetCertPolicyIDs(const char* lpszCertPolicyIDs);

Unicode (Windows)
LPWSTR GetCertPolicyIDs();
INT SetCertPolicyIDs(LPCWSTR lpszCertPolicyIDs);

char* secureblackbox_certificatemanager_getcertpolicyids(void* lpObj);
int secureblackbox_certificatemanager_setcertpolicyids(void* lpObj, const char* lpszCertPolicyIDs);

QString GetCertPolicyIDs();
int SetCertPolicyIDs(QString qsCertPolicyIDs);

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.

This property is not available at design time.

Data Type

String

CertPrivateKeyBytes Property (CertificateManager Class)

Contains the certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertPrivateKeyBytes(char* &lpCertPrivateKeyBytes, int &lenCertPrivateKeyBytes);

Unicode (Windows)
INT GetCertPrivateKeyBytes(LPSTR &lpCertPrivateKeyBytes, INT &lenCertPrivateKeyBytes);

int secureblackbox_certificatemanager_getcertprivatekeybytes(void* lpObj, char** lpCertPrivateKeyBytes, int* lenCertPrivateKeyBytes);

QByteArray GetCertPrivateKeyBytes();

Remarks

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

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

Data Type

Byte Array

CertPrivateKeyExists Property (CertificateManager Class)

Indicates whether the certificate has an associated private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertPrivateKeyExists();

Unicode (Windows)
BOOL GetCertPrivateKeyExists();

int secureblackbox_certificatemanager_getcertprivatekeyexists(void* lpObj);

bool GetCertPrivateKeyExists();

Default Value

FALSE

Remarks

Indicates whether the certificate has an associated private key.

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

Data Type

Boolean

CertPrivateKeyExtractable Property (CertificateManager Class)

Indicates whether the private key is extractable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertPrivateKeyExtractable();

Unicode (Windows)
BOOL GetCertPrivateKeyExtractable();

int secureblackbox_certificatemanager_getcertprivatekeyextractable(void* lpObj);

bool GetCertPrivateKeyExtractable();

Default Value

FALSE

Remarks

Indicates whether the private key is extractable.

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

Data Type

Boolean

CertPublicKeyBytes Property (CertificateManager Class)

Contains the certificate's public key in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertPublicKeyBytes(char* &lpCertPublicKeyBytes, int &lenCertPublicKeyBytes);

Unicode (Windows)
INT GetCertPublicKeyBytes(LPSTR &lpCertPublicKeyBytes, INT &lenCertPublicKeyBytes);

int secureblackbox_certificatemanager_getcertpublickeybytes(void* lpObj, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);

QByteArray GetCertPublicKeyBytes();

Remarks

Contains the certificate's public key in DER format.

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

Data Type

Byte Array

CertQualifiedStatements Property (CertificateManager Class)

Returns the qualified status of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertQualifiedStatements();
int SetCertQualifiedStatements(int iCertQualifiedStatements);

Unicode (Windows)
INT GetCertQualifiedStatements();
INT SetCertQualifiedStatements(INT iCertQualifiedStatements);

QST_NON_QUALIFIED(0), 
QST_QUALIFIED_HARDWARE(1), 
QST_QUALIFIED_SOFTWARE(2)

int secureblackbox_certificatemanager_getcertqualifiedstatements(void* lpObj);
int secureblackbox_certificatemanager_setcertqualifiedstatements(void* lpObj, int iCertQualifiedStatements);

int GetCertQualifiedStatements();
int SetCertQualifiedStatements(int iCertQualifiedStatements);

Default Value

0

Remarks

Returns the qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

CertSelfSigned Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertSelfSigned();

Unicode (Windows)
BOOL GetCertSelfSigned();

int secureblackbox_certificatemanager_getcertselfsigned(void* lpObj);

bool GetCertSelfSigned();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

CertSerialNumber Property (CertificateManager Class)

Returns the certificate's serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertSerialNumber(char* &lpCertSerialNumber, int &lenCertSerialNumber);
int SetCertSerialNumber(const char* lpCertSerialNumber, int lenCertSerialNumber);

Unicode (Windows)
INT GetCertSerialNumber(LPSTR &lpCertSerialNumber, INT &lenCertSerialNumber);
INT SetCertSerialNumber(LPCSTR lpCertSerialNumber, INT lenCertSerialNumber);

int secureblackbox_certificatemanager_getcertserialnumber(void* lpObj, char** lpCertSerialNumber, int* lenCertSerialNumber);
int secureblackbox_certificatemanager_setcertserialnumber(void* lpObj, const char* lpCertSerialNumber, int lenCertSerialNumber);

QByteArray GetCertSerialNumber();
int SetCertSerialNumber(QByteArray qbaCertSerialNumber);

Remarks

Returns the certificate's serial number.

This property is not available at design time.

Data Type

Byte Array

CertSigAlgorithm Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSigAlgorithm();

Unicode (Windows)
LPWSTR GetCertSigAlgorithm();

char* secureblackbox_certificatemanager_getcertsigalgorithm(void* lpObj);

QString GetCertSigAlgorithm();

Default Value

""

Remarks

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

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

Data Type

String

CertSubject Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSubject();

Unicode (Windows)
LPWSTR GetCertSubject();

char* secureblackbox_certificatemanager_getcertsubject(void* lpObj);

QString GetCertSubject();

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.

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

Data Type

String

CertSubjectAlternativeName Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSubjectAlternativeName();
int SetCertSubjectAlternativeName(const char* lpszCertSubjectAlternativeName);

Unicode (Windows)
LPWSTR GetCertSubjectAlternativeName();
INT SetCertSubjectAlternativeName(LPCWSTR lpszCertSubjectAlternativeName);

char* secureblackbox_certificatemanager_getcertsubjectalternativename(void* lpObj);
int secureblackbox_certificatemanager_setcertsubjectalternativename(void* lpObj, const char* lpszCertSubjectAlternativeName);

QString GetCertSubjectAlternativeName();
int SetCertSubjectAlternativeName(QString qsCertSubjectAlternativeName);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

CertSubjectKeyID Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertSubjectKeyID(char* &lpCertSubjectKeyID, int &lenCertSubjectKeyID);
int SetCertSubjectKeyID(const char* lpCertSubjectKeyID, int lenCertSubjectKeyID);

Unicode (Windows)
INT GetCertSubjectKeyID(LPSTR &lpCertSubjectKeyID, INT &lenCertSubjectKeyID);
INT SetCertSubjectKeyID(LPCSTR lpCertSubjectKeyID, INT lenCertSubjectKeyID);

int secureblackbox_certificatemanager_getcertsubjectkeyid(void* lpObj, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
int secureblackbox_certificatemanager_setcertsubjectkeyid(void* lpObj, const char* lpCertSubjectKeyID, int lenCertSubjectKeyID);

QByteArray GetCertSubjectKeyID();
int SetCertSubjectKeyID(QByteArray qbaCertSubjectKeyID);

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.

This property is not available at design time.

Data Type

Byte Array

CertSubjectRDN Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSubjectRDN();
int SetCertSubjectRDN(const char* lpszCertSubjectRDN);

Unicode (Windows)
LPWSTR GetCertSubjectRDN();
INT SetCertSubjectRDN(LPCWSTR lpszCertSubjectRDN);

char* secureblackbox_certificatemanager_getcertsubjectrdn(void* lpObj);
int secureblackbox_certificatemanager_setcertsubjectrdn(void* lpObj, const char* lpszCertSubjectRDN);

QString GetCertSubjectRDN();
int SetCertSubjectRDN(QString qsCertSubjectRDN);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

CertValidFrom Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertValidFrom();
int SetCertValidFrom(const char* lpszCertValidFrom);

Unicode (Windows)
LPWSTR GetCertValidFrom();
INT SetCertValidFrom(LPCWSTR lpszCertValidFrom);

char* secureblackbox_certificatemanager_getcertvalidfrom(void* lpObj);
int secureblackbox_certificatemanager_setcertvalidfrom(void* lpObj, const char* lpszCertValidFrom);

QString GetCertValidFrom();
int SetCertValidFrom(QString qsCertValidFrom);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

CertValidTo Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertValidTo();
int SetCertValidTo(const char* lpszCertValidTo);

Unicode (Windows)
LPWSTR GetCertValidTo();
INT SetCertValidTo(LPCWSTR lpszCertValidTo);

char* secureblackbox_certificatemanager_getcertvalidto(void* lpObj);
int secureblackbox_certificatemanager_setcertvalidto(void* lpObj, const char* lpszCertValidTo);

QString GetCertValidTo();
int SetCertValidTo(QString qsCertValidTo);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

CertRequestBytes Property (CertificateManager Class)

Provides access to raw certificate request data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestBytes(char* &lpCertRequestBytes, int &lenCertRequestBytes);

Unicode (Windows)
INT GetCertRequestBytes(LPSTR &lpCertRequestBytes, INT &lenCertRequestBytes);

int secureblackbox_certificatemanager_getcertrequestbytes(void* lpObj, char** lpCertRequestBytes, int* lenCertRequestBytes);

QByteArray GetCertRequestBytes();

Remarks

Provides access to raw certificate request data in DER format.

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

Data Type

Byte Array

CertRequestCurve Property (CertificateManager Class)

Specifies the elliptic curve of the EC public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestCurve();
int SetCertRequestCurve(const char* lpszCertRequestCurve);

Unicode (Windows)
LPWSTR GetCertRequestCurve();
INT SetCertRequestCurve(LPCWSTR lpszCertRequestCurve);

char* secureblackbox_certificatemanager_getcertrequestcurve(void* lpObj);
int secureblackbox_certificatemanager_setcertrequestcurve(void* lpObj, const char* lpszCertRequestCurve);

QString GetCertRequestCurve();
int SetCertRequestCurve(QString qsCertRequestCurve);

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

This property is not available at design time.

Data Type

String

CertRequestHandle Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCertRequestHandle();
int SetCertRequestHandle(int64 lCertRequestHandle);

Unicode (Windows)
LONG64 GetCertRequestHandle();
INT SetCertRequestHandle(LONG64 lCertRequestHandle);

int64 secureblackbox_certificatemanager_getcertrequesthandle(void* lpObj);
int secureblackbox_certificatemanager_setcertrequesthandle(void* lpObj, int64 lCertRequestHandle);

qint64 GetCertRequestHandle();
int SetCertRequestHandle(qint64 lCertRequestHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

CertRequestHashAlgorithm Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestHashAlgorithm();
int SetCertRequestHashAlgorithm(const char* lpszCertRequestHashAlgorithm);

Unicode (Windows)
LPWSTR GetCertRequestHashAlgorithm();
INT SetCertRequestHashAlgorithm(LPCWSTR lpszCertRequestHashAlgorithm);

char* secureblackbox_certificatemanager_getcertrequesthashalgorithm(void* lpObj);
int secureblackbox_certificatemanager_setcertrequesthashalgorithm(void* lpObj, const char* lpszCertRequestHashAlgorithm);

QString GetCertRequestHashAlgorithm();
int SetCertRequestHashAlgorithm(QString qsCertRequestHashAlgorithm);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

CertRequestKeyAlgorithm Property (CertificateManager Class)

Specifies the public key algorithm of this certificate request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestKeyAlgorithm();
int SetCertRequestKeyAlgorithm(const char* lpszCertRequestKeyAlgorithm);

Unicode (Windows)
LPWSTR GetCertRequestKeyAlgorithm();
INT SetCertRequestKeyAlgorithm(LPCWSTR lpszCertRequestKeyAlgorithm);

char* secureblackbox_certificatemanager_getcertrequestkeyalgorithm(void* lpObj);
int secureblackbox_certificatemanager_setcertrequestkeyalgorithm(void* lpObj, const char* lpszCertRequestKeyAlgorithm);

QString GetCertRequestKeyAlgorithm();
int SetCertRequestKeyAlgorithm(QString qsCertRequestKeyAlgorithm);

Default Value

""

Remarks

Specifies the public key algorithm of this certificate request.

This property is not available at design time.

Data Type

String

CertRequestKeyBits Property (CertificateManager Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestKeyBits();

Unicode (Windows)
INT GetCertRequestKeyBits();

int secureblackbox_certificatemanager_getcertrequestkeybits(void* lpObj);

int GetCertRequestKeyBits();

Default Value

0

Remarks

Returns the length of the public key.

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

Data Type

Integer

CertRequestKeyUsage Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestKeyUsage();
int SetCertRequestKeyUsage(int iCertRequestKeyUsage);

Unicode (Windows)
INT GetCertRequestKeyUsage();
INT SetCertRequestKeyUsage(INT iCertRequestKeyUsage);

int secureblackbox_certificatemanager_getcertrequestkeyusage(void* lpObj);
int secureblackbox_certificatemanager_setcertrequestkeyusage(void* lpObj, int iCertRequestKeyUsage);

int GetCertRequestKeyUsage();
int SetCertRequestKeyUsage(int iCertRequestKeyUsage);

Default Value

0

Remarks

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

This value is a bit mask of the following values:

This property is not available at design time.

Data Type

Integer

CertRequestKeyValid Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestKeyValid();

Unicode (Windows)
BOOL GetCertRequestKeyValid();

int secureblackbox_certificatemanager_getcertrequestkeyvalid(void* lpObj);

bool GetCertRequestKeyValid();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

CertRequestPrivateKeyBytes Property (CertificateManager Class)

Contains the certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestPrivateKeyBytes(char* &lpCertRequestPrivateKeyBytes, int &lenCertRequestPrivateKeyBytes);

Unicode (Windows)
INT GetCertRequestPrivateKeyBytes(LPSTR &lpCertRequestPrivateKeyBytes, INT &lenCertRequestPrivateKeyBytes);

int secureblackbox_certificatemanager_getcertrequestprivatekeybytes(void* lpObj, char** lpCertRequestPrivateKeyBytes, int* lenCertRequestPrivateKeyBytes);

QByteArray GetCertRequestPrivateKeyBytes();

Remarks

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

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

Data Type

Byte Array

CertRequestPublicKeyBytes Property (CertificateManager Class)

Contains the public key incorporated in the request, in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestPublicKeyBytes(char* &lpCertRequestPublicKeyBytes, int &lenCertRequestPublicKeyBytes);

Unicode (Windows)
INT GetCertRequestPublicKeyBytes(LPSTR &lpCertRequestPublicKeyBytes, INT &lenCertRequestPublicKeyBytes);

int secureblackbox_certificatemanager_getcertrequestpublickeybytes(void* lpObj, char** lpCertRequestPublicKeyBytes, int* lenCertRequestPublicKeyBytes);

QByteArray GetCertRequestPublicKeyBytes();

Remarks

Contains the public key incorporated in the request, in DER format.

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

Data Type

Byte Array

CertRequestSigAlgorithm Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestSigAlgorithm();

Unicode (Windows)
LPWSTR GetCertRequestSigAlgorithm();

char* secureblackbox_certificatemanager_getcertrequestsigalgorithm(void* lpObj);

QString GetCertRequestSigAlgorithm();

Default Value

""

Remarks

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

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

Data Type

String

CertRequestSubject Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestSubject();

Unicode (Windows)
LPWSTR GetCertRequestSubject();

char* secureblackbox_certificatemanager_getcertrequestsubject(void* lpObj);

QString GetCertRequestSubject();

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.

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

Data Type

String

CertRequestSubjectRDN Property (CertificateManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertRequestSubjectRDN();
int SetCertRequestSubjectRDN(const char* lpszCertRequestSubjectRDN);

Unicode (Windows)
LPWSTR GetCertRequestSubjectRDN();
INT SetCertRequestSubjectRDN(LPCWSTR lpszCertRequestSubjectRDN);

char* secureblackbox_certificatemanager_getcertrequestsubjectrdn(void* lpObj);
int secureblackbox_certificatemanager_setcertrequestsubjectrdn(void* lpObj, const char* lpszCertRequestSubjectRDN);

QString GetCertRequestSubjectRDN();
int SetCertRequestSubjectRDN(QString qsCertRequestSubjectRDN);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

CertRequestValid Property (CertificateManager Class)

Indicates whether or not the signature on the request is valid and matches the public key contained in the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertRequestValid();

Unicode (Windows)
BOOL GetCertRequestValid();

int secureblackbox_certificatemanager_getcertrequestvalid(void* lpObj);

bool GetCertRequestValid();

Default Value

FALSE

Remarks

Indicates whether or not the signature on the request is valid and matches the public key contained in the request.

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

Data Type

Boolean

ExternalCryptoAsyncDocumentID Property (CertificateManager Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID);

Unicode (Windows)
LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_certificatemanager_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_certificatemanager_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (CertificateManager Class)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams);

Unicode (Windows)
LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);

char* secureblackbox_certificatemanager_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_certificatemanager_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (CertificateManager Class)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData);

Unicode (Windows)
LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);

char* secureblackbox_certificatemanager_getexternalcryptodata(void* lpObj);
int secureblackbox_certificatemanager_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (CertificateManager Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation);

Unicode (Windows)
BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);

int secureblackbox_certificatemanager_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_certificatemanager_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (CertificateManager Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);

char* secureblackbox_certificatemanager_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_certificatemanager_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (CertificateManager Class)

The ID of the pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID);

Unicode (Windows)
LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);

char* secureblackbox_certificatemanager_getexternalcryptokeyid(void* lpObj);
int secureblackbox_certificatemanager_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example:

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (CertificateManager Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret);

Unicode (Windows)
LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);

char* secureblackbox_certificatemanager_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_certificatemanager_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (CertificateManager Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Unicode (Windows)
INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_certificatemanager_getexternalcryptomethod(void* lpObj);
int secureblackbox_certificatemanager_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (CertificateManager Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Unicode (Windows)
INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

int secureblackbox_certificatemanager_getexternalcryptomode(void* lpObj);
int secureblackbox_certificatemanager_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (CertificateManager Class)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);

char* secureblackbox_certificatemanager_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_certificatemanager_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (CertificateManager Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_certificatemanager_getfipsmode(void* lpObj);
int secureblackbox_certificatemanager_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

Config Method (CertificateManager Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_certificatemanager_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (CertificateManager Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_certificatemanager_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Download Method (CertificateManager Class)

Downloads a certificate from a remote location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Download(const char* lpszURL);

Unicode (Windows)
INT Download(LPCWSTR lpszURL);

int secureblackbox_certificatemanager_download(void* lpObj, const char* lpszURL);

int Download(const QString& qsURL);

Remarks

URL specifies the remote location where the certificate should be downloaded from.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExportCert Method (CertificateManager Class)

Exports the certificate in the chosen format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ExportCert(const char* lpszPassword, int iFormat, int bExportKey, int *lpSize = NULL);

Unicode (Windows)
LPSTR ExportCert(LPCWSTR lpszPassword, INT iFormat, BOOL bExportKey, LPINT lpSize = NULL);

char* secureblackbox_certificatemanager_exportcert(void* lpObj, const char* lpszPassword, int iFormat, int bExportKey, int *lpSize);

QByteArray ExportCert(const QString& qsPassword, int iFormat, bool bExportKey);

Remarks

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

ExportKey specifies whether to export the private key together with the certificate. Pass the encryption password via the Password parameter if needed.