PDFDecryptor Class

Properties   Methods   Events   Config Settings   Errors  

The PDFDecryptor class decrypts PDF documents.

Class Name

SecureBlackbox_PDFDecryptor

Procedural Interface

 secureblackbox_pdfdecryptor_open();
 secureblackbox_pdfdecryptor_close($res);
 secureblackbox_pdfdecryptor_register_callback($res, $id, $function);
 secureblackbox_pdfdecryptor_get_last_error($res);
 secureblackbox_pdfdecryptor_get_last_error_code($res);
 secureblackbox_pdfdecryptor_set($res, $id, $index, $value);
 secureblackbox_pdfdecryptor_get($res, $id, $index);
 secureblackbox_pdfdecryptor_do_config($res, $configurationstring);
 secureblackbox_pdfdecryptor_do_decrypt($res);
 secureblackbox_pdfdecryptor_do_doaction($res, $actionid, $actionparams);
 secureblackbox_pdfdecryptor_do_reset($res);

Remarks

PDFDecryptor decrypts PDF documents encrypted with passwords or certificates.

Use PDFDecryptor to decrypt protected PDF documents. The PDF specification offers two encryption types:

• Password-based encryption: only someone who knows the password can decrypt the document.
• Certificate-based encryption: only the person who has the private key matching the encryption certificate can decrypt the document.

Decryption is often used not only to restrict access to the document content, but also to assign specific access permissions. Among such permissions are allowed printing quality, permission to modify or extract content, to fill in forms, and a few others.

To decrypt a document encrypted with a password, simply assign the password to Password property. If the provided password matches either one of the 'user' and 'owner' passwords, it will be used to decrypt the document. While PDF allows you to use different passwords for less-restricted owner and more-restricted user, this is rarely used in practice, with the majority of implementations sticking to the same password for both types of users.

To decrypt a document encrypted with a certificate, load the recipient's certificate using CertificateManager or CertificateStorage components and assign it to the DecryptionCertificate property. The certificate needs to include the associated private key.

You can assign the decryption material before processing the document (if you know beforehand what type of encryption was used), or on-the-fly, upon discovery that a particular document is encrypted. To implement the latter approach, please subscribe to Encrypted event. This event can fire for one or more times, notifying you of each encryption method that was used to protect the document. You can then assign the password or certificate inside the event handler accordingly.

Once you have decrypted the document, use the > property to check the document permissions, and other properties of the DocumentInfo object to find out the encryption details.

Finally, provide the input and output locations using InputFile (or InputBytes) and OutputFile properties and call the Decrypt method to complete the operation. If OutputFile is not assigned, the encrypted document will be generated in OutputBytes. decryptor.InputFile = "encrypted.pdf"; decryptor.OutputFile = "decrypted.pdf"; decryptor.Password = "password"; decryptor.Decrypt();

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.

DecryptionCertificateBytes Property (SecureBlackbox_PDFDecryptor Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getDecryptionCertificateBytes();

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 1 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

DecryptionCertificateHandle Property (SecureBlackbox_PDFDecryptor Class)

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

Object Oriented Interface

public function getDecryptionCertificateHandle();
public function setDecryptionCertificateHandle($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 9 );
secureblackbox_pdfdecryptor_set($res, 9, $value );

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

DocumentInfoEncryptionAlgorithm Property (SecureBlackbox_PDFDecryptor Class)

The symmetric algorithm used to encrypt the document.

Object Oriented Interface

public function getDocumentInfoEncryptionAlgorithm();

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 40 );

Default Value

''

Remarks

The symmetric algorithm used to encrypt the document.

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

Supported values:

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

Data Type

String

DocumentInfoEncryptionType Property (SecureBlackbox_PDFDecryptor Class)

The document encryption type.

Object Oriented Interface

public function getDocumentInfoEncryptionType();

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 41 );

Default Value

1

Remarks

The document encryption type.

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

Supported values:

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

Data Type

Integer

DocumentInfoMetadataEncrypted Property (SecureBlackbox_PDFDecryptor Class)

Indicates if the document metadata is encrypted.

Object Oriented Interface

public function getDocumentInfoMetadataEncrypted();

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 42 );

Default Value

true

Remarks

Indicates if the document metadata is encrypted.

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

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

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

Data Type

Boolean

DocumentInfoPermissions Property (SecureBlackbox_PDFDecryptor Class)

Contains the document permissions associated with the encryption.

Object Oriented Interface

public function getDocumentInfoPermissions();

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 43 );

Default Value

0

Remarks

Contains the document permissions associated with the encryption.

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

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

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_PDFDecryptor Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();
public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 44 );
secureblackbox_pdfdecryptor_set($res, 44, $value );

Default Value

''

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SecureBlackbox_PDFDecryptor Class)

Custom parameters to be passed to the signing service (uninterpreted).

Object Oriented Interface

public function getExternalCryptoCustomParams();
public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 45 );
secureblackbox_pdfdecryptor_set($res, 45, $value );

Default Value

''

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SecureBlackbox_PDFDecryptor Class)

Additional data to be included in the async state and mirrored back by the requestor.

Object Oriented Interface

public function getExternalCryptoData();
public function setExternalCryptoData($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 46 );
secureblackbox_pdfdecryptor_set($res, 46, $value );

Default Value

''

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SecureBlackbox_PDFDecryptor Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Object Oriented Interface

public function getExternalCryptoExternalHashCalculation();
public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 47 );
secureblackbox_pdfdecryptor_set($res, 47, $value );

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_PDFDecryptor Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();
public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 48 );
secureblackbox_pdfdecryptor_set($res, 48, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_PDFDecryptor Class)

The ID of the pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeyID();
public function setExternalCryptoKeyID($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 49 );
secureblackbox_pdfdecryptor_set($res, 49, $value );

Default Value

''

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SecureBlackbox_PDFDecryptor Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();
public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 50 );
secureblackbox_pdfdecryptor_set($res, 50, $value );

Default Value

''

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SecureBlackbox_PDFDecryptor Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();
public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 51 );
secureblackbox_pdfdecryptor_set($res, 51, $value );

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (SecureBlackbox_PDFDecryptor Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();
public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 52 );
secureblackbox_pdfdecryptor_set($res, 52, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_PDFDecryptor Class)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();
public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 53 );
secureblackbox_pdfdecryptor_set($res, 53, $value );

Default Value

''

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (SecureBlackbox_PDFDecryptor Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 54 );
secureblackbox_pdfdecryptor_set($res, 54, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_PDFDecryptor Class)

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

Object Oriented Interface

public function getInputBytes();
public function setInputBytes($value);

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 55 );
secureblackbox_pdfdecryptor_set($res, 55, $value );

Remarks

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

This property is not available at design time.

Data Type

Byte Array

InputFile Property (SecureBlackbox_PDFDecryptor Class)

The PDF file to be decrypted.

Object Oriented Interface

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

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 56 );
secureblackbox_pdfdecryptor_set($res, 56, $value );

Default Value

''

Remarks

Provide the path to the PDF document to be decrypted.

Data Type

String

OutputBytes Property (SecureBlackbox_PDFDecryptor Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 57 );

Remarks

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

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

Data Type

Byte Array

OutputFile Property (SecureBlackbox_PDFDecryptor Class)

The file to save the decrypted document to.

Object Oriented Interface

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

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 58 );
secureblackbox_pdfdecryptor_set($res, 58, $value );

Default Value

''

Remarks

Specifies the path where the decrypted PDF should be saved.

Data Type

String

Password Property (SecureBlackbox_PDFDecryptor Class)

The decryption password.

Object Oriented Interface

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

Procedural Interface

secureblackbox_pdfdecryptor_get($res, 59 );
secureblackbox_pdfdecryptor_set($res, 59, $value );

Default Value

''

Remarks

Use this property to provide the decryption password.

Data Type

String

Config Method (SecureBlackbox_PDFDecryptor Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_pdfdecryptor_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 (SecureBlackbox_PDFDecryptor Class)

Decrypts a PDF document.

Object Oriented Interface

public function doDecrypt();

Procedural Interface

secureblackbox_pdfdecryptor_do_decrypt($res);

Remarks

Use this method to decrypt a PDF document provided via InputFile (InputStream). The decrypted document will be saved in OutputFile (OutputStream).

DoAction Method (SecureBlackbox_PDFDecryptor Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_pdfdecryptor_do_doaction($res, $actionid, $actionparams);

Remarks

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

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

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

Common ActionIDs:

Reset Method (SecureBlackbox_PDFDecryptor Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_pdfdecryptor_do_reset($res);

Remarks

Reset is a generic method available in every class.

DocumentLoaded Event (SecureBlackbox_PDFDecryptor Class)

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

Object Oriented Interface

public function fireDocumentLoaded($param);

Procedural Interface

secureblackbox_pdfdecryptor_register_callback($res, 1, array($this, 'fireDocumentLoaded'));

Parameter List

 'cancel'

Remarks

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

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

Encrypted Event (SecureBlackbox_PDFDecryptor Class)

Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document.

Object Oriented Interface

public function fireEncrypted($param);

Procedural Interface

secureblackbox_pdfdecryptor_register_callback($res, 2, array($this, 'fireEncrypted'));

Parameter List

 'certused'
 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'needcredential'
 'skipthis'

Remarks

The class fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.

This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate or Password property (depending on the encryption method used), or sets SkipThis to true.

The CertUsed parameter specifies the encryption method used. If set to true, it indicates that the document uses asymmetric (certificate-based) encryption. In that case, the IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own Encrypted event loop.

CertUsed set to false indicates that the document uses password encryption. In this case, provide the password via the Password property.

The NeedCredential parameter specifies whether the correct credential is already available to the class or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the Password property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.

Error Event (SecureBlackbox_PDFDecryptor Class)

Information about errors during signing/validation.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_pdfdecryptor_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

ExternalDecrypt Event (SecureBlackbox_PDFDecryptor Class)

Handles remote or external decryption.

Object Oriented Interface

public function fireExternalDecrypt($param);

Procedural Interface

secureblackbox_pdfdecryptor_register_callback($res, 4, array($this, 'fireExternalDecrypt'));

Parameter List

 'operationid'
 'algorithm'
 'pars'
 'encrypteddata'
 'data'

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

Notification Event (SecureBlackbox_PDFDecryptor Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_pdfdecryptor_register_callback($res, 5, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

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

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

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

Config Settings (PDFDecryptor 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.

PDFDecryptor Config Settings

Base Config Settings

Trappable Errors (PDFDecryptor Class)

PDFDecryptor Errors