PGPReader Class
Properties Methods Events Configuration Settings Errors
The PGPReader class reads and unprotects protected PGP files.
Syntax
SecureBlackboxPGPReader
SecureBlackboxPGPReaderSwift
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.
| - armored | Indicates if the processed message had been base64-armored. |
| - compressed | Indicates if the processed message had been compressed. |
| - decryptingKeyCount | The number of records in the DecryptingKey arrays. |
| - decryptingKeyHandle:(int)decryptingKeyIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - decryptingKeyKeyFP:(int)decryptingKeyIndex | The 20-byte fingerprint (hash value) of this key. |
| - decryptingKeyKeyID:(int)decryptingKeyIndex | Contains a 8-byte key identifier. |
| - decryptingKeyPassphrase:(int)decryptingKeyIndex | The key protection password. |
| - decryptingKeyPassphraseValid:(int)decryptingKeyIndex | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
| - decryptingKeyUsername:(int)decryptingKeyIndex | Specifies the name of the user bound to this key. |
| - externalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
| - externalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
| - externalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| - externalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
| - externalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
| - externalCryptoKeySecret | The pre-shared key used for DC request authentication. |
| - externalCryptoMethod | Specifies the asynchronous signing method. |
| - externalCryptoMode | Specifies the external cryptography mode. |
| - externalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
| - 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. |
| - signatureCount | The number of records in the Signature arrays. |
| - signatureCertificationType:(int)signatureIndex | Specifies the type of a UserID signature. |
| - signatureCreationTime:(int)signatureIndex | The time when the signature was created, in Universal Coordinated Time (UTC). |
| - signatureExpirationTime:(int)signatureIndex | Specifies signature expiration time, in seconds since its creation time (CreationTime). |
| - signatureExportable:(int)signatureIndex | Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer. |
| - signatureHandle:(int)signatureIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - signatureHashAlgorithm:(int)signatureIndex | Specifies the hash algorithm used in the signature. |
| - signatureKeyExpirationTime:(int)signatureIndex | The number of seconds after which the signed key will expire. |
| - signatureLegacyFormat:(int)signatureIndex | Indicates whether signature uses PGP 2. |
| - signaturePolicyURL:(int)signatureIndex | Contains the URL of the signature policy. |
| - signaturePrimaryUserID:(int)signatureIndex | Indicates whether the UserID covered by the signature is the main user id for this key. |
| - signatureReasonForRevocation:(int)signatureIndex | Describes the reason why the key or the certificate was revoked. |
| - signatureRevocable:(int)signatureIndex | Specifies whether the signature can be revoked. |
| - signatureRevocation:(int)signatureIndex | Indicates whether or not the signature is a revocation signature. |
| - signatureSignatureClass:(int)signatureIndex | Indicates the signature class. |
| - signatureSignerKeyID:(int)signatureIndex | Indicates the KeyID of the signing key. |
| - signatureSignerUserID:(int)signatureIndex | Indicates the UserID associated with the signing key. |
| - signatureStrictlyValid:(int)signatureIndex | Returns True if this signature is valid in a strict way (no compatibility relaxations). |
| - signatureTextSignature:(int)signatureIndex | Indicates whether or not the signature is made over a text document. |
| - signatureTrustAmount:(int)signatureIndex | Specifies the amount of trust assigned by this signature. |
| - signatureTrustLevel:(int)signatureIndex | The trust level assigned by this signature. |
| - signatureValidated:(int)signatureIndex | Whether the signature has been validated. |
| - signatureValidity:(int)signatureIndex | Provides the validity status of the signature if the signature has been validated. |
| - signatureVersion:(int)signatureIndex | Indicates the signature version. |
| - verifyingKeyCount | The number of records in the VerifyingKey arrays. |
| - verifyingKeyHandle:(int)verifyingKeyIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - verifyingKeyKeyFP:(int)verifyingKeyIndex | The 20-byte fingerprint (hash value) of this key. |
| - verifyingKeyKeyID:(int)verifyingKeyIndex | Contains a 8-byte key identifier. |
| - verifyingKeyUsername:(int)verifyingKeyIndex | Specifies 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.
| - 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 class with short descriptions. Click on the links for further details.
| - onEncryptionInfo | Reports early information on encryption parameters. |
| - onError | Information about errors during PGP decryption/verification. |
| - onExternalDecrypt | Handles remote or external decryption. |
| - onFileExtractionStart | Reports the beginning of file extraction process. |
| - onKeyPassphraseNeeded | Requests a key protection password from the application. |
| - onMultipleFilesFound | Fires if the PGP message is recognized to contain multiple files. |
| - onNotification | This event notifies the application about an underlying control flow event. |
| - onPassphraseNeeded | Requests a data protection password from the application. |
| - onProgress | Reports the progress of the decryption operation. |
| - onSigned | Notifies 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.
| 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 class (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 classes 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. |