PGPReader Component
Properties Methods Events Configuration Settings Errors
The PGPReader component reads and unprotects protected PGP files.
Syntax
TsbxPGPReader
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 component with short descriptions. Click on the links for further details.
| Armored | Indicates if the processed message had been base64-armored. |
| Compressed | Indicates if the processed message had been compressed. |
| DecryptingKeys | A collection of keys to be used for decryption. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| KeyPassphrase | Specifies a passphrase for the decryption key. |
| Passphrase | Specifies a message decryption password. |
| ProcessedLength | Reports the number of bytes processed. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| Signatures | Contains signatures that were included in the protected message. |
| VerifyingKeys | A collection of keys to be used for signature verification. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| DecryptAndVerify | Decrypts and verifies a protected message. |
| DecryptAndVerifyFile | Decrypts and verifies a protected message. |
| DecryptAndVerifyString | Decrypts and verifies a protected message. |
| VerifyDetached | Verifies a detached signature. |
| VerifyDetachedFile | Verifies a detached signature. |
| VerifyDetachedString | Verifies a detached signature. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| EncryptionInfo | Reports early information on encryption parameters. |
| Error | Information about errors during PGP decryption/verification. |
| ExternalDecrypt | Handles remote or external decryption. |
| FileExtractionStart | Reports the beginning of file extraction process. |
| KeyPassphraseNeeded | Requests a key protection password from the application. |
| MultipleFilesFound | Fires if the PGP message is recognized to contain multiple files. |
| Notification | This event notifies the application about an underlying control flow event. |
| PassphraseNeeded | Requests a data protection password from the application. |
| Progress | Reports the progress of the decryption operation. |
| Signed | Notifies the application about a signed message. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| IgnoreDataPacketLengths | Whether to check the length of input data packets. |
| PasswordAttempts | The number of attempts allowed for entering password. |
| TempPath | Path for storing temporary files. |
| UndefInputLength | Set this property if you are working with non-seekable streams. |
| UseGreedyMemoryConsumption | Whether to limit memory consumption for the cost of speed. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |