PDFEncryptor Class
Properties Methods Events Configuration Settings Errors
The PDFEncryptor class encrypts PDF documents.
Syntax
class secureblackbox.PDFEncryptor
Remarks
PDFEncryptor encrypts PDF documents 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.
| encryption_algorithm | The encryption algorithm to encrypt the document with. |
| encryption_certificate_bytes | Returns raw certificate data in DER format. |
| encryption_certificate_ca | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| encryption_certificate_ca_key_id | A unique identifier (fingerprint) of the CA certificate's private key. |
| encryption_certificate_crl_distribution_points | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| encryption_certificate_curve | Specifies the elliptic curve of the EC public key. |
| encryption_certificate_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| encryption_certificate_friendly_name | Contains an associated alias (friendly name) of the certificate. |
| encryption_certificate_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| encryption_certificate_hash_algorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
| encryption_certificate_issuer | The common name of the certificate issuer (CA), typically a company name. |
| encryption_certificate_issuer_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| encryption_certificate_key_algorithm | Specifies the public key algorithm of this certificate. |
| encryption_certificate_key_bits | Returns the length of the public key. |
| encryption_certificate_key_fingerprint | Returns a fingerprint of the public key contained in the certificate. |
| encryption_certificate_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| encryption_certificate_key_valid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| encryption_certificate_ocsp_locations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| encryption_certificate_origin | Returns the origin of this certificate. |
| encryption_certificate_policy_i_ds | Contains identifiers (OIDs) of the applicable certificate policies. |
| encryption_certificate_private_key_bytes | Contains the certificate's private key. |
| encryption_certificate_private_key_exists | Indicates whether the certificate has an associated private key. |
| encryption_certificate_private_key_extractable | Indicates whether the private key is extractable. |
| encryption_certificate_public_key_bytes | Contains the certificate's public key in DER format. |
| encryption_certificate_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| encryption_certificate_serial_number | Returns the certificate's serial number. |
| encryption_certificate_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| encryption_certificate_subject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| encryption_certificate_subject_key_id | Contains a unique identifier (fingerprint) of the certificate's private key. |
| encryption_certificate_subject_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| encryption_certificate_valid_from | The time point at which the certificate becomes valid, in UTC. |
| encryption_certificate_valid_to | The time point at which the certificate expires, in UTC. |
| encryption_cert_count | The number of records in the EncryptionCert arrays. |
| encryption_cert_bytes | Returns raw certificate data in DER format. |
| encryption_cert_ca | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| encryption_cert_ca_key_id | A unique identifier (fingerprint) of the CA certificate's private key. |
| encryption_cert_crl_distribution_points | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| encryption_cert_curve | Specifies the elliptic curve of the EC public key. |
| encryption_cert_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| encryption_cert_friendly_name | Contains an associated alias (friendly name) of the certificate. |
| encryption_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| encryption_cert_hash_algorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
| encryption_cert_issuer | The common name of the certificate issuer (CA), typically a company name. |
| encryption_cert_issuer_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| encryption_cert_key_algorithm | Specifies the public key algorithm of this certificate. |
| encryption_cert_key_bits | Returns the length of the public key. |
| encryption_cert_key_fingerprint | Returns a fingerprint of the public key contained in the certificate. |
| encryption_cert_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| encryption_cert_key_valid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| encryption_cert_ocsp_locations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| encryption_cert_origin | Returns the origin of this certificate. |
| encryption_cert_policy_i_ds | Contains identifiers (OIDs) of the applicable certificate policies. |
| encryption_cert_private_key_bytes | Contains the certificate's private key. |
| encryption_cert_private_key_exists | Indicates whether the certificate has an associated private key. |
| encryption_cert_private_key_extractable | Indicates whether the private key is extractable. |
| encryption_cert_public_key_bytes | Contains the certificate's public key in DER format. |
| encryption_cert_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| encryption_cert_serial_number | Returns the certificate's serial number. |
| encryption_cert_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| encryption_cert_subject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| encryption_cert_subject_key_id | Contains a unique identifier (fingerprint) of the certificate's private key. |
| encryption_cert_subject_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| encryption_cert_valid_from | The time point at which the certificate becomes valid, in UTC. |
| encryption_cert_valid_to | The time point at which the certificate expires, in UTC. |
| encryption_type | The encryption type. |
| encrypt_metadata | Specifies whether to encrypt the document metadata. |
| input_bytes | Use this property to pass the input to class in the byte array form. |
| input_file | The PDF file to be encrypted. |
| output_bytes | Use this property to read the output the class object has produced. |
| output_file | The file to save the encrypted document to. |
| owner_password | The owner 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. |
| user_password | The user password. |
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. |
| encrypt | Encrypts the 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_error | Information about errors during encryption. |
| on_notification | This event notifies the application about an underlying control flow event. |
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. |