PDFEncrypt Class

Properties   Methods   Events   Config Settings   Errors  

The PDFEncrypt class encrypts PDF documents.

Syntax

class securepdf.PDFEncrypt

Remarks

As with signing, PDF encryption is part of the PDF format itself. It is used to prevent unauthorized access to documents and is performed using either an encryption password (known as password-based or symmetric encryption) or the intended document recipient's public X.509 certificate (known as certificate-based or asymmetric encryption). The PDFEncrypt class supports both encryption types.

The benefit of this encryption scheme as defined in the standard is that encrypted PDF documents are still valid PDF documents and can be handled by almost any PDF reader. Of course, this software will need to be able to decrypt such documents, but it can always reach the metadata (information about the document) and document structure.

Password-Based Encryption

In password-based encryption, the publishers and intended users of the document must know some secret key (a password), which is used both to protect the document and access the protected data. Once the document has been protected (encrypted), the password is required to get access to the document's contents. Although this method is straightforward and widely used for protecting PDF documents, the password must be passed from the publisher to the intended users, which presents a significant disadvantage.

The following code shows how to encrypt a PDF document with a user password: pdfencrypt.InputFile = "input.pdf"; pdfencrypt.OutputFile = "password_encrypted.pdf"; pdfencrypt.Password = "password"; pdfencrypt.Encrypt(); Owner passwords are also supported. Compared to user passwords, these passwords are used to protect the permissions (set via the permissions property) that will be embedded into the document. For example, you may want to prevent the recipient from printing or editing the document. You can encrypt the document with an owner password by specifying the OwnerPassword configuration setting before calling the encrypt method.

Certificate-Based Encryption

Certificate-based encryption uses X.509 digital certificates to encrypt data. This encryption type provides a higher level of security compared to password-based encryption, as it relies on cryptographic key pairs, making it more difficult for unauthorized users to gain access. It is often used in environments where secure and authenticated document exchange is critical. Encrypting with a certificate (as opposed to a password) ensures that only the intended recipient who possesses the corresponding private key can decrypt the PDF document.

The following code shows how to encrypt a PDF document with a certificate: pdfencrypt.InputFile = "input.pdf"; pdfencrypt.OutputFile = "cert_encrypted.pdf"; pdfencrypt.EncryptionCert = new Certificate(CertStoreTypes.cstPublicKeyFile, "C:/MyCerts/cert.cer", "", "*"); pdfencrypt.Encrypt(); When encrypting using either a password or certificate, set the encryption_algorithm property to the desired encryption algorithm. As additional encryption options, you can also decide whether the document metadata will be encrypted and embed permissions into the document via the encrypt_metadata and permissions properties respectively.

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.

encryption_algorithm Property

The encryption algorithm to encrypt the PDF 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

This property is used to specify the encryption algorithm to encrypt the document with.

Possible values are:

• RC4
• AES128
• AES256

encryption_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_encryption_cert_effective_date() -> str: ...

encryption_cert_effective_date = property(get_encryption_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

encryption_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_encryption_cert_expiration_date() -> str: ...

encryption_cert_expiration_date = property(get_encryption_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

encryption_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_encryption_cert_extended_key_usage() -> str: ...

encryption_cert_extended_key_usage = property(get_encryption_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

encryption_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_encryption_cert_fingerprint() -> str: ...

encryption_cert_fingerprint = property(get_encryption_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

encryption_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_encryption_cert_fingerprint_sha1() -> str: ...

encryption_cert_fingerprint_sha1 = property(get_encryption_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

encryption_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_encryption_cert_fingerprint_sha256() -> str: ...

encryption_cert_fingerprint_sha256 = property(get_encryption_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

encryption_cert_issuer Property

The issuer of the certificate.

Syntax

def get_encryption_cert_issuer() -> str: ...

encryption_cert_issuer = property(get_encryption_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

encryption_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_encryption_cert_private_key() -> str: ...

encryption_cert_private_key = property(get_encryption_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The encryption_cert_private_key may be available but not exportable. In this case, encryption_cert_private_key returns an empty string.

This property is read-only.

encryption_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_encryption_cert_private_key_available() -> bool: ...

encryption_cert_private_key_available = property(get_encryption_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a encryption_cert_private_key is available for the selected certificate. If encryption_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

encryption_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_encryption_cert_private_key_container() -> str: ...

encryption_cert_private_key_container = property(get_encryption_cert_private_key_container, None)

Default Value

""

Remarks

The name of the encryption_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

encryption_cert_public_key Property

The public key of the certificate.

Syntax

def get_encryption_cert_public_key() -> str: ...

encryption_cert_public_key = property(get_encryption_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

encryption_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_encryption_cert_public_key_algorithm() -> str: ...

encryption_cert_public_key_algorithm = property(get_encryption_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

encryption_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_encryption_cert_public_key_length() -> int: ...

encryption_cert_public_key_length = property(get_encryption_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

encryption_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_encryption_cert_serial_number() -> str: ...

encryption_cert_serial_number = property(get_encryption_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

encryption_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_encryption_cert_signature_algorithm() -> str: ...

encryption_cert_signature_algorithm = property(get_encryption_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

encryption_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_encryption_cert_store() -> bytes: ...
def set_encryption_cert_store(value: bytes) -> None: ...

encryption_cert_store = property(get_encryption_cert_store, set_encryption_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The encryption_cert_store_type property denotes the type of the certificate store specified by encryption_cert_store. If the store is password-protected, specify the password in encryption_cert_store_password.

encryption_cert_store is used in conjunction with the encryption_cert_subject property to specify client certificates. If encryption_cert_store has a value, and encryption_cert_subject or encryption_cert_encoded is set, a search for a certificate is initiated. Please see the encryption_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

encryption_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_encryption_cert_store_password() -> str: ...
def set_encryption_cert_store_password(value: str) -> None: ...

encryption_cert_store_password = property(get_encryption_cert_store_password, set_encryption_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

encryption_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_encryption_cert_store_type() -> int: ...
def set_encryption_cert_store_type(value: int) -> None: ...

encryption_cert_store_type = property(get_encryption_cert_store_type, set_encryption_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

encryption_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_encryption_cert_subject_alt_names() -> str: ...

encryption_cert_subject_alt_names = property(get_encryption_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

encryption_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_encryption_cert_thumbprint_md5() -> str: ...

encryption_cert_thumbprint_md5 = property(get_encryption_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

encryption_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_encryption_cert_thumbprint_sha1() -> str: ...

encryption_cert_thumbprint_sha1 = property(get_encryption_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

encryption_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_encryption_cert_thumbprint_sha256() -> str: ...

encryption_cert_thumbprint_sha256 = property(get_encryption_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

encryption_cert_usage Property

The text description of UsageFlags .

Syntax

def get_encryption_cert_usage() -> str: ...

encryption_cert_usage = property(get_encryption_cert_usage, None)

Default Value

""

Remarks

The text description of encryption_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

encryption_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_encryption_cert_usage_flags() -> int: ...

encryption_cert_usage_flags = property(get_encryption_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of encryption_cert_usage_flags is a combination of the following flags:

Please see the encryption_cert_usage property for a text representation of encryption_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

encryption_cert_version Property

The certificate's version number.

Syntax

def get_encryption_cert_version() -> str: ...

encryption_cert_version = property(get_encryption_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

encryption_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_encryption_cert_subject() -> str: ...
def set_encryption_cert_subject(value: str) -> None: ...

encryption_cert_subject = property(get_encryption_cert_subject, set_encryption_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

encryption_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_encryption_cert_encoded() -> bytes: ...
def set_encryption_cert_encoded(value: bytes) -> None: ...

encryption_cert_encoded = property(get_encryption_cert_encoded, set_encryption_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The encryption_cert_store and encryption_cert_subject properties also may be used to specify a certificate.

When encryption_cert_encoded is set, a search is initiated in the current encryption_cert_store for the private key of the certificate. If the key is found, encryption_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, encryption_cert_subject is set to an empty string.

encrypt_metadata Property

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

This property indicates whether the document metadata will be encrypted when the encrypt method is called. Metadata contains additional information about the document, such as its name and author.

input_data Property

A byte array containing the PDF document to process.

Syntax

def get_input_data() -> bytes: ...
def set_input_data(value: bytes) -> None: ...

input_data = property(get_input_data, set_input_data)

Remarks

This property is used to assign a byte array containing the PDF document to be processed.

input_file Property

The PDF file to process.

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

This property is used to provide a path to the PDF document to be processed.

output_data Property

A byte array containing the PDF document after processing.

Syntax

def get_output_data() -> bytes: ...

output_data = property(get_output_data, None)

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It will only be set if an output file and output stream have not been assigned via output_file and set_output_stream respectively.

This property is read-only.

output_file Property

The path to a local file where the output will be written.

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

This property is used to provide a path where the resulting PDF document will be saved after the operation has completed.

overwrite Property

Whether or not the class should overwrite files.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite output_file, output_data, or the stream set in set_output_stream. If set to False, an error will be thrown whenever output_file, output_data, or the stream set in set_output_stream exists before an operation.

password Property

The password to encrypt the document with.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

This property is used to provide the user password for encryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

permissions Property

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

This property is used to specify the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents, but note that it is a policy-like requirement rather than an enforcement.

Its value should be provided as a bitmask of the following flags:

close Method

Closes an opened PDF document.

Syntax

def close() -> None: ...

Remarks

This method is used to close the previously opened document specified in input_file, input_data, or set_input_stream. It should always be preceded by a call to the open method.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close();

If any changes are made to the document, they will be saved automatically to output_file, output_data, or the stream set in set_output_stream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

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.

encrypt Method

Encrypts a PDF document.

Syntax

def encrypt() -> None: ...

Remarks

This method is used to encrypt the PDF document specified in input_file, input_data, or set_input_stream. The document will be encrypted using encryption_algorithm and either password (for password-based encryption) or encryption_cert (for certificate-based encryption), then saved in output_file, output_data, or the stream set in set_output_stream.

Example: pdfencrypt.InputFile = "input.pdf"; pdfencrypt.OutputFile = "encrypted.pdf"; pdfencrypt.Password = "password"; pdfencrypt.EncryptionAlgorithm = "AES256"; pdfencrypt.Encrypt(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

encrypted Method

Checks whether a PDF document is encrypted.

Syntax

def encrypted() -> bool: ...

Remarks

This method is used to determine whether or not the document specified in input_file, input_data, or set_input_stream is encrypted. It will return False if the document is pseudo-encrypted with an empty password.

Example: pdfencrypt.InputFile = "input.pdf"; if (!pdfencrypt.Encrypted()) { pdfencrypt.OutputFile = "encrypted.pdf"; // Set Password or EncryptionCert pdfencrypt.Encrypt(); } Note: If the document is not already opened, this method will open it, perform the operation, then close it.

open Method

Opens a PDF document for processing.

Syntax

def open() -> None: ...

Remarks

This method is used to open the document specified in input_file, input_data, or set_input_stream before performing some operation on it, such as encryption. When finished, call close to complete or discard the operation.

It is recommended to use this method (alongside close) when performing multiple operations on the document at once.

Automatic Decryption Functionality

If this method is called on an encrypted document, the on_password or on_recipient_info event will fire (depending on the encryption type) as a notification that the document must be decrypted before processing can continue.

Once the correct decryption material is supplied, the class will then attempt to decrypt the document automatically within this method. When this occurs, the decrypted content is kept in memory so that the document's encrypted status is preserved when it is saved later. Use the decrypt method to save a decrypted copy of the document instead.

reset Method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

This method is used to reset the class's properties and configuration settings to their default values.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_log Event

Fired once for each log message.

Syntax

class PDFEncryptLogEventParams(object):
  @property
  def log_level() -> int: ...

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

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

# In class PDFEncrypt:
@property
def on_log() -> Callable[[PDFEncryptLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[PDFEncryptLogEventParams], None]) -> None: ...

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel configuration setting.

The LogLevel parameter indicates the detail level of the message. Possible values are:

The Message parameter is the log message.

The LogType parameter identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

on_password Event

Fired when the class detects that the PDF document is encrypted with a password.

Syntax

class PDFEncryptPasswordEventParams(object):
  @property
  def available() -> bool: ...

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

# In class PDFEncrypt:
@property
def on_password() -> Callable[[PDFEncryptPasswordEventParams], None]: ...
@on_password.setter
def on_password(event_hook: Callable[[PDFEncryptPasswordEventParams], None]) -> None: ...

Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to the password property.

The Available parameter indicates whether the decryption password is already available to the class or still needs to be set. If this parameter is set to False, the correct password must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the class will stop firing this event to request a password.

on_recipient_info Event

Fired for each recipient certificate of the encrypted PDF document.

Syntax

class PDFEncryptRecipientInfoEventParams(object):
  @property
  def issuer() -> str: ...

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

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

  @property
  def available() -> bool: ...

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

# In class PDFEncrypt:
@property
def on_recipient_info() -> Callable[[PDFEncryptRecipientInfoEventParams], None]: ...
@on_recipient_info.setter
def on_recipient_info(event_hook: Callable[[PDFEncryptRecipientInfoEventParams], None]) -> None: ...

Remarks

This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to the decryption_cert property.

The Issuer parameter specifies the subject of the issuer certificate.

The SerialNumber parameter specifies the serial number of the encryption certificate.

The SubjectKeyIdentifier parameter specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

The Available parameter indicates whether the decryption certificate is already available to the class or still needs to be set. If this parameter is set to False, the correct certificate must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the class will stop firing this event to request a certificate.

Note: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will cause its own invocation of this event.

PDFEncrypt 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.

PDFEncrypt Config Settings

Base Config Settings

PDFEncrypt Errors

PDFEncrypt Errors

PDF Errors

Parsing Errors