PGPReader Class

Properties   Methods   Events   Config Settings   Errors  

The PGPReader class reads and unprotects protected PGP files.

Syntax

PGPReader

Remarks

PGPReader allows you to parse PGP messages and manipulate PGP-secured data. It decrypts the protected data, decompresses it, verifies signatures, and returns "clear" 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.

ArmoredIndicates if the processed message had been base64-armored.
CompressedIndicates if the processed message had been compressed.
DataBytesUse this property to pass the original signed data to class in the byte array form.
DataFileThe name of the file containing the original signed data.
DecryptingKeysA collection of keys to be used for decryption.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
InputBytesUse this property to pass the input to class in byte array form.
InputFileProvides a filename of a file to process.
KeyPassphraseSpecifies a passphrase for the decryption key.
OutputBytesUse this property to read the output the class object has produced.
OutputFileThe file where the encrypted and/or signed data will be saved.
PassphraseSpecifies a message decryption password.
ProcessedLengthReports the number of bytes processed.
ProfileSpecifies a pre-defined profile to apply when creating the signature.
SignaturesContains signatures that were included in the protected message.
VerifyingKeysA collection of keys to be used for signature verification.

Method List


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

ConfigSets or retrieves a configuration setting.
DecryptAndVerifyDecrypts and verifies a protected message.
DoActionPerforms an additional action.
ResetResets the class settings.
VerifyDetachedVerifies a detached signature.

Event List


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

EncryptionInfoReports early information on encryption parameters.
ErrorInformation about errors during PGP decryption/verification.
ExternalDecryptHandles remote or external decryption.
FileExtractionFinishReports the ending of file extraction process.
FileExtractionStartReports the beginning of file extraction process.
KeyPassphraseNeededRequests a key protection password from the application.
MultipleFilesFoundFires if the PGP message is recognized to contain multiple files.
NotificationThis event notifies the application about an underlying control flow event.
PassphraseNeededRequests a data protection password from the application.
ProgressReports the progress of the decryption operation.
SignedNotifies the application about a signed message.

Config Settings


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

IgnoreDataPacketLengthsWhether to check the length of input data packets.
PasswordAttemptsThe number of attempts allowed for entering password.
TempPathPath for storing temporary files.
UndefInputLengthSet this property if you are working with non-seekable streams.
UseGreedyMemoryConsumptionWhether to limit memory consumption for the cost of speed.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
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.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
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.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
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.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
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.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Armored Property (PGPReader Class)

Indicates if the processed message had been base64-armored.

Syntax

ANSI (Cross Platform)
int GetArmored();

Unicode (Windows)
BOOL GetArmored();
int secureblackbox_pgpreader_getarmored(void* lpObj);
bool GetArmored();

Default Value

FALSE

Remarks

This property is set to true if the supplied message was armored by encoding it into base64 and adding BEGIN and END brackets.

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

Data Type

Boolean

Compressed Property (PGPReader Class)

Indicates if the processed message had been compressed.

Syntax

ANSI (Cross Platform)
int GetCompressed();

Unicode (Windows)
BOOL GetCompressed();
int secureblackbox_pgpreader_getcompressed(void* lpObj);
bool GetCompressed();

Default Value

FALSE

Remarks

This property is set to true if the supplied message was compressed by its creator.

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

Data Type

Boolean

DataBytes Property (PGPReader Class)

Use this property to pass the original signed data to class in the byte array form.

Syntax

ANSI (Cross Platform)
int GetDataBytes(char* &lpDataBytes, int &lenDataBytes);
int SetDataBytes(const char* lpDataBytes, int lenDataBytes); Unicode (Windows) INT GetDataBytes(LPSTR &lpDataBytes, INT &lenDataBytes);
INT SetDataBytes(LPCSTR lpDataBytes, INT lenDataBytes);
int secureblackbox_pgpreader_getdatabytes(void* lpObj, char** lpDataBytes, int* lenDataBytes);
int secureblackbox_pgpreader_setdatabytes(void* lpObj, const char* lpDataBytes, int lenDataBytes);
QByteArray GetDataBytes();
int SetDataBytes(QByteArray qbaDataBytes);

Remarks

When validating detached signatures, assign a byte array containing the signed data to this property.

This property is not available at design time.

Data Type

Byte Array

DataFile Property (PGPReader Class)

The name of the file containing the original signed data.

Syntax

ANSI (Cross Platform)
char* GetDataFile();
int SetDataFile(const char* lpszDataFile); Unicode (Windows) LPWSTR GetDataFile();
INT SetDataFile(LPCWSTR lpszDataFile);
char* secureblackbox_pgpreader_getdatafile(void* lpObj);
int secureblackbox_pgpreader_setdatafile(void* lpObj, const char* lpszDataFile);
QString GetDataFile();
int SetDataFile(QString qsDataFile);

Default Value

""

Remarks

Use this property to provide the original data when validating detached signatures with VerifyDetached.

Data Type

String

DecryptingKeys Property (PGPReader Class)

A collection of keys to be used for decryption.

Syntax

SecureBlackboxList<SecureBlackboxPGPKey>* GetDecryptingKeys();
int SetDecryptingKeys(SecureBlackboxList<SecureBlackboxPGPKey>* val);
int secureblackbox_pgpreader_getdecryptingkeycount(void* lpObj);
int secureblackbox_pgpreader_setdecryptingkeycount(void* lpObj, int iDecryptingKeyCount);
int64 secureblackbox_pgpreader_getdecryptingkeyhandle(void* lpObj, int decryptingkeyindex);
int secureblackbox_pgpreader_setdecryptingkeyhandle(void* lpObj, int decryptingkeyindex, int64 lDecryptingKeyHandle);
char* secureblackbox_pgpreader_getdecryptingkeykeyfp(void* lpObj, int decryptingkeyindex);
char* secureblackbox_pgpreader_getdecryptingkeykeyid(void* lpObj, int decryptingkeyindex);
char* secureblackbox_pgpreader_getdecryptingkeypassphrase(void* lpObj, int decryptingkeyindex);
int secureblackbox_pgpreader_setdecryptingkeypassphrase(void* lpObj, int decryptingkeyindex, const char* lpszDecryptingKeyPassphrase);
int secureblackbox_pgpreader_getdecryptingkeypassphrasevalid(void* lpObj, int decryptingkeyindex);
char* secureblackbox_pgpreader_getdecryptingkeyusername(void* lpObj, int decryptingkeyindex);
int GetDecryptingKeyCount();
int SetDecryptingKeyCount(int iDecryptingKeyCount); qint64 GetDecryptingKeyHandle(int iDecryptingKeyIndex);
int SetDecryptingKeyHandle(int iDecryptingKeyIndex, qint64 lDecryptingKeyHandle); QString GetDecryptingKeyKeyFP(int iDecryptingKeyIndex); QString GetDecryptingKeyKeyID(int iDecryptingKeyIndex); QString GetDecryptingKeyPassphrase(int iDecryptingKeyIndex);
int SetDecryptingKeyPassphrase(int iDecryptingKeyIndex, QString qsDecryptingKeyPassphrase); bool GetDecryptingKeyPassphraseValid(int iDecryptingKeyIndex); QString GetDecryptingKeyUsername(int iDecryptingKeyIndex);

Remarks

Use this property to provide decryption keys. Note that only secret keys can decrypt.

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

This property is not available at design time.

Data Type

SecureBlackboxPGPKey

ExternalCrypto Property (PGPReader Class)

Provides access to external signing and DC parameters.

Syntax

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_pgpreader_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_pgpreader_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_pgpreader_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_pgpreader_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_pgpreader_getexternalcryptodata(void* lpObj);
int secureblackbox_pgpreader_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_pgpreader_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_pgpreader_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_pgpreader_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_pgpreader_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_pgpreader_getexternalcryptokeyid(void* lpObj);
int secureblackbox_pgpreader_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_pgpreader_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_pgpreader_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_pgpreader_getexternalcryptomethod(void* lpObj);
int secureblackbox_pgpreader_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_pgpreader_getexternalcryptomode(void* lpObj);
int secureblackbox_pgpreader_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_pgpreader_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_pgpreader_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

FIPSMode Property (PGPReader Class)

Reserved.

Syntax

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

InputBytes Property (PGPReader Class)

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

Syntax

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_pgpreader_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_pgpreader_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 (PGPReader Class)

Provides a filename of a file to process.

Syntax

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* secureblackbox_pgpreader_getinputfile(void* lpObj);
int secureblackbox_pgpreader_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

KeyPassphrase Property (PGPReader Class)

Specifies a passphrase for the decryption key.

Syntax

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

Default Value

""

Remarks

Use this property to provide a passphrase for the decryption secret key.

If this property is left empty or a wrong passphrase is provided, the KeyPassphraseNeeded event will be fired to request the correct passphrase.

Data Type

String

OutputBytes Property (PGPReader Class)

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

Syntax

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

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);
int secureblackbox_pgpreader_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 (PGPReader Class)

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

Syntax

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* secureblackbox_pgpreader_getoutputfile(void* lpObj);
int secureblackbox_pgpreader_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 (PGPReader Class)

Specifies a message decryption password.

Syntax

ANSI (Cross Platform)
char* GetPassphrase();
int SetPassphrase(const char* lpszPassphrase); Unicode (Windows) LPWSTR GetPassphrase();
INT SetPassphrase(LPCWSTR lpszPassphrase);
char* secureblackbox_pgpreader_getpassphrase(void* lpObj);
int secureblackbox_pgpreader_setpassphrase(void* lpObj, const char* lpszPassphrase);
QString GetPassphrase();
int SetPassphrase(QString qsPassphrase);

Default Value

""

Remarks

Use this property to provide a password to decrypt the data. Whether the message can be decrypted with a password is indicated by PassphraseUsed parameter of EncryptionInfo event.

Note that this is not the same as a secret key passphrase, which should be provided via KeyPassphrase property.

If this property is left empty or the assigned passphrase is incorrect, the PassphraseNeeded event will be fired to request the correct one.

Data Type

String

ProcessedLength Property (PGPReader Class)

Reports the number of bytes processed.

Syntax

ANSI (Cross Platform)
int64 GetProcessedLength();

Unicode (Windows)
LONG64 GetProcessedLength();
int64 secureblackbox_pgpreader_getprocessedlength(void* lpObj);
qint64 GetProcessedLength();

Default Value

0

Remarks

Use this property to check the number of bytes that the component has read when processing the protected message.

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

Data Type

Long64

Profile Property (PGPReader Class)

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

Syntax

ANSI (Cross Platform)
char* GetProfile();
int SetProfile(const char* lpszProfile); Unicode (Windows) LPWSTR GetProfile();
INT SetProfile(LPCWSTR lpszProfile);
char* secureblackbox_pgpreader_getprofile(void* lpObj);
int secureblackbox_pgpreader_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

Signatures Property (PGPReader Class)

Contains signatures that were included in the protected message.

Syntax

int secureblackbox_pgpreader_getsignaturecount(void* lpObj);
int secureblackbox_pgpreader_getsignaturecertificationtype(void* lpObj, int signatureindex);
char* secureblackbox_pgpreader_getsignaturecreationtime(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignatureexpirationtime(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignatureexportable(void* lpObj, int signatureindex);
int64 secureblackbox_pgpreader_getsignaturehandle(void* lpObj, int signatureindex);
char* secureblackbox_pgpreader_getsignaturehashalgorithm(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturehashmark(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturekeyexpirationtime(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturekeyflags(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturelegacyformat(void* lpObj, int signatureindex);
char* secureblackbox_pgpreader_getsignaturepolicyurl(void* lpObj, int signatureindex);
char* secureblackbox_pgpreader_getsignaturepreferredalgorithms(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignatureprimaryuserid(void* lpObj, int signatureindex);
char* secureblackbox_pgpreader_getsignaturereasonforrevocation(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturerevocable(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturerevocation(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturesignatureclass(void* lpObj, int signatureindex);
char* secureblackbox_pgpreader_getsignaturesignerkeyid(void* lpObj, int signatureindex);
char* secureblackbox_pgpreader_getsignaturesigneruserid(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturestrictlyvalid(void* lpObj, int signatureindex);
char* secureblackbox_pgpreader_getsignaturetarget(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturetextsignature(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturetrustamount(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturetrustlevel(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturevalidated(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignaturevalidity(void* lpObj, int signatureindex);
int secureblackbox_pgpreader_getsignatureversion(void* lpObj, int signatureindex);
int GetSignatureCount();

int GetSignatureCertificationType(int iSignatureIndex);

QString GetSignatureCreationTime(int iSignatureIndex);

int GetSignatureExpirationTime(int iSignatureIndex);

bool GetSignatureExportable(int iSignatureIndex);

qint64 GetSignatureHandle(int iSignatureIndex);

QString GetSignatureHashAlgorithm(int iSignatureIndex);

int GetSignatureHashMark(int iSignatureIndex);

int GetSignatureKeyExpirationTime(int iSignatureIndex);

int GetSignatureKeyFlags(int iSignatureIndex);

bool GetSignatureLegacyFormat(int iSignatureIndex);

QString GetSignaturePolicyURL(int iSignatureIndex);

QString GetSignaturePreferredAlgorithms(int iSignatureIndex);

bool GetSignaturePrimaryUserID(int iSignatureIndex);

QString GetSignatureReasonForRevocation(int iSignatureIndex);

bool GetSignatureRevocable(int iSignatureIndex);

bool GetSignatureRevocation(int iSignatureIndex);

int GetSignatureSignatureClass(int iSignatureIndex);

QString GetSignatureSignerKeyID(int iSignatureIndex);

QString GetSignatureSignerUserID(int iSignatureIndex);

bool GetSignatureStrictlyValid(int iSignatureIndex);

QString GetSignatureTarget(int iSignatureIndex);

bool GetSignatureTextSignature(int iSignatureIndex);

int GetSignatureTrustAmount(int iSignatureIndex);

int GetSignatureTrustLevel(int iSignatureIndex);

bool GetSignatureValidated(int iSignatureIndex);

int GetSignatureValidity(int iSignatureIndex);

int GetSignatureVersion(int iSignatureIndex);

Remarks

Use this property to access the details of the signatures included in the processed message.

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

Data Type

SecureBlackboxPGPSignature

VerifyingKeys Property (PGPReader Class)

A collection of keys to be used for signature verification.

Syntax

SecureBlackboxList<SecureBlackboxPGPKey>* GetVerifyingKeys();
int SetVerifyingKeys(SecureBlackboxList<SecureBlackboxPGPKey>* val);
int secureblackbox_pgpreader_getverifyingkeycount(void* lpObj);
int secureblackbox_pgpreader_setverifyingkeycount(void* lpObj, int iVerifyingKeyCount);
int64 secureblackbox_pgpreader_getverifyingkeyhandle(void* lpObj, int verifyingkeyindex);
int secureblackbox_pgpreader_setverifyingkeyhandle(void* lpObj, int verifyingkeyindex, int64 lVerifyingKeyHandle);
char* secureblackbox_pgpreader_getverifyingkeykeyfp(void* lpObj, int verifyingkeyindex);
char* secureblackbox_pgpreader_getverifyingkeykeyid(void* lpObj, int verifyingkeyindex);
char* secureblackbox_pgpreader_getverifyingkeyusername(void* lpObj, int verifyingkeyindex);
int GetVerifyingKeyCount();
int SetVerifyingKeyCount(int iVerifyingKeyCount); qint64 GetVerifyingKeyHandle(int iVerifyingKeyIndex);
int SetVerifyingKeyHandle(int iVerifyingKeyIndex, qint64 lVerifyingKeyHandle); QString GetVerifyingKeyKeyFP(int iVerifyingKeyIndex); QString GetVerifyingKeyKeyID(int iVerifyingKeyIndex); QString GetVerifyingKeyUsername(int iVerifyingKeyIndex);

Remarks

Use this property to provide verifying keys.

You will need an appropriate key to verify every signature included in the message. Use Signed event to get informed about the keys that were used for signing.

This property is not available at design time.

Data Type

SecureBlackboxPGPKey

Config Method (PGPReader Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_pgpreader_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.

DecryptAndVerify Method (PGPReader Class)

Decrypts and verifies a protected message.

Syntax

ANSI (Cross Platform)
int DecryptAndVerify();

Unicode (Windows)
INT DecryptAndVerify();
int secureblackbox_pgpreader_decryptandverify(void* lpObj);
int DecryptAndVerify();

Remarks

Use this method to unprotect a PGP message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream). The method writes the decrypted message to a byte array (OutputBytes), to a file (OutputFile) or to a stream (OutputStream).

Error Handling (C++)

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

DoAction Method (PGPReader 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_pgpreader_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.

Reset Method (PGPReader Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int secureblackbox_pgpreader_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.)

VerifyDetached Method (PGPReader Class)

Verifies a detached signature.

Syntax

ANSI (Cross Platform)
int VerifyDetached();

Unicode (Windows)
INT VerifyDetached();
int secureblackbox_pgpreader_verifydetached(void* lpObj);
int VerifyDetached();

Remarks

Use this method to verify a detached signature contained in a byte array (DataBytes), in a file (DataFile) or in a stream (DataStream) over a message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream).

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

EncryptionInfo Event (PGPReader Class)

Reports early information on encryption parameters.

Syntax

ANSI (Cross Platform)
virtual int FireEncryptionInfo(PGPReaderEncryptionInfoEventParams *e);
typedef struct {
const char *KeyIDs;
int EncryptedProtection;
int PassphraseUsed; int reserved; } PGPReaderEncryptionInfoEventParams;
Unicode (Windows) virtual INT FireEncryptionInfo(PGPReaderEncryptionInfoEventParams *e);
typedef struct {
LPCWSTR KeyIDs;
INT EncryptedProtection;
BOOL PassphraseUsed; INT reserved; } PGPReaderEncryptionInfoEventParams;
#define EID_PGPREADER_ENCRYPTIONINFO 1

virtual INT SECUREBLACKBOX_CALL FireEncryptionInfo(LPSTR &lpszKeyIDs, INT &iEncryptedProtection, BOOL &bPassphraseUsed);
class PGPReaderEncryptionInfoEventParams {
public:
  const QString &KeyIDs();

  int EncryptedProtection();

  bool PassphraseUsed();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void EncryptionInfo(PGPReaderEncryptionInfoEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireEncryptionInfo(PGPReaderEncryptionInfoEventParams *e) {...}

Remarks

The class fires this event to report early encryption information. Use this event to find out what encryption type is used, and to provide appropriate decryption material (the secret keys or the password) via DecryptingKeys or Passphrase properties.

KeyIDs contains the IDs of the keys that can be used to decrypt the data. PassphraseUsed shows if the message can also be decrypted with a passphrase. Both can be set at the same time, indicating that each of the decryption routes can be taken.

EncryptedProtection parameter specifies whether the message includes a modification detection record.

Error Event (PGPReader Class)

Information about errors during PGP decryption/verification.

Syntax

ANSI (Cross Platform)
virtual int FireError(PGPReaderErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } PGPReaderErrorEventParams;
Unicode (Windows) virtual INT FireError(PGPReaderErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } PGPReaderErrorEventParams;
#define EID_PGPREADER_ERROR 2

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class PGPReaderErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(PGPReaderErrorEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireError(PGPReaderErrorEventParams *e) {...}

Remarks

The event is fired in case of exceptional conditions during decryption/verification of protected data.

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

ExternalDecrypt Event (PGPReader Class)

Handles remote or external decryption.

Syntax

ANSI (Cross Platform)
virtual int FireExternalDecrypt(PGPReaderExternalDecryptEventParams *e);
typedef struct {
const char *OperationId;
const char *Algorithm;
const char *Pars;
const char *EncryptedData;
char *Data; int reserved; } PGPReaderExternalDecryptEventParams;
Unicode (Windows) virtual INT FireExternalDecrypt(PGPReaderExternalDecryptEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR Algorithm;
LPCWSTR Pars;
LPCWSTR EncryptedData;
LPWSTR Data; INT reserved; } PGPReaderExternalDecryptEventParams;
#define EID_PGPREADER_EXTERNALDECRYPT 3

virtual INT SECUREBLACKBOX_CALL FireExternalDecrypt(LPSTR &lpszOperationId, LPSTR &lpszAlgorithm, LPSTR &lpszPars, LPSTR &lpszEncryptedData, LPSTR &lpszData);
class PGPReaderExternalDecryptEventParams {
public:
  const QString &OperationId();

  const QString &Algorithm();

  const QString &Pars();

  const QString &EncryptedData();

  const QString &Data();
  void SetData(const QString &qsData);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ExternalDecrypt(PGPReaderExternalDecryptEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireExternalDecrypt(PGPReaderExternalDecryptEventParams *e) {...}

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

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

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

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

FileExtractionFinish Event (PGPReader Class)

Reports the ending of file extraction process.

Syntax

ANSI (Cross Platform)
virtual int FireFileExtractionFinish(PGPReaderFileExtractionFinishEventParams *e);
typedef struct {
const char *FileName;
const char *Timestamp; int reserved; } PGPReaderFileExtractionFinishEventParams;
Unicode (Windows) virtual INT FireFileExtractionFinish(PGPReaderFileExtractionFinishEventParams *e);
typedef struct {
LPCWSTR FileName;
LPCWSTR Timestamp; INT reserved; } PGPReaderFileExtractionFinishEventParams;
#define EID_PGPREADER_FILEEXTRACTIONFINISH 4

virtual INT SECUREBLACKBOX_CALL FireFileExtractionFinish(LPSTR &lpszFileName, LPSTR &lpszTimestamp);
class PGPReaderFileExtractionFinishEventParams {
public:
  const QString &FileName();

  const QString &Timestamp();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void FileExtractionFinish(PGPReaderFileExtractionFinishEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireFileExtractionFinish(PGPReaderFileExtractionFinishEventParams *e) {...}

Remarks

This event informs about the ending of extraction of the next available file. FileName parameter indicates the original file name, and the Timestamp its last modification time.

In the handler, the user can take away the output stream or store the file data from OutputBytes.

FileExtractionStart Event (PGPReader Class)

Reports the beginning of file extraction process.

Syntax

ANSI (Cross Platform)
virtual int FireFileExtractionStart(PGPReaderFileExtractionStartEventParams *e);
typedef struct {
const char *FileName;
const char *Timestamp;
int Skip; int reserved; } PGPReaderFileExtractionStartEventParams;
Unicode (Windows) virtual INT FireFileExtractionStart(PGPReaderFileExtractionStartEventParams *e);
typedef struct {
LPCWSTR FileName;
LPCWSTR Timestamp;
BOOL Skip; INT reserved; } PGPReaderFileExtractionStartEventParams;
#define EID_PGPREADER_FILEEXTRACTIONSTART 5

virtual INT SECUREBLACKBOX_CALL FireFileExtractionStart(LPSTR &lpszFileName, LPSTR &lpszTimestamp, BOOL &bSkip);
class PGPReaderFileExtractionStartEventParams {
public:
  const QString &FileName();

  const QString &Timestamp();

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void FileExtractionStart(PGPReaderFileExtractionStartEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireFileExtractionStart(PGPReaderFileExtractionStartEventParams *e) {...}

Remarks

This event informs about the beginning of extraction of the next available file. A PGP message may contain more than one file. FileName parameter indicates the original file name, and the Timestamp its last modification time.

The user should provide an output filename in OutputFile or a stream in OutputStream. If none of them is provided, the extracted file will be placed to OutputBytes. After the file is extracted, FileExtractionFinish event is fired.

KeyPassphraseNeeded Event (PGPReader Class)

Requests a key protection password from the application.

Syntax

ANSI (Cross Platform)
virtual int FireKeyPassphraseNeeded(PGPReaderKeyPassphraseNeededEventParams *e);
typedef struct {
const char *KeyID;
const char *UserID;
int MainKey;
char *Passphrase;
int Skip; int reserved; } PGPReaderKeyPassphraseNeededEventParams;
Unicode (Windows) virtual INT FireKeyPassphraseNeeded(PGPReaderKeyPassphraseNeededEventParams *e);
typedef struct {
LPCWSTR KeyID;
LPCWSTR UserID;
BOOL MainKey;
LPWSTR Passphrase;
BOOL Skip; INT reserved; } PGPReaderKeyPassphraseNeededEventParams;
#define EID_PGPREADER_KEYPASSPHRASENEEDED 6

virtual INT SECUREBLACKBOX_CALL FireKeyPassphraseNeeded(LPSTR &lpszKeyID, LPSTR &lpszUserID, BOOL &bMainKey, LPSTR &lpszPassphrase, BOOL &bSkip);
class PGPReaderKeyPassphraseNeededEventParams {
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(PGPReaderKeyPassphraseNeededEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireKeyPassphraseNeeded(PGPReaderKeyPassphraseNeededEventParams *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 (which is requested via PassphraseNeeded). The class fires it when it has found a suitable decryption secret key in the keyring, and attempts to use it to decrypt the data.

If the data is encrypted with multiple keys, this event is called for each key in a loop until the password for at least one key is provided correctly. 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.

MultipleFilesFound Event (PGPReader Class)

Fires if the PGP message is recognized to contain multiple files.

Syntax

ANSI (Cross Platform)
virtual int FireMultipleFilesFound(PGPReaderMultipleFilesFoundEventParams *e);
typedef struct {
const char *TarFileName;
int Proceed; int reserved; } PGPReaderMultipleFilesFoundEventParams;
Unicode (Windows) virtual INT FireMultipleFilesFound(PGPReaderMultipleFilesFoundEventParams *e);
typedef struct {
LPCWSTR TarFileName;
BOOL Proceed; INT reserved; } PGPReaderMultipleFilesFoundEventParams;
#define EID_PGPREADER_MULTIPLEFILESFOUND 7

virtual INT SECUREBLACKBOX_CALL FireMultipleFilesFound(LPSTR &lpszTarFileName, BOOL &bProceed);
class PGPReaderMultipleFilesFoundEventParams {
public:
  const QString &TarFileName();

  bool Proceed();
  void SetProceed(bool bProceed);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void MultipleFilesFound(PGPReaderMultipleFilesFoundEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireMultipleFilesFound(PGPReaderMultipleFilesFoundEventParams *e) {...}

Remarks

The class fires this event to report that there is more than one file in the PGP message.

The TarFileName specifies the name of the TAR file containing the files. Tune up Proceed to go ahead or stop the processing.

Notification Event (PGPReader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireNotification(PGPReaderNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } PGPReaderNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(PGPReaderNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } PGPReaderNotificationEventParams;
#define EID_PGPREADER_NOTIFICATION 8

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class PGPReaderNotificationEventParams {
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(PGPReaderNotificationEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireNotification(PGPReaderNotificationEventParams *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.

PassphraseNeeded Event (PGPReader Class)

Requests a data protection password from the application.

Syntax

ANSI (Cross Platform)
virtual int FirePassphraseNeeded(PGPReaderPassphraseNeededEventParams *e);
typedef struct {
char *Passphrase;
int Skip; int reserved; } PGPReaderPassphraseNeededEventParams;
Unicode (Windows) virtual INT FirePassphraseNeeded(PGPReaderPassphraseNeededEventParams *e);
typedef struct {
LPWSTR Passphrase;
BOOL Skip; INT reserved; } PGPReaderPassphraseNeededEventParams;
#define EID_PGPREADER_PASSPHRASENEEDED 9

virtual INT SECUREBLACKBOX_CALL FirePassphraseNeeded(LPSTR &lpszPassphrase, BOOL &bSkip);
class PGPReaderPassphraseNeededEventParams {
public:
  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 PassphraseNeeded(PGPReaderPassphraseNeededEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FirePassphraseNeeded(PGPReaderPassphraseNeededEventParams *e) {...}

Remarks

The class fires this event to request a decryption password. It is only fired if the data can be decrypted without a key.

The event is fired in a loop until the correct password is passed or the number of password attempts is exceeded.

Progress Event (PGPReader Class)

Reports the progress of the decryption operation.

Syntax

ANSI (Cross Platform)
virtual int FireProgress(PGPReaderProgressEventParams *e);
typedef struct {
int64 Current;
int64 Total;
int Cancel; int reserved; } PGPReaderProgressEventParams;
Unicode (Windows) virtual INT FireProgress(PGPReaderProgressEventParams *e);
typedef struct {
LONG64 Current;
LONG64 Total;
BOOL Cancel; INT reserved; } PGPReaderProgressEventParams;
#define EID_PGPREADER_PROGRESS 10

virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lCurrent, LONG64 &lTotal, BOOL &bCancel);
class PGPReaderProgressEventParams {
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(PGPReaderProgressEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireProgress(PGPReaderProgressEventParams *e) {...}

Remarks

The class fires this event repeatedly to report the progress of the file extraction 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 extraction process.

Signed Event (PGPReader Class)

Notifies the application about a signed message.

Syntax

ANSI (Cross Platform)
virtual int FireSigned(PGPReaderSignedEventParams *e);
typedef struct {
const char *KeyIDs;
int SignatureType; int reserved; } PGPReaderSignedEventParams;
Unicode (Windows) virtual INT FireSigned(PGPReaderSignedEventParams *e);
typedef struct {
LPCWSTR KeyIDs;
INT SignatureType; INT reserved; } PGPReaderSignedEventParams;
#define EID_PGPREADER_SIGNED 11

virtual INT SECUREBLACKBOX_CALL FireSigned(LPSTR &lpszKeyIDs, INT &iSignatureType);
class PGPReaderSignedEventParams {
public:
  const QString &KeyIDs();

  int SignatureType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Signed(PGPReaderSignedEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireSigned(PGPReaderSignedEventParams *e) {...}

Remarks

The class fires this event when it identifies a signed message to allow the application to prepare the component for verification.

Use the KeyIDs parameter to identify keys used that were used to sign the message, and make sure they are available in the VerifyingKeys list.

SignatureType indicates the signature type:

pstNormal0A traditional signature, compatible (algorithm permitting) with PGP 2.6.x

pstOnePass1A newer one-pass signature

pstDetached2A detached signature, i.e., a signature contained in a separate file from the data it covers

pstCleartext3A signature made over textual data and appended to it

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.

The following fields are available:

Fields

AsyncDocumentID
char*

Default Value: ""

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

CustomParams
char*

Default Value: ""

Custom parameters to be passed to the signing service (uninterpreted).

Data
char*

Default Value: ""

Additional data to be included in the async state and mirrored back by the requestor.

ExternalHashCalculation
int

Default Value: FALSE

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

HashAlgorithm
char*

Default Value: "SHA256"

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

KeyID
char*

Default Value: ""

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

KeySecret
char*

Default Value: ""

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the KeyID topic.

Method
int

Default Value: 0

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

asmdPKCS10
asmdPKCS71

Mode
int

Default Value: 0

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with the OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

PublicKeyAlgorithm
char*

Default Value: ""

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Constructors

ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

PGPKey Type

This container represents a PGP key.

Syntax

SecureBlackboxPGPKey (declared in secureblackbox.h)

Remarks

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

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

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

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

The following fields are available:

Fields

BitsInKey
int (read-only)

Default Value: 2048

Indicates the key length in bits.

CanEncrypt
int (read-only)

Default Value: FALSE

Returns True if this key can be used for encryption.

CanSign
int (read-only)

Default Value: FALSE

Returns True if this key can be used for signing.

Curve
char* (read-only)

Default Value: ""

Indicates the elliptic curve associated with a EC key.

Supported values:

SB_PGP_CURVE_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

Enabled
int

Default Value: FALSE

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

EncryptionAlgorithm
char* (read-only)

Default Value: "AES128"

Indicates the symmetric algorithm used to encrypt the secret key.

Handle
int64

Default Value: 0

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

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

IsPublic
int (read-only)

Default Value: FALSE

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

IsSecret
int (read-only)

Default Value: FALSE

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

IsSubkey
int (read-only)

Default Value: FALSE

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

KeyFP
char* (read-only)

Default Value: ""

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

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

KeyID
char* (read-only)

Default Value: ""

Contains a 8-byte key identifier.

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

Passphrase
char*

Default Value: ""

The key protection password.

PassphraseValid
int (read-only)

Default Value: FALSE

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

PrimaryKeyID
char* (read-only)

Default Value: ""

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

Protection
int (read-only)

Default Value: 0

Specifies the level of protection applied to the secret key.

Allowed values:

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

PublicKeyAlgorithm
char* (read-only)

Default Value: ""

Specifies the asymmetric algorithm of the key.

QBits
int (read-only)

Default Value: 0

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

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

Timestamp
char* (read-only)

Default Value: ""

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

Username
char* (read-only)

Default Value: ""

Specifies the name of the user bound to this key.

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

ValidTo
char* (read-only)

Default Value: "0"

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

Version
int (read-only)

Default Value: 0

Indicates the key version.

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

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

Constructors

PGPKey()

Creates an empty PGP key object.

PGPSignature Type

A container for PGP signature properties.

Syntax

SecureBlackboxPGPSignature (declared in secureblackbox.h)

Remarks

PGPSignature contains details and validation information for a PGP signature.

The following fields are available:

Fields

CertificationType
int (read-only)

Default Value: 0

Specifies the type of a UserID signature.

pctGeneric0Generic certification of a User ID and Public Key packet. The issuer of this certification does not make any particular assertion as to how well the certifier has checked that the owner of the key is in fact the person described by the User ID. By default user certifications use Generic type.
pctPersona1Persona certification of a User ID and Public Key packet. The issuer of this certification has not done any verification of the claim that the owner of this key corresponds to the specified User ID.
pctCasual2Casual certification of a User ID and a Public Key packet. The issuer of this certification has done some casual verification of the claim of identity.
pctPositive3Positive certification of a User ID and a Public Key packet. The issuer of this certification has done substantial verification of the claim of identity.

CreationTime
char* (read-only)

Default Value: ""

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

ExpirationTime
int (read-only)

Default Value: 0

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

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

Exportable
int (read-only)

Default Value: FALSE

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

Handle
int64

Default Value: 0

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

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

HashAlgorithm
char* (read-only)

Default Value: ""

Specifies the hash algorithm used in the signature.

HashMark
int (read-only)

Default Value: 0

Returns the hash mark attribute of a signature.

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

KeyExpirationTime
int (read-only)

Default Value: 0

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

KeyFlags
int (read-only)

Default Value: 0

Returns the key flags included in the signature.

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

LegacyFormat
int (read-only)

Default Value: FALSE

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

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

PolicyURL
char* (read-only)

Default Value: ""

Contains the URL of the signature policy.

PreferredAlgorithms
char* (read-only)

Default Value: ""

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

PrimaryUserID
int (read-only)

Default Value: FALSE

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

ReasonForRevocation
char* (read-only)

Default Value: ""

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

Revocable
int (read-only)

Default Value: FALSE

Specifies whether the signature can be revoked.

Revocation
int (read-only)

Default Value: FALSE

Indicates whether or not the signature is a revocation signature.

SignatureClass
int (read-only)

Default Value: 0

Indicates the signature class.

pscDocument0Signature over binary file
pscTextDocument1Signature over text
pscStandalone2A standalone signature
pscUIDGeneric3User certification signature
pscUIDPersona4User certification signature (persona)
pscUIDCasual5User certification signature (casual)
pscUIDPositive6User certification signature (positive)
pscSubkeyBinding7Subkey binding signature
pscPrimaryKeyBinding8Primary key binding signature
pscDirectKey9Direct signature over a public key
pscKeyRevocation10Key revocation
pscSubkeyRevocation11Subkey revocation
pscCertRevocation12User revocation
pscTimestamp13Timestamp signature
pscThirdParty14Third-party signature
pscNotSpecified15Signature type not provided

SignerKeyID
char* (read-only)

Default Value: ""

Indicates the KeyID of the signing key.

SignerUserID
char* (read-only)

Default Value: ""

Indicates the UserID associated with the signing key.

StrictlyValid
int (read-only)

Default Value: FALSE

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

Target
char* (read-only)

Default Value: ""

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

TextSignature
int (read-only)

Default Value: FALSE

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

TrustAmount
int (read-only)

Default Value: 0

Specifies the amount of trust assigned by this signature.

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

TrustLevel
int (read-only)

Default Value: 0

The trust level assigned by this signature.

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

Validated
int (read-only)

Default Value: FALSE

Whether the signature has been validated.

Validity
int (read-only)

Default Value: 0

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

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

Version
int (read-only)

Default Value: 0

Indicates the signature version.

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

Constructors

PGPSignature()

Creates an empty PGPSignature object.

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

Methods

GetCount This method returns the current size of the collection.

int GetCount() {}

SetCount This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.

int SetCount(int count) {}

Get This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.

T* Get(int index) {}

Set This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.

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

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

PGPReader Config Settings

IgnoreDataPacketLengths:   Whether to check the length of input data packets.

Set this property to True to prevent the class from checking input packet lengths.

PasswordAttempts:   The number of attempts allowed for entering password.

Use this property to specify how many times a wrong password may be entered.

TempPath:   Path for storing temporary files.

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

UndefInputLength:   Set this property if you are working with non-seekable streams.

Use this property to turn on support for streams with unknown length and position parameters, such as network or database streams. It prevents the class from checking input stream length or position.

UseGreedyMemoryConsumption:   Whether to limit memory consumption for the cost of speed.

When this property is True, the class uses more memory, but decrypts data faster. Otherwise, less memory is consumed, but the decryption is slower.

Base Config Settings

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

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

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

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

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

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

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

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

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

Supported values are:

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.

DNSLocalSuffix:   The suffix to assign for TLD names.

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

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

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

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

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

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

HardwareCryptoUsePolicy:   The hardware crypto usage policy.

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

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

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

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

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

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

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

ListDelimiter:   The delimiter character for multi-element lists.

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

LogDestination:   Specifies the debug log destination.

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

Supported values are:

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.

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

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

ProductVersion:   Returns the version of the SecureBlackbox library.

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

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

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

StaticDNS:   Specifies whether static DNS rules should be used.

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

Supported values are:

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

UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

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

UseLegacyAdESValidation:   Enables legacy AdES validation mode.

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

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

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

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

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

UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

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

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

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

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

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

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

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

PGPReader Errors

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