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.

FIPSModeReserved.
KeyBitsInKeyIndicates the key length in bits.
KeyCurveIndicates the elliptic curve associated with a EC key.
KeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
KeyExpiresIndicates key expiration time in whole days from its generation moment.
KeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KeyHashAlgorithmSpecifies the hash algorithm associated with the key.
KeyOldPacketFormatIndicates whether legacy (PGP 2.
KeyPassphraseThe key protection password.
KeyProtectionSpecifies the level of protection applied to the secret key.
KeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
KeyQBitsThe length of the DSA Q (legitimate range: 160-512).
KeyUsernameSpecifies the name of the user bound to this 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.

AddSubkeyAdds a new subkey to the Key.
BindUserBinds a new UserID to the Key.
ChangePassphraseChanges the password of the secret key.
ChangeProtectionChanges the protection level of the secret key.
CheckPassphraseChecks if the password matches the secret key.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
ExportKeySerializes the key to a byte array.
ExportPublicKeyExports the public key to a byte array.
ExportPublicToFileExports the public key to a file.
ExportPublicToStreamExports the public key to a stream.
ExportToFileExports the key to a file.
ExportToStreamExports the key to a stream.
GenerateGenerates a new single PGP key.
GenerateLegacyGenerates a new key in the old format.
GeneratePairGenerates a new pair of PGP keys.
ImportFromFileLoads a key from a file.
ImportFromStreamLoads a key from a stream.
ImportKeyLoads a key from a byte array.
RemoveSubkeyRemoves the specified subkey from the key.
RemoveUserUnbinds the specified user from the key.
RevokeKeyRevokes the key.
RevokeSubkeyRevokes the key's subkey.
RevokeSubkeybyIDRevokes the key's subkey.
RevokeUserRevokes a user certification.
RevokeUserByNameRevokes a user certification.
ValidateValidates the key.

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.

ErrorInformation about errors during PGP key management.
NotificationThis 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.

TempPathPath for storing temporary files.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

FIPSMode Property (PGPKeyManager Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_pgpkeymanager_getfipsmode(void* lpObj);
int secureblackbox_pgpkeymanager_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

KeyBitsInKey Property (PGPKeyManager Class)

Indicates the key length in bits.

Syntax

ANSI (Cross Platform)
int GetKeyBitsInKey();
int SetKeyBitsInKey(int iKeyBitsInKey); Unicode (Windows) INT GetKeyBitsInKey();
INT SetKeyBitsInKey(INT iKeyBitsInKey);
int secureblackbox_pgpkeymanager_getkeybitsinkey(void* lpObj);
int secureblackbox_pgpkeymanager_setkeybitsinkey(void* lpObj, int iKeyBitsInKey);
int GetKeyBitsInKey();
int SetKeyBitsInKey(int iKeyBitsInKey);

Default Value

2048

Remarks

Indicates the key length in bits.

This property is not available at design time.

Data Type

Integer

KeyCurve Property (PGPKeyManager Class)

Indicates the elliptic curve associated with a EC key.

Syntax

ANSI (Cross Platform)
char* GetKeyCurve();
int SetKeyCurve(const char* lpszKeyCurve); Unicode (Windows) LPWSTR GetKeyCurve();
INT SetKeyCurve(LPCWSTR lpszKeyCurve);
char* secureblackbox_pgpkeymanager_getkeycurve(void* lpObj);
int secureblackbox_pgpkeymanager_setkeycurve(void* lpObj, const char* lpszKeyCurve);
QString GetKeyCurve();
int SetKeyCurve(QString qsKeyCurve);

Default Value

""

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

SB_PGP_CURVE_P256P256
SB_PGP_CURVE_P384P384
SB_PGP_CURVE_P521P521
SB_PGP_CURVE_ED25519ED25519
SB_PGP_CURVE_CURVE25519CURVE25519
SB_PGP_CURVE_BRAINPOOLP256R1BRAINPOOLP256
SB_PGP_CURVE_BRAINPOOLP512R1BRAINPOOLP512

This property is not available at design time.

Data Type

String

KeyEncryptionAlgorithm Property (PGPKeyManager Class)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

ANSI (Cross Platform)
char* GetKeyEncryptionAlgorithm();
int SetKeyEncryptionAlgorithm(const char* lpszKeyEncryptionAlgorithm); Unicode (Windows) LPWSTR GetKeyEncryptionAlgorithm();
INT SetKeyEncryptionAlgorithm(LPCWSTR lpszKeyEncryptionAlgorithm);
char* secureblackbox_pgpkeymanager_getkeyencryptionalgorithm(void* lpObj);
int secureblackbox_pgpkeymanager_setkeyencryptionalgorithm(void* lpObj, const char* lpszKeyEncryptionAlgorithm);
QString GetKeyEncryptionAlgorithm();
int SetKeyEncryptionAlgorithm(QString qsKeyEncryptionAlgorithm);

Default Value

"CAST5"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

This property is not available at design time.

Data Type

String

KeyExpires Property (PGPKeyManager Class)

Indicates key expiration time in whole days from its generation moment.

Syntax

ANSI (Cross Platform)
int GetKeyExpires();
int SetKeyExpires(int iKeyExpires); Unicode (Windows) INT GetKeyExpires();
INT SetKeyExpires(INT iKeyExpires);
int secureblackbox_pgpkeymanager_getkeyexpires(void* lpObj);
int secureblackbox_pgpkeymanager_setkeyexpires(void* lpObj, int iKeyExpires);
int GetKeyExpires();
int SetKeyExpires(int iKeyExpires);

Default Value

0

Remarks

Indicates key expiration time in whole days from its generation moment. The value of 0 indicates that the key does not expire.

This property is not available at design time.

Data Type

Integer

KeyHandle Property (PGPKeyManager 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_pgpkeymanager_getkeyhandle(void* lpObj);
int secureblackbox_pgpkeymanager_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

KeyHashAlgorithm Property (PGPKeyManager Class)

Specifies the hash algorithm associated with the key.

Syntax

ANSI (Cross Platform)
char* GetKeyHashAlgorithm();
int SetKeyHashAlgorithm(const char* lpszKeyHashAlgorithm); Unicode (Windows) LPWSTR GetKeyHashAlgorithm();
INT SetKeyHashAlgorithm(LPCWSTR lpszKeyHashAlgorithm);
char* secureblackbox_pgpkeymanager_getkeyhashalgorithm(void* lpObj);
int secureblackbox_pgpkeymanager_setkeyhashalgorithm(void* lpObj, const char* lpszKeyHashAlgorithm);
QString GetKeyHashAlgorithm();
int SetKeyHashAlgorithm(QString qsKeyHashAlgorithm);

Default Value

"SHA256"

Remarks

Specifies the hash algorithm associated with the key.

This property is not available at design time.

Data Type

String

KeyOldPacketFormat Property (PGPKeyManager Class)

Indicates whether legacy (PGP 2.

Syntax

ANSI (Cross Platform)
int GetKeyOldPacketFormat();
int SetKeyOldPacketFormat(int bKeyOldPacketFormat); Unicode (Windows) BOOL GetKeyOldPacketFormat();
INT SetKeyOldPacketFormat(BOOL bKeyOldPacketFormat);
int secureblackbox_pgpkeymanager_getkeyoldpacketformat(void* lpObj);
int secureblackbox_pgpkeymanager_setkeyoldpacketformat(void* lpObj, int bKeyOldPacketFormat);
bool GetKeyOldPacketFormat();
int SetKeyOldPacketFormat(bool bKeyOldPacketFormat);

Default Value

FALSE

Remarks

Indicates whether legacy (PGP 2.6.x) packet format should be used.

This property is not available at design time.

Data Type

Boolean

KeyPassphrase Property (PGPKeyManager Class)

The key protection password.

Syntax

ANSI (Cross Platform)
char* GetKeyPassphrase();
int SetKeyPassphrase(const char* lpszKeyPassphrase); Unicode (Windows) LPWSTR GetKeyPassphrase();
INT SetKeyPassphrase(LPCWSTR lpszKeyPassphrase);
char* secureblackbox_pgpkeymanager_getkeypassphrase(void* lpObj);
int secureblackbox_pgpkeymanager_setkeypassphrase(void* lpObj, const char* lpszKeyPassphrase);
QString GetKeyPassphrase();
int SetKeyPassphrase(QString qsKeyPassphrase);

Default Value

""

Remarks

The key protection password.

This property is not available at design time.

Data Type

String

KeyProtection Property (PGPKeyManager Class)

Specifies the level of protection applied to the secret key.

Syntax

ANSI (Cross Platform)
int GetKeyProtection();
int SetKeyProtection(int iKeyProtection); Unicode (Windows) INT GetKeyProtection();
INT SetKeyProtection(INT iKeyProtection);

Possible Values

PPT_NONE(0), 
PPT_LOW(1),
PPT_NORMAL(2),
PPT_HIGH(3)
int secureblackbox_pgpkeymanager_getkeyprotection(void* lpObj);
int secureblackbox_pgpkeymanager_setkeyprotection(void* lpObj, int iKeyProtection);
int GetKeyProtection();
int SetKeyProtection(int iKeyProtection);

Default Value

0

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

pptNone0Key is not encrypted
pptLow1Only the password hash is used to derive the secret key
pptNormal2Password hash with salt is used to derive the secret key
pptHigh3Hash from multiple passwords and salt are used for key derivation

This property is not available at design time.

Data Type

Integer

KeyPublicKeyAlgorithm Property (PGPKeyManager Class)

Specifies the asymmetric algorithm of the key.

Syntax

ANSI (Cross Platform)
char* GetKeyPublicKeyAlgorithm();
int SetKeyPublicKeyAlgorithm(const char* lpszKeyPublicKeyAlgorithm); Unicode (Windows) LPWSTR GetKeyPublicKeyAlgorithm();
INT SetKeyPublicKeyAlgorithm(LPCWSTR lpszKeyPublicKeyAlgorithm);
char* secureblackbox_pgpkeymanager_getkeypublickeyalgorithm(void* lpObj);
int secureblackbox_pgpkeymanager_setkeypublickeyalgorithm(void* lpObj, const char* lpszKeyPublicKeyAlgorithm);
QString GetKeyPublicKeyAlgorithm();
int SetKeyPublicKeyAlgorithm(QString qsKeyPublicKeyAlgorithm);

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

This property is not available at design time.

Data Type

String

KeyQBits Property (PGPKeyManager Class)

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

Syntax

ANSI (Cross Platform)
int GetKeyQBits();
int SetKeyQBits(int iKeyQBits); Unicode (Windows) INT GetKeyQBits();
INT SetKeyQBits(INT iKeyQBits);
int secureblackbox_pgpkeymanager_getkeyqbits(void* lpObj);
int secureblackbox_pgpkeymanager_setkeyqbits(void* lpObj, int iKeyQBits);
int GetKeyQBits();
int SetKeyQBits(int iKeyQBits);

Default Value

0

Remarks

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.

This property is not available at design time.

Data Type

Integer

KeyUsername Property (PGPKeyManager Class)

Specifies the name of the user bound to this key.

Syntax

ANSI (Cross Platform)
char* GetKeyUsername();
int SetKeyUsername(const char* lpszKeyUsername); Unicode (Windows) LPWSTR GetKeyUsername();
INT SetKeyUsername(LPCWSTR lpszKeyUsername);
char* secureblackbox_pgpkeymanager_getkeyusername(void* lpObj);
int secureblackbox_pgpkeymanager_setkeyusername(void* lpObj, const char* lpszKeyUsername);
QString GetKeyUsername();
int SetKeyUsername(QString qsKeyUsername);

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

AddSubkey Method (PGPKeyManager Class)

Adds a new subkey to the Key.

Syntax

ANSI (Cross Platform)
int AddSubkey(int iBits, const char* lpszAlgorithm, int iExpires);

Unicode (Windows)
INT AddSubkey(INT iBits, LPCWSTR lpszAlgorithm, INT iExpires);
int secureblackbox_pgpkeymanager_addsubkey(void* lpObj, int iBits, const char* lpszAlgorithm, int iExpires);
int AddSubkey(int iBits, const QString& qsAlgorithm, int iExpires);

Remarks

Use this method to add a subkey to a key. Note that the key you are adding the subkey to needs to contain its secret counterpart to be able to sign the new subkey.

Bits specifies the number of bits in the new subkey, Expires is the new subkey's expiration time and date, and Algorithm specifies its public key algorithm:

SB_PGP_PUBLIC_KEY_ALGORITHM_RSARSA
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_ENCRYPTRSA-encrypt
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_SIGNRSA-sign
SB_PGP_PUBLIC_KEY_ALGORITHM_DSADSA
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDSAECDSA
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDHECDH
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL_ENCRYPTElgamal-encrypt
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMALElgamal
SB_PGP_PUBLIC_KEY_ALGORITHM_EDDSAEDDSA

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

BindUser Method (PGPKeyManager Class)

Binds a new UserID to the Key.

Syntax

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

Unicode (Windows)
INT BindUser(LPCWSTR lpszUsername);
int secureblackbox_pgpkeymanager_binduser(void* lpObj, const char* lpszUsername);
int BindUser(const QString& qsUsername);

Remarks

Use this method to add a new Username as an owner of the Key.

Note that the key needs to contain its secret counterpart to be able to sign the new user ID.

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

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 for more details), EncAlgorithm is the key encryption algorithm, and

SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXTPlaintext
SB_PGP_SYMMETRIC_ALGORITHM_IDEAIdea
SB_PGP_SYMMETRIC_ALGORITHM_3DES3DES
SB_PGP_SYMMETRIC_ALGORITHM_CAST5CAST5
SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish
SB_PGP_SYMMETRIC_ALGORITHM_AES128AES128
SB_PGP_SYMMETRIC_ALGORITHM_AES192AES192
SB_PGP_SYMMETRIC_ALGORITHM_AES256AES256
SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256Twofish256
and HashAlgorithm specify the algorithms to be used for key derivation.
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512

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

CheckPassphrase Method (PGPKeyManager Class)

Checks if the password matches the secret key.

Syntax

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

Unicode (Windows)
INT CheckPassphrase(LPCWSTR lpszPassphrase);
int 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.

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

ExportKey Method (PGPKeyManager Class)

Serializes the key to a byte array.

Syntax

ANSI (Cross Platform)
char* ExportKey(int *lpSize = NULL);

Unicode (Windows)
LPSTR ExportKey(LPINT lpSize = NULL);
char* secureblackbox_pgpkeymanager_exportkey(void* lpObjint *lpSize);
QByteArray ExportKey();

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.

ExportPublicKey Method (PGPKeyManager Class)

Exports the public key to a byte array.

Syntax

ANSI (Cross Platform)
char* ExportPublicKey(int *lpSize = NULL);

Unicode (Windows)
LPSTR ExportPublicKey(LPINT lpSize = NULL);
char* secureblackbox_pgpkeymanager_exportpublickey(void* lpObjint *lpSize);
QByteArray ExportPublicKey();

Remarks

Use this method to save the public key contained in Key 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.

ExportPublicToFile Method (PGPKeyManager Class)

Exports the public key to a file.

Syntax

ANSI (Cross Platform)
int ExportPublicToFile(const char* lpszFilename);

Unicode (Windows)
INT ExportPublicToFile(LPCWSTR lpszFilename);
int secureblackbox_pgpkeymanager_exportpublictofile(void* lpObj, const char* lpszFilename);
int ExportPublicToFile(const QString& qsFilename);

Remarks

Use this method to save the public key stored in Key to the file specified by Filename.

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

ExportPublicToStream Method (PGPKeyManager Class)

Exports the public key to a stream.

Syntax

ANSI (Cross Platform)
int ExportPublicToStream(SecureBlackboxStream* sStream);

Unicode (Windows)
INT ExportPublicToStream(SecureBlackboxStream* sStream);
int secureblackbox_pgpkeymanager_exportpublictostream(void* lpObj, SecureBlackboxStream* sStream);
int ExportPublicToStream(SecureBlackboxStream* sStream);

Remarks

Use this method to save the public key to the stream specified by Stream.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExportToFile Method (PGPKeyManager Class)

Exports the key to a file.

Syntax

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

Unicode (Windows)
INT ExportToFile(LPCWSTR lpszFilename);
int secureblackbox_pgpkeymanager_exporttofile(void* lpObj, const char* lpszFilename);
int ExportToFile(const QString& qsFilename);

Remarks

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

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

Exports the key to a stream.

Syntax

ANSI (Cross Platform)
int ExportToStream(SecureBlackboxStream* sStream);

Unicode (Windows)
INT ExportToStream(SecureBlackboxStream* sStream);
int secureblackbox_pgpkeymanager_exporttostream(void* lpObj, SecureBlackboxStream* sStream);
int ExportToStream(SecureBlackboxStream* sStream);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Generate Method (PGPKeyManager Class)

Generates a new single PGP key.

Syntax

ANSI (Cross Platform)
int Generate();

Unicode (Windows)
INT Generate();
int secureblackbox_pgpkeymanager_generate(void* lpObj);
int Generate();

Remarks

Call this method after setting up relevant fields of Key to generate a new PGP key. This method generates a 'standalone' key without subkeys. Use GeneratePair to generate a pair of a main key and a subkey.

Most PGP implementations work with pairs of keys: the sign-only primary key and the encrypt-only (or encrypt-and-sign) subkey. If you need to generate a conformant PGP key to use with other PGP software, you likely need to use the GeneratePair method.

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

GenerateLegacy Method (PGPKeyManager Class)

Generates a new key in the old format.

Syntax

ANSI (Cross Platform)
int GenerateLegacy(const char* lpszUsername, int iBits, const char* lpszPassword, int iExpires);

Unicode (Windows)
INT GenerateLegacy(LPCWSTR lpszUsername, INT iBits, LPCWSTR lpszPassword, INT iExpires);
int secureblackbox_pgpkeymanager_generatelegacy(void* lpObj, const char* lpszUsername, int iBits, const char* lpszPassword, int iExpires);
int GenerateLegacy(const QString& qsUsername, int iBits, const QString& qsPassword, int iExpires);

Remarks

Use this method when you need to generate an RSA key in the old (PGP 2.6.x) format.

Username specifies the user of the key, Bits is the key length in bits. Provide Password for the key and its expiration date and time via Expires.

Only use this method where you want to work with very old PGP software. While still providing a decent level of protection (subject to key length, of course), legacy keys are rarely used these days, and have almost everywhere been replaced with new-style keys.

Most modern PGP implementations work with pairs of keys: the sign-only primary key and the encrypt-only (or encrypt-and-sign) subkey. If you need to generate a conformant PGP key to use with other PGP software, you likely need to use the GeneratePair method.

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

GeneratePair Method (PGPKeyManager Class)

Generates a new pair of PGP keys.

Syntax

ANSI (Cross Platform)
int GeneratePair(const char* lpszUsername, const char* lpszKeyAlgorithm, int iKeyBits, const char* lpszSubKeyAlgorithm, int iSubKeyBits, const char* lpszPassword, int iExpires);

Unicode (Windows)
INT GeneratePair(LPCWSTR lpszUsername, LPCWSTR lpszKeyAlgorithm, INT iKeyBits, LPCWSTR lpszSubKeyAlgorithm, INT iSubKeyBits, LPCWSTR lpszPassword, INT iExpires);
int secureblackbox_pgpkeymanager_generatepair(void* lpObj, const char* lpszUsername, const char* lpszKeyAlgorithm, int iKeyBits, const char* lpszSubKeyAlgorithm, int iSubKeyBits, const char* lpszPassword, int iExpires);
int GeneratePair(const QString& qsUsername, const QString& qsKeyAlgorithm, int iKeyBits, const QString& qsSubKeyAlgorithm, int iSubKeyBits, const QString& qsPassword, int iExpires);

Remarks

Use this method to create a new 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.

Set KeyAlgorithm and SubKeyAlgorithm to the public key algorithms that you want to use for the new key. See the full list of algorithms below. Where ECDSA or ECDH algorithm is used, you can specify a particular curve after the algorithm name, separated with the colon: ECDSA:P384 or ECDH:BRAINPOOLP256. KeyBits and SubKeyBits specify the number of bits in the key and the subkey. These parameters can be set to zero if the key length is implicitly defined by the algorithm of the key. For example, ECDSA P256 keys are always 256 bit long, so you may pass 0 as the corresponding KeyBits or SubKeyBits parameter.

Provide the key encryption password and the validity period in days via the Password and Expires parameters. Set Expires to zero to indicate that the key does not expire.

While you can use any combination of algorithms for your key and subkey, most implementations got used to specific hard-wired combinations. Sticking to those will help make sure your keys are understood by other implementations. Typical combinations are:

  • EDDSA main key with ECDH:CURVE25519 subkey;
  • ECDSA main key with ECDH subkey; both with NIST curves (P256, P384, or P512);
  • ECDSA main key with ECDH subkey; both with Brainpool curves (BRAINPOOLP256 or BRAINPOOLP512);
  • RSA main key with RSA subkey.
The code snippet below illustrates a typical key generation procedure: Pgpkeymanager mgr = new Pgpkeymanager(); // generating a pair mgr.GeneratePair("Michel Legrand <ml@email.com>", "EDDSA", 0, "ECDH:CURVE25519", 0, "password", 0); // creating a keyring object and adding the new pair to the keyring Pgpkeyring keyring = new Pgpkeyring(); keyring.CreateNew(); keyring.PinnedKey = mgr.Key; keyring.AddPinned(); // exporting the keyring to a file keyring.Save("pubkey.pkr", "seckey.skr"); Alternative calls to GeneratePair may look like this: mgr.GeneratePair("Michel Legrand <ml@email.com>", "ECDSA:P384", 0, "ECDH", 0, "password", 0); mgr.GeneratePair("Michel Legrand <ml@email.com>", "ECDSA:BRAINPOOLP256", 0, "ECDH:BRAINPOOLP256", 0, "password", 0); mgr.GeneratePair("Michel Legrand <ml@email.com>", "RSA", 4096, "RSA", 2048, "password", 0); Supported public key algorithms:
SB_PGP_PUBLIC_KEY_ALGORITHM_RSARSA
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_ENCRYPTRSA-encrypt
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_SIGNRSA-sign
SB_PGP_PUBLIC_KEY_ALGORITHM_DSADSA
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDSAECDSA
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDHECDH
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL_ENCRYPTElgamal-encrypt
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMALElgamal
SB_PGP_PUBLIC_KEY_ALGORITHM_EDDSAEDDSA
Supported elliptic curves:
SB_PGP_CURVE_P256P256
SB_PGP_CURVE_P384P384
SB_PGP_CURVE_P521P521
SB_PGP_CURVE_ED25519ED25519
SB_PGP_CURVE_CURVE25519CURVE25519
SB_PGP_CURVE_BRAINPOOLP256R1BRAINPOOLP256
SB_PGP_CURVE_BRAINPOOLP512R1BRAINPOOLP512

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

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

Loads a key from a stream.

Syntax

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

Unicode (Windows)
INT ImportFromStream(SecureBlackboxStream* sStream);
int secureblackbox_pgpkeymanager_importfromstream(void* lpObj, SecureBlackboxStream* sStream);
int ImportFromStream(SecureBlackboxStream* sStream);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportKey Method (PGPKeyManager Class)

Loads a key from a byte array.

Syntax

ANSI (Cross Platform)
int ImportKey(const char* lpData, int lenData);

Unicode (Windows)
INT ImportKey(LPCSTR lpData, INT lenData);
int secureblackbox_pgpkeymanager_importkey(void* lpObj, const char* lpData, int lenData);
int ImportKey(QByteArray qbaData);

Remarks

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

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

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

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

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

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

RevokeKey Method (PGPKeyManager Class)

Revokes the key.

Syntax

ANSI (Cross Platform)
int RevokeKey();

Unicode (Windows)
INT RevokeKey();
int secureblackbox_pgpkeymanager_revokekey(void* lpObj);
int RevokeKey();

Remarks

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

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

RevokeSubkey Method (PGPKeyManager Class)

Revokes the key's subkey.

Syntax

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

Unicode (Windows)
INT RevokeSubkey(INT iIndex);
int secureblackbox_pgpkeymanager_revokesubkey(void* lpObj, int iIndex);
int RevokeSubkey(int iIndex);

Remarks

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

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

RevokeSubkeybyID Method (PGPKeyManager Class)

Revokes the key's subkey.

Syntax

ANSI (Cross Platform)
int RevokeSubkeybyID(const char* lpszKeyId);

Unicode (Windows)
INT RevokeSubkeybyID(LPCWSTR lpszKeyId);
int secureblackbox_pgpkeymanager_revokesubkeybyid(void* lpObj, const char* lpszKeyId);
int RevokeSubkeybyID(const QString& qsKeyId);

Remarks

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

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

RevokeUser Method (PGPKeyManager Class)

Revokes a user certification.

Syntax

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

Unicode (Windows)
INT RevokeUser(INT iIndex);
int secureblackbox_pgpkeymanager_revokeuser(void* lpObj, int iIndex);
int RevokeUser(int iIndex);

Remarks

Use this method to revoke the user with the specified Index by adding a revocation signature to the 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.)

RevokeUserByName Method (PGPKeyManager Class)

Revokes a user certification.

Syntax

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

Unicode (Windows)
INT RevokeUserByName(LPCWSTR lpszUsername);
int secureblackbox_pgpkeymanager_revokeuserbyname(void* lpObj, const char* lpszUsername);
int RevokeUserByName(const QString& qsUsername);

Remarks

Use this method to revoke the certification of the user specified by Username by adding a revocation signature.

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

Validate Method (PGPKeyManager Class)

Validates the key.

Syntax

ANSI (Cross Platform)
int Validate();

Unicode (Windows)
INT Validate();
int secureblackbox_pgpkeymanager_validate(void* lpObj);
int Validate();

Remarks

Call this method to validate signatures over the PGP key and all the subkeys.

Possible result:

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity unknown

Error Handling (C++)

This method returns an Integer 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.

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.

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 2

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

TempPath:   Path for storing temporary files.

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

Base Config Settings

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:

offNo caching (default)
localLocal caching
globalGlobal 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.

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

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.

LogDestination:   Specifies the debug log destination.

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

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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.

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:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal 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).

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.

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 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) 
27262977   File does not exist (SB_ERROR_PGP_FILE_NOT_EXISTS)
27262978   Invalid key (SB_ERROR_PGP_INVALID_KEY)
27262979   No public key (SB_ERROR_PGP_NO_PUBLIC_KEY)
27262980   No secret key (SB_ERROR_PGP_NO_SECRET_KEY)
27262981   Not found (SB_ERROR_PGP_NOT_FOUND)
27262982   Operation cannot be performed on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY)