SecureBlackbox 2020 macOS Edition

Questions / Feedback?

PGPReader Module

Properties   Methods   Events   Configuration Settings   Errors  

The PGPReader component reads and unprotects protected PGP files.

Syntax

nsoftware.SecureBlackbox.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 module 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.
DecryptingKeysA collection of keys to be used for decryption.
ExternalCryptoProvides access to external signing and DC parameters.
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.
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 module 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 module 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 module 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 component (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 components 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 macOS Edition - Version 20.0 [Build 8165]