CryptoKeyManager Class

Properties   Methods   Events   Config Settings   Errors  

The CryptoKeyManager class provides a simple way to load, generate and manage generic crypto keys.

Syntax

CryptoKeyManager

Remarks

CryptoKeyManager allows you to load, save, generate, import, and export low-level crypto keys. One example of such keys are raw RSA keys stored in PKCS1 format or AES256 keys. CryptoKeyManager supports asymmetric, symmetric, and HMAC keys.

CryptoKeyManager is a typical companion for low-level cryptography classes, such as PublicKeyCrypto, SymmetricCrypto, and HashFunction. It can also be used to provide external key material to certificate objects, and to derive cryptographic keys from passwords.

Use ImportBytes or ImportFromFile method to load the key material from a buffer or file. Use ImportFromCert (and remember to assign the certificate object to the Certificate property before calling it) to import a key from an X.509 certificate. Once loaded, the key will be available in the Key property.

To generate a new key or keypair use Generate method. You can export the generated key using ExportBytes or ExportToFile method. You can attach the generated or loaded key to an external certificate object using the ExportToCert method.

Note: CryptoKeyManager can only work with one cryptographic key at a time. Use CryptoKeyStorage to access media containing more than one key.

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.

CertBytes Property (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertca(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertcrldistributionpoints(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertcurve(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcerthandle(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcerthashalgorithm(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertissuerrdn(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertkeyalgorithm(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyBits();

Unicode (Windows)
INT GetCertKeyBits();

int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertkeyusage(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertocsplocations(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertocspnocheck(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager Class)

Returns the origin of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertOrigin();

Unicode (Windows)
INT GetCertOrigin();

int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertpolicyids(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager Class)

Indicates whether the private key is extractable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertPrivateKeyExtractable();

Unicode (Windows)
BOOL GetCertPrivateKeyExtractable();

int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertqualifiedstatements(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertserialnumber(void* lpObj, char** lpCertSerialNumber, int* lenCertSerialNumber);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertsubjectalternativename(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertsubjectkeyid(void* lpObj, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertsubjectrdn(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertvalidfrom(void* lpObj);
int secureblackbox_cryptokeymanager_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 (CryptoKeyManager 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_cryptokeymanager_getcertvalidto(void* lpObj);
int secureblackbox_cryptokeymanager_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

DerivationAlgorithm Property (CryptoKeyManager Class)

Specifies the algorithm to use for key derivation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDerivationAlgorithm();
int SetDerivationAlgorithm(const char* lpszDerivationAlgorithm);

Unicode (Windows)
LPWSTR GetDerivationAlgorithm();
INT SetDerivationAlgorithm(LPCWSTR lpszDerivationAlgorithm);

char* secureblackbox_cryptokeymanager_getderivationalgorithm(void* lpObj);
int secureblackbox_cryptokeymanager_setderivationalgorithm(void* lpObj, const char* lpszDerivationAlgorithm);

QString GetDerivationAlgorithm();
int SetDerivationAlgorithm(QString qsDerivationAlgorithm);

Default Value

"PKCS5"

Remarks

Use this property to specify the key derivation algorithm to use.

Class supports the following algorithms: PKCS5, BCrypt, SCrypt, Argon2d, Argon2i, Argon2id.

Data Type

String

DeriveIterations Property (CryptoKeyManager Class)

Specifies the number of iterations to use as part of key derivation routine.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDeriveIterations();
int SetDeriveIterations(int iDeriveIterations);

Unicode (Windows)
INT GetDeriveIterations();
INT SetDeriveIterations(INT iDeriveIterations);

int secureblackbox_cryptokeymanager_getderiveiterations(void* lpObj);
int secureblackbox_cryptokeymanager_setderiveiterations(void* lpObj, int iDeriveIterations);

int GetDeriveIterations();
int SetDeriveIterations(int iDeriveIterations);

Default Value

2048

Remarks

Use this property to adjust the number of hash algorithm iterations to employ as part of key derivation function.

Data Type

Integer

FIPSMode Property (CryptoKeyManager 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_cryptokeymanager_getfipsmode(void* lpObj);
int secureblackbox_cryptokeymanager_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

HMACAlgorithm Property (CryptoKeyManager Class)

Specifies the HMAC algorithm to use with the key derivation algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHMACAlgorithm();
int SetHMACAlgorithm(const char* lpszHMACAlgorithm);

Unicode (Windows)
LPWSTR GetHMACAlgorithm();
INT SetHMACAlgorithm(LPCWSTR lpszHMACAlgorithm);

char* secureblackbox_cryptokeymanager_gethmacalgorithm(void* lpObj);
int secureblackbox_cryptokeymanager_sethmacalgorithm(void* lpObj, const char* lpszHMACAlgorithm);

QString GetHMACAlgorithm();
int SetHMACAlgorithm(QString qsHMACAlgorithm);

Default Value

"SHA1"

Remarks

Use this property to specify the HMAC algorithm to use with the chosen key derivation algorithm.

Class supports the following algorithms: SHA1, SHA224, SHA256, SHA384, SHA512, MD5, RIPEMD, HMAC.

Data Type

String

KeyAlgorithm Property (CryptoKeyManager Class)

The algorithm of the cryptographic key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyAlgorithm();
int SetKeyAlgorithm(const char* lpszKeyAlgorithm);

Unicode (Windows)
LPWSTR GetKeyAlgorithm();
INT SetKeyAlgorithm(LPCWSTR lpszKeyAlgorithm);

char* secureblackbox_cryptokeymanager_getkeyalgorithm(void* lpObj);
int secureblackbox_cryptokeymanager_setkeyalgorithm(void* lpObj, const char* lpszKeyAlgorithm);

QString GetKeyAlgorithm();
int SetKeyAlgorithm(QString qsKeyAlgorithm);

Default Value

""

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.

This property is not available at design time.

Data Type

String

KeyBits Property (CryptoKeyManager Class)

The length of the key in bits.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyBits();

Unicode (Windows)
INT GetKeyBits();

int secureblackbox_cryptokeymanager_getkeybits(void* lpObj);

int GetKeyBits();

Default Value

0

Remarks

The length of the key in bits.

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

Data Type

Integer

KeyCurve Property (CryptoKeyManager Class)

This property specifies the name of the curve the EC key is built on.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyCurve();
int SetKeyCurve(const char* lpszKeyCurve);

Unicode (Windows)
LPWSTR GetKeyCurve();
INT SetKeyCurve(LPCWSTR lpszKeyCurve);

char* secureblackbox_cryptokeymanager_getkeycurve(void* lpObj);
int secureblackbox_cryptokeymanager_setkeycurve(void* lpObj, const char* lpszKeyCurve);

QString GetKeyCurve();
int SetKeyCurve(QString qsKeyCurve);

Default Value

""

Remarks

This property specifies the name of the curve the EC key is built on.

This property is not available at design time.

Data Type

String

KeyExportable Property (CryptoKeyManager Class)

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyExportable();

Unicode (Windows)
BOOL GetKeyExportable();

int secureblackbox_cryptokeymanager_getkeyexportable(void* lpObj);

bool GetKeyExportable();

Default Value

FALSE

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

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

Data Type

Boolean

KeyHandle Property (CryptoKeyManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKeyHandle();
int SetKeyHandle(int64 lKeyHandle);

Unicode (Windows)
LONG64 GetKeyHandle();
INT SetKeyHandle(LONG64 lKeyHandle);

int64 secureblackbox_cryptokeymanager_getkeyhandle(void* lpObj);
int secureblackbox_cryptokeymanager_setkeyhandle(void* lpObj, int64 lKeyHandle);

qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);

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

KeyID Property (CryptoKeyManager Class)

Provides access to a storage-specific key identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyID(char* &lpKeyID, int &lenKeyID);
int SetKeyID(const char* lpKeyID, int lenKeyID);

Unicode (Windows)
INT GetKeyID(LPSTR &lpKeyID, INT &lenKeyID);
INT SetKeyID(LPCSTR lpKeyID, INT lenKeyID);

int secureblackbox_cryptokeymanager_getkeyid(void* lpObj, char** lpKeyID, int* lenKeyID);
int secureblackbox_cryptokeymanager_setkeyid(void* lpObj, const char* lpKeyID, int lenKeyID);

QByteArray GetKeyID();
int SetKeyID(QByteArray qbaKeyID);

Remarks

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

This property is not available at design time.

Data Type

Byte Array

KeyIV Property (CryptoKeyManager Class)

The initialization vector (IV) of a symmetric key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyIV(char* &lpKeyIV, int &lenKeyIV);
int SetKeyIV(const char* lpKeyIV, int lenKeyIV);

Unicode (Windows)
INT GetKeyIV(LPSTR &lpKeyIV, INT &lenKeyIV);
INT SetKeyIV(LPCSTR lpKeyIV, INT lenKeyIV);

int secureblackbox_cryptokeymanager_getkeyiv(void* lpObj, char** lpKeyIV, int* lenKeyIV);
int secureblackbox_cryptokeymanager_setkeyiv(void* lpObj, const char* lpKeyIV, int lenKeyIV);

QByteArray GetKeyIV();
int SetKeyIV(QByteArray qbaKeyIV);

Remarks

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

This property is not available at design time.

Data Type

Byte Array

KeyKey Property (CryptoKeyManager Class)

The byte array representation of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyKey(char* &lpKeyKey, int &lenKeyKey);

Unicode (Windows)
INT GetKeyKey(LPSTR &lpKeyKey, INT &lenKeyKey);

int secureblackbox_cryptokeymanager_getkeykey(void* lpObj, char** lpKeyKey, int* lenKeyKey);

QByteArray GetKeyKey();

Remarks

The byte array representation of the key. This may not be available for non-KeyExportable keys.

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

Data Type

Byte Array

KeyNonce Property (CryptoKeyManager Class)

A nonce value associated with a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyNonce(char* &lpKeyNonce, int &lenKeyNonce);
int SetKeyNonce(const char* lpKeyNonce, int lenKeyNonce);

Unicode (Windows)
INT GetKeyNonce(LPSTR &lpKeyNonce, INT &lenKeyNonce);
INT SetKeyNonce(LPCSTR lpKeyNonce, INT lenKeyNonce);

int secureblackbox_cryptokeymanager_getkeynonce(void* lpObj, char** lpKeyNonce, int* lenKeyNonce);
int secureblackbox_cryptokeymanager_setkeynonce(void* lpObj, const char* lpKeyNonce, int lenKeyNonce);

QByteArray GetKeyNonce();
int SetKeyNonce(QByteArray qbaKeyNonce);

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

This property is not available at design time.

Data Type

Byte Array

KeyPrivate Property (CryptoKeyManager Class)

Returns True if the object hosts a private key, and False otherwise.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyPrivate();

Unicode (Windows)
BOOL GetKeyPrivate();

int secureblackbox_cryptokeymanager_getkeyprivate(void* lpObj);

bool GetKeyPrivate();

Default Value

FALSE

Remarks

Returns True if the object hosts a private key, and False otherwise.

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

Data Type

Boolean

KeyPublic Property (CryptoKeyManager Class)

Returns True if the object hosts a public key, and False otherwise.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyPublic();

Unicode (Windows)
BOOL GetKeyPublic();

int secureblackbox_cryptokeymanager_getkeypublic(void* lpObj);

bool GetKeyPublic();

Default Value

FALSE

Remarks

Returns True if the object hosts a public key, and False otherwise.

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

Data Type

Boolean

KeySubject Property (CryptoKeyManager Class)

Returns the key subject.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeySubject(char* &lpKeySubject, int &lenKeySubject);
int SetKeySubject(const char* lpKeySubject, int lenKeySubject);

Unicode (Windows)
INT GetKeySubject(LPSTR &lpKeySubject, INT &lenKeySubject);
INT SetKeySubject(LPCSTR lpKeySubject, INT lenKeySubject);

int secureblackbox_cryptokeymanager_getkeysubject(void* lpObj, char** lpKeySubject, int* lenKeySubject);
int secureblackbox_cryptokeymanager_setkeysubject(void* lpObj, const char* lpKeySubject, int lenKeySubject);

QByteArray GetKeySubject();
int SetKeySubject(QByteArray qbaKeySubject);

Remarks

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

This property is not available at design time.

Data Type

Byte Array

KeySymmetric Property (CryptoKeyManager Class)

Returns True if the object contains a symmetric key, and False otherwise.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeySymmetric();

Unicode (Windows)
BOOL GetKeySymmetric();

int secureblackbox_cryptokeymanager_getkeysymmetric(void* lpObj);

bool GetKeySymmetric();

Default Value

FALSE

Remarks

Returns True if the object contains a symmetric key, and False otherwise.

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

Data Type

Boolean

KeyValid Property (CryptoKeyManager Class)

Returns True if this key is valid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyValid();

Unicode (Windows)
BOOL GetKeyValid();

int secureblackbox_cryptokeymanager_getkeyvalid(void* lpObj);

bool GetKeyValid();

Default Value

FALSE

Remarks

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

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

Data Type

Boolean

Config Method (CryptoKeyManager 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_cryptokeymanager_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.

DeriveKey Method (CryptoKeyManager Class)

Generates a strong cryptographic key from a password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeriveKey(int iKeyBits, const char* lpszPassword, const char* lpszSalt);

Unicode (Windows)
INT DeriveKey(INT iKeyBits, LPCWSTR lpszPassword, LPCWSTR lpszSalt);

int secureblackbox_cryptokeymanager_derivekey(void* lpObj, int iKeyBits, const char* lpszPassword, const char* lpszSalt);

int DeriveKey(int iKeyBits, const QString& qsPassword, const QString& qsSalt);

Remarks

Use this method to generate a cryptographically strong key of a needed length from a password.

This method uses a general-purpose PBKDF2 function with PRF1 and 2048 iterations.

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.)

DoAction Method (CryptoKeyManager 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_cryptokeymanager_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.

ExportBytes Method (CryptoKeyManager Class)

Exports the key to a byte array.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ExportBytes(int iFormat, int iKeyType, int *lpSize = NULL);

Unicode (Windows)
LPSTR ExportBytes(INT iFormat, INT iKeyType, LPINT lpSize = NULL);

char* secureblackbox_cryptokeymanager_exportbytes(void* lpObj, int iFormat, int iKeyType, int *lpSize);

QByteArray ExportBytes(int iFormat, int iKeyType);

Remarks

Use this method to save the Key (both the public and secret parts) to a byte array.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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.

ExportToCert Method (CryptoKeyManager Class)

Exports the key to a certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExportToCert();

Unicode (Windows)
INT ExportToCert();

int secureblackbox_cryptokeymanager_exporttocert(void* lpObj);

int ExportToCert();

Remarks

Use this method to save the Key (both the public and secret parts) to the certificate specified in Certificate.

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.)

ExportToFile Method (CryptoKeyManager Class)

Exports the key to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExportToFile(const char* lpszFilename, int iFormat, int iKeyType);

Unicode (Windows)
INT ExportToFile(LPCWSTR lpszFilename, INT iFormat, INT iKeyType);

int secureblackbox_cryptokeymanager_exporttofile(void* lpObj, const char* lpszFilename, int iFormat, int iKeyType);

int ExportToFile(const QString& qsFilename, int iFormat, int iKeyType);

Remarks

Use this method to save the Key (both the public and secret parts) to the file passed via the Filename parameter.

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.)

ExportToStream Method (CryptoKeyManager Class)

Exports the key to a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExportToStream(SecureBlackboxStream* sStream, int iFormat, int iKeyType);

Unicode (Windows)
INT ExportToStream(SecureBlackboxStream* sStream, INT iFormat, INT iKeyType);

int secureblackbox_cryptokeymanager_exporttostream(void* lpObj, SecureBlackboxStream* sStream, int iFormat, int iKeyType);

int ExportToStream(SecureBlackboxStream* sStream, int iFormat, int iKeyType);

Remarks

Use this method to save the Key (both the public and secret parts) to a stream pointed by the Stream parameter.

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.)

Generate Method (CryptoKeyManager Class)

Generates a new crypto key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Generate(const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyBits);

Unicode (Windows)
INT Generate(LPCWSTR lpszKeyAlgorithm, LPCWSTR lpszScheme, LPCWSTR lpszSchemeParams, INT iKeyBits);

int secureblackbox_cryptokeymanager_generate(void* lpObj, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyBits);

int Generate(const QString& qsKeyAlgorithm, const QString& qsScheme, const QString& qsSchemeParams, int iKeyBits);

Remarks

Call this method to generate a new key or keypair with the desired KeyAlgorithm and KeyBits of length.

The generated key will be populated in the Key property.

The below snippet illustrates the use of the Generate method to create an RSA keypair:

 
 Copy
  CryptoKeyManager keyMgr = new CryptoKeyManager();

  keyMgr.Generate("RSA", "", "", 2048);

  keyMgr.ExportToFile("public.pem", Constants.kffPEM, Constants.ktPublic);
  keyMgr.ExportToFile("private.pem", Constants.kffPEM, Constants.ktSecret);

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.)

GetKeyParam Method (CryptoKeyManager Class)

Returns an algorithm-specific key parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyParam(const char* lpszName, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetKeyParam(LPCWSTR lpszName, LPINT lpSize = NULL);

char* secureblackbox_cryptokeymanager_getkeyparam(void* lpObj, const char* lpszName, int *lpSize);

QByteArray GetKeyParam(const QString& qsName);

Remarks

Use this method to retrieve an algorithm-specific key parameter.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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.

GetKeyParamStr Method (CryptoKeyManager Class)

Returns an algorithm-specific key parameter to a string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyParamStr(const char* lpszName);

Unicode (Windows)
LPWSTR GetKeyParamStr(LPCWSTR lpszName);

char* secureblackbox_cryptokeymanager_getkeyparamstr(void* lpObj, const char* lpszName);

QString GetKeyParamStr(const QString& qsName);

Remarks

Use this method to get an algorithm-specific key parameter to 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.

ImportBytes Method (CryptoKeyManager Class)

Loads a key from a byte array.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportBytes(const char* lpValue, int lenValue, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType);

Unicode (Windows)
INT ImportBytes(LPCSTR lpValue, INT lenValue, INT iFormat, LPCWSTR lpszKeyAlgorithm, LPCWSTR lpszScheme, LPCWSTR lpszSchemeParams, INT iKeyType);

int secureblackbox_cryptokeymanager_importbytes(void* lpObj, const char* lpValue, int lenValue, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType);

int ImportBytes(QByteArray qbaValue, int iFormat, const QString& qsKeyAlgorithm, const QString& qsScheme, const QString& qsSchemeParams, int iKeyType);

Remarks

Use this method to load a key, either public or secret, from a byte array.

 
 Copy
Mgr.ImportBytes(ThirtyTwoKeyBytes, kffDER, "AES256", "", "", ktSecret)

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.)

ImportFromCert Method (CryptoKeyManager Class)

Loads a key from a certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportFromCert();

Unicode (Windows)
INT ImportFromCert();

int secureblackbox_cryptokeymanager_importfromcert(void* lpObj);

int ImportFromCert();

Remarks

Use this method to load a key, either public or secret, from a certificate.

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.)

ImportFromFile Method (CryptoKeyManager Class)

Loads a key from a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportFromFile(const char* lpszFilename, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType);

Unicode (Windows)
INT ImportFromFile(LPCWSTR lpszFilename, INT iFormat, LPCWSTR lpszKeyAlgorithm, LPCWSTR lpszScheme, LPCWSTR lpszSchemeParams, INT iKeyType);

int secureblackbox_cryptokeymanager_importfromfile(void* lpObj, const char* lpszFilename, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType);

int ImportFromFile(const QString& qsFilename, int iFormat, const QString& qsKeyAlgorithm, const QString& qsScheme, const QString& qsSchemeParams, int iKeyType);

Remarks

Use this method to load a key, either public or secret, from a file.

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.)

ImportFromStream Method (CryptoKeyManager Class)

Loads a key from a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportFromStream(SecureBlackboxStream* sStream, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType);

Unicode (Windows)
INT ImportFromStream(SecureBlackboxStream* sStream, INT iFormat, LPCWSTR lpszKeyAlgorithm, LPCWSTR lpszScheme, LPCWSTR lpszSchemeParams, INT iKeyType);

int secureblackbox_cryptokeymanager_importfromstream(void* lpObj, SecureBlackboxStream* sStream, int iFormat, const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyType);

int ImportFromStream(SecureBlackboxStream* sStream, int iFormat, const QString& qsKeyAlgorithm, const QString& qsScheme, const QString& qsSchemeParams, int iKeyType);

Remarks

Use this method to load a key, either public or secret, from a stream.

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.)

SetKeyParam Method (CryptoKeyManager Class)

Sets an algorithm-specific key parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetKeyParam(const char* lpszName, const char* lpValue, int lenValue);

Unicode (Windows)
INT SetKeyParam(LPCWSTR lpszName, LPCSTR lpValue, INT lenValue);

int secureblackbox_cryptokeymanager_setkeyparam(void* lpObj, const char* lpszName, const char* lpValue, int lenValue);

int SetKeyParam(const QString& qsName, QByteArray qbaValue);

Remarks

Use this method to set an algorithm-specific key parameter.

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.)

SetKeyParamStr Method (CryptoKeyManager Class)

Sets an algorithm-specific key parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetKeyParamStr(const char* lpszName, const char* lpszValueStr);

Unicode (Windows)
INT SetKeyParamStr(LPCWSTR lpszName, LPCWSTR lpszValueStr);

int secureblackbox_cryptokeymanager_setkeyparamstr(void* lpObj, const char* lpszName, const char* lpszValueStr);

int SetKeyParamStr(const QString& qsName, const QString& qsValueStr);

Remarks

Use this method to set an algorithm-specific key parameter provided in a string.

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.)

Error Event (CryptoKeyManager Class)

Informs about an error during an operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(CryptoKeyManagerErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} CryptoKeyManagerErrorEventParams;


Unicode (Windows)
virtual INT FireError(CryptoKeyManagerErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} CryptoKeyManagerErrorEventParams;

#define EID_CRYPTOKEYMANAGER_ERROR 1

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class CryptoKeyManagerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(CryptoKeyManagerErrorEventParams *e);

// Or, subclass CryptoKeyManager and override this emitter function.
virtual int FireError(CryptoKeyManagerErrorEventParams *e) {...}

Remarks

The event is fired when an error happens in the middle of the class's work.

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

Notification Event (CryptoKeyManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(CryptoKeyManagerNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} CryptoKeyManagerNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(CryptoKeyManagerNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} CryptoKeyManagerNotificationEventParams;

#define EID_CRYPTOKEYMANAGER_NOTIFICATION 2

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class CryptoKeyManagerNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(CryptoKeyManagerNotificationEventParams *e);

// Or, subclass CryptoKeyManager and override this emitter function.
virtual int FireNotification(CryptoKeyManagerNotificationEventParams *e) {...}

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

This event is fired when a decryption password is needed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePasswordNeeded(CryptoKeyManagerPasswordNeededEventParams *e);

typedef struct {
  const char *NeededFor;
  char *Password;
  int Cancel;
  int reserved;
} CryptoKeyManagerPasswordNeededEventParams;


Unicode (Windows)
virtual INT FirePasswordNeeded(CryptoKeyManagerPasswordNeededEventParams *e);

typedef struct {
  LPCWSTR NeededFor;
  LPWSTR Password;
  BOOL Cancel;
  INT reserved;
} CryptoKeyManagerPasswordNeededEventParams;

#define EID_CRYPTOKEYMANAGER_PASSWORDNEEDED 3

virtual INT SECUREBLACKBOX_CALL FirePasswordNeeded(LPSTR &lpszNeededFor, LPSTR &lpszPassword, BOOL &bCancel);

class CryptoKeyManagerPasswordNeededEventParams {
public:
  const QString &NeededFor();

  const QString &Password();
  void SetPassword(const QString &qsPassword);

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PasswordNeeded(CryptoKeyManagerPasswordNeededEventParams *e);

// Or, subclass CryptoKeyManager and override this emitter function.
virtual int FirePasswordNeeded(CryptoKeyManagerPasswordNeededEventParams *e) {...}

Remarks

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

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

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

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The CryptoKeyManager class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the CryptoKeyManager class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (CryptoKeyManager Class)

CryptoKeyManager Config Settings

Base Config Settings

Trappable Errors (CryptoKeyManager Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CryptoKeyManager Errors