SSHKeyManager Class

Properties   Methods   Events   Config Settings   Errors  

The SSHKeyManager class stores information about SSH keys.

Syntax

SSHKeyManager

Remarks

SSHKeyManager provides the capabilities of generating, storing, importing, and exporting SSH keys.

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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertca(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertcrldistributionpoints(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertcurve(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcerthandle(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcerthashalgorithm(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertissuerrdn(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertkeyalgorithm(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertKeyBits();

Unicode (Windows)
INT GetCertKeyBits();

int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertkeyusage(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertocsplocations(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertocspnocheck(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager Class)

Returns the origin of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertOrigin();

Unicode (Windows)
INT GetCertOrigin();

int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertpolicyids(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager Class)

Indicates whether the private key is extractable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertPrivateKeyExtractable();

Unicode (Windows)
BOOL GetCertPrivateKeyExtractable();

int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertqualifiedstatements(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertserialnumber(void* lpObj, char** lpCertSerialNumber, int* lenCertSerialNumber);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertsubjectalternativename(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertsubjectkeyid(void* lpObj, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertsubjectrdn(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertvalidfrom(void* lpObj);
int secureblackbox_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_getcertvalidto(void* lpObj);
int secureblackbox_sshkeymanager_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

CryptoKeyAlgorithm Property (SSHKeyManager Class)

The algorithm of the cryptographic key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCryptoKeyAlgorithm();
int SetCryptoKeyAlgorithm(const char* lpszCryptoKeyAlgorithm);

Unicode (Windows)
LPWSTR GetCryptoKeyAlgorithm();
INT SetCryptoKeyAlgorithm(LPCWSTR lpszCryptoKeyAlgorithm);

char* secureblackbox_sshkeymanager_getcryptokeyalgorithm(void* lpObj);
int secureblackbox_sshkeymanager_setcryptokeyalgorithm(void* lpObj, const char* lpszCryptoKeyAlgorithm);

QString GetCryptoKeyAlgorithm();
int SetCryptoKeyAlgorithm(QString qsCryptoKeyAlgorithm);

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

CryptoKeyBits Property (SSHKeyManager Class)

The length of the key in bits.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCryptoKeyBits();

Unicode (Windows)
INT GetCryptoKeyBits();

int secureblackbox_sshkeymanager_getcryptokeybits(void* lpObj);

int GetCryptoKeyBits();

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

CryptoKeyCurve Property (SSHKeyManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCryptoKeyCurve();
int SetCryptoKeyCurve(const char* lpszCryptoKeyCurve);

Unicode (Windows)
LPWSTR GetCryptoKeyCurve();
INT SetCryptoKeyCurve(LPCWSTR lpszCryptoKeyCurve);

char* secureblackbox_sshkeymanager_getcryptokeycurve(void* lpObj);
int secureblackbox_sshkeymanager_setcryptokeycurve(void* lpObj, const char* lpszCryptoKeyCurve);

QString GetCryptoKeyCurve();
int SetCryptoKeyCurve(QString qsCryptoKeyCurve);

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

CryptoKeyExportable Property (SSHKeyManager 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 GetCryptoKeyExportable();

Unicode (Windows)
BOOL GetCryptoKeyExportable();

int secureblackbox_sshkeymanager_getcryptokeyexportable(void* lpObj);

bool GetCryptoKeyExportable();

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

CryptoKeyHandle Property (SSHKeyManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCryptoKeyHandle();
int SetCryptoKeyHandle(int64 lCryptoKeyHandle);

Unicode (Windows)
LONG64 GetCryptoKeyHandle();
INT SetCryptoKeyHandle(LONG64 lCryptoKeyHandle);

int64 secureblackbox_sshkeymanager_getcryptokeyhandle(void* lpObj);
int secureblackbox_sshkeymanager_setcryptokeyhandle(void* lpObj, int64 lCryptoKeyHandle);

qint64 GetCryptoKeyHandle();
int SetCryptoKeyHandle(qint64 lCryptoKeyHandle);

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

CryptoKeyID Property (SSHKeyManager Class)

Provides access to a storage-specific key identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCryptoKeyID(char* &lpCryptoKeyID, int &lenCryptoKeyID);
int SetCryptoKeyID(const char* lpCryptoKeyID, int lenCryptoKeyID);

Unicode (Windows)
INT GetCryptoKeyID(LPSTR &lpCryptoKeyID, INT &lenCryptoKeyID);
INT SetCryptoKeyID(LPCSTR lpCryptoKeyID, INT lenCryptoKeyID);

int secureblackbox_sshkeymanager_getcryptokeyid(void* lpObj, char** lpCryptoKeyID, int* lenCryptoKeyID);
int secureblackbox_sshkeymanager_setcryptokeyid(void* lpObj, const char* lpCryptoKeyID, int lenCryptoKeyID);

QByteArray GetCryptoKeyID();
int SetCryptoKeyID(QByteArray qbaCryptoKeyID);

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

CryptoKeyIV Property (SSHKeyManager Class)

The initialization vector (IV) of a symmetric key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCryptoKeyIV(char* &lpCryptoKeyIV, int &lenCryptoKeyIV);
int SetCryptoKeyIV(const char* lpCryptoKeyIV, int lenCryptoKeyIV);

Unicode (Windows)
INT GetCryptoKeyIV(LPSTR &lpCryptoKeyIV, INT &lenCryptoKeyIV);
INT SetCryptoKeyIV(LPCSTR lpCryptoKeyIV, INT lenCryptoKeyIV);

int secureblackbox_sshkeymanager_getcryptokeyiv(void* lpObj, char** lpCryptoKeyIV, int* lenCryptoKeyIV);
int secureblackbox_sshkeymanager_setcryptokeyiv(void* lpObj, const char* lpCryptoKeyIV, int lenCryptoKeyIV);

QByteArray GetCryptoKeyIV();
int SetCryptoKeyIV(QByteArray qbaCryptoKeyIV);

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

CryptoKeyKey Property (SSHKeyManager Class)

The byte array representation of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCryptoKeyKey(char* &lpCryptoKeyKey, int &lenCryptoKeyKey);

Unicode (Windows)
INT GetCryptoKeyKey(LPSTR &lpCryptoKeyKey, INT &lenCryptoKeyKey);

int secureblackbox_sshkeymanager_getcryptokeykey(void* lpObj, char** lpCryptoKeyKey, int* lenCryptoKeyKey);

QByteArray GetCryptoKeyKey();

Remarks

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

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

Data Type

Byte Array

CryptoKeyNonce Property (SSHKeyManager Class)

A nonce value associated with a key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCryptoKeyNonce(char* &lpCryptoKeyNonce, int &lenCryptoKeyNonce);
int SetCryptoKeyNonce(const char* lpCryptoKeyNonce, int lenCryptoKeyNonce);

Unicode (Windows)
INT GetCryptoKeyNonce(LPSTR &lpCryptoKeyNonce, INT &lenCryptoKeyNonce);
INT SetCryptoKeyNonce(LPCSTR lpCryptoKeyNonce, INT lenCryptoKeyNonce);

int secureblackbox_sshkeymanager_getcryptokeynonce(void* lpObj, char** lpCryptoKeyNonce, int* lenCryptoKeyNonce);
int secureblackbox_sshkeymanager_setcryptokeynonce(void* lpObj, const char* lpCryptoKeyNonce, int lenCryptoKeyNonce);

QByteArray GetCryptoKeyNonce();
int SetCryptoKeyNonce(QByteArray qbaCryptoKeyNonce);

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

CryptoKeyPrivate Property (SSHKeyManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCryptoKeyPrivate();

Unicode (Windows)
BOOL GetCryptoKeyPrivate();

int secureblackbox_sshkeymanager_getcryptokeyprivate(void* lpObj);

bool GetCryptoKeyPrivate();

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

CryptoKeyPublic Property (SSHKeyManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCryptoKeyPublic();

Unicode (Windows)
BOOL GetCryptoKeyPublic();

int secureblackbox_sshkeymanager_getcryptokeypublic(void* lpObj);

bool GetCryptoKeyPublic();

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

CryptoKeySubject Property (SSHKeyManager Class)

Returns the key subject.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCryptoKeySubject(char* &lpCryptoKeySubject, int &lenCryptoKeySubject);
int SetCryptoKeySubject(const char* lpCryptoKeySubject, int lenCryptoKeySubject);

Unicode (Windows)
INT GetCryptoKeySubject(LPSTR &lpCryptoKeySubject, INT &lenCryptoKeySubject);
INT SetCryptoKeySubject(LPCSTR lpCryptoKeySubject, INT lenCryptoKeySubject);

int secureblackbox_sshkeymanager_getcryptokeysubject(void* lpObj, char** lpCryptoKeySubject, int* lenCryptoKeySubject);
int secureblackbox_sshkeymanager_setcryptokeysubject(void* lpObj, const char* lpCryptoKeySubject, int lenCryptoKeySubject);

QByteArray GetCryptoKeySubject();
int SetCryptoKeySubject(QByteArray qbaCryptoKeySubject);

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

CryptoKeySymmetric Property (SSHKeyManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCryptoKeySymmetric();

Unicode (Windows)
BOOL GetCryptoKeySymmetric();

int secureblackbox_sshkeymanager_getcryptokeysymmetric(void* lpObj);

bool GetCryptoKeySymmetric();

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

CryptoKeyValid Property (SSHKeyManager Class)

Returns True if this key is valid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCryptoKeyValid();

Unicode (Windows)
BOOL GetCryptoKeyValid();

int secureblackbox_sshkeymanager_getcryptokeyvalid(void* lpObj);

bool GetCryptoKeyValid();

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

FIPSMode Property (SSHKeyManager 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_sshkeymanager_getfipsmode(void* lpObj);
int secureblackbox_sshkeymanager_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

KeyAlgorithm Property (SSHKeyManager Class)

Specifies the key algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyAlgorithm();

Unicode (Windows)
LPWSTR GetKeyAlgorithm();

char* secureblackbox_sshkeymanager_getkeyalgorithm(void* lpObj);

QString GetKeyAlgorithm();

Default Value

""

Remarks

Specifies the key algorithm.

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

Data Type

String

KeyBits Property (SSHKeyManager Class)

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyBits();

Unicode (Windows)
INT GetKeyBits();

int secureblackbox_sshkeymanager_getkeybits(void* lpObj);

int GetKeyBits();

Default Value

0

Remarks

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

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

Data Type

Integer

KeyComment Property (SSHKeyManager Class)

The comment for the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyComment();
int SetKeyComment(const char* lpszKeyComment);

Unicode (Windows)
LPWSTR GetKeyComment();
INT SetKeyComment(LPCWSTR lpszKeyComment);

char* secureblackbox_sshkeymanager_getkeycomment(void* lpObj);
int secureblackbox_sshkeymanager_setkeycomment(void* lpObj, const char* lpszKeyComment);

QString GetKeyComment();
int SetKeyComment(QString qsKeyComment);

Default Value

""

Remarks

The comment for the public key.

This property is not available at design time.

Data Type

String

KeyCurve Property (SSHKeyManager Class)

Specifies the elliptical curve when EC cryptography is used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyCurve();

Unicode (Windows)
LPWSTR GetKeyCurve();

char* secureblackbox_sshkeymanager_getkeycurve(void* lpObj);

QString GetKeyCurve();

Default Value

""

Remarks

Specifies the elliptical curve when EC cryptography is used.

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

Data Type

String

KeyDSSG Property (SSHKeyManager Class)

The G (Generator) parameter of the DSS signature key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyDSSG(char* &lpKeyDSSG, int &lenKeyDSSG);

Unicode (Windows)
INT GetKeyDSSG(LPSTR &lpKeyDSSG, INT &lenKeyDSSG);

int secureblackbox_sshkeymanager_getkeydssg(void* lpObj, char** lpKeyDSSG, int* lenKeyDSSG);

QByteArray GetKeyDSSG();

Remarks

The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.

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

Data Type

Byte Array

KeyDSSP Property (SSHKeyManager Class)

The P (Prime) parameter of the DSS signature key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyDSSP(char* &lpKeyDSSP, int &lenKeyDSSP);

Unicode (Windows)
INT GetKeyDSSP(LPSTR &lpKeyDSSP, INT &lenKeyDSSP);

int secureblackbox_sshkeymanager_getkeydssp(void* lpObj, char** lpKeyDSSP, int* lenKeyDSSP);

QByteArray GetKeyDSSP();

Remarks

The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.

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

Data Type

Byte Array

KeyDSSQ Property (SSHKeyManager Class)

The Q (Prime Factor) parameter of the DSS signature key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyDSSQ(char* &lpKeyDSSQ, int &lenKeyDSSQ);

Unicode (Windows)
INT GetKeyDSSQ(LPSTR &lpKeyDSSQ, INT &lenKeyDSSQ);

int secureblackbox_sshkeymanager_getkeydssq(void* lpObj, char** lpKeyDSSQ, int* lenKeyDSSQ);

QByteArray GetKeyDSSQ();

Remarks

The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.

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

Data Type

Byte Array

KeyDSSX Property (SSHKeyManager Class)

The X (Private key) parameter of the DSS signature key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyDSSX(char* &lpKeyDSSX, int &lenKeyDSSX);

Unicode (Windows)
INT GetKeyDSSX(LPSTR &lpKeyDSSX, INT &lenKeyDSSX);

int secureblackbox_sshkeymanager_getkeydssx(void* lpObj, char** lpKeyDSSX, int* lenKeyDSSX);

QByteArray GetKeyDSSX();

Remarks

The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.

This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).

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

Data Type

Byte Array

KeyDSSY Property (SSHKeyManager Class)

The Y (Public key) parameter of the DSS signature key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyDSSY(char* &lpKeyDSSY, int &lenKeyDSSY);

Unicode (Windows)
INT GetKeyDSSY(LPSTR &lpKeyDSSY, INT &lenKeyDSSY);

int secureblackbox_sshkeymanager_getkeydssy(void* lpObj, char** lpKeyDSSY, int* lenKeyDSSY);

QByteArray GetKeyDSSY();

Remarks

The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.

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

Data Type

Byte Array

KeyECCD Property (SSHKeyManager Class)

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyECCD(char* &lpKeyECCD, int &lenKeyECCD);

Unicode (Windows)
INT GetKeyECCD(LPSTR &lpKeyECCD, INT &lenKeyECCD);

int secureblackbox_sshkeymanager_getkeyeccd(void* lpObj, char** lpKeyECCD, int* lenKeyECCD);

QByteArray GetKeyECCD();

Remarks

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.

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

Data Type

Byte Array

KeyECCQX Property (SSHKeyManager Class)

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyECCQX(char* &lpKeyECCQX, int &lenKeyECCQX);

Unicode (Windows)
INT GetKeyECCQX(LPSTR &lpKeyECCQX, INT &lenKeyECCQX);

int secureblackbox_sshkeymanager_getkeyeccqx(void* lpObj, char** lpKeyECCQX, int* lenKeyECCQX);

QByteArray GetKeyECCQX();

Remarks

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.

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

Data Type

Byte Array

KeyECCQY Property (SSHKeyManager Class)

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyECCQY(char* &lpKeyECCQY, int &lenKeyECCQY);

Unicode (Windows)
INT GetKeyECCQY(LPSTR &lpKeyECCQY, INT &lenKeyECCQY);

int secureblackbox_sshkeymanager_getkeyeccqy(void* lpObj, char** lpKeyECCQY, int* lenKeyECCQY);

QByteArray GetKeyECCQY();

Remarks

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.

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

Data Type

Byte Array

KeyEdPrivate Property (SSHKeyManager Class)

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyEdPrivate(char* &lpKeyEdPrivate, int &lenKeyEdPrivate);

Unicode (Windows)
INT GetKeyEdPrivate(LPSTR &lpKeyEdPrivate, INT &lenKeyEdPrivate);

int secureblackbox_sshkeymanager_getkeyedprivate(void* lpObj, char** lpKeyEdPrivate, int* lenKeyEdPrivate);

QByteArray GetKeyEdPrivate();

Remarks

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

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

Data Type

Byte Array

KeyEdPublic Property (SSHKeyManager Class)

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyEdPublic(char* &lpKeyEdPublic, int &lenKeyEdPublic);

Unicode (Windows)
INT GetKeyEdPublic(LPSTR &lpKeyEdPublic, INT &lenKeyEdPublic);

int secureblackbox_sshkeymanager_getkeyedpublic(void* lpObj, char** lpKeyEdPublic, int* lenKeyEdPublic);

QByteArray GetKeyEdPublic();

Remarks

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

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

Data Type

Byte Array

KeyFingerprintMD5 Property (SSHKeyManager Class)

Contains the MD5 fingerprint (hash) of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyFingerprintMD5();

Unicode (Windows)
LPWSTR GetKeyFingerprintMD5();

char* secureblackbox_sshkeymanager_getkeyfingerprintmd5(void* lpObj);

QString GetKeyFingerprintMD5();

Default Value

""

Remarks

Contains the MD5 fingerprint (hash) of the key.

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

Data Type

String

KeyFingerprintSHA1 Property (SSHKeyManager Class)

Contains the SHA-1 fingerprint (hash) of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyFingerprintSHA1();

Unicode (Windows)
LPWSTR GetKeyFingerprintSHA1();

char* secureblackbox_sshkeymanager_getkeyfingerprintsha1(void* lpObj);

QString GetKeyFingerprintSHA1();

Default Value

""

Remarks

Contains the SHA-1 fingerprint (hash) of the key.

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

Data Type

String

KeyFingerprintSHA256 Property (SSHKeyManager Class)

Contains the SHA-256 fingerprint (hash) of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyFingerprintSHA256();

Unicode (Windows)
LPWSTR GetKeyFingerprintSHA256();

char* secureblackbox_sshkeymanager_getkeyfingerprintsha256(void* lpObj);

QString GetKeyFingerprintSHA256();

Default Value

""

Remarks

Contains the SHA-256 fingerprint (hash) of the key.

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

Data Type

String

KeyHandle Property (SSHKeyManager 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_sshkeymanager_getkeyhandle(void* lpObj);
int secureblackbox_sshkeymanager_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

KeyIsExtractable Property (SSHKeyManager Class)

Whether the key is extractable (e.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyIsExtractable();

Unicode (Windows)
BOOL GetKeyIsExtractable();

int secureblackbox_sshkeymanager_getkeyisextractable(void* lpObj);

bool GetKeyIsExtractable();

Default Value

FALSE

Remarks

Whether the key is extractable (e.g., from a security token), or not.

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

Data Type

Boolean

KeyIsPrivate Property (SSHKeyManager Class)

Whether this key is a private key or not.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyIsPrivate();

Unicode (Windows)
BOOL GetKeyIsPrivate();

int secureblackbox_sshkeymanager_getkeyisprivate(void* lpObj);

bool GetKeyIsPrivate();

Default Value

FALSE

Remarks

Whether this key is a private key or not.

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

Data Type

Boolean

KeyIsPublic Property (SSHKeyManager Class)

Whether this key is a public key or not.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyIsPublic();

Unicode (Windows)
BOOL GetKeyIsPublic();

int secureblackbox_sshkeymanager_getkeyispublic(void* lpObj);

bool GetKeyIsPublic();

Default Value

FALSE

Remarks

Whether this key is a public key or not.

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

Data Type

Boolean

KeyKDFRounds Property (SSHKeyManager Class)

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyKDFRounds();

Unicode (Windows)
INT GetKeyKDFRounds();

int secureblackbox_sshkeymanager_getkeykdfrounds(void* lpObj);

int GetKeyKDFRounds();

Default Value

0

Remarks

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

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

Data Type

Integer

KeyKDFSalt Property (SSHKeyManager Class)

The salt value used by the Key Derivation Function (KDF) to generate this key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyKDFSalt(char* &lpKeyKDFSalt, int &lenKeyKDFSalt);

Unicode (Windows)
INT GetKeyKDFSalt(LPSTR &lpKeyKDFSalt, INT &lenKeyKDFSalt);

int secureblackbox_sshkeymanager_getkeykdfsalt(void* lpObj, char** lpKeyKDFSalt, int* lenKeyKDFSalt);

QByteArray GetKeyKDFSalt();

Remarks

The salt value used by the Key Derivation Function (KDF) to generate this key.

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

Data Type

Byte Array

KeyKeyFormat Property (SSHKeyManager Class)

Specifies the format in which the key is stored.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyKeyFormat();

Unicode (Windows)
INT GetKeyKeyFormat();

CKF_OPEN_SSH(0), 
CKF_OPEN_SSH2(1), 
CKF_IETF(2), 
CKF_PU_TTY(3), 
CKF_X509(4), 
CKF_BINARY(5), 
CKF_SSH1(6), 
CKF_PGP(7), 
CKF_PKCS8(8), 
CKF_PU_TTY3(9)

int secureblackbox_sshkeymanager_getkeykeyformat(void* lpObj);

int GetKeyKeyFormat();

Default Value

0

Remarks

Specifies the format in which the key is stored.

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

Data Type

Integer

KeyKeyProtectionAlgorithm Property (SSHKeyManager Class)

Specifies the key protection algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyKeyProtectionAlgorithm();

Unicode (Windows)
LPWSTR GetKeyKeyProtectionAlgorithm();

char* secureblackbox_sshkeymanager_getkeykeyprotectionalgorithm(void* lpObj);

QString GetKeyKeyProtectionAlgorithm();

Default Value

""

Remarks

Specifies the key protection algorithm.

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

Data Type

String

KeyRSAExponent Property (SSHKeyManager Class)

Returns the e parameter (public exponent) of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyRSAExponent(char* &lpKeyRSAExponent, int &lenKeyRSAExponent);

Unicode (Windows)
INT GetKeyRSAExponent(LPSTR &lpKeyRSAExponent, INT &lenKeyRSAExponent);

int secureblackbox_sshkeymanager_getkeyrsaexponent(void* lpObj, char** lpKeyRSAExponent, int* lenKeyRSAExponent);

QByteArray GetKeyRSAExponent();

Remarks

Returns the e parameter (public exponent) of the RSA key.

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

Data Type

Byte Array

KeyRSAIQMP Property (SSHKeyManager Class)

Returns the iqmp parameter of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyRSAIQMP(char* &lpKeyRSAIQMP, int &lenKeyRSAIQMP);

Unicode (Windows)
INT GetKeyRSAIQMP(LPSTR &lpKeyRSAIQMP, INT &lenKeyRSAIQMP);

int secureblackbox_sshkeymanager_getkeyrsaiqmp(void* lpObj, char** lpKeyRSAIQMP, int* lenKeyRSAIQMP);

QByteArray GetKeyRSAIQMP();

Remarks

Returns the iqmp parameter of the RSA key.

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

Data Type

Byte Array

KeyRSAModulus Property (SSHKeyManager Class)

Returns the m parameter (public modulus) of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyRSAModulus(char* &lpKeyRSAModulus, int &lenKeyRSAModulus);

Unicode (Windows)
INT GetKeyRSAModulus(LPSTR &lpKeyRSAModulus, INT &lenKeyRSAModulus);

int secureblackbox_sshkeymanager_getkeyrsamodulus(void* lpObj, char** lpKeyRSAModulus, int* lenKeyRSAModulus);

QByteArray GetKeyRSAModulus();

Remarks

Returns the m parameter (public modulus) of the RSA key.

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

Data Type

Byte Array

KeyRSAP Property (SSHKeyManager Class)

Returns the p parameter (first factor of the common modulus n) of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyRSAP(char* &lpKeyRSAP, int &lenKeyRSAP);

Unicode (Windows)
INT GetKeyRSAP(LPSTR &lpKeyRSAP, INT &lenKeyRSAP);

int secureblackbox_sshkeymanager_getkeyrsap(void* lpObj, char** lpKeyRSAP, int* lenKeyRSAP);

QByteArray GetKeyRSAP();

Remarks

Returns the p parameter (first factor of the common modulus n) of the RSA key.

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

Data Type

Byte Array

KeyRSAPrivateExponent Property (SSHKeyManager Class)

Returns the d parameter (private exponent) of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyRSAPrivateExponent(char* &lpKeyRSAPrivateExponent, int &lenKeyRSAPrivateExponent);

Unicode (Windows)
INT GetKeyRSAPrivateExponent(LPSTR &lpKeyRSAPrivateExponent, INT &lenKeyRSAPrivateExponent);

int secureblackbox_sshkeymanager_getkeyrsaprivateexponent(void* lpObj, char** lpKeyRSAPrivateExponent, int* lenKeyRSAPrivateExponent);

QByteArray GetKeyRSAPrivateExponent();

Remarks

Returns the d parameter (private exponent) of the RSA key.

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

Data Type

Byte Array

KeyRSAQ Property (SSHKeyManager Class)

Returns the q parameter (second factor of the common modulus n) of the RSA key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyRSAQ(char* &lpKeyRSAQ, int &lenKeyRSAQ);

Unicode (Windows)
INT GetKeyRSAQ(LPSTR &lpKeyRSAQ, INT &lenKeyRSAQ);

int secureblackbox_sshkeymanager_getkeyrsaq(void* lpObj, char** lpKeyRSAQ, int* lenKeyRSAQ);

QByteArray GetKeyRSAQ();

Remarks

Returns the q parameter (second factor of the common modulus n) of the RSA key.

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

Data Type

Byte Array

KeySubject Property (SSHKeyManager Class)

Specifies the public key owner (subject).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeySubject();
int SetKeySubject(const char* lpszKeySubject);

Unicode (Windows)
LPWSTR GetKeySubject();
INT SetKeySubject(LPCWSTR lpszKeySubject);

char* secureblackbox_sshkeymanager_getkeysubject(void* lpObj);
int secureblackbox_sshkeymanager_setkeysubject(void* lpObj, const char* lpszKeySubject);

QString GetKeySubject();
int SetKeySubject(QString qsKeySubject);

Default Value

""

Remarks

Specifies the public key owner (subject). This property is used only for IETF-keys.

This property is not available at design time.

Data Type

String

Config Method (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager Class)

Writes the key to a memory buffer.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_sshkeymanager_exportbytes(void* lpObj, int iKeyType, const char* lpszPassword, int *lpSize);

QByteArray ExportBytes(int iKeyType, const QString& qsPassword);

Remarks

Use this method to save Key in the buffer. KeyType specifies the format in which the key should be stored, and Password is a password to decrypt the private key.

Allowed key types:

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

Exports the key to a certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExportToCert();

Unicode (Windows)
INT ExportToCert();

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

ExportToCryptoKey Method (SSHKeyManager Class)

Exports the key to a crypto key object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExportToCryptoKey();

Unicode (Windows)
INT ExportToCryptoKey();

int secureblackbox_sshkeymanager_exporttocryptokey(void* lpObj);

int ExportToCryptoKey();

Remarks

Use this method to save the Key (both the public and secret parts) to the crypto key provided via CryptoKey.

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

Writes key to file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExportToFile(int iKeyType, const char* lpszPath, const char* lpszPassword);

Unicode (Windows)
INT ExportToFile(INT iKeyType, LPCWSTR lpszPath, LPCWSTR lpszPassword);

int secureblackbox_sshkeymanager_exporttofile(void* lpObj, int iKeyType, const char* lpszPath, const char* lpszPassword);

int ExportToFile(int iKeyType, const QString& qsPath, const QString& qsPassword);

Remarks

Use this method to save Key in the file. KeyType specifies the format in which the key should be stored, Path specifies the full path to the file, and Password is a password to decrypt the private key.

Allowed key types:

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

Writes the key to a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExportToStream(int iKeyType, SecureBlackboxStream* sStream, const char* lpszPassword);

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

int secureblackbox_sshkeymanager_exporttostream(void* lpObj, int iKeyType, SecureBlackboxStream* sStream, const char* lpszPassword);

int ExportToStream(int iKeyType, SecureBlackboxStream* sStream, const QString& qsPassword);

Remarks

Use this method to save Key in the stream specified by Stream. KeyType specifies the format in which the key should be stored, and Password specifies a password to decrypt the private key.

Allowed key types:

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

Generates a new SSH 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_sshkeymanager_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 KeyAlgorithm parameter supports the following algorithm identifiers:

• RSA
• DSS
• ECDSA
• EDDSA

If using ECDSA, the following curves are supported (to be passed as the Scheme parameter):

• NISTP256
• NISTP384
• NISTP521
• NISTK163
• NISTP192
• NISTP224
• NISTK233
• NISTB233
• NISTK283
• NISTK409
• NISTB409
• NISTK571

The following curves can also be used with EDDSA:

• CURVE25519
• CURVE448

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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager 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_sshkeymanager_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 (SSHKeyManager Class)

Loads key from buffer.

Syntax