PDFDecrypt Class

Properties   Methods   Events   Config Settings   Errors  

The PDFDecrypt class decrypts PDF documents.

Class Name

SecurePDF_PDFDecrypt

Procedural Interface

 securepdf_pdfdecrypt_open();
 securepdf_pdfdecrypt_close($res);
 securepdf_pdfdecrypt_register_callback($res, $id, $function);
 securepdf_pdfdecrypt_get_last_error($res);
 securepdf_pdfdecrypt_get_last_error_code($res);
 securepdf_pdfdecrypt_set($res, $id, $index, $value);
 securepdf_pdfdecrypt_get($res, $id, $index);
 securepdf_pdfdecrypt_do_close($res);
 securepdf_pdfdecrypt_do_config($res, $configurationstring);
 securepdf_pdfdecrypt_do_decrypt($res);
 securepdf_pdfdecrypt_do_encrypted($res);
 securepdf_pdfdecrypt_do_open($res);
 securepdf_pdfdecrypt_do_reset($res);

Remarks

The PDFDecrypt class supports decryption of both password-encrypted and certificate-encrypted PDF documents. To determine the document's encryption type before decrypting it, subscribe to the Password and RecipientInfo events and open the document. For example: pdfdecrypt.InputFile = "encrypted.pdf"; pdfdecrypt.OnPassword += (s, e) => { Console.WriteLine("The PDF document is encrypted with a password."); }; pdfdecrypt.OnRecipientInfo += (s, e) => { Console.WriteLine("The PDF document is encrypted with a certificate."); }; pdfdecrypt.Open(); pdfdecrypt.Close();

Password-Based Decryption

If you have determined that the PDF is encrypted with a password (or know that fact beforehand), you must provide the correct decryption password via the Password property (for user passwords) or the OwnerPassword configuration setting (for owner passwords) in order to decrypt the document and get access to its contents.

The following code shows how to decrypt a password-encrypted PDF document: pdfdecrypt.InputFile = "password_encrypted.pdf"; pdfdecrypt.OutputFile = "decrypted.pdf"; pdfdecrypt.Password = "password"; pdfdecrypt.Decrypt(); Alternatively, set the decryption password within your Password event handler, and the class will decrypt the document all the same. The Available parameter may come in handy in determining whether the class already possesses the necessary decryption password.

Certificate-Based Decryption

If you have determined that the PDF is encrypted with a certificate (or know that fact beforehand), you must provide the decryption certificate containing the correct private key in order to decrypt the document and get access to its contents.

The following code shows how to decrypt a certificate-encrypted PDF document: pdfdecrypt.InputFile = "cert_encrypted.pdf"; pdfdecrypt.OutputFile = "decrypted.pdf"; pdfdecrypt.DecryptionCert = new Certificate(CertStoreTypes.cstPFXFile, "C:/MyCerts/cert.pfx", "cert_pass", "*"); pdfdecrypt.Decrypt(); Alternatively, set the decryption certificate within your RecipientInfo event handler, and the class will decrypt the document all the same. Like in the Password event, the Available parameter may come in handy in determining whether the class already possesses the necessary decryption certificate. The information published by the other parameters in the event (i.e., Issuer, SerialNumber, and SubjectKeyIdentifier) may also be useful for determining which decryption certificate should be used.

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.

DecryptionCertEffectiveDate Property (SecurePDF_PDFDecrypt Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getDecryptionCertEffectiveDate();

Procedural Interface

securepdf_pdfdecrypt_get($res, 1 );

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 and not available at design time.

Data Type

String

DecryptionCertExpirationDate Property (SecurePDF_PDFDecrypt Class)

The date on which the certificate expires.

Object Oriented Interface

public function getDecryptionCertExpirationDate();

Procedural Interface

securepdf_pdfdecrypt_get($res, 2 );

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 and not available at design time.

Data Type

String

DecryptionCertExtendedKeyUsage Property (SecurePDF_PDFDecrypt Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getDecryptionCertExtendedKeyUsage();

Procedural Interface

securepdf_pdfdecrypt_get($res, 3 );

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 and not available at design time.

Data Type

String

DecryptionCertFingerprint Property (SecurePDF_PDFDecrypt Class)

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

Object Oriented Interface

public function getDecryptionCertFingerprint();

Procedural Interface

securepdf_pdfdecrypt_get($res, 4 );

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 and not available at design time.

Data Type

String

DecryptionCertFingerprintSHA1 Property (SecurePDF_PDFDecrypt Class)

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

Object Oriented Interface

public function getDecryptionCertFingerprintSHA1();

Procedural Interface

securepdf_pdfdecrypt_get($res, 5 );

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 and not available at design time.

Data Type

String

DecryptionCertFingerprintSHA256 Property (SecurePDF_PDFDecrypt Class)

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

Object Oriented Interface

public function getDecryptionCertFingerprintSHA256();

Procedural Interface

securepdf_pdfdecrypt_get($res, 6 );

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 and not available at design time.

Data Type

String

DecryptionCertIssuer Property (SecurePDF_PDFDecrypt Class)

The issuer of the certificate.

Object Oriented Interface

public function getDecryptionCertIssuer();

Procedural Interface

securepdf_pdfdecrypt_get($res, 7 );

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 and not available at design time.

Data Type

String

DecryptionCertPrivateKey Property (SecurePDF_PDFDecrypt Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getDecryptionCertPrivateKey();

Procedural Interface

securepdf_pdfdecrypt_get($res, 8 );

Default Value

''

Remarks

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

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPrivateKeyAvailable Property (SecurePDF_PDFDecrypt Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getDecryptionCertPrivateKeyAvailable();

Procedural Interface

securepdf_pdfdecrypt_get($res, 9 );

Default Value

false

Remarks

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

This property is read-only and not available at design time.

Data Type

Boolean

DecryptionCertPrivateKeyContainer Property (SecurePDF_PDFDecrypt Class)

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

Object Oriented Interface

public function getDecryptionCertPrivateKeyContainer();

Procedural Interface

securepdf_pdfdecrypt_get($res, 10 );

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPublicKey Property (SecurePDF_PDFDecrypt Class)

The public key of the certificate.

Object Oriented Interface

public function getDecryptionCertPublicKey();

Procedural Interface

securepdf_pdfdecrypt_get($res, 11 );

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPublicKeyAlgorithm Property (SecurePDF_PDFDecrypt Class)

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

Object Oriented Interface

public function getDecryptionCertPublicKeyAlgorithm();

Procedural Interface

securepdf_pdfdecrypt_get($res, 12 );

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 and not available at design time.

Data Type

String

DecryptionCertPublicKeyLength Property (SecurePDF_PDFDecrypt Class)

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

Object Oriented Interface

public function getDecryptionCertPublicKeyLength();

Procedural Interface

securepdf_pdfdecrypt_get($res, 13 );

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 and not available at design time.

Data Type

Integer

DecryptionCertSerialNumber Property (SecurePDF_PDFDecrypt Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getDecryptionCertSerialNumber();

Procedural Interface

securepdf_pdfdecrypt_get($res, 14 );

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 and not available at design time.

Data Type

String

DecryptionCertSignatureAlgorithm Property (SecurePDF_PDFDecrypt Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getDecryptionCertSignatureAlgorithm();

Procedural Interface

securepdf_pdfdecrypt_get($res, 15 );

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 and not available at design time.

Data Type

String

DecryptionCertStore Property (SecurePDF_PDFDecrypt Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getDecryptionCertStore();
public function setDecryptionCertStore($value);

Procedural Interface

securepdf_pdfdecrypt_get($res, 16 );
securepdf_pdfdecrypt_set($res, 16, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The DecryptionCertStoreType property denotes the type of the certificate store specified by DecryptionCertStore. If the store is password-protected, specify the password in DecryptionCertStorePassword.

DecryptionCertStore is used in conjunction with the DecryptionCertSubject property to specify client certificates. If DecryptionCertStore has a value, and DecryptionCertSubject or DecryptionCertEncoded is set, a search for a certificate is initiated. Please see the DecryptionCertSubject 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).

This property is not available at design time.

Data Type

Binary String

DecryptionCertStorePassword Property (SecurePDF_PDFDecrypt Class)

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

Object Oriented Interface

public function getDecryptionCertStorePassword();
public function setDecryptionCertStorePassword($value);

Procedural Interface

securepdf_pdfdecrypt_get($res, 17 );
securepdf_pdfdecrypt_set($res, 17, $value );

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.

This property is not available at design time.

Data Type

String

DecryptionCertStoreType Property (SecurePDF_PDFDecrypt Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getDecryptionCertStoreType();
public function setDecryptionCertStoreType($value);

Procedural Interface

securepdf_pdfdecrypt_get($res, 18 );
securepdf_pdfdecrypt_set($res, 18, $value );

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:

This property is not available at design time.

Data Type

Integer

DecryptionCertSubjectAltNames Property (SecurePDF_PDFDecrypt Class)

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

Object Oriented Interface

public function getDecryptionCertSubjectAltNames();

Procedural Interface

securepdf_pdfdecrypt_get($res, 19 );

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertThumbprintMD5 Property (SecurePDF_PDFDecrypt Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getDecryptionCertThumbprintMD5();

Procedural Interface

securepdf_pdfdecrypt_get($res, 20 );

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 and not available at design time.

Data Type

String

DecryptionCertThumbprintSHA1 Property (SecurePDF_PDFDecrypt Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getDecryptionCertThumbprintSHA1();

Procedural Interface

securepdf_pdfdecrypt_get($res, 21 );

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 and not available at design time.

Data Type

String

DecryptionCertThumbprintSHA256 Property (SecurePDF_PDFDecrypt Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getDecryptionCertThumbprintSHA256();

Procedural Interface

securepdf_pdfdecrypt_get($res, 22 );

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 and not available at design time.

Data Type

String

DecryptionCertUsage Property (SecurePDF_PDFDecrypt Class)

The text description of UsageFlags .

Object Oriented Interface

public function getDecryptionCertUsage();

Procedural Interface

securepdf_pdfdecrypt_get($res, 23 );

Default Value

''

Remarks

The text description of DecryptionCertUsageFlags.

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 and not available at design time.

Data Type

String

DecryptionCertUsageFlags Property (SecurePDF_PDFDecrypt Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getDecryptionCertUsageFlags();

Procedural Interface

securepdf_pdfdecrypt_get($res, 24 );

Default Value

0

Remarks

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

Please see the DecryptionCertUsage property for a text representation of DecryptionCertUsageFlags.

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

This property is read-only and not available at design time.

Data Type

Integer

DecryptionCertVersion Property (SecurePDF_PDFDecrypt Class)

The certificate's version number.

Object Oriented Interface

public function getDecryptionCertVersion();

Procedural Interface

securepdf_pdfdecrypt_get($res, 25 );

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertSubject Property (SecurePDF_PDFDecrypt Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getDecryptionCertSubject();
public function setDecryptionCertSubject($value);

Procedural Interface

securepdf_pdfdecrypt_get($res, 26 );
securepdf_pdfdecrypt_set($res, 26, $value );

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.

This property is not available at design time.

Data Type

String

DecryptionCertEncoded Property (SecurePDF_PDFDecrypt Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getDecryptionCertEncoded();
public function setDecryptionCertEncoded($value);

Procedural Interface

securepdf_pdfdecrypt_get($res, 27 );
securepdf_pdfdecrypt_set($res, 27, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

InputData Property (SecurePDF_PDFDecrypt Class)

A byte array containing the PDF document to process.

Object Oriented Interface

public function getInputData();
public function setInputData($value);

Procedural Interface

securepdf_pdfdecrypt_get($res, 28 );
securepdf_pdfdecrypt_set($res, 28, $value );

Remarks

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

This property is not available at design time.

Data Type

Byte Array

InputFile Property (SecurePDF_PDFDecrypt Class)

The PDF file to process.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

securepdf_pdfdecrypt_get($res, 29 );
securepdf_pdfdecrypt_set($res, 29, $value );

Default Value

''

Remarks

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

Data Type

String

OutputData Property (SecurePDF_PDFDecrypt Class)

A byte array containing the PDF document after processing.

Object Oriented Interface

public function getOutputData();

Procedural Interface

securepdf_pdfdecrypt_get($res, 30 );

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 OutputFile and SetOutputStream respectively.

This property is read-only and not available at design time.

Data Type

Byte Array

OutputFile Property (SecurePDF_PDFDecrypt Class)

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

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

securepdf_pdfdecrypt_get($res, 31 );
securepdf_pdfdecrypt_set($res, 31, $value );

Default Value

''

Remarks

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

Data Type

String

Overwrite Property (SecurePDF_PDFDecrypt Class)

Whether or not the class should overwrite files.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

securepdf_pdfdecrypt_get($res, 32 );
securepdf_pdfdecrypt_set($res, 32, $value );

Default Value

false

Remarks

This property indicates whether or not the class will overwrite OutputFile, OutputData, or the stream set in SetOutputStream. If set to false, an error will be thrown whenever OutputFile, OutputData, or the stream set in SetOutputStream exists before an operation.

Data Type

Boolean

Password Property (SecurePDF_PDFDecrypt Class)

The password to decrypt the document with.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

securepdf_pdfdecrypt_get($res, 33 );
securepdf_pdfdecrypt_set($res, 33, $value );

Default Value

''

Remarks

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

Data Type

String

Close Method (SecurePDF_PDFDecrypt Class)

Closes an opened PDF document.

Object Oriented Interface

public function doClose();

Procedural Interface

securepdf_pdfdecrypt_do_close($res);

Remarks

This method is used to close the previously opened document specified in InputFile, InputData, or SetInputStream. 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 OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

Config Method (SecurePDF_PDFDecrypt Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

securepdf_pdfdecrypt_do_config($res, $configurationstring);

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.

Decrypt Method (SecurePDF_PDFDecrypt Class)

Decrypts a PDF document.

Object Oriented Interface

public function doDecrypt();

Procedural Interface

securepdf_pdfdecrypt_do_decrypt($res);

Remarks

This method is used to permanently remove encryption from the PDF document specified in InputFile, InputData, or SetInputStream. The document will be decrypted with either Password (for password-based encryption) or DecryptionCert (for certificate-based encryption) and saved in OutputFile, OutputData, or the stream set in SetOutputStream.

Example: pdfdecrypt.InputFile = "encrypted.pdf"; pdfdecrypt.OutputFile = "decrypted.pdf"; // Set decryption material (Password or DecryptionCert) here pdfdecrypt.Decrypt(); Note: Since full decryption invalidates all signatures, this method will automatically remove them from the document. Existing signatures should therefore be verified before calling this method.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Encrypted Method (SecurePDF_PDFDecrypt Class)

Checks whether a PDF document is encrypted.

Object Oriented Interface

public function doEncrypted();

Procedural Interface

securepdf_pdfdecrypt_do_encrypted($res);

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is encrypted. It will return false if the document is pseudo-encrypted with an empty password.

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

Open Method (SecurePDF_PDFDecrypt Class)

Opens a PDF document for processing.

Object Oriented Interface

public function doOpen();

Procedural Interface

securepdf_pdfdecrypt_do_open($res);

Remarks

This method is used to open the document specified in InputFile, InputData, or SetInputStream before performing some operation on it, such as decryption. 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 Password or RecipientInfo 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 (SecurePDF_PDFDecrypt Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

securepdf_pdfdecrypt_do_reset($res);

Remarks

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

Error Event (SecurePDF_PDFDecrypt Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

securepdf_pdfdecrypt_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

Log Event (SecurePDF_PDFDecrypt Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

securepdf_pdfdecrypt_register_callback($res, 2, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

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

Password Event (SecurePDF_PDFDecrypt Class)

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

Object Oriented Interface

public function firePassword($param);

Procedural Interface

securepdf_pdfdecrypt_register_callback($res, 3, array($this, 'firePassword'));

Parameter List

 'available'
 'cancel'

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.

RecipientInfo Event (SecurePDF_PDFDecrypt Class)

Fired for each recipient certificate of the encrypted PDF document.

Object Oriented Interface

public function fireRecipientInfo($param);

Procedural Interface

securepdf_pdfdecrypt_register_callback($res, 4, array($this, 'fireRecipientInfo'));

Parameter List

 'issuer'
 'serialnumber'
 'subjectkeyidentifier'
 'available'
 'cancel'

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

Config Settings (PDFDecrypt Class)

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.

PDFDecrypt Config Settings

Base Config Settings

Trappable Errors (PDFDecrypt Class)

PDFDecrypt Errors

PDF Errors

Parsing Errors