SecureBlackbox 2020 Qt Edition

Questions / Feedback?

PGPReader Class

Properties   Methods   Events   Configuration 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.
DecryptingKeyCountThe number of records in the DecryptingKey arrays.
DecryptingKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
DecryptingKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
DecryptingKeyKeyIDContains a 8-byte key identifier.
DecryptingKeyPassphraseThe key protection password.
DecryptingKeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
DecryptingKeyUsernameSpecifies the name of the user bound to this key.
ExternalCryptoCustomParamsCustom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoDataAdditional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculationSpecifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithmSpecifies the request's signature hash algorithm.
ExternalCryptoKeyIDThe ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecretThe pre-shared key used for DC request authentication.
ExternalCryptoMethodSpecifies the asynchronous signing method.
ExternalCryptoModeSpecifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithmProvide public key algorithm here if the certificate is not available on the pre-signing stage.
KeyPassphraseSpecifies a passphrase for the decryption key.
PassphraseSpecifies a message decryption password.
ProcessedLengthReports the number of bytes processed.
ProfileSpecifies a pre-defined profile to apply when creating the signature.
SignatureCountThe number of records in the Signature arrays.
SignatureCertificationTypeSpecifies the type of a UserID signature.
SignatureCreationTimeThe time when the signature was created, in Universal Coordinated Time (UTC).
SignatureExpirationTimeSpecifies signature expiration time, in seconds since its creation time (CreationTime).
SignatureExportableSpecifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.
SignatureHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SignatureHashAlgorithmSpecifies the hash algorithm used in the signature.
SignatureKeyExpirationTimeThe number of seconds after which the signed key will expire.
SignatureLegacyFormatIndicates whether signature uses PGP 2.
SignaturePolicyURLContains the URL of the signature policy.
SignaturePrimaryUserIDIndicates whether the UserID covered by the signature is the main user id for this key.
SignatureReasonForRevocationDescribes the reason why the key or the certificate was revoked.
SignatureRevocableSpecifies whether the signature can be revoked.
SignatureRevocationIndicates whether or not the signature is a revocation signature.
SignatureSignatureClassIndicates the signature class.
SignatureSignerKeyIDIndicates the KeyID of the signing key.
SignatureSignerUserIDIndicates the UserID associated with the signing key.
SignatureStrictlyValidReturns True if this signature is valid in a strict way (no compatibility relaxations).
SignatureTextSignatureIndicates whether or not the signature is made over a text document.
SignatureTrustAmountSpecifies the amount of trust assigned by this signature.
SignatureTrustLevelThe trust level assigned by this signature.
SignatureValidatedWhether the signature has been validated.
SignatureValidityProvides the validity status of the signature if the signature has been validated.
SignatureVersionIndicates the signature version.
VerifyingKeyCountThe number of records in the VerifyingKey arrays.
VerifyingKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
VerifyingKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
VerifyingKeyKeyIDContains a 8-byte key identifier.
VerifyingKeyUsernameSpecifies the name of the user bound to this key.

Method List


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

ConfigSets or retrieves a configuration setting.
DecryptAndVerifyDecrypts and verifies a protected message.
DecryptAndVerifyFileDecrypts and verifies a protected message.
DecryptAndVerifyStringDecrypts and verifies a protected message.
VerifyDetachedVerifies a detached signature.
VerifyDetachedFileVerifies a detached signature.
VerifyDetachedStringVerifies 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.
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.

Configuration Settings


The following is a list of configuration 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.
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 (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Qt Edition - Version 20.0 [Build 8154]