PDFDecryptor Class

Properties   Methods   Events   Config Settings   Errors  

The PDFDecryptor class decrypts PDF documents.

Syntax

secureblackbox.Pdfdecryptor

Remarks

PDFDecryptor decrypts PDF documents encrypted with passwords or certificates.

Property List

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

Method List

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

Event List

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

Config Settings

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

DecryptionCertificate Property (PDFDecryptor Class)

A decryption certificate.

Syntax

public Certificate getDecryptionCertificate();


public void setDecryptionCertificate(Certificate decryptionCertificate);

Remarks

Use this property to provide the decryption certificate. The certificate should have a private key associated with it.

This property is not available at design time.

DocumentInfo Property (PDFDecryptor Class)

Contains information about the document properties.

Syntax

public PDFDocumentInfo getDocumentInfo();

Remarks

Use this property to access general parameters of the document being processed. A good place to check this property is in the handler of the DocumentLoaded event.

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

ExternalCrypto Property (PDFDecryptor Class)

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto getExternalCrypto();

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

FIPSMode Property (PDFDecryptor Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

InputBytes Property (PDFDecryptor Class)

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

Syntax

public byte[] getInputBytes();


public void setInputBytes(byte[] inputBytes);

Remarks

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

This property is not available at design time.

InputFile Property (PDFDecryptor Class)

The PDF file to be decrypted.

Syntax

public String getInputFile();


public void setInputFile(String inputFile);

Default Value

""

Remarks

Provide the path to the PDF document to be decrypted.

InputStream Property (PDFDecryptor Class)

A stream containing the PDF document.

Syntax

public java.io.InputStream getInputStream();


public void setInputStream(java.io.InputStream inputStream);

Default Value

null

Remarks

Use this property to supply the PDF document for decryption in a stream.

This property is not available at design time.

OutputBytes Property (PDFDecryptor Class)

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

Syntax

public byte[] getOutputBytes();

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.

OutputFile Property (PDFDecryptor Class)

The file to save the decrypted document to.

Syntax

public String getOutputFile();


public void setOutputFile(String outputFile);

Default Value

""

Remarks

Specifies the path where the decrypted PDF should be saved.

OutputStream Property (PDFDecryptor Class)

The stream to write the decrypted document to.

Syntax

public java.io.OutputStream getOutputStream();


public void setOutputStream(java.io.OutputStream outputStream);

Default Value

null

Remarks

Use this property to pass a stream to save the decrypted document to.

This property is not available at design time.

Password Property (PDFDecryptor Class)

The decryption password.

Syntax

public String getPassword();


public void setPassword(String password);

Default Value

""

Remarks

Use this property to provide the decryption password.

Config Method (Pdfdecryptor Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String 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 (Pdfdecryptor Class)

Decrypts a PDF document.

Syntax

public void decrypt();

Remarks

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

DoAction Method (Pdfdecryptor Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String 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;....

DocumentLoaded Event (Pdfdecryptor Class)

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

Syntax

public class DefaultPdfdecryptorEventListener implements PdfdecryptorEventListener {
  ...
  public void documentLoaded(PdfdecryptorDocumentLoadedEvent e) {}
  ...
}

public class PdfdecryptorDocumentLoadedEvent {
  public boolean 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 (Pdfdecryptor Class)

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

Syntax

public class DefaultPdfdecryptorEventListener implements PdfdecryptorEventListener {
  ...
  public void encrypted(PdfdecryptorEncryptedEvent e) {}
  ...
}

public class PdfdecryptorEncryptedEvent {
  public boolean certUsed;
  public String issuerRDN;
  public byte[] serialNumber;
  public byte[] subjectKeyID;
  public boolean needCredential;
  public boolean 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 (Pdfdecryptor Class)

Information about errors during signing/validation.

Syntax

public class DefaultPdfdecryptorEventListener implements PdfdecryptorEventListener {
  ...
  public void error(PdfdecryptorErrorEvent e) {}
  ...
}

public class PdfdecryptorErrorEvent {
  public int errorCode;
  public String 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 (Pdfdecryptor Class)

Handles remote or external decryption.

Syntax

public class DefaultPdfdecryptorEventListener implements PdfdecryptorEventListener {
  ...
  public void externalDecrypt(PdfdecryptorExternalDecryptEvent e) {}
  ...
}

public class PdfdecryptorExternalDecryptEvent {
  public String operationId;
  public String algorithm;
  public String pars;
  public String encryptedData;
  public String 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 (Pdfdecryptor Class)

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

Syntax

public class DefaultPdfdecryptorEventListener implements PdfdecryptorEventListener {
  ...
  public void notification(PdfdecryptorNotificationEvent e) {}
  ...
}

public class PdfdecryptorNotificationEvent {
  public String eventID;
  public String 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.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

public Certificate( bytes,  startIndex,  count,  password);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( bytes,  startIndex,  count);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

public Certificate( path,  password);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certPath,  keyPath,  password);

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

public Certificate( path);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

public Certificate( stream);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public Certificate( stream,  password);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certStream,  keyStream,  password);

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

public Certificate();

Creates a new object with default field values.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Constructors

public ExternalCrypto();

Creates a new ExternalCrypto object with default field values.

PDFDocumentInfo Type

Contains document security information.

Remarks

This type provides an overview of the document security parameters, including the encryption method (if used) and signature count. This information is available early into the signing/validation process and lets you prepare for the subsequent signature validation.

Fields

Constructors

public PDFDocumentInfo();

Initializes an instance of PDFDocumentInfo class.

Config Settings (Pdfdecryptor Class)

PDFDecryptor Config Settings

Base Config Settings

Trappable Errors (Pdfdecryptor Class)

PDFDecryptor Errors