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.


Certificate	A container for the certificate object.
CryptoKey	The key object that the manager is currently working with.
FIPSMode	Reserved.
Key	The key which is currently being processed.

Method List

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


Config	Sets or retrieves a configuration setting.
CreateNew	Creates a template for a new keypair.
DoAction	Performs an additional action.
ExportBytes	Writes the key to a memory buffer.
ExportToCert	Exports the key to a certificate.
ExportToCryptoKey	Exports the key to a crypto key object.
ExportToFile	Writes key to file.
ExportToStream	Writes the key to a stream.
Generate	Generates a new SSH key.
GetKeyParam	Returns an algorithm-specific key parameter.
GetKeyParamStr	Returns an algorithm-specific key parameter to a string.
ImportBytes	Loads key from buffer.
ImportFromCert	Loads a key from a certificate.
ImportFromCryptoKey	Imports a key from a crypto key.
ImportFromFile	Loads key from file.
ImportFromStream	Loads key from stream.
Reset	Resets the class settings.
SetKeyParam	Sets an algorithm-specific key parameter.
SetKeyParamStr	Sets an algorithm-specific key parameter.

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.


Error	Information about errors during SSH key management.
Notification	This event notifies the application about an underlying control flow event.

Config Settings

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


DuplicatePublicKeyInOpenSSHEdDSA	Enables or disables inclusion of the public part in private EdDSA keys.
HashAlgorithm	Specifies the hash algorithm to be used with an RSA key when authenticating.
TempPath	Path for storing temporary files.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

Certificate Property (SSHKeyManager Class)

A container for the certificate object.

Syntax

SecureBlackboxCertificate* GetCertificate();
int SetCertificate(SecureBlackboxCertificate* val);

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

int secureblackbox_sshkeymanager_getcertca(void* lpObj);
int secureblackbox_sshkeymanager_setcertca(void* lpObj, int bCertCA);

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

int secureblackbox_sshkeymanager_getcertcerttype(void* lpObj);

char* secureblackbox_sshkeymanager_getcertcrldistributionpoints(void* lpObj);
int secureblackbox_sshkeymanager_setcertcrldistributionpoints(void* lpObj, const char* lpszCertCRLDistributionPoints);

char* secureblackbox_sshkeymanager_getcertcurve(void* lpObj);
int secureblackbox_sshkeymanager_setcertcurve(void* lpObj, const char* lpszCertCurve);

char* secureblackbox_sshkeymanager_getcertfingerprint(void* lpObj);

char* secureblackbox_sshkeymanager_getcertfriendlyname(void* lpObj);

int64 secureblackbox_sshkeymanager_getcerthandle(void* lpObj);
int secureblackbox_sshkeymanager_setcerthandle(void* lpObj, int64 lCertHandle);

char* secureblackbox_sshkeymanager_getcerthashalgorithm(void* lpObj);
int secureblackbox_sshkeymanager_setcerthashalgorithm(void* lpObj, const char* lpszCertHashAlgorithm);

char* secureblackbox_sshkeymanager_getcertissuer(void* lpObj);

char* secureblackbox_sshkeymanager_getcertissuerrdn(void* lpObj);
int secureblackbox_sshkeymanager_setcertissuerrdn(void* lpObj, const char* lpszCertIssuerRDN);

char* secureblackbox_sshkeymanager_getcertkeyalgorithm(void* lpObj);
int secureblackbox_sshkeymanager_setcertkeyalgorithm(void* lpObj, const char* lpszCertKeyAlgorithm);

int secureblackbox_sshkeymanager_getcertkeybits(void* lpObj);

char* secureblackbox_sshkeymanager_getcertkeyfingerprint(void* lpObj);

int secureblackbox_sshkeymanager_getcertkeyusage(void* lpObj);
int secureblackbox_sshkeymanager_setcertkeyusage(void* lpObj, int iCertKeyUsage);

int secureblackbox_sshkeymanager_getcertkeyvalid(void* lpObj);

char* secureblackbox_sshkeymanager_getcertocsplocations(void* lpObj);
int secureblackbox_sshkeymanager_setcertocsplocations(void* lpObj, const char* lpszCertOCSPLocations);

int secureblackbox_sshkeymanager_getcertocspnocheck(void* lpObj);
int secureblackbox_sshkeymanager_setcertocspnocheck(void* lpObj, int bCertOCSPNoCheck);

int secureblackbox_sshkeymanager_getcertorigin(void* lpObj);

char* secureblackbox_sshkeymanager_getcertpolicyids(void* lpObj);
int secureblackbox_sshkeymanager_setcertpolicyids(void* lpObj, const char* lpszCertPolicyIDs);

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

int secureblackbox_sshkeymanager_getcertprivatekeyexists(void* lpObj);

int secureblackbox_sshkeymanager_getcertprivatekeyextractable(void* lpObj);

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

int secureblackbox_sshkeymanager_getcertqualified(void* lpObj);

int secureblackbox_sshkeymanager_getcertqualifiedstatements(void* lpObj);
int secureblackbox_sshkeymanager_setcertqualifiedstatements(void* lpObj, int iCertQualifiedStatements);

char* secureblackbox_sshkeymanager_getcertqualifiers(void* lpObj);

int secureblackbox_sshkeymanager_getcertselfsigned(void* lpObj);

int secureblackbox_sshkeymanager_getcertserialnumber(void* lpObj, char** lpCertSerialNumber, int* lenCertSerialNumber);
int secureblackbox_sshkeymanager_setcertserialnumber(void* lpObj, const char* lpCertSerialNumber, int lenCertSerialNumber);

char* secureblackbox_sshkeymanager_getcertsigalgorithm(void* lpObj);

int secureblackbox_sshkeymanager_getcertsource(void* lpObj);

char* secureblackbox_sshkeymanager_getcertsubject(void* lpObj);

char* secureblackbox_sshkeymanager_getcertsubjectalternativename(void* lpObj);
int secureblackbox_sshkeymanager_setcertsubjectalternativename(void* lpObj, const char* lpszCertSubjectAlternativeName);

int secureblackbox_sshkeymanager_getcertsubjectkeyid(void* lpObj, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
int secureblackbox_sshkeymanager_setcertsubjectkeyid(void* lpObj, const char* lpCertSubjectKeyID, int lenCertSubjectKeyID);

char* secureblackbox_sshkeymanager_getcertsubjectrdn(void* lpObj);
int secureblackbox_sshkeymanager_setcertsubjectrdn(void* lpObj, const char* lpszCertSubjectRDN);

int secureblackbox_sshkeymanager_getcertvalid(void* lpObj);

char* secureblackbox_sshkeymanager_getcertvalidfrom(void* lpObj);
int secureblackbox_sshkeymanager_setcertvalidfrom(void* lpObj, const char* lpszCertValidFrom);

char* secureblackbox_sshkeymanager_getcertvalidto(void* lpObj);
int secureblackbox_sshkeymanager_setcertvalidto(void* lpObj, const char* lpszCertValidTo);

QByteArray GetCertBytes();

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

QByteArray GetCertCAKeyID();

int GetCertCertType();

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

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

QString GetCertFingerprint();

QString GetCertFriendlyName();

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

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

QString GetCertIssuer();

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

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

int GetCertKeyBits();

QString GetCertKeyFingerprint();

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

bool GetCertKeyValid();

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

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

int GetCertOrigin();

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

QByteArray GetCertPrivateKeyBytes();

bool GetCertPrivateKeyExists();

bool GetCertPrivateKeyExtractable();

QByteArray GetCertPublicKeyBytes();

bool GetCertQualified();

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

QString GetCertQualifiers();

bool GetCertSelfSigned();

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

QString GetCertSigAlgorithm();

int GetCertSource();

QString GetCertSubject();

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

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

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

bool GetCertValid();

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

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

Remarks

Use this property to set or access the properties of the certificate object on which an import or export action is to be performed.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

CryptoKey Property (SSHKeyManager Class)

The key object that the manager is currently working with.

Syntax

SecureBlackboxCryptoKey* GetCryptoKey();
int SetCryptoKey(SecureBlackboxCryptoKey* val);

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

int secureblackbox_sshkeymanager_getcryptokeybits(void* lpObj);

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

int secureblackbox_sshkeymanager_getcryptokeyexportable(void* lpObj);

char* secureblackbox_sshkeymanager_getcryptokeyfingerprint(void* lpObj);

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

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

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

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

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

int secureblackbox_sshkeymanager_getcryptokeyprivate(void* lpObj);

int secureblackbox_sshkeymanager_getcryptokeypublic(void* lpObj);

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

int secureblackbox_sshkeymanager_getcryptokeysymmetric(void* lpObj);

int secureblackbox_sshkeymanager_getcryptokeyvalid(void* lpObj);

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

int GetCryptoKeyBits();

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

bool GetCryptoKeyExportable();

QString GetCryptoKeyFingerprint();

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

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

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

QByteArray GetCryptoKeyKey();

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

bool GetCryptoKeyPrivate();

bool GetCryptoKeyPublic();

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

bool GetCryptoKeySymmetric();

bool GetCryptoKeyValid();

Remarks

Use this property to pass a key to the manager (for example, for importing), or to obtain a key from the manager (e.g., after exporting to it).

This property is not available at design time.

Data Type

SecureBlackboxCryptoKey

FIPSMode Property (SSHKeyManager Class)

Reserved.

Syntax

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

Key Property (SSHKeyManager Class)

The key which is currently being processed.

Syntax

SecureBlackboxSSHKey* GetKey();
int SetKey(SecureBlackboxSSHKey* val);

char* secureblackbox_sshkeymanager_getkeyalgorithm(void* lpObj);

int secureblackbox_sshkeymanager_getkeybits(void* lpObj);

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

char* secureblackbox_sshkeymanager_getkeycurve(void* lpObj);

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

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

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

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

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

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

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

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

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

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

char* secureblackbox_sshkeymanager_getkeyfingerprintmd5(void* lpObj);

char* secureblackbox_sshkeymanager_getkeyfingerprintsha1(void* lpObj);

char* secureblackbox_sshkeymanager_getkeyfingerprintsha256(void* lpObj);

int64 secureblackbox_sshkeymanager_getkeyhandle(void* lpObj);
int secureblackbox_sshkeymanager_setkeyhandle(void* lpObj, int64 lKeyHandle);

int secureblackbox_sshkeymanager_getkeyisextractable(void* lpObj);

int secureblackbox_sshkeymanager_getkeyisprivate(void* lpObj);

int secureblackbox_sshkeymanager_getkeyispublic(void* lpObj);

int secureblackbox_sshkeymanager_getkeykdfrounds(void* lpObj);

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

int secureblackbox_sshkeymanager_getkeykeyformat(void* lpObj);

char* secureblackbox_sshkeymanager_getkeykeyprotectionalgorithm(void* lpObj);

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

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

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

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

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

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

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

QString GetKeyAlgorithm();

int GetKeyBits();

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

QString GetKeyCurve();

QByteArray GetKeyDSSG();

QByteArray GetKeyDSSP();

QByteArray GetKeyDSSQ();

QByteArray GetKeyDSSX();

QByteArray GetKeyDSSY();

QByteArray GetKeyECCD();

QByteArray GetKeyECCQX();

QByteArray GetKeyECCQY();

QByteArray GetKeyEdPrivate();

QByteArray GetKeyEdPublic();

QString GetKeyFingerprintMD5();

QString GetKeyFingerprintSHA1();

QString GetKeyFingerprintSHA256();

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

bool GetKeyIsExtractable();

bool GetKeyIsPrivate();

bool GetKeyIsPublic();

int GetKeyKDFRounds();

QByteArray GetKeyKDFSalt();

int GetKeyKeyFormat();

QString GetKeyKeyProtectionAlgorithm();

QByteArray GetKeyRSAExponent();

QByteArray GetKeyRSAIQMP();

QByteArray GetKeyRSAModulus();

QByteArray GetKeyRSAP();

QByteArray GetKeyRSAPrivateExponent();

QByteArray GetKeyRSAQ();

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

Remarks

This property contains the key on which the class could operate now.

This property is not available at design time.

Data Type

SecureBlackboxSSHKey

Config Method (SSHKeyManager Class)

Sets or retrieves a configuration setting.

Syntax

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.

CreateNew Method (SSHKeyManager Class)

Creates a template for a new keypair.

Syntax

ANSI (Cross Platform)
int CreateNew();

Unicode (Windows)
INT CreateNew();

int secureblackbox_sshkeymanager_createnew(void* lpObj);

int CreateNew();

Remarks

This method pre-generates a template for a new key.

Adjust the properties of the Key object and call Generate to complete the generation.

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

Performs an additional action.

Syntax

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

ExportBytes Method (SSHKeyManager Class)

Writes the key to a memory buffer.

Syntax

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

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

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

QByteArray ExportBytes(int iFormat, bool bPrivateKey, const QString& qsPassword);

Remarks

Use this method to save Key in the buffer. Format specifies the format in which the key should be stored, as following:


ckfOpenSSH	`0`
ckfOpenSSH2	`1`
ckfIETF	`2`
ckfPuTTY	`3`
ckfX509	`4`
ckfBinary	`5`
ckfSSH1	`6`
ckfPGP	`7`
ckfPKCS8	`8`
ckfPuTTY3	`9`

The PrivateKey parameter tells whether it the private (or public, otherwise) key should be exported. The Password defines the password that should be used to encrypt the private key.

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

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

ExportToCryptoKey Method (SSHKeyManager Class)

Exports the key to a crypto key object.

Syntax

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

ExportToFile Method (SSHKeyManager Class)

Writes key to file.

Syntax

ANSI (Cross Platform)
int ExportToFile(const char* lpszFileName, int iFormat, int bPrivateKey, const char* lpszPassword);

Unicode (Windows)
INT ExportToFile(LPCWSTR lpszFileName, INT iFormat, BOOL bPrivateKey, LPCWSTR lpszPassword);

int secureblackbox_sshkeymanager_exporttofile(void* lpObj, const char* lpszFileName, int iFormat, int bPrivateKey, const char* lpszPassword);

int ExportToFile(const QString& qsFileName, int iFormat, bool bPrivateKey, const QString& qsPassword);

Remarks

Use this method to save Key in the file. Format specifies the format in which the key should be stored, as following:


ckfOpenSSH	`0`
ckfOpenSSH2	`1`
ckfIETF	`2`
ckfPuTTY	`3`
ckfX509	`4`
ckfBinary	`5`
ckfSSH1	`6`
ckfPGP	`7`
ckfPKCS8	`8`
ckfPuTTY3	`9`

The PrivateKey parameter tells whether it the private (or public, otherwise) key should be exported. Path designates the path to the file that the key should be written to, and Password defines the password that should be used to encrypt the private key.

Error Handling (C++)

ExportToStream Method (SSHKeyManager Class)

Writes the key to a stream.

Syntax

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

Unicode (Windows)
INT ExportToStream(SecureBlackboxStream* sStream, INT iFormat, BOOL bPrivateKey, LPCWSTR lpszPassword);

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

int ExportToStream(SecureBlackboxStream* sStream, int iFormat, bool bPrivateKey, const QString& qsPassword);

Remarks

Use this method to save Key in the stream specified by Stream. Format specifies the format in which the key should be stored, as following:


ckfOpenSSH	`0`
ckfOpenSSH2	`1`
ckfIETF	`2`
ckfPuTTY	`3`
ckfX509	`4`
ckfBinary	`5`
ckfSSH1	`6`
ckfPGP	`7`
ckfPKCS8	`8`
ckfPuTTY3	`9`

The PrivateKey parameter tells whether it the private (or public, otherwise) key should be exported. The Password defines the password that should be used to encrypt the private key.

Error Handling (C++)

Generate Method (SSHKeyManager Class)

Generates a new SSH key.

Syntax

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

GetKeyParam Method (SSHKeyManager Class)

Returns an algorithm-specific key parameter.

Syntax

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

GetKeyParamStr Method (SSHKeyManager Class)

Returns an algorithm-specific key parameter to a string.

Syntax

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

ImportBytes Method (SSHKeyManager Class)

Loads key from buffer.

Syntax

ANSI (Cross Platform)
int ImportBytes(const char* lpBytes, int lenBytes, const char* lpszPassword);

Unicode (Windows)
INT ImportBytes(LPCSTR lpBytes, INT lenBytes, LPCWSTR lpszPassword);

int secureblackbox_sshkeymanager_importbytes(void* lpObj, const char* lpBytes, int lenBytes, const char* lpszPassword);

int ImportBytes(QByteArray qbaBytes, const QString& qsPassword);

Remarks

Use this method to read a key stored in a buffer. Password specifies a password to decrypt the private key.

Error Handling (C++)

ImportFromCert Method (SSHKeyManager Class)

Loads a key from a certificate.

Syntax

ANSI (Cross Platform)
int ImportFromCert();

Unicode (Windows)
INT ImportFromCert();

int secureblackbox_sshkeymanager_importfromcert(void* lpObj);

int ImportFromCert();

Remarks

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

Error Handling (C++)

ImportFromCryptoKey Method (SSHKeyManager Class)

Imports a key from a crypto key.

Syntax

ANSI (Cross Platform)
int ImportFromCryptoKey();

Unicode (Windows)
INT ImportFromCryptoKey();

int secureblackbox_sshkeymanager_importfromcryptokey(void* lpObj);

int ImportFromCryptoKey();

Remarks

Use this method to load a key, either public or private, from a crypto key. Provide the key via CryptoKey property.

Error Handling (C++)

ImportFromFile Method (SSHKeyManager Class)

Loads key from file.

Syntax

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

Unicode (Windows)
INT ImportFromFile(LPCWSTR lpszPath, LPCWSTR lpszPassword);

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

int ImportFromFile(const QString& qsPath, const QString& qsPassword);

Remarks

Use this method to read a key stored in a file. Path specifies the full path to the file, Password is a password to decrypt the private key.

Error Handling (C++)

ImportFromStream Method (SSHKeyManager Class)

Loads key from stream.

Syntax

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

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

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

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

Remarks

Use this method to read a key stored in a stream. Password specifies a password to decrypt the private key.

Error Handling (C++)

Reset Method (SSHKeyManager Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_sshkeymanager_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

SetKeyParam Method (SSHKeyManager Class)

Sets an algorithm-specific key parameter.

Syntax

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_sshkeymanager_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++)

SetKeyParamStr Method (SSHKeyManager Class)

Sets an algorithm-specific key parameter.

Syntax

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

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

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

Error Event (SSHKeyManager Class)

Information about errors during SSH key management.

Syntax

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

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


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

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

#define EID_SSHKEYMANAGER_ERROR 1

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

class SSHKeyManagerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

The event is fired in case of exceptional conditions during key management.

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

Notification Event (SSHKeyManager Class)

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

Syntax

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

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


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

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

#define EID_SSHKEYMANAGER_NOTIFICATION 2

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

class SSHKeyManagerNotificationEventParams {
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(SSHKeyManagerNotificationEventParams *e);

// Or, subclass SSHKeyManager and override this emitter function.
virtual int FireNotification(SSHKeyManagerNotificationEventParams *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.

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

Fields

Bytes
char* (read-only)
Default Value:

Returns the raw certificate data in DER format.

CA
int
Default Value: FALSE

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.

CAKeyID
char* (read-only)
Default Value:

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

CertType
int (read-only)
Default Value: 0

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

CRLDistributionPoints
char*
Default Value: ""

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

Curve
char*
Default Value: ""

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

Fingerprint
char* (read-only)
Default Value: ""

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

FriendlyName
char* (read-only)
Default Value: ""

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

Handle
int64
Default Value: 0

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

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

HashAlgorithm
char*
Default Value: ""

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.


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`

Issuer
char* (read-only)
Default Value: ""

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.

IssuerRDN
char*
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

KeyAlgorithm
char*
Default Value: "0"

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.

KeyBits
int (read-only)
Default Value: 0

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.

KeyFingerprint
char* (read-only)
Default Value: ""

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

KeyUsage
int
Default Value: 0

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:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this field before generating the certificate to propagate the key usage flags to the new certificate.

KeyValid
int (read-only)
Default Value: FALSE

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

OCSPLocations
char*
Default Value: ""

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

OCSPNoCheck
int
Default Value: FALSE

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

Origin
int (read-only)
Default Value: 0

Returns the location that the certificate was taken or loaded from.

PolicyIDs
char*
Default Value: ""

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.

Set this field when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

PrivateKeyBytes
char* (read-only)
Default Value:

Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

PrivateKeyExists
int (read-only)
Default Value: FALSE

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

PrivateKeyExtractable
int (read-only)
Default Value: FALSE

Indicates whether the private key is extractable (exportable).

PublicKeyBytes
char* (read-only)
Default Value:

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

Qualified
int (read-only)
Default Value: FALSE

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

QualifiedStatements
int
Default Value: 0

Returns a simplified qualified status of the certificate.

Qualifiers
char* (read-only)
Default Value: ""

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

SelfSigned
int (read-only)
Default Value: FALSE

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

SerialNumber
char*
Default Value:

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

SigAlgorithm
char* (read-only)
Default Value: ""

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

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

Source
int (read-only)
Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Subject
char* (read-only)
Default Value: ""

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.

SubjectAlternativeName
char*
Default Value: ""

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

Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

SubjectKeyID
char*
Default Value:

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

SubjectRDN
char*
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

Valid
int (read-only)
Default Value: FALSE

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

ValidFrom
char*
Default Value: ""

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

ValidTo
char*
Default Value: ""

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

Constructors

Certificate()

Creates a new object with default field values.

CryptoKey Type

This container represents a cryptographic key.

Syntax

SecureBlackboxCryptoKey (declared in secureblackbox.h)

Remarks

This type is a universal placeholder for cryptographic keys.

The following fields are available:

Fields

Algorithm
char*
Default Value: ""

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


SB_SYMMETRIC_ALGORITHM_RC4	`RC4`
SB_SYMMETRIC_ALGORITHM_DES	`DES`
SB_SYMMETRIC_ALGORITHM_3DES	`3DES`
SB_SYMMETRIC_ALGORITHM_RC2	`RC2`
SB_SYMMETRIC_ALGORITHM_AES128	`AES128`
SB_SYMMETRIC_ALGORITHM_AES192	`AES192`
SB_SYMMETRIC_ALGORITHM_AES256	`AES256`
SB_SYMMETRIC_ALGORITHM_IDENTITY	`Identity`
SB_SYMMETRIC_ALGORITHM_BLOWFISH	`Blowfish`
SB_SYMMETRIC_ALGORITHM_CAST128	`CAST128`
SB_SYMMETRIC_ALGORITHM_IDEA	`IDEA`
SB_SYMMETRIC_ALGORITHM_TWOFISH	`Twofish`
SB_SYMMETRIC_ALGORITHM_TWOFISH128	`Twofish128`
SB_SYMMETRIC_ALGORITHM_TWOFISH192	`Twofish192`
SB_SYMMETRIC_ALGORITHM_TWOFISH256	`Twofish256`
SB_SYMMETRIC_ALGORITHM_CAMELLIA	`Camellia`
SB_SYMMETRIC_ALGORITHM_CAMELLIA128	`Camellia128`
SB_SYMMETRIC_ALGORITHM_CAMELLIA192	`Camellia192`
SB_SYMMETRIC_ALGORITHM_CAMELLIA256	`Camellia256`
SB_SYMMETRIC_ALGORITHM_SERPENT	`Serpent`
SB_SYMMETRIC_ALGORITHM_SERPENT128	`Serpent128`
SB_SYMMETRIC_ALGORITHM_SERPENT192	`Serpent192`
SB_SYMMETRIC_ALGORITHM_SERPENT256	`Serpent256`
SB_SYMMETRIC_ALGORITHM_SEED	`SEED`
SB_SYMMETRIC_ALGORITHM_RABBIT	`Rabbit`
SB_SYMMETRIC_ALGORITHM_SYMMETRIC	`Generic`
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989	`GOST-28147-1989`
SB_SYMMETRIC_ALGORITHM_CHACHA20	`ChaCha20`


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`

Bits
int (read-only)
Default Value: 0

The length of the key in bits.

Curve
char*
Default Value: ""

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

Exportable
int (read-only)
Default Value: FALSE

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

Fingerprint
char* (read-only)
Default Value: ""

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

Handle
int64
Default Value: 0

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.

ID
char*
Default Value:

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

IV
char*
Default Value:

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.

Key
char* (read-only)
Default Value:

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

Nonce
char*
Default Value:

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

Private
int (read-only)
Default Value: FALSE

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

Public
int (read-only)
Default Value: FALSE

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

Subject
char*
Default Value:

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

Symmetric
int (read-only)
Default Value: FALSE

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

Valid
int (read-only)
Default Value: FALSE

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.

Constructors

CryptoKey()

Creates an empty crypto key object.

SSHKey Type

SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key.

Syntax

SecureBlackboxSSHKey (declared in secureblackbox.h)

Remarks

SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits.

The following fields are available:

Fields

Algorithm
char* (read-only)
Default Value: ""

Specifies the key algorithm.

Bits
int (read-only)
Default Value: 0

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

Comment
char*
Default Value: ""

The comment for the public key.

Curve
char* (read-only)
Default Value: ""

Specifies the elliptical curve when EC cryptography is used.

DSSG
char* (read-only)
Default Value:

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

DSSP
char* (read-only)
Default Value:

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

DSSQ
char* (read-only)
Default Value:

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

DSSX
char* (read-only)
Default Value:

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

DSSY
char* (read-only)
Default Value:

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

ECCD
char* (read-only)
Default Value:

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.

ECCQX
char* (read-only)
Default Value:

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.

ECCQY
char* (read-only)
Default Value:

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.

EdPrivate
char* (read-only)
Default Value:

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

EdPublic
char* (read-only)
Default Value:

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

FingerprintMD5
char* (read-only)
Default Value: ""

Contains the MD5 fingerprint (hash) of the key.

FingerprintSHA1
char* (read-only)
Default Value: ""

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

FingerprintSHA256
char* (read-only)
Default Value: ""

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

Handle
int64
Default Value: 0

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.

IsExtractable
int (read-only)
Default Value: FALSE

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

IsPrivate
int (read-only)
Default Value: FALSE

Whether this key is a private key or not.

IsPublic
int (read-only)
Default Value: FALSE

Whether this key is a public key or not.

KDFRounds
int (read-only)
Default Value: 0

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

KDFSalt
char* (read-only)
Default Value:

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

KeyFormat
int (read-only)
Default Value: 0

Specifies the format in which the key is stored.


ckfOpenSSH	`0`
ckfOpenSSH2	`1`
ckfIETF	`2`
ckfPuTTY	`3`
ckfX509	`4`
ckfBinary	`5`
ckfSSH1	`6`
ckfPGP	`7`
ckfPKCS8	`8`
ckfPuTTY3	`9`

KeyProtectionAlgorithm
char* (read-only)
Default Value: ""

Specifies the key protection algorithm.

RSAExponent
char* (read-only)
Default Value:

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

RSAIQMP
char* (read-only)
Default Value:

Returns the iqmp parameter of the RSA key.

RSAModulus
char* (read-only)
Default Value:

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

RSAP
char* (read-only)
Default Value:

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

RSAPrivateExponent
char* (read-only)
Default Value:

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

RSAQ
char* (read-only)
Default Value:

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

Subject
char*
Default Value: ""

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

Constructors

SSHKey()

Creates a new key.

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The SSHKeyManager 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 SSHKeyManager 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.

Properties

CanRead	Whether the stream supports reading. bool CanRead() { return true; }
CanSeek	Whether the stream supports seeking. bool CanSeek() { return true; }
CanWrite	Whether the stream supports writing. bool CanWrite() { return true; }
Length	Gets the length of the stream, in bytes. int64 GetLength() = 0;
Methods

Close	Closes the stream, releasing all resources currently allocated for it. void Close() {} This method is called automatically when a SecureBlackboxStream object is deleted.
Flush	Forces all data held by the stream's buffers to be written out to storage. int Flush() { return 0; } Must return `0` if flushing is successful; or `-1` if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return `0`.
Read	Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. int Read(void* buffer, int count) = 0; `Buffer` specifies the buffer to populate with data from the stream. `Count` specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into `Buffer`; this may be less than `Count` if that many bytes are not currently available, or `0` if the end of the stream has been reached. Must return `-1` if an error occurs, if reading is not supported, or if the stream is closed.
Seek	Sets the current position within the stream based on a particular point of origin. int64 Seek(int64 offset, int seekOrigin) = 0; `Offset` specifies the offset in the stream to seek to, relative to `SeekOrigin`. Valid values for `SeekOrigin` are: `0`: Seek from beginning. `1`: Seek from current position. `2`: Seek from end. Must return the new position within the stream; or `-1` if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If `-1` is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an `Offset` of `0` and a `SeekOrigin` of `1` to obtain the current position within the stream, even if seeking is not otherwise supported.
Write	Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. int Write(const void* buffer, int count) = 0; `Buffer` specifies the buffer with data to write to the stream. `Count` specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than `Count` if that many bytes could not be written. Must return `-1` if an error occurs, if writing is not supported, or if the stream is closed.

Config Settings (SSHKeyManager Class)

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

SSHKeyManager Config Settings

DuplicatePublicKeyInOpenSSHEdDSA: Enables or disables inclusion of the public part in private EdDSA keys.

This is a global setting that regulates whether to include the public EdDSA part when writing EdDSA private keys. This is a compatibility setting.

HashAlgorithm: Specifies the hash algorithm to be used with an RSA key when authenticating.

This property specifies the hash algorithm that you would like to use when authenticating with this key. This only applies to RSA keys to resolve ambiguity between ssh-rsa and rsa-sha2-256/512 algorithms.

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Config Settings

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

HttpVersion: The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert: Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter: The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

ProductVersion: Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses: Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (SSHKeyManager 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.

SSHKeyManager Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)
34603009	Failed to loaded the trusted keys (`SB_ERROR_SSH_INVALID_KEY`)
34603010	Other operation is in progress (`SB_ERROR_SSH_BUSY`)
34603011	Command execution failed (`SB_ERROR_SSH_EXEC_FAILED`)
34603012	Failed to read data from the connection (`SB_ERROR_SSH_READ_FAILED`)
34603013	Failed to write data to the connection (`SB_ERROR_SSH_WRITE_FAILED`)