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.
CertBytes | Returns raw certificate data in DER format. |
CertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
CertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
CertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
CertCurve | Specifies the elliptic curve of the EC public key. |
CertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
CertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
CertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CertHashAlgorithm | 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 . |
CertIssuer | The common name of the certificate issuer (CA), typically a company name. |
CertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
CertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
CertKeyBits | Returns the length of the public key. |
CertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
CertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
CertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
CertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
CertOCSPNoCheck | Accessor to the value of the certificates ocsp-no-check extension. |
CertOrigin | Returns the origin of this certificate. |
CertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
CertPrivateKeyBytes | Contains the certificate's private key. |
CertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
CertPrivateKeyExtractable | Indicates whether the private key is extractable. |
CertPublicKeyBytes | Contains the certificate's public key in DER format. |
CertQualifiedStatements | Returns the qualified status of the certificate. |
CertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
CertSerialNumber | Returns the certificate's serial number. |
CertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
CertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
CertSubjectAlternativeName | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
CertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
CertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
CertValidFrom | The time point at which the certificate becomes valid, in UTC. |
CertValidTo | The time point at which the certificate expires, in UTC. |
CryptoKeyAlgorithm | The algorithm of the cryptographic key. |
CryptoKeyBits | The length of the key in bits. |
CryptoKeyCurve | This property specifies the name of the curve the EC key is built on. |
CryptoKeyExportable | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
CryptoKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CryptoKeyID | Provides access to a storage-specific key identifier. |
CryptoKeyIV | The initialization vector (IV) of a symmetric key. |
CryptoKeyKey | The byte array representation of the key. |
CryptoKeyNonce | A nonce value associated with a key. |
CryptoKeyPrivate | Returns True if the object hosts a private key, and False otherwise. |
CryptoKeyPublic | Returns True if the object hosts a public key, and False otherwise. |
CryptoKeySubject | Returns the key subject. |
CryptoKeySymmetric | Returns True if the object contains a symmetric key, and False otherwise. |
CryptoKeyValid | Returns True if this key is valid. |
FIPSMode | Reserved. |
KeyAlgorithm | Specifies the key algorithm. |
KeyBits | The number of bits in the key: the more the better, 2048 or 4096 are typical values. |
KeyComment | The comment for the public key. |
KeyCurve | Specifies the elliptical curve when EC cryptography is used. |
KeyDSSG | The G (Generator) parameter of the DSS signature key. |
KeyDSSP | The P (Prime) parameter of the DSS signature key. |
KeyDSSQ | The Q (Prime Factor) parameter of the DSS signature key. |
KeyDSSX | The X (Private key) parameter of the DSS signature key. |
KeyDSSY | The Y (Public key) parameter of the DSS signature key. |
KeyECCD | The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. |
KeyECCQX | The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. |
KeyECCQY | The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. |
KeyEdPrivate | The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used. |
KeyEdPublic | The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used. |
KeyFingerprintMD5 | Contains the MD5 fingerprint (hash) of the key. |
KeyFingerprintSHA1 | Contains the SHA-1 fingerprint (hash) of the key. |
KeyFingerprintSHA256 | Contains the SHA-256 fingerprint (hash) of the key. |
KeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KeyIsExtractable | Whether the key is extractable (e. |
KeyIsPrivate | Whether this key is a private key or not. |
KeyIsPublic | Whether this key is a public key or not. |
KeyKDFRounds | Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key. |
KeyKDFSalt | The salt value used by the Key Derivation Function (KDF) to generate this key. |
KeyKeyFormat | Specifies the format in which the key is stored. |
KeyKeyProtectionAlgorithm | Specifies the key protection algorithm. |
KeyRSAExponent | Returns the e parameter (public exponent) of the RSA key. |
KeyRSAIQMP | Returns the iqmp parameter of the RSA key. |
KeyRSAModulus | Returns the m parameter (public modulus) of the RSA key. |
KeyRSAP | Returns the p parameter (first factor of the common modulus n) of the RSA key. |
KeyRSAPrivateExponent | Returns the d parameter (private exponent) of the RSA key. |
KeyRSAQ | Returns the q parameter (second factor of the common modulus n) of the RSA key. |
KeySubject | Specifies the public key owner (subject). |
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. |
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. |
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.
TempPath | Path for storing temporary files. |
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. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
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. |
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. |
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. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
CertBytes Property (SSHKeyManager Class)
Returns raw certificate data in DER format.
Syntax
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 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 BasicConstraints extension).
Syntax
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 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
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
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
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.
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 |
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
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
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
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.
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
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)
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 |
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
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
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
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.
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 |
This property is not available at design time.
Data Type
String
CertKeyBits Property (SSHKeyManager Class)
Returns the length of the public key.
Syntax
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
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
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:
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 |
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
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
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 certificates ocsp-no-check extension.
Syntax
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 certificates 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
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
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
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
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
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
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
ANSI (Cross Platform) int GetCertQualifiedStatements();
int SetCertQualifiedStatements(int iCertQualifiedStatements); Unicode (Windows) INT GetCertQualifiedStatements();
INT SetCertQualifiedStatements(INT iCertQualifiedStatements);
Possible Values
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
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
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
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
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
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
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
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
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
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
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.
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 |
This property is not available at design time.
Data Type
String
CryptoKeyBits Property (SSHKeyManager Class)
The length of the key in bits.
Syntax
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
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
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
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.
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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.
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
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
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
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
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
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
ANSI (Cross Platform) int GetKeyKeyFormat(); Unicode (Windows) INT GetKeyKeyFormat();
Possible Values
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.
ckfOpenSSH | 0 | |
ckfOpenSSH2 | 1 | |
ckfIETF | 2 | |
ckfPuTTY | 3 | |
ckfX509 | 4 | |
ckfBinary | 5 | |
ckfSSH1 | 6 | |
ckfPGP | 7 | |
ckfPKCS8 | 8 | |
ckfPuTTY3 | 9 |
This property is read-only and not available at design time.
Data Type
Integer
KeyKeyProtectionAlgorithm Property (SSHKeyManager Class)
Specifies the key protection algorithm.
Syntax
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
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
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
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
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
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
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
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
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
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 insencitive) 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
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:
cktPrivate | 0 | A private key |
cktPublic | 1 | A public 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++)
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
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
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:
cktPrivate | 0 | A private key |
cktPublic | 1 | A public key |
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
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:
cktPrivate | 0 | A private key |
cktPublic | 1 | A public key |
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
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
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
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
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++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ImportFromCert Method (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++)
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.)
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++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ImportFromFile Method (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++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ImportFromStream Method (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++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetKeyParam Method (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++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetKeyParamStr Method (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++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (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 component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
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:
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
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
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 |
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 |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
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. |
The default value of this setting is 100.
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) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
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 value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
34603009 Invalid key (SB_ERROR_SSH_INVALID_KEY) |