PGPKeyManager Class

Properties Methods Events Config Settings Errors

The PGPKeyManager class manages PGP keys.

Syntax

PGPKeyManager

Remarks

PGPKeyManager allows you to load, save, generate, import, and export PGP 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.


Key	The key to manipulate on.
PinnedKey	A PGP key that is being manipulated on.
Signatures	Signatures available in the key.
SigningKey	A PGP key that is being manipulated on.
Subkeys	PGP subkeys available in the key.
Users	Users available in the key.

Method List

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


ChangePassphrase	Changes the password of the secret key.
ChangeProtection	Changes the protection level of the secret key.
CheckPassphrase	Checks if the password matches the secret key.
Config	Sets or retrieves a configuration setting.
CreateKey	Generates a new key.
CreateSubkey	Generates a new subkey.
CreateUser	Adds a user to an existing key.
DoAction	Performs an additional action.
ExportBytes	Serializes the key to a byte array.
ExportToFile	Exports the key to a file.
ExportToStream	Exports the key to a stream.
GeneratePair	Generates a new pair of PGP keys.
ImportBytes	Loads a key from a byte array.
ImportFromFile	Loads a key from a file.
ImportFromStream	Loads a key from a stream.
ImportPinned	Loads a key from a pinned key object.
RemoveSignature	Unbinds the specified signature from the key, subkey or user.
RemoveSubkey	Removes the specified subkey from the key.
RemoveUser	Unbinds the specified user from the key.
Reset	Creates a new empty keyring.
RevokeKey	Revokes the key.
RevokeSubkey	Revokes the key's subkey.
RevokeUser	Revokes a user certification.
SignKey	Sign the key.
SignSubkey	Sign the key's subkey.
SignUser	Sign a user certification.
Verify	Verifies the integrity of a key signature.

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 PGP key management.
KeyPassphraseNeeded	Requests a key protection password from the application.
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.


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

Key Property (PGPKeyManager Class)

The key to manipulate on.

Syntax

SecureBlackboxPGPKey* GetKey();

int secureblackbox_pgpkeymanager_getkeybitsinkey(void* lpObj);

int secureblackbox_pgpkeymanager_getkeycanencrypt(void* lpObj);

int secureblackbox_pgpkeymanager_getkeycansign(void* lpObj);

char* secureblackbox_pgpkeymanager_getkeycurve(void* lpObj);

int secureblackbox_pgpkeymanager_getkeyenabled(void* lpObj);
int secureblackbox_pgpkeymanager_setkeyenabled(void* lpObj, int bKeyEnabled);

char* secureblackbox_pgpkeymanager_getkeyencryptionalgorithm(void* lpObj);

int secureblackbox_pgpkeymanager_getkeyispublic(void* lpObj);

int secureblackbox_pgpkeymanager_getkeyissecret(void* lpObj);

int secureblackbox_pgpkeymanager_getkeyissubkey(void* lpObj);

char* secureblackbox_pgpkeymanager_getkeykeyfp(void* lpObj);

char* secureblackbox_pgpkeymanager_getkeykeyid(void* lpObj);

char* secureblackbox_pgpkeymanager_getkeypassphrase(void* lpObj);
int secureblackbox_pgpkeymanager_setkeypassphrase(void* lpObj, const char* lpszKeyPassphrase);

int secureblackbox_pgpkeymanager_getkeypassphrasevalid(void* lpObj);

char* secureblackbox_pgpkeymanager_getkeyprimarykeyid(void* lpObj);

int secureblackbox_pgpkeymanager_getkeyprotection(void* lpObj);

char* secureblackbox_pgpkeymanager_getkeypublickeyalgorithm(void* lpObj);

int secureblackbox_pgpkeymanager_getkeyqbits(void* lpObj);

char* secureblackbox_pgpkeymanager_getkeytimestamp(void* lpObj);

char* secureblackbox_pgpkeymanager_getkeyusername(void* lpObj);

char* secureblackbox_pgpkeymanager_getkeyvalidto(void* lpObj);

int secureblackbox_pgpkeymanager_getkeyversion(void* lpObj);

int GetKeyBitsInKey();

bool GetKeyCanEncrypt();

bool GetKeyCanSign();

QString GetKeyCurve();

bool GetKeyEnabled();
int SetKeyEnabled(bool bKeyEnabled);

QString GetKeyEncryptionAlgorithm();

bool GetKeyIsPublic();

bool GetKeyIsSecret();

bool GetKeyIsSubkey();

QString GetKeyKeyFP();

QString GetKeyKeyID();

QString GetKeyPassphrase();
int SetKeyPassphrase(QString qsKeyPassphrase);

bool GetKeyPassphraseValid();

QString GetKeyPrimaryKeyID();

int GetKeyProtection();

QString GetKeyPublicKeyAlgorithm();

int GetKeyQBits();

QString GetKeyTimestamp();

QString GetKeyUsername();

QString GetKeyValidTo();

int GetKeyVersion();

Remarks

Use this property to specify the key to perform operations on.

This property is read-only.

Data Type

SecureBlackboxPGPKey

PinnedKey Property (PGPKeyManager Class)

A PGP key that is being manipulated on.

Syntax

SecureBlackboxPGPKey* GetPinnedKey();
int SetPinnedKey(SecureBlackboxPGPKey* val);

int64 secureblackbox_pgpkeymanager_getpinnedkeyhandle(void* lpObj);
int secureblackbox_pgpkeymanager_setpinnedkeyhandle(void* lpObj, int64 lPinnedKeyHandle);

qint64 GetPinnedKeyHandle();
int SetPinnedKeyHandle(qint64 lPinnedKeyHandle);

Remarks

Use this property to specify a key to perform operations on, such as adding.

This property is not available at design time.

Data Type

SecureBlackboxPGPKey

Signatures Property (PGPKeyManager Class)

Signatures available in the key.

Syntax

SecureBlackboxList<SecureBlackboxPGPSignature>* GetSignatures();

int secureblackbox_pgpkeymanager_getsignaturecount(void* lpObj);

int secureblackbox_pgpkeymanager_getsignaturecertificationtype(void* lpObj, int signatureindex);

char* secureblackbox_pgpkeymanager_getsignaturecreationtime(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignatureexpirationtime(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignatureexportable(void* lpObj, int signatureindex);

int64 secureblackbox_pgpkeymanager_getsignaturehandle(void* lpObj, int signatureindex);

char* secureblackbox_pgpkeymanager_getsignaturehashalgorithm(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturehashmark(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturekeyexpirationtime(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturekeyflags(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturelegacyformat(void* lpObj, int signatureindex);

char* secureblackbox_pgpkeymanager_getsignaturepolicyurl(void* lpObj, int signatureindex);

char* secureblackbox_pgpkeymanager_getsignaturepreferredalgorithms(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignatureprimaryuserid(void* lpObj, int signatureindex);

char* secureblackbox_pgpkeymanager_getsignaturereasonforrevocation(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturerevocable(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturerevocation(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturesignatureclass(void* lpObj, int signatureindex);

char* secureblackbox_pgpkeymanager_getsignaturesignerkeyid(void* lpObj, int signatureindex);

char* secureblackbox_pgpkeymanager_getsignaturesigneruserid(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturestrictlyvalid(void* lpObj, int signatureindex);

char* secureblackbox_pgpkeymanager_getsignaturetarget(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturetextsignature(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturetrustamount(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturetrustlevel(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturevalidated(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignaturevalidity(void* lpObj, int signatureindex);

int secureblackbox_pgpkeymanager_getsignatureversion(void* lpObj, int signatureindex);

int GetSignatureCount();

int GetSignatureCertificationType(int iSignatureIndex);

QString GetSignatureCreationTime(int iSignatureIndex);

int GetSignatureExpirationTime(int iSignatureIndex);

bool GetSignatureExportable(int iSignatureIndex);

qint64 GetSignatureHandle(int iSignatureIndex);

QString GetSignatureHashAlgorithm(int iSignatureIndex);

int GetSignatureHashMark(int iSignatureIndex);

int GetSignatureKeyExpirationTime(int iSignatureIndex);

int GetSignatureKeyFlags(int iSignatureIndex);

bool GetSignatureLegacyFormat(int iSignatureIndex);

QString GetSignaturePolicyURL(int iSignatureIndex);

QString GetSignaturePreferredAlgorithms(int iSignatureIndex);

bool GetSignaturePrimaryUserID(int iSignatureIndex);

QString GetSignatureReasonForRevocation(int iSignatureIndex);

bool GetSignatureRevocable(int iSignatureIndex);

bool GetSignatureRevocation(int iSignatureIndex);

int GetSignatureSignatureClass(int iSignatureIndex);

QString GetSignatureSignerKeyID(int iSignatureIndex);

QString GetSignatureSignerUserID(int iSignatureIndex);

bool GetSignatureStrictlyValid(int iSignatureIndex);

QString GetSignatureTarget(int iSignatureIndex);

bool GetSignatureTextSignature(int iSignatureIndex);

int GetSignatureTrustAmount(int iSignatureIndex);

int GetSignatureTrustLevel(int iSignatureIndex);

bool GetSignatureValidated(int iSignatureIndex);

int GetSignatureValidity(int iSignatureIndex);

int GetSignatureVersion(int iSignatureIndex);

Remarks

This property populates a collection of all signatures contained in the key.

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

Data Type

SecureBlackboxPGPSignature

SigningKey Property (PGPKeyManager Class)

A PGP key that is being manipulated on.

Syntax

SecureBlackboxPGPKey* GetSigningKey();
int SetSigningKey(SecureBlackboxPGPKey* val);

int64 secureblackbox_pgpkeymanager_getsigningkeyhandle(void* lpObj);
int secureblackbox_pgpkeymanager_setsigningkeyhandle(void* lpObj, int64 lSigningKeyHandle);

qint64 GetSigningKeyHandle();
int SetSigningKeyHandle(qint64 lSigningKeyHandle);

Remarks

Use this property to specify a key to perform operations on, such as adding.

This property is not available at design time.

Data Type

SecureBlackboxPGPKey

Subkeys Property (PGPKeyManager Class)

PGP subkeys available in the key.

Syntax

SecureBlackboxList<SecureBlackboxPGPKey>* GetSubkeys();

int secureblackbox_pgpkeymanager_getsubkeycount(void* lpObj);

int secureblackbox_pgpkeymanager_getsubkeybitsinkey(void* lpObj, int subkeyindex);

int secureblackbox_pgpkeymanager_getsubkeycanencrypt(void* lpObj, int subkeyindex);

int secureblackbox_pgpkeymanager_getsubkeycansign(void* lpObj, int subkeyindex);

char* secureblackbox_pgpkeymanager_getsubkeycurve(void* lpObj, int subkeyindex);

int secureblackbox_pgpkeymanager_getsubkeyenabled(void* lpObj, int subkeyindex);

char* secureblackbox_pgpkeymanager_getsubkeyencryptionalgorithm(void* lpObj, int subkeyindex);

int64 secureblackbox_pgpkeymanager_getsubkeyhandle(void* lpObj, int subkeyindex);

int secureblackbox_pgpkeymanager_getsubkeyispublic(void* lpObj, int subkeyindex);

int secureblackbox_pgpkeymanager_getsubkeyissecret(void* lpObj, int subkeyindex);

int secureblackbox_pgpkeymanager_getsubkeyissubkey(void* lpObj, int subkeyindex);

char* secureblackbox_pgpkeymanager_getsubkeykeyfp(void* lpObj, int subkeyindex);

char* secureblackbox_pgpkeymanager_getsubkeykeyid(void* lpObj, int subkeyindex);

char* secureblackbox_pgpkeymanager_getsubkeypassphrase(void* lpObj, int subkeyindex);

int secureblackbox_pgpkeymanager_getsubkeypassphrasevalid(void* lpObj, int subkeyindex);

char* secureblackbox_pgpkeymanager_getsubkeyprimarykeyid(void* lpObj, int subkeyindex);

int secureblackbox_pgpkeymanager_getsubkeyprotection(void* lpObj, int subkeyindex);

char* secureblackbox_pgpkeymanager_getsubkeypublickeyalgorithm(void* lpObj, int subkeyindex);

int secureblackbox_pgpkeymanager_getsubkeyqbits(void* lpObj, int subkeyindex);

char* secureblackbox_pgpkeymanager_getsubkeytimestamp(void* lpObj, int subkeyindex);

char* secureblackbox_pgpkeymanager_getsubkeyusername(void* lpObj, int subkeyindex);

char* secureblackbox_pgpkeymanager_getsubkeyvalidto(void* lpObj, int subkeyindex);

int secureblackbox_pgpkeymanager_getsubkeyversion(void* lpObj, int subkeyindex);

int GetSubkeyCount();

int GetSubkeyBitsInKey(int iSubkeyIndex);

bool GetSubkeyCanEncrypt(int iSubkeyIndex);

bool GetSubkeyCanSign(int iSubkeyIndex);

QString GetSubkeyCurve(int iSubkeyIndex);

bool GetSubkeyEnabled(int iSubkeyIndex);

QString GetSubkeyEncryptionAlgorithm(int iSubkeyIndex);

qint64 GetSubkeyHandle(int iSubkeyIndex);

bool GetSubkeyIsPublic(int iSubkeyIndex);

bool GetSubkeyIsSecret(int iSubkeyIndex);

bool GetSubkeyIsSubkey(int iSubkeyIndex);

QString GetSubkeyKeyFP(int iSubkeyIndex);

QString GetSubkeyKeyID(int iSubkeyIndex);

QString GetSubkeyPassphrase(int iSubkeyIndex);

bool GetSubkeyPassphraseValid(int iSubkeyIndex);

QString GetSubkeyPrimaryKeyID(int iSubkeyIndex);

int GetSubkeyProtection(int iSubkeyIndex);

QString GetSubkeyPublicKeyAlgorithm(int iSubkeyIndex);

int GetSubkeyQBits(int iSubkeyIndex);

QString GetSubkeyTimestamp(int iSubkeyIndex);

QString GetSubkeyUsername(int iSubkeyIndex);

QString GetSubkeyValidTo(int iSubkeyIndex);

int GetSubkeyVersion(int iSubkeyIndex);

Remarks

This property populates a collection of all subkeys contained in the key.

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

Data Type

SecureBlackboxPGPKey

Users Property (PGPKeyManager Class)

Users available in the key.

Syntax

SecureBlackboxList<SecureBlackboxPGPUser>* GetUsers();

int secureblackbox_pgpkeymanager_getusercount(void* lpObj);

int64 secureblackbox_pgpkeymanager_getuserhandle(void* lpObj, int userindex);

char* secureblackbox_pgpkeymanager_getuserusername(void* lpObj, int userindex);

int GetUserCount();

qint64 GetUserHandle(int iUserIndex);

QString GetUserUsername(int iUserIndex);

Remarks

This property populates a collection of all users contained in the key.

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

Data Type

SecureBlackboxPGPUser

ChangePassphrase Method (PGPKeyManager Class)

Changes the password of the secret key.

Syntax

ANSI (Cross Platform)
int ChangePassphrase(const char* lpszOldPassphrase, const char* lpszNewPassphrase);

Unicode (Windows)
INT ChangePassphrase(LPCWSTR lpszOldPassphrase, LPCWSTR lpszNewPassphrase);

int secureblackbox_pgpkeymanager_changepassphrase(void* lpObj, const char* lpszOldPassphrase, const char* lpszNewPassphrase);

int ChangePassphrase(const QString& qsOldPassphrase, const QString& qsNewPassphrase);

Remarks

Call this method to change the password that protects the secret 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.)

ChangeProtection Method (PGPKeyManager Class)

Changes the protection level of the secret key.

Syntax

ANSI (Cross Platform)
int ChangeProtection(const char* lpszOldPassphrase, const char* lpszNewPassphrase, int iProtType, const char* lpszEncAlgorithm, const char* lpszHashAlgorithm);

Unicode (Windows)
INT ChangeProtection(LPCWSTR lpszOldPassphrase, LPCWSTR lpszNewPassphrase, INT iProtType, LPCWSTR lpszEncAlgorithm, LPCWSTR lpszHashAlgorithm);

int secureblackbox_pgpkeymanager_changeprotection(void* lpObj, const char* lpszOldPassphrase, const char* lpszNewPassphrase, int iProtType, const char* lpszEncAlgorithm, const char* lpszHashAlgorithm);

int ChangeProtection(const QString& qsOldPassphrase, const QString& qsNewPassphrase, int iProtType, const QString& qsEncAlgorithm, const QString& qsHashAlgorithm);

Remarks

Use this method to change the protection level of the Key.

OldPassphrase specifies the current password to decrypt the key, NewPassphrase is the new password for the key, ProtType is the new protection type (see Protection for more details), EncAlgorithm is the key encryption algorithm, and


SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXT	`Plaintext`
SB_PGP_SYMMETRIC_ALGORITHM_IDEA	`Idea`
SB_PGP_SYMMETRIC_ALGORITHM_3DES	`3DES`
SB_PGP_SYMMETRIC_ALGORITHM_CAST5	`CAST5`
SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISH	`Blowfish`
SB_PGP_SYMMETRIC_ALGORITHM_AES128	`AES128`
SB_PGP_SYMMETRIC_ALGORITHM_AES192	`AES192`
SB_PGP_SYMMETRIC_ALGORITHM_AES256	`AES256`
SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256	`Twofish256`

and HashAlgorithm specify the algorithms to be used for key derivation.


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
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_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

Error Handling (C++)

CheckPassphrase Method (PGPKeyManager Class)

Checks if the password matches the secret key.

Syntax

ANSI (Cross Platform)
bool CheckPassphrase(const char* lpszPassphrase);

Unicode (Windows)
INT CheckPassphrase(LPCWSTR lpszPassphrase);

bool secureblackbox_pgpkeymanager_checkpassphrase(void* lpObj, const char* lpszPassphrase);

bool CheckPassphrase(const QString& qsPassphrase);

Remarks

Use this method to check if a password can decrypt the Key.

Error Handling (C++)

This method returns a Boolean 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.

Config Method (PGPKeyManager Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_pgpkeymanager_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.

CreateKey Method (PGPKeyManager Class)

Generates a new key.

Syntax

ANSI (Cross Platform)
int CreateKey(int iVersion, const char* lpszAlgorithm, int iBits, const char* lpszValidTo, const char* lpszPassword);

Unicode (Windows)
INT CreateKey(INT iVersion, LPCWSTR lpszAlgorithm, INT iBits, LPCWSTR lpszValidTo, LPCWSTR lpszPassword);

int secureblackbox_pgpkeymanager_createkey(void* lpObj, int iVersion, const char* lpszAlgorithm, int iBits, const char* lpszValidTo, const char* lpszPassword);

int CreateKey(int iVersion, const QString& qsAlgorithm, int iBits, const QString& qsValidTo, const QString& qsPassword);

Remarks

Use this method to generate a new key with the provided parameters.

Error Handling (C++)

CreateSubkey Method (PGPKeyManager Class)

Generates a new subkey.

Syntax

ANSI (Cross Platform)
int CreateSubkey(const char* lpszAlgorithm, int iBits, const char* lpszValidTo, const char* lpszPassword);

Unicode (Windows)
INT CreateSubkey(LPCWSTR lpszAlgorithm, INT iBits, LPCWSTR lpszValidTo, LPCWSTR lpszPassword);

int secureblackbox_pgpkeymanager_createsubkey(void* lpObj, const char* lpszAlgorithm, int iBits, const char* lpszValidTo, const char* lpszPassword);

int CreateSubkey(const QString& qsAlgorithm, int iBits, const QString& qsValidTo, const QString& qsPassword);

Remarks

Use this method to generate a new subkey with the provided parameters.

Error Handling (C++)

CreateUser Method (PGPKeyManager Class)

Adds a user to an existing key.

Syntax

ANSI (Cross Platform)
int CreateUser(const char* lpszUsername);

Unicode (Windows)
INT CreateUser(LPCWSTR lpszUsername);

int secureblackbox_pgpkeymanager_createuser(void* lpObj, const char* lpszUsername);

int CreateUser(const QString& qsUsername);

Remarks

Use this method to add a user to an existing key. A typical format for a PGP key usage is "Name <email>", for example "John Johnson <john@johnson.com>".

Error Handling (C++)

DoAction Method (PGPKeyManager 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_pgpkeymanager_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

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

Remarks

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

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling (C++)

ExportBytes Method (PGPKeyManager Class)

Serializes the key to a byte array.

Syntax

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

Unicode (Windows)
LPSTR ExportBytes(BOOL bSecret, LPINT lpSize = NULL);

char* secureblackbox_pgpkeymanager_exportbytes(void* lpObj, int bSecret, int *lpSize);

QByteArray ExportBytes(bool bSecret);

Remarks

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

Error Handling (C++)

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

ExportToFile Method (PGPKeyManager Class)

Exports the key to a file.

Syntax

ANSI (Cross Platform)
int ExportToFile(const char* lpszFileName, int bSecret);

Unicode (Windows)
INT ExportToFile(LPCWSTR lpszFileName, BOOL bSecret);

int secureblackbox_pgpkeymanager_exporttofile(void* lpObj, const char* lpszFileName, int bSecret);

int ExportToFile(const QString& qsFileName, bool bSecret);

Remarks

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

Error Handling (C++)

ExportToStream Method (PGPKeyManager Class)

Exports the key to a stream.

Syntax

ANSI (Cross Platform)
int ExportToStream(SecureBlackboxStream* sKeyStream, int bSecret);

Unicode (Windows)
INT ExportToStream(SecureBlackboxStream* sKeyStream, BOOL bSecret);

int secureblackbox_pgpkeymanager_exporttostream(void* lpObj, SecureBlackboxStream* sKeyStream, int bSecret);

int ExportToStream(SecureBlackboxStream* sKeyStream, bool bSecret);

Remarks

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

Error Handling (C++)

GeneratePair Method (PGPKeyManager Class)

Generates a new pair of PGP keys.

Syntax

ANSI (Cross Platform)
int GeneratePair(int iVersion, const char* lpszUsername, int iStrength, const char* lpszValidTo, const char* lpszPassword);

Unicode (Windows)
INT GeneratePair(INT iVersion, LPCWSTR lpszUsername, INT iStrength, LPCWSTR lpszValidTo, LPCWSTR lpszPassword);

int secureblackbox_pgpkeymanager_generatepair(void* lpObj, int iVersion, const char* lpszUsername, int iStrength, const char* lpszValidTo, const char* lpszPassword);

int GeneratePair(int iVersion, const QString& qsUsername, int iStrength, const QString& qsValidTo, const QString& qsPassword);

Remarks

Use this method to create a standard key-subkey pair. This is the primary method for generating conformant PGP keys.

Pass the user ID of the new key via the Username property. This typically should be in the format of User Name <user@email>, for example Robert Frost <robert@frost.com>, but generally can be an arbitrary text string.

This method generates a 'standard' keypair based on the Version and Strength parameters. This can range from RSA keys for version 3 to strong Ed25519 keys for version 6.

The following PGP key versions and strengths are supported:


pvDefault	`0`	The default version (situation-specific)
pv3	`3`	Version 3
pv4	`4`	Version 4
pv5	`5`	Version 5
pv6	`6`	Version 6


psNormal	`0`	Normal strength
psStrong	`1`	Increased strength

Provide the key encryption password and the validity period in days via the Password and ValidTo parameters.

Error Handling (C++)

ImportBytes Method (PGPKeyManager Class)

Loads a key from a byte array.

Syntax

ANSI (Cross Platform)
int ImportBytes(const char* lpKey, int lenKey);

Unicode (Windows)
INT ImportBytes(LPCSTR lpKey, INT lenKey);

int secureblackbox_pgpkeymanager_importbytes(void* lpObj, const char* lpKey, int lenKey);

int ImportBytes(QByteArray qbaKey);

Remarks

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

Error Handling (C++)

ImportFromFile Method (PGPKeyManager Class)

Loads a key from a file.

Syntax

ANSI (Cross Platform)
int ImportFromFile(const char* lpszFileName);

Unicode (Windows)
INT ImportFromFile(LPCWSTR lpszFileName);

int secureblackbox_pgpkeymanager_importfromfile(void* lpObj, const char* lpszFileName);

int ImportFromFile(const QString& qsFileName);

Remarks

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

Error Handling (C++)

ImportFromStream Method (PGPKeyManager Class)

Loads a key from a stream.

Syntax

ANSI (Cross Platform)
int ImportFromStream(SecureBlackboxStream* sKeyStream);

Unicode (Windows)
INT ImportFromStream(SecureBlackboxStream* sKeyStream);

int secureblackbox_pgpkeymanager_importfromstream(void* lpObj, SecureBlackboxStream* sKeyStream);

int ImportFromStream(SecureBlackboxStream* sKeyStream);

Remarks

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

Error Handling (C++)

ImportPinned Method (PGPKeyManager Class)

Loads a key from a pinned key object.

Syntax

ANSI (Cross Platform)
int ImportPinned();

Unicode (Windows)
INT ImportPinned();

int secureblackbox_pgpkeymanager_importpinned(void* lpObj);

int ImportPinned();

Remarks

Use this method to load a PGP key from a PinnedKey object. This is an easy way to import a key object from a keyring.

Error Handling (C++)

RemoveSignature Method (PGPKeyManager Class)

Unbinds the specified signature from the key, subkey or user.

Syntax

ANSI (Cross Platform)
int RemoveSignature(int iIndex);

Unicode (Windows)
INT RemoveSignature(INT iIndex);

int secureblackbox_pgpkeymanager_removesignature(void* lpObj, int iIndex);

int RemoveSignature(int iIndex);

Remarks

Use this method to remove the specified signature from the list of Signatures bound to the key, subkey or user.

Error Handling (C++)

RemoveSubkey Method (PGPKeyManager Class)

Removes the specified subkey from the key.

Syntax

ANSI (Cross Platform)
int RemoveSubkey(int iIndex);

Unicode (Windows)
INT RemoveSubkey(INT iIndex);

int secureblackbox_pgpkeymanager_removesubkey(void* lpObj, int iIndex);

int RemoveSubkey(int iIndex);

Remarks

Use this method to remove the subkey referred by its Index from the key.

Error Handling (C++)

RemoveUser Method (PGPKeyManager Class)

Unbinds the specified user from the key.

Syntax

ANSI (Cross Platform)
int RemoveUser(int iIndex);

Unicode (Windows)
INT RemoveUser(INT iIndex);

int secureblackbox_pgpkeymanager_removeuser(void* lpObj, int iIndex);

int RemoveUser(int iIndex);

Remarks

Use this method to remove the specified user from the list of UserIDs bound to the key.

Error Handling (C++)

Reset Method (PGPKeyManager Class)

Creates a new empty keyring.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_pgpkeymanager_reset(void* lpObj);

int Reset();

Remarks

Use this method to initialize a new empty keyring.

Error Handling (C++)

RevokeKey Method (PGPKeyManager Class)

Revokes the key.

Syntax

ANSI (Cross Platform)
int RevokeKey(int iReason, const char* lpszComment);

Unicode (Windows)
INT RevokeKey(INT iReason, LPCWSTR lpszComment);

int secureblackbox_pgpkeymanager_revokekey(void* lpObj, int iReason, const char* lpszComment);

int RevokeKey(int iReason, const QString& qsComment);

Remarks

Use this method to revoke the key by adding a revocation signature.

Error Handling (C++)

RevokeSubkey Method (PGPKeyManager Class)

Revokes the key's subkey.

Syntax

ANSI (Cross Platform)
int RevokeSubkey(int iIndex, int iReason, const char* lpszComment);

Unicode (Windows)
INT RevokeSubkey(INT iIndex, INT iReason, LPCWSTR lpszComment);

int secureblackbox_pgpkeymanager_revokesubkey(void* lpObj, int iIndex, int iReason, const char* lpszComment);

int RevokeSubkey(int iIndex, int iReason, const QString& qsComment);

Remarks

Use this method to revoke the subkey with a given Index by adding a revocation signature.

Error Handling (C++)

RevokeUser Method (PGPKeyManager Class)

Revokes a user certification.

Syntax

ANSI (Cross Platform)
int RevokeUser(int iIndex, int iReason, const char* lpszComment);

Unicode (Windows)
INT RevokeUser(INT iIndex, INT iReason, LPCWSTR lpszComment);

int secureblackbox_pgpkeymanager_revokeuser(void* lpObj, int iIndex, int iReason, const char* lpszComment);

int RevokeUser(int iIndex, int iReason, const QString& qsComment);

Remarks

Use this method to revoke the user with the specified Index by adding a revocation signature to the key.

Error Handling (C++)

SignKey Method (PGPKeyManager Class)

Sign the key.

Syntax

ANSI (Cross Platform)
int SignKey(const char* lpszKeyValidTo, const char* lpszHashAlgorithm, const char* lpszPreferredAlgs, int iKeyFlags);

Unicode (Windows)
INT SignKey(LPCWSTR lpszKeyValidTo, LPCWSTR lpszHashAlgorithm, LPCWSTR lpszPreferredAlgs, INT iKeyFlags);

int secureblackbox_pgpkeymanager_signkey(void* lpObj, const char* lpszKeyValidTo, const char* lpszHashAlgorithm, const char* lpszPreferredAlgs, int iKeyFlags);

int SignKey(const QString& qsKeyValidTo, const QString& qsHashAlgorithm, const QString& qsPreferredAlgs, int iKeyFlags);

Remarks

Use this method to sign the key.

Error Handling (C++)

SignSubkey Method (PGPKeyManager Class)

Sign the key's subkey.

Syntax

ANSI (Cross Platform)
int SignSubkey(int iIndex, const char* lpszKeyValidTo, const char* lpszHashAlgorithm, const char* lpszPreferredAlgs, int iKeyFlags);

Unicode (Windows)
INT SignSubkey(INT iIndex, LPCWSTR lpszKeyValidTo, LPCWSTR lpszHashAlgorithm, LPCWSTR lpszPreferredAlgs, INT iKeyFlags);

int secureblackbox_pgpkeymanager_signsubkey(void* lpObj, int iIndex, const char* lpszKeyValidTo, const char* lpszHashAlgorithm, const char* lpszPreferredAlgs, int iKeyFlags);

int SignSubkey(int iIndex, const QString& qsKeyValidTo, const QString& qsHashAlgorithm, const QString& qsPreferredAlgs, int iKeyFlags);

Remarks

Use this method to sign the subkey with a given Index.

Error Handling (C++)

SignUser Method (PGPKeyManager Class)

Sign a user certification.

Syntax

ANSI (Cross Platform)
int SignUser(int iIndex, const char* lpszKeyValidTo, const char* lpszHashAlgorithm, int bPrimary, int iCertType);

Unicode (Windows)
INT SignUser(INT iIndex, LPCWSTR lpszKeyValidTo, LPCWSTR lpszHashAlgorithm, BOOL bPrimary, INT iCertType);

int secureblackbox_pgpkeymanager_signuser(void* lpObj, int iIndex, const char* lpszKeyValidTo, const char* lpszHashAlgorithm, int bPrimary, int iCertType);

int SignUser(int iIndex, const QString& qsKeyValidTo, const QString& qsHashAlgorithm, bool bPrimary, int iCertType);

Remarks

Use this method to sign the user with the specified Index.

Error Handling (C++)

Verify Method (PGPKeyManager Class)

Verifies the integrity of a key signature.

Syntax

ANSI (Cross Platform)
bool Verify(int iIndex);

Unicode (Windows)
INT Verify(INT iIndex);

bool secureblackbox_pgpkeymanager_verify(void* lpObj, int iIndex);

bool Verify(int iIndex);

Remarks

Use this method to validate a key signature. Provide the index of the signature as a parameter.

Error Handling (C++)

Error Event (PGPKeyManager Class)

Information about errors during PGP key management.

Syntax

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

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


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

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

#define EID_PGPKEYMANAGER_ERROR 1

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

class PGPKeyManagerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass PGPKeyManager and override this emitter function.
virtual int FireError(PGPKeyManagerErrorEventParams *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.

KeyPassphraseNeeded Event (PGPKeyManager Class)

Requests a key protection password from the application.

Syntax

ANSI (Cross Platform)
virtual int FireKeyPassphraseNeeded(PGPKeyManagerKeyPassphraseNeededEventParams *e);

typedef struct {
  const char *KeyID;
  const char *UserID;
  int MainKey;
  char *Passphrase;
  int Skip;
  int reserved;
} PGPKeyManagerKeyPassphraseNeededEventParams;


Unicode (Windows)
virtual INT FireKeyPassphraseNeeded(PGPKeyManagerKeyPassphraseNeededEventParams *e);

typedef struct {
  LPCWSTR KeyID;
  LPCWSTR UserID;
  BOOL MainKey;
  LPWSTR Passphrase;
  BOOL Skip;
  INT reserved;
} PGPKeyManagerKeyPassphraseNeededEventParams;

#define EID_PGPKEYMANAGER_KEYPASSPHRASENEEDED 2

virtual INT SECUREBLACKBOX_CALL FireKeyPassphraseNeeded(LPSTR &lpszKeyID, LPSTR &lpszUserID, BOOL &bMainKey, LPSTR &lpszPassphrase, BOOL &bSkip);

class PGPKeyManagerKeyPassphraseNeededEventParams {
public:
  const QString &KeyID();

  const QString &UserID();

  bool MainKey();

  const QString &Passphrase();
  void SetPassphrase(const QString &qsPassphrase);

  bool Skip();
  void SetSkip(bool bSkip);

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

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

// Or, subclass PGPKeyManager and override this emitter function.
virtual int FireKeyPassphraseNeeded(PGPKeyManagerKeyPassphraseNeededEventParams *e) {...}

Remarks

The class fires this event to request a secret key passphrase from the application. Note that this event asks for a key protection passphrase rather than a message protection passphrase. The class fires it when it attempts to use a secret key to sign the data.

This event is fired for every protected secret key residing in SigningKeys. KeyID specifies the key for which the password is requested, and UserID identifies its user. MainKey tells whether the key is a master key or a subkey.

The handler should provide password via the Passphrase parameter, or set Skip to True to skip this key.

For each key KeyPassphraseNeeded is called in a loop until the correct password is provided or the maximum number of password attempts reached.

Notification Event (PGPKeyManager Class)

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

Syntax

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

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


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

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

#define EID_PGPKEYMANAGER_NOTIFICATION 3

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

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

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

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

PGPKey Type

This container represents a PGP key.

Syntax

SecureBlackboxPGPKey (declared in secureblackbox.h)

Remarks

OpenPGP standard supports several types of keys. In our days, a typical OpenPGP keypair actually consists of two cryptographic keys: a primary key and a subkey. The primary key is normally used for signing, while the subkey is used for encryption.

While it is typical for PGP environments to use a primary key/subkey bundle, this is not a must. Sometimes you may come across standalone keys (mainly when dealing with older implementations), as well as whole key trees, each of those carrying a bunch of differently-purposed subkeys bound to the same primary key.

Algorithm-wise, OpenPGP keys also differ. Generally speaking, OpenPGP supports the following public key algorithms: RSA, Elgamal (often incorrectly referred to as DH), DSA, ECDH and ECDSA. When it comes to primary key/subkey bundles, DSA/Elgamal, RSA/RSA and ECDSA/ECDH pairs are typically used. Although there's no restriction on algorithm bundles, and, e.g. a ECDSA/Elgamal key bundle is perfectly possible, such combination is rarely used in practice.

A typical OpenPGP key is associated with some kind of user ID (Username). It is normally represented with a user's e-mail address, while in theory can be any piece of text. The secret part of the OpenPGP keypair is protected with a password (Passphrase).

The following fields are available:

Fields

BitsInKey
int (read-only)
Default Value: 2048

Indicates the key length in bits.

CanEncrypt
int (read-only)
Default Value: FALSE

Returns True if this key can be used for encryption.

CanSign
int (read-only)
Default Value: FALSE

Returns True if this key can be used for signing.

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

Indicates the elliptic curve associated with a EC key.

Supported values:


SB_PGP_CURVE_P256	`P256`
SB_PGP_CURVE_P384	`P384`
SB_PGP_CURVE_P521	`P521`
SB_PGP_CURVE_ED25519	`ED25519`
SB_PGP_CURVE_CURVE25519	`CURVE25519`
SB_PGP_CURVE_BRAINPOOLP256R1	`BRAINPOOLP256`
SB_PGP_CURVE_BRAINPOOLP512R1	`BRAINPOOLP512`

Enabled
int
Default Value: FALSE

Enables or disables this key for use in encryption or signing operation.

EncryptionAlgorithm
char* (read-only)
Default Value: "AES128"

Indicates the symmetric algorithm used to encrypt the secret key.

Handle
int64
Default Value: 0

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

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());

IsPublic
int (read-only)
Default Value: FALSE

Returns True if this key is a public key, and False otherwise.

IsSecret
int (read-only)
Default Value: FALSE

Returns True if this key is a secret key, and False otherwise.

IsSubkey
int (read-only)
Default Value: FALSE

Returns True if this key is a subkey of another key, and False otherwise.

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

The 20-byte fingerprint (hash value) of this key.

KeyFP could be used to distinguish two keys with the same KeyID.

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

Contains a 8-byte key identifier.

It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.

Passphrase
char*
Default Value: ""

The key protection password.

PassphraseValid
int (read-only)
Default Value: FALSE

Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.

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

If this key is a subkey (IsSubkey returns True), this field contains the identifier of the subkey's primary key.

Protection
int (read-only)
Default Value: 0

Specifies the level of protection applied to the secret key.

Allowed values:


pptNone	`0`	Key is not encrypted
pptLow	`1`	Only the password hash is used to derive the secret key
pptNormal	`2`	Password hash with salt is used to derive the secret key
pptHigh	`3`	Hash from multiple passwords and salt are used for key derivation

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

Specifies the asymmetric algorithm of the key.

QBits
int (read-only)
Default Value: 0

The length of the DSA Q (legitimate range: 160-512).

This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used.

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

Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).

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

Specifies the name of the user bound to this key.

The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.

ValidTo
char* (read-only)
Default Value: "0"

Provide accurate expiration moment indication. This is different to expires property which only contains expiration time in days in old keys.

Version
int (read-only)
Default Value: 0

Indicates the key version.

The key version refers to the version of the public-key packet format as defined in RFC 4880.

Only four versions are currently allowed here: 3, 4, 5 and 6. It is recommended that all new keys are created with version of 6.

Constructors

PGPKey()

Creates an empty PGP key object.

PGPSignature Type

A container for PGP signature properties.

Syntax

SecureBlackboxPGPSignature (declared in secureblackbox.h)

Remarks

PGPSignature contains details and validation information for a PGP signature.

The following fields are available:

Fields

CertificationType
int (read-only)
Default Value: 0

Specifies the type of a UserID signature.


pctGeneric	`0`	Generic certification of a User ID and Public Key packet. The issuer of this certification does not make any particular assertion as to how well the certifier has checked that the owner of the key is in fact the person described by the User ID. By default user certifications use Generic type.
pctPersona	`1`	Persona certification of a User ID and Public Key packet. The issuer of this certification has not done any verification of the claim that the owner of this key corresponds to the specified User ID.
pctCasual	`2`	Casual certification of a User ID and a Public Key packet. The issuer of this certification has done some casual verification of the claim of identity.
pctPositive	`3`	Positive certification of a User ID and a Public Key packet. The issuer of this certification has done substantial verification of the claim of identity.

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

The time when the signature was created, in Universal Coordinated Time (UTC).

ExpirationTime
int (read-only)
Default Value: 0

Specifies signature expiration time, in seconds since its creation time (CreationTime).

Ths property set to 0 indicates that the signature never expires.

Exportable
int (read-only)
Default Value: FALSE

Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.

Handle
int64
Default Value: 0

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

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

Specifies the hash algorithm used in the signature.

HashMark
int (read-only)
Default Value: 0

Returns the hash mark attribute of a signature.

Check this property to get a hash mark of a signature.

KeyExpirationTime
int (read-only)
Default Value: 0

The number of seconds after which the signed key will expire.

KeyFlags
int (read-only)
Default Value: 0

Returns the key flags included in the signature.

Use this property to retrieve the key flags stored in the key signature.

LegacyFormat
int (read-only)
Default Value: FALSE

Indicates whether signature uses PGP 2.6.x-compatible packet format.

The signature is fully compatible with the 'old' format only if it has version 3, uses MD5 hash algorithm, RSA public key algorithm, and its key length is not greater than 1024 bits.

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

Contains the URL of the signature policy.

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

Contains a list of algorithms preferred by the signed key holder.

PrimaryUserID
int (read-only)
Default Value: FALSE

Indicates whether the UserID covered by the signature is the main user id for this key.

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

Describes the reason why the key or the certificate was revoked.

Revocable
int (read-only)
Default Value: FALSE

Specifies whether the signature can be revoked.

Revocation
int (read-only)
Default Value: FALSE

Indicates whether or not the signature is a revocation signature.

SignatureClass
int (read-only)
Default Value: 0

Indicates the signature class.


pscDocument	`0`	Signature over binary file
pscTextDocument	`1`	Signature over text
pscStandalone	`2`	A standalone signature
pscUIDGeneric	`3`	User certification signature
pscUIDPersona	`4`	User certification signature (persona)
pscUIDCasual	`5`	User certification signature (casual)
pscUIDPositive	`6`	User certification signature (positive)
pscSubkeyBinding	`7`	Subkey binding signature
pscPrimaryKeyBinding	`8`	Primary key binding signature
pscDirectKey	`9`	Direct signature over a public key
pscKeyRevocation	`10`	Key revocation
pscSubkeyRevocation	`11`	Subkey revocation
pscCertRevocation	`12`	User revocation
pscTimestamp	`13`	Timestamp signature
pscThirdParty	`14`	Third-party signature
pscNotSpecified	`15`	Signature type not provided

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

Indicates the KeyID of the signing key.

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

Indicates the UserID associated with the signing key.

StrictlyValid
int (read-only)
Default Value: FALSE

Returns True if this signature is valid in a strict way (no compatibility relaxations).

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

Indicates the KeyID or Username of the target key or user.

TextSignature
int (read-only)
Default Value: FALSE

Indicates whether or not the signature is made over a text document.

TrustAmount
int (read-only)
Default Value: 0

Specifies the amount of trust assigned by this signature.

Specifies the amount of trust, in range 0-255, interpreted such that values less than 120 indicate partial trust and values of 120 or greater indicate complete trust.

TrustLevel
int (read-only)
Default Value: 0

The trust level assigned by this signature.

Level 1 means that the signed key is asserted to be a valid trusted introducer, with the 2nd octet of the body specifying the degree of trust. Level n means that the signed key is asserted to be trusted to issue level (n-1)-trust signatures.

Validated
int (read-only)
Default Value: FALSE

Whether the signature has been validated.

Validity
int (read-only)
Default Value: 0

Provides the validity status of the signature if the signature has been validated.


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

Version
int (read-only)
Default Value: 0

Indicates the signature version.

RFC 4880 defines two versions for PGP signatures: 3 and 4.

Constructors

PGPSignature()

Creates an empty PGPSignature object.

PGPUser Type

A container for PGP user properties.

Syntax

SecureBlackboxPGPUser (declared in secureblackbox.h)

Remarks

PGPUser contains details information for a PGP user.

The following fields are available:

Handle

Username

Fields

Handle
int64
Default Value: 0

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

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

Specifies the user name of user.

Constructors

PGPUser()

Creates an empty PGPUser object.

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the PGPKeyManager class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The PGPKeyManager 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 PGPKeyManager class an instance of that concrete class.

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

Properties

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

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

Config Settings (PGPKeyManager 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.

PGPKeyManager Config Settings

Armor: Enables or disables ASCII armouring.

Adjust this setting to enable or disable ASCII armouring on the outgoing messages.

ArmorBoundary: Specifies the armour boundary/title.

Use this setting to specify custom ASCII armouring titles that go after the -----BEGIN and -----END tokens.

ArmorHeaders: Specifies armour headers.

Use this setting to provide custom ASCII armouring (PEM) headers that should be included in the output.

HashAlgorithm: TBD.

TBD

KeyHashAlgorithm: TBD.

TBD

RawKeyFormat: TBD.

TBD

SignatureCreationTime: TBD.

TBD

SignatureExpirationTime: TBD.

TBD

SignatureHashAlgorithm: TBD.

TBD

SubkeyIndex: TBD.

TBD

UseLongKeyIDs: TBD.

TBD

Base Config Settings

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

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

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

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

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

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

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

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

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

Supported values are:


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

Cookies: Gets or sets local cookies for the class.

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

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

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

DNSLocalSuffix: The suffix to assign for TLD names.

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

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

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

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

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

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

HardwareCryptoUsePolicy: The hardware crypto usage policy.

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

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

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

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

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

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

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

ListDelimiter: The delimiter character for multi-element lists.

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

LogDestination: Specifies the debug log destination.

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

Supported values are:


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

LogDetails: Specifies the debug log details to dump.

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

Supported values are:


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

LogFile: Specifies the debug log filename.

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

LogFilters: Specifies the debug log filters.

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

Supported filter names are:


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

LogFlushMode: Specifies the log flush mode.

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


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

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


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

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

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

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

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


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

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

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

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

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

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

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

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

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

ProductVersion: Returns the version of the SecureBlackbox library.

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

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

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

StaticDNS: Specifies whether static DNS rules should be used.

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

Supported values are:


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

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

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

StaticIPAddresses: Gets or sets all the static DNS rules.

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

Tag: Allows to store any custom data.

Use this config property to store any custom data.

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

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

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

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

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

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

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

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

UseLegacyAdESValidation: Enables legacy AdES validation mode.

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

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

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

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

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

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

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

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

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

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

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

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

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

PGPKeyManager Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)
27262977	The file was not found (`SB_ERROR_PGP_FILE_NOT_EXISTS`)
27262978	Invalid signing key (`SB_ERROR_PGP_INVALID_KEY`)
27262980	No secret key is available (`SB_ERROR_PGP_NO_SECRET_KEY`)
27262982	The operation is not supported on a subkey (`SB_ERROR_PGP_OPERATION_ON_SUBKEY`)