PGPWriter Class

Properties   Methods   Events   Config Settings   Errors  

The PGPWriter class protects data using PGP keys and certificates.

Syntax

PGPWriter

Remarks

PGPWriter allows you to encrypt, sign, armor, and compress the input data.

Property List

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

Method List

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

Event List

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

Config Settings

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

Armor Property (PGPWriter Class)

Specifies whether the data should be armored.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArmor();
int SetArmor(int bArmor);

Unicode (Windows)
BOOL GetArmor();
INT SetArmor(BOOL bArmor);

int secureblackbox_pgpwriter_getarmor(void* lpObj);
int secureblackbox_pgpwriter_setarmor(void* lpObj, int bArmor);

bool GetArmor();
int SetArmor(bool bArmor);

Default Value

FALSE

Remarks

Switch this property on to armor the protected data by encoding it in base64 and enveloping with BEGIN and END markings.

Data Type

Boolean

ArmorBoundary Property (PGPWriter Class)

A boundary to put around the base64 armor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArmorBoundary();
int SetArmorBoundary(const char* lpszArmorBoundary);

Unicode (Windows)
LPWSTR GetArmorBoundary();
INT SetArmorBoundary(LPCWSTR lpszArmorBoundary);

char* secureblackbox_pgpwriter_getarmorboundary(void* lpObj);
int secureblackbox_pgpwriter_setarmorboundary(void* lpObj, const char* lpszArmorBoundary);

QString GetArmorBoundary();
int SetArmorBoundary(QString qsArmorBoundary);

Default Value

""

Remarks

Use this property to specify the boundary to put around the base64 armor. If set to 'PGP MESSAGE', the armored data will be enveloped with '-----BEGIN PGP MESSAGE-----' and '-----END PGP MESSAGE-----' lines.

This property only makes sense if Armor is set True.

Data Type

String

ArmorHeaders Property (PGPWriter Class)

Additional headers to include with the armored message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArmorHeaders();
int SetArmorHeaders(const char* lpszArmorHeaders);

Unicode (Windows)
LPWSTR GetArmorHeaders();
INT SetArmorHeaders(LPCWSTR lpszArmorHeaders);

char* secureblackbox_pgpwriter_getarmorheaders(void* lpObj);
int secureblackbox_pgpwriter_setarmorheaders(void* lpObj, const char* lpszArmorHeaders);

QString GetArmorHeaders();
int SetArmorHeaders(QString qsArmorHeaders);

Default Value

""

Remarks

Use this property to specify additional headers to be included with the armored message.

Assign this property with a multi-line text, with each line being of "header: value" form (without quotes).

Data Type

String

Compress Property (PGPWriter Class)

Whether to compress the data before encrypting it.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCompress();
int SetCompress(int bCompress);

Unicode (Windows)
BOOL GetCompress();
INT SetCompress(BOOL bCompress);

int secureblackbox_pgpwriter_getcompress(void* lpObj);
int secureblackbox_pgpwriter_setcompress(void* lpObj, int bCompress);

bool GetCompress();
int SetCompress(bool bCompress);

Default Value

FALSE

Remarks

Set this property to True to compress the data before encryption. Use CompressionAlgorithm and CompressionLevel to tune up compression parameters.

Data Type

Boolean

CompressionAlgorithm Property (PGPWriter Class)

The compression algorithm to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCompressionAlgorithm();
int SetCompressionAlgorithm(const char* lpszCompressionAlgorithm);

Unicode (Windows)
LPWSTR GetCompressionAlgorithm();
INT SetCompressionAlgorithm(LPCWSTR lpszCompressionAlgorithm);

char* secureblackbox_pgpwriter_getcompressionalgorithm(void* lpObj);
int secureblackbox_pgpwriter_setcompressionalgorithm(void* lpObj, const char* lpszCompressionAlgorithm);

QString GetCompressionAlgorithm();
int SetCompressionAlgorithm(QString qsCompressionAlgorithm);

Default Value

"Uncompressed"

Remarks

Use this property to specify the compression algorithm to use before encrypting the data. This property only makes sense if Compress is True.

Data Type

String

CompressionLevel Property (PGPWriter Class)

The compression level to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel);

Unicode (Windows)
INT GetCompressionLevel();
INT SetCompressionLevel(INT iCompressionLevel);

int secureblackbox_pgpwriter_getcompressionlevel(void* lpObj);
int secureblackbox_pgpwriter_setcompressionlevel(void* lpObj, int iCompressionLevel);

int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel);

Default Value

0

Remarks

Use this property to specify the compression level, from 1 (fastest) to 9 (best).

Data Type

Integer

EncryptingKeys Property (PGPWriter Class)

The keys to be used for data encryption.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxPGPKey>* GetEncryptingKeys();
int SetEncryptingKeys(SecureBlackboxList<SecureBlackboxPGPKey>* val);

int secureblackbox_pgpwriter_getencryptingkeycount(void* lpObj);
int secureblackbox_pgpwriter_setencryptingkeycount(void* lpObj, int iEncryptingKeyCount);

int64 secureblackbox_pgpwriter_getencryptingkeyhandle(void* lpObj, int encryptingkeyindex);
int secureblackbox_pgpwriter_setencryptingkeyhandle(void* lpObj, int encryptingkeyindex, int64 lEncryptingKeyHandle);

char* secureblackbox_pgpwriter_getencryptingkeykeyfp(void* lpObj, int encryptingkeyindex);

char* secureblackbox_pgpwriter_getencryptingkeykeyid(void* lpObj, int encryptingkeyindex);

char* secureblackbox_pgpwriter_getencryptingkeyusername(void* lpObj, int encryptingkeyindex);

int GetEncryptingKeyCount();
int SetEncryptingKeyCount(int iEncryptingKeyCount);

qint64 GetEncryptingKeyHandle(int iEncryptingKeyIndex);
int SetEncryptingKeyHandle(int iEncryptingKeyIndex, qint64 lEncryptingKeyHandle);

QString GetEncryptingKeyKeyFP(int iEncryptingKeyIndex);

QString GetEncryptingKeyKeyID(int iEncryptingKeyIndex);

QString GetEncryptingKeyUsername(int iEncryptingKeyIndex);

Remarks

Use this property to set the keys to encrypt the message for. You only need public keys to encrypt data.

This property is not available at design time.

Data Type

SecureBlackboxPGPKey

EncryptionAlgorithm Property (PGPWriter Class)

A symmetric algorithm to use for data encryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(const char* lpszEncryptionAlgorithm);

Unicode (Windows)
LPWSTR GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(LPCWSTR lpszEncryptionAlgorithm);

char* secureblackbox_pgpwriter_getencryptionalgorithm(void* lpObj);
int secureblackbox_pgpwriter_setencryptionalgorithm(void* lpObj, const char* lpszEncryptionAlgorithm);

QString GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(QString qsEncryptionAlgorithm);

Default Value

"AES128"

Remarks

Use this property to specify a symmetric algorithm to use for data encryption.

Data Type

String

ExternalCrypto Property (PGPWriter Class)

Provides access to external signing and DC parameters.

Syntax

• C++
• C
• Qt

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_pgpwriter_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_pgpwriter_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_pgpwriter_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_pgpwriter_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

char* secureblackbox_pgpwriter_getexternalcryptodata(void* lpObj);
int secureblackbox_pgpwriter_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

int secureblackbox_pgpwriter_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_pgpwriter_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

char* secureblackbox_pgpwriter_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_pgpwriter_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

char* secureblackbox_pgpwriter_getexternalcryptokeyid(void* lpObj);
int secureblackbox_pgpwriter_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

char* secureblackbox_pgpwriter_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_pgpwriter_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

int secureblackbox_pgpwriter_getexternalcryptomethod(void* lpObj);
int secureblackbox_pgpwriter_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int secureblackbox_pgpwriter_getexternalcryptomode(void* lpObj);
int secureblackbox_pgpwriter_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

char* secureblackbox_pgpwriter_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_pgpwriter_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FileName Property (PGPWriter Class)

Specifies the name of the file being protected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFileName();
int SetFileName(const char* lpszFileName);

Unicode (Windows)
LPWSTR GetFileName();
INT SetFileName(LPCWSTR lpszFileName);

char* secureblackbox_pgpwriter_getfilename(void* lpObj);
int secureblackbox_pgpwriter_setfilename(void* lpObj, const char* lpszFileName);

QString GetFileName();
int SetFileName(QString qsFileName);

Default Value

""

Remarks

Use this property to set the name of the file being protected, such as 'document.txt'. If Filename is empty or its value is "_CONSOLE", the data will be protected for-your-eyes-only, meaning the decryptor will only be able to read it on their screen, but not save.

Data Type

String

FIPSMode Property (PGPWriter Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_pgpwriter_getfipsmode(void* lpObj);
int secureblackbox_pgpwriter_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

HashAlgorithm Property (PGPWriter Class)

The hash algorithm to use for signing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHashAlgorithm();
int SetHashAlgorithm(const char* lpszHashAlgorithm);

Unicode (Windows)
LPWSTR GetHashAlgorithm();
INT SetHashAlgorithm(LPCWSTR lpszHashAlgorithm);

char* secureblackbox_pgpwriter_gethashalgorithm(void* lpObj);
int secureblackbox_pgpwriter_sethashalgorithm(void* lpObj, const char* lpszHashAlgorithm);

QString GetHashAlgorithm();
int SetHashAlgorithm(QString qsHashAlgorithm);

Default Value

""

Remarks

Use this property to specify the hash algorithm to use for calculating signatures.

Data Type

String

InputBytes Property (PGPWriter Class)

Use this property to pass the input to class in byte array form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes);

Unicode (Windows)
INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);

int secureblackbox_pgpwriter_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_pgpwriter_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (PGPWriter Class)

Provides a filename of a file to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* secureblackbox_pgpwriter_getinputfile(void* lpObj);
int secureblackbox_pgpwriter_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

Use this property to provide a path to the file to be encrypted and/or signed.

Data Type

String

InputIsText Property (PGPWriter Class)

Whether the input data is text.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputIsText();
int SetInputIsText(int bInputIsText);

Unicode (Windows)
BOOL GetInputIsText();
INT SetInputIsText(BOOL bInputIsText);

int secureblackbox_pgpwriter_getinputistext(void* lpObj);
int secureblackbox_pgpwriter_setinputistext(void* lpObj, int bInputIsText);

bool GetInputIsText();
int SetInputIsText(bool bInputIsText);

Default Value

FALSE

Remarks

Set this property to true to indicate that the supplied data should be treated as text.

Data Type

Boolean

OutputBytes Property (PGPWriter Class)

Use this property to read the output the class object has produced.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_pgpwriter_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (PGPWriter Class)

The file where the encrypted and/or signed data will be saved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* secureblackbox_pgpwriter_getoutputfile(void* lpObj);
int secureblackbox_pgpwriter_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

Use this property to provide a path to the file where the class should store the encrypted and/or signed data.

Data Type

String

Passphrase Property (PGPWriter Class)

The encryption password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassphrase();
int SetPassphrase(const char* lpszPassphrase);

Unicode (Windows)
LPWSTR GetPassphrase();
INT SetPassphrase(LPCWSTR lpszPassphrase);

char* secureblackbox_pgpwriter_getpassphrase(void* lpObj);
int secureblackbox_pgpwriter_setpassphrase(void* lpObj, const char* lpszPassphrase);

QString GetPassphrase();
int SetPassphrase(QString qsPassphrase);

Default Value

""

Remarks

Use this property to provide the encryption password. If an encryption password is used, no key will be needed to decrypt the data.

Data Type

String

Profile Property (PGPWriter Class)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProfile();
int SetProfile(const char* lpszProfile);

Unicode (Windows)
LPWSTR GetProfile();
INT SetProfile(LPCWSTR lpszProfile);

char* secureblackbox_pgpwriter_getprofile(void* lpObj);
int secureblackbox_pgpwriter_setprofile(void* lpObj, const char* lpszProfile);

QString GetProfile();
int SetProfile(QString qsProfile);

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Data Type

String

Protection Property (PGPWriter Class)

Specifies a password protection level.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProtection();
int SetProtection(int iProtection);

Unicode (Windows)
INT GetProtection();
INT SetProtection(INT iProtection);

PPT_NONE(0), 
PPT_LOW(1), 
PPT_NORMAL(2), 
PPT_HIGH(3)

int secureblackbox_pgpwriter_getprotection(void* lpObj);
int secureblackbox_pgpwriter_setprotection(void* lpObj, int iProtection);

int GetProtection();
int SetProtection(int iProtection);

Default Value

0

Remarks

This property specifies the complexity of key derivation function for password-protected documents.

Allowed values:

Data Type

Integer

SigningKeys Property (PGPWriter Class)

The keys to be used for signing.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxPGPKey>* GetSigningKeys();
int SetSigningKeys(SecureBlackboxList<SecureBlackboxPGPKey>* val);

int secureblackbox_pgpwriter_getsigningkeycount(void* lpObj);
int secureblackbox_pgpwriter_setsigningkeycount(void* lpObj, int iSigningKeyCount);

int64 secureblackbox_pgpwriter_getsigningkeyhandle(void* lpObj, int signingkeyindex);
int secureblackbox_pgpwriter_setsigningkeyhandle(void* lpObj, int signingkeyindex, int64 lSigningKeyHandle);

char* secureblackbox_pgpwriter_getsigningkeykeyfp(void* lpObj, int signingkeyindex);

char* secureblackbox_pgpwriter_getsigningkeykeyid(void* lpObj, int signingkeyindex);

char* secureblackbox_pgpwriter_getsigningkeypassphrase(void* lpObj, int signingkeyindex);
int secureblackbox_pgpwriter_setsigningkeypassphrase(void* lpObj, int signingkeyindex, const char* lpszSigningKeyPassphrase);

int secureblackbox_pgpwriter_getsigningkeypassphrasevalid(void* lpObj, int signingkeyindex);

char* secureblackbox_pgpwriter_getsigningkeyusername(void* lpObj, int signingkeyindex);

int GetSigningKeyCount();
int SetSigningKeyCount(int iSigningKeyCount);

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

QString GetSigningKeyKeyFP(int iSigningKeyIndex);

QString GetSigningKeyKeyID(int iSigningKeyIndex);

QString GetSigningKeyPassphrase(int iSigningKeyIndex);
int SetSigningKeyPassphrase(int iSigningKeyIndex, QString qsSigningKeyPassphrase);

bool GetSigningKeyPassphraseValid(int iSigningKeyIndex);

QString GetSigningKeyUsername(int iSigningKeyIndex);

Remarks

Use this property to set the keys to sign the message with. The keys need to contain their secret compound.

In most cases you will also need to supply a passphrase for the chosen signing keys. Use this by subscribing to KeyPassphraseNeeded event, or setting the Passphrase property of the relevant key object.

This property is not available at design time.

Data Type

SecureBlackboxPGPKey

Timestamp Property (PGPWriter Class)

The date and time of the last modification of the protected data file (in UTC).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTimestamp();
int SetTimestamp(const char* lpszTimestamp);

Unicode (Windows)
LPWSTR GetTimestamp();
INT SetTimestamp(LPCWSTR lpszTimestamp);

char* secureblackbox_pgpwriter_gettimestamp(void* lpObj);
int secureblackbox_pgpwriter_settimestamp(void* lpObj, const char* lpszTimestamp);

QString GetTimestamp();
int SetTimestamp(QString qsTimestamp);

Default Value

""

Remarks

Use this property to set a timestamp for the data being protected.

Data Type

String

ClearTextSign Method (PGPWriter Class)

Creates a cleartext signature over the provided data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ClearTextSign();

Unicode (Windows)
INT ClearTextSign();

int secureblackbox_pgpwriter_cleartextsign(void* lpObj);

int ClearTextSign();

Remarks

Call this method to create a cleartext signature over the provided data buffer (InputBytes). Only textual data can be signed in cleartext.

Pass the signing key(s) via SigningKeys property.

Error Handling (C++)

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

Config Method (PGPWriter Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_pgpwriter_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 (PGPWriter Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_pgpwriter_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

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

Remarks

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

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

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

Error Handling (C++)

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

Encrypt Method (PGPWriter Class)

Encrypts data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int secureblackbox_pgpwriter_encrypt(void* lpObj);

int Encrypt();

Remarks

Use this method to encrypt input data from a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the protected message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).

Specify encryption keys in EncryptingKeys property, and/or encryption password via Passphrase property.

Error Handling (C++)

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

EncryptAndSign Method (PGPWriter Class)

Encrypts and signs data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EncryptAndSign();

Unicode (Windows)
INT EncryptAndSign();

int secureblackbox_pgpwriter_encryptandsign(void* lpObj);

int EncryptAndSign();

Remarks

Use this method to encrypt and sign a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the protected message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).

Specify encryption keys in EncryptingKeys property, and/or encryption password via Passphrase property. Use SigningKeys to provide the signing keys.

Please note that you might need to provide a passphrase to decrypt your signing key. This can be done via KeyPassphraseNeeded event, or by assigning the passphrase to the key object's Passphrase property.

Error Handling (C++)

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

Reset Method (PGPWriter Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_pgpwriter_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

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

Sign Method (PGPWriter Class)

Signs data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign(int bDetached);

Unicode (Windows)
INT Sign(BOOL bDetached);

int secureblackbox_pgpwriter_sign(void* lpObj, int bDetached);

int Sign(bool bDetached);

Remarks

Use this method to sign a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the signed message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).

Use SigningKeys to provide the signing keys.

Please note that you might need to provide a passphrase to decrypt your signing key. This can be done via KeyPassphraseNeeded event, or by assigning the passphrase to the key object's Passphrase property.

Error Handling (C++)

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

Error Event (PGPWriter Class)

Information about errors during PGP encryption.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PGPWRITER_ERROR 1

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

class PGPWriterErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

The event is fired in case of exceptional conditions during data encryption or signing.

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

ExternalSign Event (PGPWriter Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireExternalSign(PGPWriterExternalSignEventParams *e);

typedef struct {
  const char *OperationId;
  const char *HashAlgorithm;
  const char *Pars;
  const char *Data;
  char *SignedData;
  int reserved;
} PGPWriterExternalSignEventParams;


Unicode (Windows)
virtual INT FireExternalSign(PGPWriterExternalSignEventParams *e);

typedef struct {
  LPCWSTR OperationId;
  LPCWSTR HashAlgorithm;
  LPCWSTR Pars;
  LPCWSTR Data;
  LPWSTR SignedData;
  INT reserved;
} PGPWriterExternalSignEventParams;

#define EID_PGPWRITER_EXTERNALSIGN 2

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);

class PGPWriterExternalSignEventParams {
public:
  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

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

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

// Or, subclass PGPWriter and override this emitter function.
virtual int FireExternalSign(PGPWriterExternalSignEventParams *e) {...}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

KeyPassphraseNeeded Event (PGPWriter Class)

Requests a key protection password from the application.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PGPWRITER_KEYPASSPHRASENEEDED 3

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

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

// Or, subclass PGPWriter and override this emitter function.
virtual int FireKeyPassphraseNeeded(PGPWriterKeyPassphraseNeededEventParams *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 (PGPWriter Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PGPWRITER_NOTIFICATION 4

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

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

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

Progress Event (PGPWriter Class)

Reports the progress of the decryption operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(PGPWriterProgressEventParams *e);

typedef struct {
  int64 Current;
  int64 Total;
  int Cancel;
  int reserved;
} PGPWriterProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(PGPWriterProgressEventParams *e);

typedef struct {
  LONG64 Current;
  LONG64 Total;
  BOOL Cancel;
  INT reserved;
} PGPWriterProgressEventParams;

#define EID_PGPWRITER_PROGRESS 5

virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lCurrent, LONG64 &lTotal, BOOL &bCancel);

class PGPWriterProgressEventParams {
public:
  qint64 Current();

  qint64 Total();

  bool Cancel();
  void SetCancel(bool bCancel);

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

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

// Or, subclass PGPWriter and override this emitter function.
virtual int FireProgress(PGPWriterProgressEventParams *e) {...}

Remarks

The class fires this event repeatedly to report the progress of the file protection operation.

Current indicates the amount of processed data in bytes, and Total is the total number of bytes to be processed. Use Cancel to terminate the protection process.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

ExternalCrypto()

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

Fields

Constructors

PGPKey()

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

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (PGPWriter Class)

PGPWriter Config Settings

Base Config Settings

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

PGPWriter Errors