PGPWriter Class
Properties Methods Events Configuration Settings Errors
The PGPWriter class protects data using PGP keys and certificates.
Syntax
class secureblackbox.PGPWriter
Remarks
PGPWriter allows you to encrypt, sign, armor, and compress the input 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.
| armor | Specifies whether the data should be armored. |
| armor_boundary | A boundary to put around the base64 armor. |
| armor_headers | Additional headers to include with the armored message. |
| compress | Whether to compress the data before encrypting it. |
| compression_algorithm | The compression algorithm to use. |
| compression_level | The compression level to use. |
| encrypting_key_count | The number of records in the EncryptingKey arrays. |
| encrypting_key_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| encrypting_key_key_fp | The 20-byte fingerprint (hash value) of this key. |
| encrypting_key_key_id | Contains a 8-byte key identifier. |
| encrypting_key_username | Specifies the name of the user bound to this key. |
| encryption_algorithm | A symmetric algorithm to use for data encryption. |
| external_crypto_custom_params | Custom parameters to be passed to the signing service (uninterpreted). |
| external_crypto_data | Additional data to be included in the async state and mirrored back by the requestor. |
| external_crypto_external_hash_calculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| external_crypto_hash_algorithm | Specifies the request's signature hash algorithm. |
| external_crypto_key_id | The ID of the pre-shared key used for DC request authentication. |
| external_crypto_key_secret | The pre-shared key used for DC request authentication. |
| external_crypto_method | Specifies the asynchronous signing method. |
| external_crypto_mode | Specifies the external cryptography mode. |
| external_crypto_public_key_algorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
| filename | Specifies the name of the file being protected. |
| hash_algorithm | The hash algorithm to use for signing. |
| input_is_text | Whether the input data is text. |
| passphrase | The encryption password. |
| profile | Specifies a pre-defined profile to apply when creating the signature. |
| protection | Specifies a password protection level. |
| signing_key_count | The number of records in the SigningKey arrays. |
| signing_key_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| signing_key_key_fp | The 20-byte fingerprint (hash value) of this key. |
| signing_key_key_id | Contains a 8-byte key identifier. |
| signing_key_passphrase | The key protection password. |
| signing_key_passphrase_valid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
| signing_key_username | Specifies the name of the user bound to this key. |
| timestamp | The date and time of the last modification of the protected data file (in UTC). |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| clear_text_sign | Creates a cleartext signature over the provided data. |
| clear_text_sign_file | Creates a cleartext signature over the provided data. |
| clear_text_sign_string | Creates a cleartext signature over the provided data. |
| config | Sets or retrieves a configuration setting. |
| encrypt | Encrypts a buffer. |
| encrypt_and_sign | Encrypts and signs a buffer. |
| encrypt_and_sign_file | Encrypts and signs a file. |
| encrypt_and_sign_folder | Encrypts and signs a folder. |
| encrypt_and_sign_string | Encrypts and signs a string. |
| encrypt_file | Encrypts a file. |
| encrypt_folder | Encrypts a folder. |
| encrypt_string | Encrypts a string. |
| sign | Signs a buffer. |
| sign_file | Signs a file. |
| sign_folder | Signs a folder. |
| sign_string | Signs a string. |
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.
| on_error | Information about errors during PGP encryption. |
| on_external_sign | Handles remote or external signing initiated by the SignExternal method or other source. |
| on_key_passphrase_needed | Requests a key protection password from the application. |
| on_notification | This event notifies the application about an underlying control flow event. |
| on_progress | Reports the progress of the decryption operation. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| PasswordAttempts | The number of attempts allowed for entering password. |
| PreserveFilePaths | Whether to preserve full file names when saving the PGP file. |
| SignBufferingMethod | The type of buffering used during signing. |
| TempPath | Path for storing temporary files. |
| TextCompatibilityMode | Whether whitespaces must be trimmed from the signature. |
| UndefInputLength | Set this property if you are working with non-seekable streams. |
| UseNewFeatures | Whether the new algorithms, or only the algorithms compatible with PGP 2.6.x, are allowed. |
| UseOldPackets | Whether signature packets of old format, compatible with PGP 2.6.3, should be used. |
| 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. |