PDFDecryptor Class
Properties Methods Events Configuration Settings Errors
The PDFDecryptor class decrypts PDF documents.
Syntax
class secureblackbox.PDFDecryptor
Remarks
PDFDecryptor decrypts PDF documents encrypted with passwords or certificates.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| decryption_certificate_bytes | Returns raw certificate data in DER format. |
| decryption_certificate_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| decryption_cert_count | The number of records in the DecryptionCert arrays. |
| decryption_cert_bytes | Returns raw certificate data in DER format. |
| decryption_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| encrypted | Indicates if the PDF document is encrypted. |
| encryption_algorithm | The symmetric algorithm used to encrypt the document. |
| encryption_type | The document encryption type. |
| 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. |
| input_bytes | Use this property to pass the input to class in the byte array form. |
| input_file | The PDF file to be decrypted. |
| metadata_encrypted | Indicates if the document metadata is encrypted. |
| output_bytes | Use this property to read the output the class object has produced. |
| output_file | The file to save the decrypted document to. |
| password | The decryption password. |
| perms_annotations | Indicates whether the viewer may add annotations to the document. |
| perms_assemble | Indicates if the viewer may assemble a new document on the basis of the encrypted one. |
| perms_extract | Indicates if the user may extract (copy) pictures and text from the encrypted document. |
| perms_extract_acc | Indicates if the user may extract pictures/text from the document for accessibility purposes. |
| perms_fill_in_forms | Indicates if the user may fill in forms in the document. |
| perms_high_quality_print | Indicates if the document may be printed in high quality. |
| perms_low_quality_print | Indicates if the document may be printed in low quality. |
| perms_modify | Indicates if the document may be modified. |
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. |
| decrypt | Decrypts a PDF document. |
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_decryption_info_needed | Requests decryption information during decryption, signing, or validation. |
| on_error | Information about errors during signing/validation. |
| on_external_decrypt | Handles remote or external decryption. |
| on_notification | This event notifies the application about an underlying control flow event. |
| on_recipient_found | Provides recipient certificate details to the application. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| EncryptionHandlerName | Specifies the custom security handler PDF-name. |
| HardenedKeyGeneration | Specifies if hardened Key generation should be used. |
| RC4KeyBits | Specifies the number of key bits used for RC4 algorithm. |
| TempPath | Location where the temporary files are stored. |
| 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. |