PDFEncryptor Class

Properties   Methods   Events   Config 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.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

document_info_encryption_algorithm Property

The symmetric algorithm used to encrypt the document.

Syntax

def get_document_info_encryption_algorithm() -> str: ...

document_info_encryption_algorithm = property(get_document_info_encryption_algorithm, None)

Default Value

""

Remarks

The symmetric algorithm used to encrypt the document.

This property contains the encryption algorithm that was used to encrypt the PDF document.

Supported values:

This property is read-only.

document_info_encryption_type Property

The document encryption type.

Syntax

def get_document_info_encryption_type() -> int: ...

document_info_encryption_type = property(get_document_info_encryption_type, None)

Default Value

1

Remarks

The document encryption type.

This property indicates the kind of encryption that was used to encrypt the PDF document.

Supported values:

This property is read-only.

document_info_metadata_encrypted Property

Indicates if the document metadata is encrypted.

Syntax

def get_document_info_metadata_encrypted() -> bool: ...

document_info_metadata_encrypted = property(get_document_info_metadata_encrypted, None)

Default Value

TRUE

Remarks

Indicates if the document metadata is encrypted.

Use this property to check if the document metadata is encrypted.

Metadata contains additional information about the document such as its name and author.

This property is read-only.

document_info_permissions Property

Contains the document permissions associated with the encryption.

Syntax

def get_document_info_permissions() -> int: ...

document_info_permissions = property(get_document_info_permissions, None)

Default Value

0

Remarks

Contains the document permissions associated with the encryption.

Use this property to check the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents. Contains a bit mask of the following flags:

This property is read-only.

encryption_algorithm Property

The encryption algorithm to encrypt the document with.

Syntax

def get_encryption_algorithm() -> str: ...
def set_encryption_algorithm(value: str) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

"AES256"

Remarks

Use this property to specify the encryption algorithm to encrypt the PDF document with.

Supported values:

encryption_certificate_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_encryption_certificate_bytes() -> bytes: ...

encryption_certificate_bytes = property(get_encryption_certificate_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

encryption_certificate_ca Property

Indicates whether the certificate has a CA capability.

Syntax

def get_encryption_certificate_ca() -> bool: ...
def set_encryption_certificate_ca(value: bool) -> None: ...

encryption_certificate_ca = property(get_encryption_certificate_ca, set_encryption_certificate_ca)

Default Value

FALSE

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

encryption_certificate_ca_key_id Property

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

def get_encryption_certificate_ca_key_id() -> bytes: ...

encryption_certificate_ca_key_id = property(get_encryption_certificate_ca_key_id, None)

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the encryption_certificate_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

encryption_certificate_cert_type Property

Returns the type of the entity contained in the Certificate object.

Syntax

def get_encryption_certificate_cert_type() -> int: ...

encryption_certificate_cert_type = property(get_encryption_certificate_cert_type, None)

Default Value

0

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

This property is read-only.

encryption_certificate_crl_distribution_points Property

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

def get_encryption_certificate_crl_distribution_points() -> str: ...
def set_encryption_certificate_crl_distribution_points(value: str) -> None: ...

encryption_certificate_crl_distribution_points = property(get_encryption_certificate_crl_distribution_points, set_encryption_certificate_crl_distribution_points)

Default Value

""

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

encryption_certificate_curve Property

Specifies the elliptic curve associated with the certificate's public key.

Syntax

def get_encryption_certificate_curve() -> str: ...
def set_encryption_certificate_curve(value: str) -> None: ...

encryption_certificate_curve = property(get_encryption_certificate_curve, set_encryption_certificate_curve)

Default Value

""

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

encryption_certificate_fingerprint Property

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

def get_encryption_certificate_fingerprint() -> str: ...

encryption_certificate_fingerprint = property(get_encryption_certificate_fingerprint, None)

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

This property is read-only.

encryption_certificate_friendly_name Property

Contains an associated alias (friendly name) of the certificate.

Syntax

def get_encryption_certificate_friendly_name() -> str: ...

encryption_certificate_friendly_name = property(get_encryption_certificate_friendly_name, None)

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

This property is read-only.

encryption_certificate_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_encryption_certificate_handle() -> int: ...
def set_encryption_certificate_handle(value: int) -> None: ...

encryption_certificate_handle = property(get_encryption_certificate_handle, set_encryption_certificate_handle)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

encryption_certificate_hash_algorithm Property

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

def get_encryption_certificate_hash_algorithm() -> str: ...
def set_encryption_certificate_hash_algorithm(value: str) -> None: ...

encryption_certificate_hash_algorithm = property(get_encryption_certificate_hash_algorithm, set_encryption_certificate_hash_algorithm)

Default Value

""

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use encryption_certificate_sig_algorithm to find out the hash algorithm that is part of the certificate signature.

encryption_certificate_issuer Property

The common name of the certificate issuer (CA), typically a company name.

Syntax

def get_encryption_certificate_issuer() -> str: ...

encryption_certificate_issuer = property(get_encryption_certificate_issuer, None)

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via encryption_certificate_issuer_rdn.

This property is read-only.

encryption_certificate_issuer_rdn Property

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

def get_encryption_certificate_issuer_rdn() -> str: ...
def set_encryption_certificate_issuer_rdn(value: str) -> None: ...

encryption_certificate_issuer_rdn = property(get_encryption_certificate_issuer_rdn, set_encryption_certificate_issuer_rdn)

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

encryption_certificate_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_encryption_certificate_key_algorithm() -> str: ...
def set_encryption_certificate_key_algorithm(value: str) -> None: ...

encryption_certificate_key_algorithm = property(get_encryption_certificate_key_algorithm, set_encryption_certificate_key_algorithm)

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the encryption_certificate_key_bits, encryption_certificate_curve, and encryption_certificate_public_key_bytes properties to get more details about the key the certificate contains.

encryption_certificate_key_bits Property

Returns the length of the public key in bits.

Syntax

def get_encryption_certificate_key_bits() -> int: ...

encryption_certificate_key_bits = property(get_encryption_certificate_key_bits, None)

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the encryption_certificate_public_key_bytes or encryption_certificate_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

encryption_certificate_key_fingerprint Property

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

def get_encryption_certificate_key_fingerprint() -> str: ...

encryption_certificate_key_fingerprint = property(get_encryption_certificate_key_fingerprint, None)

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the encryption_certificate_fingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

encryption_certificate_key_usage Property

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

def get_encryption_certificate_key_usage() -> int: ...
def set_encryption_certificate_key_usage(value: int) -> None: ...

encryption_certificate_key_usage = property(get_encryption_certificate_key_usage, set_encryption_certificate_key_usage)

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

encryption_certificate_key_valid Property

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

def get_encryption_certificate_key_valid() -> bool: ...

encryption_certificate_key_valid = property(get_encryption_certificate_key_valid, None)

Default Value

FALSE

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

This property is read-only.

encryption_certificate_ocsp_locations Property

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

def get_encryption_certificate_ocsp_locations() -> str: ...
def set_encryption_certificate_ocsp_locations(value: str) -> None: ...

encryption_certificate_ocsp_locations = property(get_encryption_certificate_ocsp_locations, set_encryption_certificate_ocsp_locations)

Default Value

""

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

encryption_certificate_ocsp_no_check Property

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

def get_encryption_certificate_ocsp_no_check() -> bool: ...
def set_encryption_certificate_ocsp_no_check(value: bool) -> None: ...

encryption_certificate_ocsp_no_check = property(get_encryption_certificate_ocsp_no_check, set_encryption_certificate_ocsp_no_check)

Default Value

FALSE

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

encryption_certificate_origin Property

Returns the location that the certificate was taken or loaded from.

Syntax

def get_encryption_certificate_origin() -> int: ...

encryption_certificate_origin = property(get_encryption_certificate_origin, None)

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

This property is read-only.

encryption_certificate_policy_i_ds Property

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

def get_encryption_certificate_policy_i_ds() -> str: ...
def set_encryption_certificate_policy_i_ds(value: str) -> None: ...

encryption_certificate_policy_i_ds = property(get_encryption_certificate_policy_i_ds, set_encryption_certificate_policy_i_ds)

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

encryption_certificate_private_key_bytes Property

Returns the certificate's private key in DER-encoded format.

Syntax

def get_encryption_certificate_private_key_bytes() -> bytes: ...

encryption_certificate_private_key_bytes = property(get_encryption_certificate_private_key_bytes, None)

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

This property is read-only.

encryption_certificate_private_key_exists Property

Indicates whether the certificate has a usable private key associated with it.

Syntax

def get_encryption_certificate_private_key_exists() -> bool: ...

encryption_certificate_private_key_exists = property(get_encryption_certificate_private_key_exists, None)

Default Value

FALSE

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from encryption_certificate_private_key_bytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

This property is read-only.

encryption_certificate_private_key_extractable Property

Indicates whether the private key is extractable (exportable).

Syntax

def get_encryption_certificate_private_key_extractable() -> bool: ...

encryption_certificate_private_key_extractable = property(get_encryption_certificate_private_key_extractable, None)

Default Value

FALSE

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

encryption_certificate_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

def get_encryption_certificate_public_key_bytes() -> bytes: ...

encryption_certificate_public_key_bytes = property(get_encryption_certificate_public_key_bytes, None)

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

This property is read-only.

encryption_certificate_qualified Property

Indicates whether the certificate is qualified.

Syntax

def get_encryption_certificate_qualified() -> bool: ...

encryption_certificate_qualified = property(get_encryption_certificate_qualified, None)

Default Value

FALSE

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

This property is read-only.

encryption_certificate_qualified_statements Property

Returns a simplified qualified status of the certificate.

Syntax

def get_encryption_certificate_qualified_statements() -> int: ...
def set_encryption_certificate_qualified_statements(value: int) -> None: ...

encryption_certificate_qualified_statements = property(get_encryption_certificate_qualified_statements, set_encryption_certificate_qualified_statements)

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

encryption_certificate_qualifiers Property

A list of qualifiers.

Syntax

def get_encryption_certificate_qualifiers() -> str: ...

encryption_certificate_qualifiers = property(get_encryption_certificate_qualifiers, None)

Default Value

""

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

This property is read-only.

encryption_certificate_self_signed Property

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

def get_encryption_certificate_self_signed() -> bool: ...

encryption_certificate_self_signed = property(get_encryption_certificate_self_signed, None)

Default Value

FALSE

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

This property is read-only.

encryption_certificate_serial_number Property

Returns the certificate's serial number.

Syntax

def get_encryption_certificate_serial_number() -> bytes: ...
def set_encryption_certificate_serial_number(value: bytes) -> None: ...

encryption_certificate_serial_number = property(get_encryption_certificate_serial_number, set_encryption_certificate_serial_number)

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

encryption_certificate_sig_algorithm Property

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

def get_encryption_certificate_sig_algorithm() -> str: ...

encryption_certificate_sig_algorithm = property(get_encryption_certificate_sig_algorithm, None)

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

This property is read-only.

encryption_certificate_source Property

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

def get_encryption_certificate_source() -> int: ...

encryption_certificate_source = property(get_encryption_certificate_source, None)

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

This property is read-only.

encryption_certificate_subject Property

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

def get_encryption_certificate_subject() -> str: ...

encryption_certificate_subject = property(get_encryption_certificate_subject, None)

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via encryption_certificate_subject_rdn.

This property is read-only.

encryption_certificate_subject_alternative_name Property

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

def get_encryption_certificate_subject_alternative_name() -> str: ...
def set_encryption_certificate_subject_alternative_name(value: str) -> None: ...

encryption_certificate_subject_alternative_name = property(get_encryption_certificate_subject_alternative_name, set_encryption_certificate_subject_alternative_name)

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main encryption_certificate_subject_rdn field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

encryption_certificate_subject_key_id Property

Contains a unique identifier of the certificate's cryptographic key.

Syntax

def get_encryption_certificate_subject_key_id() -> bytes: ...
def set_encryption_certificate_subject_key_id(value: bytes) -> None: ...

encryption_certificate_subject_key_id = property(get_encryption_certificate_subject_key_id, set_encryption_certificate_subject_key_id)

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The encryption_certificate_subject_key_id and encryption_certificate_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

encryption_certificate_subject_rdn Property

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

def get_encryption_certificate_subject_rdn() -> str: ...
def set_encryption_certificate_subject_rdn(value: str) -> None: ...

encryption_certificate_subject_rdn = property(get_encryption_certificate_subject_rdn, set_encryption_certificate_subject_rdn)

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

encryption_certificate_valid Property

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

def get_encryption_certificate_valid() -> bool: ...

encryption_certificate_valid = property(get_encryption_certificate_valid, None)

Default Value

FALSE

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

This property is read-only.

encryption_certificate_valid_from Property

The time point at which the certificate becomes valid, in UTC.

Syntax

def get_encryption_certificate_valid_from() -> str: ...
def set_encryption_certificate_valid_from(value: str) -> None: ...

encryption_certificate_valid_from = property(get_encryption_certificate_valid_from, set_encryption_certificate_valid_from)

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

encryption_certificate_valid_to Property

The time point at which the certificate expires, in UTC.

Syntax

def get_encryption_certificate_valid_to() -> str: ...
def set_encryption_certificate_valid_to(value: str) -> None: ...

encryption_certificate_valid_to = property(get_encryption_certificate_valid_to, set_encryption_certificate_valid_to)

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

encrypt_metadata Property

Specifies whether to encrypt the document metadata.

Syntax

def get_encrypt_metadata() -> bool: ...
def set_encrypt_metadata(value: bool) -> None: ...

encrypt_metadata = property(get_encrypt_metadata, set_encrypt_metadata)

Default Value

TRUE

Remarks

Use this property to enable or disable metadata encryption.

Metadata contains additional information about the document, such as its name and author.

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

input_bytes Property

Use this property to pass the input to class in byte array form.

Syntax

def get_input_bytes() -> bytes: ...
def set_input_bytes(value: bytes) -> None: ...

input_bytes = property(get_input_bytes, set_input_bytes)

Remarks

Assign a byte array containing the data to be processed to this property.

input_file Property

The PDF file to be encrypted.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

Default Value

""

Remarks

Provide the path to the PDF document to be encrypted.

output_bytes Property

Use this property to read the output the class object has produced.

Syntax

def get_output_bytes() -> bytes: ...

output_bytes = property(get_output_bytes, None)

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the output_file and output_stream properties had not been assigned.

This property is read-only.

output_file Property

The file to save the encrypted document to.

Syntax

def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...

output_file = property(get_output_file, set_output_file)

Default Value

""

Remarks

Specifies the path where the encrypted PDF should be saved.

owner_password Property

The owner password.

Syntax

def get_owner_password() -> str: ...
def set_owner_password(value: str) -> None: ...

owner_password = property(get_owner_password, set_owner_password)

Default Value

""

Remarks

Use this property to provide the document owner password. Though it may be different from user_password, most implementations use the same value for both.

permissions Property

Specifies the document permissions associated with the encryption.

Syntax

def get_permissions() -> int: ...
def set_permissions(value: int) -> None: ...

permissions = property(get_permissions, set_permissions)

Default Value

0

Remarks

Use this property to specify the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents, but keep in mind that it is a policy-like requirement rather than an enforcement. Provide the permissions as a bit mask of the following flags:

user_password Property

The user password.

Syntax

def get_user_password() -> str: ...
def set_user_password(value: str) -> None: ...

user_password = property(get_user_password, set_user_password)

Default Value

""

Remarks

Use this property to provide the document user password. Though it may be different from owner_password, most implementations use the same value for both.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

encrypt Method

Encrypts the PDF document.

Syntax

def encrypt() -> None: ...

Remarks

Use this method to encrypt the PDF document as configured in the object's properties.

reset Method

Resets the class settings.

Syntax

def reset() -> None: ...

Remarks

reset is a generic method available in every class.

on_document_loaded Event

This event is fired when the document has been loaded into memory.

Syntax

class PDFEncryptorDocumentLoadedEventParams(object):
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class PDFEncryptor:
@property
def on_document_loaded() -> Callable[[PDFEncryptorDocumentLoadedEventParams], None]: ...
@on_document_loaded.setter
def on_document_loaded(event_hook: Callable[[PDFEncryptorDocumentLoadedEventParams], None]) -> None: ...

Remarks

The handler for this event is a good place to check the document structure, which may be useful when preparing the signature. For example, you can use the pages information to find the optimal position for the signature widget.

Set Cancel to true to terminate document processing on this stage.

on_error Event

Information about errors during encryption.

Syntax

class PDFEncryptorErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class PDFEncryptor:
@property
def on_error() -> Callable[[PDFEncryptorErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PDFEncryptorErrorEventParams], None]) -> None: ...

Remarks

The event is fired in case of exceptional conditions during PDF processing.

ErrorCode contains an error code and Description contains a textual description of the error.

on_notification Event

This event notifies the application about an underlying control flow event.

Syntax

class PDFEncryptorNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class PDFEncryptor:
@property
def on_notification() -> Callable[[PDFEncryptorNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[PDFEncryptorNotificationEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

PDFEncryptor Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

PDFEncryptor Config Settings

Base Config Settings

PDFEncryptor Errors

PDFEncryptor Errors