Struct securepdf::PDFEncrypt

Properties   Methods   Events   Config Settings   Errors  

The PDFEncrypt struct encrypts PDF documents.

Syntax

securepdf::PDFEncrypt

Remarks

As with signing, PDF encryption is part of the PDF format. 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 struct 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 needs 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 gain 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 with user passwords, these passwords are used to protect the permissions (set using the permissions property) that are 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 encrypt.

Certificate-Based Encryption

Certificate-based encryption uses X.509 digital certificates to encrypt data. This encryption type provides a higher level of security than password-based encryption, because it relies on cryptographic key pairs, making it more difficult for unauthorized users to gain access. It is often used in environments in which 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 using the encrypt_metadata and permissions properties, respectively.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecurePDF. Due to this, the PDFEncrypt struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of PDFEncrypt when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

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

encryption_algorithm property (PDFEncrypt Struct)

The encryption algorithm to encrypt the document with.

Syntax

fn encryption_algorithm(&self ) -> Result<String, SecurePDFError> 
fn set_encryption_algorithm(&self, value : &str) ->  Option<SecurePDFError> 
fn set_encryption_algorithm_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

"AES256"

Remarks

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

Possible values are:

• RC4
• AES128
• AES256

Data Type

String

encryption_cert_effective_date property (PDFEncrypt Struct)

The date on which this certificate becomes valid.

Syntax

fn encryption_cert_effective_date(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_expiration_date property (PDFEncrypt Struct)

The date on which the certificate expires.

Syntax

fn encryption_cert_expiration_date(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_extended_key_usage property (PDFEncrypt Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn encryption_cert_extended_key_usage(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_fingerprint property (PDFEncrypt Struct)

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

Syntax

fn encryption_cert_fingerprint(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_fingerprint_sha1 property (PDFEncrypt Struct)

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

Syntax

fn encryption_cert_fingerprint_sha1(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_fingerprint_sha256 property (PDFEncrypt Struct)

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

Syntax

fn encryption_cert_fingerprint_sha256(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_issuer property (PDFEncrypt Struct)

The issuer of the certificate.

Syntax

fn encryption_cert_issuer(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_private_key property (PDFEncrypt Struct)

The private key of the certificate (if available).

Syntax

fn encryption_cert_private_key(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_private_key_available property (PDFEncrypt Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn encryption_cert_private_key_available(&self ) -> Result<bool, SecurePDFError> 

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.

Data Type

bool

encryption_cert_private_key_container property (PDFEncrypt Struct)

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

Syntax

fn encryption_cert_private_key_container(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_public_key property (PDFEncrypt Struct)

The public key of the certificate.

Syntax

fn encryption_cert_public_key(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

encryption_cert_public_key_algorithm property (PDFEncrypt Struct)

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

Syntax

fn encryption_cert_public_key_algorithm(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_public_key_length property (PDFEncrypt Struct)

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

Syntax

fn encryption_cert_public_key_length(&self ) -> Result<i32, SecurePDFError> 

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.

Data Type

i32

encryption_cert_serial_number property (PDFEncrypt Struct)

The serial number of the certificate encoded as a string.

Syntax

fn encryption_cert_serial_number(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_signature_algorithm property (PDFEncrypt Struct)

The text description of the certificate's signature algorithm.

Syntax

fn encryption_cert_signature_algorithm(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_store property (PDFEncrypt Struct)

The name of the certificate store for the client certificate.

Syntax

fn encryption_cert_store(&self ) -> Result<Vec<u8>, SecurePDFError> 
fn set_encryption_cert_store(&self, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_encryption_cert_store_ref(&self, value : &[u8]) ->  Option<SecurePDFError> 

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

Data Type

Vec

encryption_cert_store_password property (PDFEncrypt Struct)

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

Syntax

fn encryption_cert_store_password(&self ) -> Result<String, SecurePDFError> 
fn set_encryption_cert_store_password(&self, value : &str) ->  Option<SecurePDFError> 
fn set_encryption_cert_store_password_ref(&self, value : &String) ->  Option<SecurePDFError> 

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.

Data Type

String

encryption_cert_store_type property (PDFEncrypt Struct)

The type of certificate store for this certificate.

Syntax

fn encryption_cert_store_type(&self ) -> Result<i32, SecurePDFError> 
fn set_encryption_cert_store_type(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

encryption_cert_subject_alt_names property (PDFEncrypt Struct)

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

Syntax

fn encryption_cert_subject_alt_names(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

encryption_cert_thumbprint_md5 property (PDFEncrypt Struct)

The MD5 hash of the certificate.

Syntax

fn encryption_cert_thumbprint_md5(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_thumbprint_sha1 property (PDFEncrypt Struct)

The SHA-1 hash of the certificate.

Syntax

fn encryption_cert_thumbprint_sha1(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_thumbprint_sha256 property (PDFEncrypt Struct)

The SHA-256 hash of the certificate.

Syntax

fn encryption_cert_thumbprint_sha256(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_usage property (PDFEncrypt Struct)

The text description of UsageFlags .

Syntax

fn encryption_cert_usage(&self ) -> Result<String, SecurePDFError> 

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.

Data Type

String

encryption_cert_usage_flags property (PDFEncrypt Struct)

The flags that show intended use for the certificate.

Syntax

fn encryption_cert_usage_flags(&self ) -> Result<i32, SecurePDFError> 

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.

Data Type

i32

encryption_cert_version property (PDFEncrypt Struct)

The certificate's version number.

Syntax

fn encryption_cert_version(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

encryption_cert_subject property (PDFEncrypt Struct)

The subject of the certificate used for client authentication.

Syntax

fn encryption_cert_subject(&self ) -> Result<String, SecurePDFError> 
fn set_encryption_cert_subject(&self, value : &str) ->  Option<SecurePDFError> 
fn set_encryption_cert_subject_ref(&self, value : &String) ->  Option<SecurePDFError> 

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

encryption_cert_encoded property (PDFEncrypt Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn encryption_cert_encoded(&self ) -> Result<Vec<u8>, SecurePDFError> 
fn set_encryption_cert_encoded(&self, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_encryption_cert_encoded_ref(&self, value : &[u8]) ->  Option<SecurePDFError> 

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.

Data Type

Vec

encrypt_metadata property (PDFEncrypt Struct)

Whether to encrypt the document metadata.

Syntax

fn encrypt_metadata(&self ) -> Result<bool, SecurePDFError> 
fn set_encrypt_metadata(&self, value : bool) ->  Option<SecurePDFError> 

Default Value

true

Remarks

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

Data Type

bool

input_data property (PDFEncrypt Struct)

A byte array containing the PDF document to process.

Syntax

fn input_data(&self ) -> Result<Vec<u8>, SecurePDFError> 
fn set_input_data(&self, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_input_data_ref(&self, value : &[u8]) ->  Option<SecurePDFError> 

Remarks

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

Data Type

Vec

input_file property (PDFEncrypt Struct)

The PDF file to process.

Syntax

fn input_file(&self ) -> Result<String, SecurePDFError> 
fn set_input_file(&self, value : &str) ->  Option<SecurePDFError> 
fn set_input_file_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

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

Data Type

String

output_data property (PDFEncrypt Struct)

A byte array containing the PDF document after processing.

Syntax

fn output_data(&self ) -> Result<Vec<u8>, SecurePDFError> 

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It is only 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.

Data Type

Vec

output_file property (PDFEncrypt Struct)

The path to a local file where the output is written.

Syntax

fn output_file(&self ) -> Result<String, SecurePDFError> 
fn set_output_file(&self, value : &str) ->  Option<SecurePDFError> 
fn set_output_file_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

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

Data Type

String

overwrite property (PDFEncrypt Struct)

Whether the struct should overwrite files.

Syntax

fn overwrite(&self ) -> Result<bool, SecurePDFError> 
fn set_overwrite(&self, value : bool) ->  Option<SecurePDFError> 

Default Value

false

Remarks

This property indicates whether the struct overwrites output_file. If set to false, an error is thrown whenever output_file exists before an operation.

Data Type

bool

password property (PDFEncrypt Struct)

The password to encrypt the document with.

Syntax

fn password(&self ) -> Result<String, SecurePDFError> 
fn set_password(&self, value : &str) ->  Option<SecurePDFError> 
fn set_password_ref(&self, value : &String) ->  Option<SecurePDFError> 

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.

Data Type

String

permissions property (PDFEncrypt Struct)

The document permissions associated with the encryption.

Syntax

fn permissions(&self ) -> Result<i32, SecurePDFError> 
fn set_permissions(&self, value : i32) ->  Option<SecurePDFError> 

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:

Data Type

i32

close method (PDFEncrypt Struct)

Closes the opened document.

Syntax

fn close(&self) -> Result<(), SecurePDFError>

Remarks

This method is used to close the previously opened document. It should always be preceded by a call to open.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close(); If any changes are made to the document, they are 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 SaveChanges.

config method (PDFEncrypt Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecurePDFError>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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 (PDFEncrypt Struct)

Encrypts the document.

Syntax

fn encrypt(&self) -> Result<(), SecurePDFError>

Remarks

This method is used to encrypt the document. The document is encrypted using encryption_algorithm and either password (for password-based encryption) or encryption_cert (for certificate-based encryption).

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 opens it, performs the operation, then closes it.

encrypted method (PDFEncrypt Struct)

Checks whether the document is encrypted.

Syntax

fn encrypted(&self) ->  Result<bool, SecurePDFError>

Remarks

This method is used to determine whether the document is encrypted. It returns 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 opens it, performs the operation, then closes it.

open method (PDFEncrypt Struct)

Opens the document for processing.

Syntax

fn open(&self) -> Result<(), SecurePDFError>

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 fires (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 struct then attempts 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 decrypt to save a decrypted copy of the document instead.

reset method (PDFEncrypt Struct)

Resets the struct.

Syntax

fn reset(&self) -> Result<(), SecurePDFError>

Remarks

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

on_error event (PDFEncrypt Struct)

Fired when information is available about errors during data delivery.

Syntax

// PDFEncryptErrorEventArgs carries the PDFEncrypt Error event's parameters.
pub struct PDFEncryptErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// PDFEncryptErrorEvent defines the signature of the PDFEncrypt Error event's handler function.
pub trait PDFEncryptErrorEvent {
  fn on_error(&self, sender : PDFEncrypt, e : &mut PDFEncryptErrorEventArgs);
}

impl <'a> PDFEncrypt<'a> {
  pub fn on_error(&self) -> &'a dyn PDFEncryptErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn PDFEncryptErrorEvent);
  ...
}

Remarks

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

The error_code 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 (PDFEncrypt Struct)

Fired once for each log message.

Syntax

// PDFEncryptLogEventArgs carries the PDFEncrypt Log event's parameters.
pub struct PDFEncryptLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// PDFEncryptLogEvent defines the signature of the PDFEncrypt Log event's handler function.
pub trait PDFEncryptLogEvent {
  fn on_log(&self, sender : PDFEncrypt, e : &mut PDFEncryptLogEventArgs);
}

impl <'a> PDFEncrypt<'a> {
  pub fn on_log(&self) -> &'a dyn PDFEncryptLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn PDFEncryptLogEvent);
  ...
}

Remarks

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

log_level indicates the detail level of the message. Possible values are:

message is the log message.

log_type identifies the type of log entry. Possible values are:

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

on_password event (PDFEncrypt Struct)

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

Syntax

// PDFEncryptPasswordEventArgs carries the PDFEncrypt Password event's parameters.
pub struct PDFEncryptPasswordEventArgs {
  fn available(&self) -> bool
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PDFEncryptPasswordEvent defines the signature of the PDFEncrypt Password event's handler function.
pub trait PDFEncryptPasswordEvent {
  fn on_password(&self, sender : PDFEncrypt, e : &mut PDFEncryptPasswordEventArgs);
}

impl <'a> PDFEncrypt<'a> {
  pub fn on_password(&self) -> &'a dyn PDFEncryptPasswordEvent;
  pub fn set_on_password(&mut self, value : &'a dyn PDFEncryptPasswordEvent);
  ...
}

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

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

cancel determines whether the struct will stop firing this event to request a password.

on_recipient_info event (PDFEncrypt Struct)

Fired for each recipient certificate of the encrypted document.

Syntax

// PDFEncryptRecipientInfoEventArgs carries the PDFEncrypt RecipientInfo event's parameters.
pub struct PDFEncryptRecipientInfoEventArgs {
  fn issuer(&self) -> &String
  fn serial_number(&self) -> &String
  fn subject_key_identifier(&self) -> &String
  fn available(&self) -> bool
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PDFEncryptRecipientInfoEvent defines the signature of the PDFEncrypt RecipientInfo event's handler function.
pub trait PDFEncryptRecipientInfoEvent {
  fn on_recipient_info(&self, sender : PDFEncrypt, e : &mut PDFEncryptRecipientInfoEventArgs);
}

impl <'a> PDFEncrypt<'a> {
  pub fn on_recipient_info(&self) -> &'a dyn PDFEncryptRecipientInfoEvent;
  pub fn set_on_recipient_info(&mut self, value : &'a dyn PDFEncryptRecipientInfoEvent);
  ...
}

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

issuer specifies the subject of the issuer certificate.

serial_number specifies the serial number of the encryption certificate.

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

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

cancel determines whether the struct 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 causes its own invocation of this event.

Config Settings (PDFEncrypt Struct)

The struct 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 struct, access to these internal properties is provided through the config method.

PDFEncrypt Config Settings

Base Config Settings

Trappable Errors (PDFEncrypt Struct)

PDFEncrypt Errors

PDF Errors

Parsing Errors