PDFDecrypt Module

Properties   Methods   Events   Config Settings   Errors  

The PDFDecrypt module decrypts PDF documents.

Syntax

SecurePDF.PDFDecrypt

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

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

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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

DecryptionCert Property (PDFDecrypt Module)

The decryption certificate.

Syntax

• Swift
• Objective-C

public var decryptionCert: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=decryptionCertEffectiveDate) NSString* decryptionCertEffectiveDate;

- (NSString*)decryptionCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=decryptionCertExpirationDate) NSString* decryptionCertExpirationDate;

- (NSString*)decryptionCertExpirationDate;

@property (nonatomic,readonly,assign,getter=decryptionCertExtendedKeyUsage) NSString* decryptionCertExtendedKeyUsage;

- (NSString*)decryptionCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=decryptionCertFingerprint) NSString* decryptionCertFingerprint;

- (NSString*)decryptionCertFingerprint;

@property (nonatomic,readonly,assign,getter=decryptionCertFingerprintSHA1) NSString* decryptionCertFingerprintSHA1;

- (NSString*)decryptionCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=decryptionCertFingerprintSHA256) NSString* decryptionCertFingerprintSHA256;

- (NSString*)decryptionCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=decryptionCertIssuer) NSString* decryptionCertIssuer;

- (NSString*)decryptionCertIssuer;

@property (nonatomic,readonly,assign,getter=decryptionCertPrivateKey) NSString* decryptionCertPrivateKey;

- (NSString*)decryptionCertPrivateKey;

@property (nonatomic,readonly,assign,getter=decryptionCertPrivateKeyAvailable) BOOL decryptionCertPrivateKeyAvailable;

- (BOOL)decryptionCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=decryptionCertPrivateKeyContainer) NSString* decryptionCertPrivateKeyContainer;

- (NSString*)decryptionCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=decryptionCertPublicKey) NSString* decryptionCertPublicKey;

- (NSString*)decryptionCertPublicKey;

@property (nonatomic,readonly,assign,getter=decryptionCertPublicKeyAlgorithm) NSString* decryptionCertPublicKeyAlgorithm;

- (NSString*)decryptionCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=decryptionCertPublicKeyLength) int decryptionCertPublicKeyLength;

- (int)decryptionCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=decryptionCertSerialNumber) NSString* decryptionCertSerialNumber;

- (NSString*)decryptionCertSerialNumber;

@property (nonatomic,readonly,assign,getter=decryptionCertSignatureAlgorithm) NSString* decryptionCertSignatureAlgorithm;

- (NSString*)decryptionCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=decryptionCertStore,setter=setDecryptionCertStore:) NSString* decryptionCertStore;

- (NSString*)decryptionCertStore;
- (void)setDecryptionCertStore :(NSString*)newDecryptionCertStore;

@property (nonatomic,readwrite,assign,getter=decryptionCertStoreB,setter=setDecryptionCertStoreB:) NSData* decryptionCertStoreB;

- (NSData*)decryptionCertStoreB;
- (void)setDecryptionCertStoreB :(NSData*)newDecryptionCertStore;
@property (nonatomic,readwrite,assign,getter=decryptionCertStorePassword,setter=setDecryptionCertStorePassword:) NSString* decryptionCertStorePassword;

- (NSString*)decryptionCertStorePassword;
- (void)setDecryptionCertStorePassword :(NSString*)newDecryptionCertStorePassword;

@property (nonatomic,readwrite,assign,getter=decryptionCertStoreType,setter=setDecryptionCertStoreType:) int decryptionCertStoreType;

- (int)decryptionCertStoreType;
- (void)setDecryptionCertStoreType :(int)newDecryptionCertStoreType;

@property (nonatomic,readonly,assign,getter=decryptionCertSubjectAltNames) NSString* decryptionCertSubjectAltNames;

- (NSString*)decryptionCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=decryptionCertThumbprintMD5) NSString* decryptionCertThumbprintMD5;

- (NSString*)decryptionCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=decryptionCertThumbprintSHA1) NSString* decryptionCertThumbprintSHA1;

- (NSString*)decryptionCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=decryptionCertThumbprintSHA256) NSString* decryptionCertThumbprintSHA256;

- (NSString*)decryptionCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=decryptionCertUsage) NSString* decryptionCertUsage;

- (NSString*)decryptionCertUsage;

@property (nonatomic,readonly,assign,getter=decryptionCertUsageFlags) int decryptionCertUsageFlags;

- (int)decryptionCertUsageFlags;

@property (nonatomic,readonly,assign,getter=decryptionCertVersion) NSString* decryptionCertVersion;

- (NSString*)decryptionCertVersion;

@property (nonatomic,readwrite,assign,getter=decryptionCertSubject,setter=setDecryptionCertSubject:) NSString* decryptionCertSubject;

- (NSString*)decryptionCertSubject;
- (void)setDecryptionCertSubject :(NSString*)newDecryptionCertSubject;

@property (nonatomic,readwrite,assign,getter=decryptionCertEncoded,setter=setDecryptionCertEncoded:) NSString* decryptionCertEncoded;

- (NSString*)decryptionCertEncoded;
- (void)setDecryptionCertEncoded :(NSString*)newDecryptionCertEncoded;

@property (nonatomic,readwrite,assign,getter=decryptionCertEncodedB,setter=setDecryptionCertEncodedB:) NSData* decryptionCertEncodedB;

- (NSData*)decryptionCertEncodedB;
- (void)setDecryptionCertEncodedB :(NSData*)newDecryptionCertEncoded;
 

Default Value

""

Remarks

This property is used to provide the certificate used for decryption. Note that this certificate must have a private key associated with it.

InputData Property (PDFDecrypt Module)

A byte array containing the PDF document to process.

Syntax

• Swift
• Objective-C

public var inputData: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputData,setter=setInputData:) NSData* inputData;

- (NSData*)inputData;
- (void)setInputData :(NSData*)newInputData;

Remarks

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

InputFile Property (PDFDecrypt Module)

The PDF file to process.

Syntax

• Swift
• Objective-C

public var inputFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile;

- (NSString*)inputFile;
- (void)setInputFile :(NSString*)newInputFile;

Default Value

""

Remarks

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

OutputData Property (PDFDecrypt Module)

A byte array containing the PDF document after processing.

Syntax

• Swift
• Objective-C

public var outputData: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=outputData) NSData* outputData;

- (NSData*)outputData;

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.

OutputFile Property (PDFDecrypt Module)

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

Syntax

• Swift
• Objective-C

public var outputFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=outputFile,setter=setOutputFile:) NSString* outputFile;

- (NSString*)outputFile;
- (void)setOutputFile :(NSString*)newOutputFile;

Default Value

""

Remarks

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

Overwrite Property (PDFDecrypt Module)

Whether or not the module should overwrite files.

Syntax

• Swift
• Objective-C

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

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 , an error will be thrown whenever OutputFile, OutputData, or the stream set in SetOutputStream exists before an operation.

Password Property (PDFDecrypt Module)

The password to decrypt the document with.

Syntax

• Swift
• Objective-C

public var password: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

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.

Close Method (PDFDecrypt Module)

Closes an opened PDF document.

Syntax

• Swift
• Objective-C

public func close() throws -> Void

- (void)close;

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 (PDFDecrypt Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 (PDFDecrypt Module)

Decrypts a PDF document.

Syntax

• Swift
• Objective-C

public func decrypt() throws -> Void

- (void)decrypt;

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 (PDFDecrypt Module)

Checks whether a PDF document is encrypted.

Syntax

• Swift
• Objective-C

public func encrypted() throws -> Bool

- (BOOL)encrypted;

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is encrypted. It will return 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 (PDFDecrypt Module)

Opens a PDF document for processing.

Syntax

• Swift
• Objective-C

public func open() throws -> Void

- (void)open;

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

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 (PDFDecrypt Module)

Resets the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

Error Event (PDFDecrypt Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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 (PDFDecrypt Module)

Fired once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)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 (PDFDecrypt Module)

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

Syntax

• Swift
• Objective-C

func onPassword(available: Bool, cancel: inout Bool)

- (void)onPassword:(BOOL)available :(int*)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 , 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 (PDFDecrypt Module)

Fired for each recipient certificate of the encrypted PDF document.

Syntax

• Swift
• Objective-C

func onRecipientInfo(issuer: String, serialNumber: String, subjectKeyIdentifier: String, available: Bool, cancel: inout Bool)

- (void)onRecipientInfo:(NSString*)issuer :(NSString*)serialNumber :(NSString*)subjectKeyIdentifier :(BOOL)available :(int*)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 , 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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public init()

public init(encoded: )

public init(storeType: , store: , storePassword: , subject: )

public init(storeType: , store: , storePassword: , subject: )

Config Settings (PDFDecrypt Module)

PDFDecrypt Config Settings

Base Config Settings

Trappable Errors (PDFDecrypt Module)

PDFDecrypt Errors

PDF Errors

Parsing Errors