PDFEncrypt Module

Properties   Methods   Events   Config Settings   Errors  

The PDFEncrypt module encrypts PDF documents.

Syntax

SecurePDF.PDFEncrypt

Remarks

As with signing, PDF encryption is part of the PDF format itself. It is used to prevent unauthorized access to documents and is performed using either an encryption password (known as password-based or symmetric encryption) or the intended document recipient's public X.509 certificate (known as certificate-based or asymmetric encryption). The PDFEncrypt class supports both encryption types.

The benefit of this encryption scheme as defined in the standard is that encrypted PDF documents are still valid PDF documents and can be handled by almost any PDF reader. Of course, this software will need to be able to decrypt such documents, but it can always reach the metadata (information about the document) and document structure.

Password-Based Encryption

The following code shows how to encrypt a PDF document with a user password: pdfencrypt.InputFile = "input.pdf"; pdfencrypt.OutputFile = "password_encrypted.pdf"; pdfencrypt.Password = "password"; pdfencrypt.Encrypt(); Owner passwords are also supported. Compared to user passwords, these passwords are used to protect the permissions (set via the Permissions property) that will be embedded into the document. For example, you may want to prevent the recipient from printing or editing the document. You can encrypt the document with an owner password by specifying the OwnerPassword configuration setting before calling the Encrypt method.

Certificate-Based Encryption

The following code shows how to encrypt a PDF document with a certificate: pdfencrypt.InputFile = "input.pdf"; pdfencrypt.OutputFile = "cert_encrypted.pdf"; pdfencrypt.EncryptionCert = new Certificate(CertStoreTypes.cstPublicKeyFile, "C:/MyCerts/cert.cer", "", "*"); pdfencrypt.Encrypt(); When encrypting using either a password or certificate, set the EncryptionAlgorithm property to the desired encryption algorithm. As additional encryption options, you can also decide whether the document metadata will be encrypted and embed permissions into the document via the EncryptMetadata and Permissions properties respectively.

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.

EncryptionAlgorithm Property (PDFEncrypt Module)

The encryption algorithm to encrypt the PDF document with.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) NSString* encryptionAlgorithm;

- (NSString*)encryptionAlgorithm;
- (void)setEncryptionAlgorithm :(NSString*)newEncryptionAlgorithm;

Default Value

"AES256"

Remarks

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

Possible values are:

• RC4
• AES128
• AES256

EncryptionCert Property (PDFEncrypt Module)

The encryption certificate.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)encryptionCertEffectiveDate;

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

- (NSString*)encryptionCertExpirationDate;

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

- (NSString*)encryptionCertExtendedKeyUsage;

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

- (NSString*)encryptionCertFingerprint;

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

- (NSString*)encryptionCertFingerprintSHA1;

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

- (NSString*)encryptionCertFingerprintSHA256;

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

- (NSString*)encryptionCertIssuer;

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

- (NSString*)encryptionCertPrivateKey;

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

- (BOOL)encryptionCertPrivateKeyAvailable;

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

- (NSString*)encryptionCertPrivateKeyContainer;

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

- (NSString*)encryptionCertPublicKey;

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

- (NSString*)encryptionCertPublicKeyAlgorithm;

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

- (int)encryptionCertPublicKeyLength;

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

- (NSString*)encryptionCertSerialNumber;

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

- (NSString*)encryptionCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=encryptionCertStore,setter=setEncryptionCertStore:) NSString* encryptionCertStore;

- (NSString*)encryptionCertStore;
- (void)setEncryptionCertStore :(NSString*)newEncryptionCertStore;

@property (nonatomic,readwrite,assign,getter=encryptionCertStoreB,setter=setEncryptionCertStoreB:) NSData* encryptionCertStoreB;

- (NSData*)encryptionCertStoreB;
- (void)setEncryptionCertStoreB :(NSData*)newEncryptionCertStore;
@property (nonatomic,readwrite,assign,getter=encryptionCertStorePassword,setter=setEncryptionCertStorePassword:) NSString* encryptionCertStorePassword;

- (NSString*)encryptionCertStorePassword;
- (void)setEncryptionCertStorePassword :(NSString*)newEncryptionCertStorePassword;

@property (nonatomic,readwrite,assign,getter=encryptionCertStoreType,setter=setEncryptionCertStoreType:) int encryptionCertStoreType;

- (int)encryptionCertStoreType;
- (void)setEncryptionCertStoreType :(int)newEncryptionCertStoreType;

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

- (NSString*)encryptionCertSubjectAltNames;

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

- (NSString*)encryptionCertThumbprintMD5;

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

- (NSString*)encryptionCertThumbprintSHA1;

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

- (NSString*)encryptionCertThumbprintSHA256;

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

- (NSString*)encryptionCertUsage;

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

- (int)encryptionCertUsageFlags;

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

- (NSString*)encryptionCertVersion;

@property (nonatomic,readwrite,assign,getter=encryptionCertSubject,setter=setEncryptionCertSubject:) NSString* encryptionCertSubject;

- (NSString*)encryptionCertSubject;
- (void)setEncryptionCertSubject :(NSString*)newEncryptionCertSubject;

@property (nonatomic,readwrite,assign,getter=encryptionCertEncoded,setter=setEncryptionCertEncoded:) NSString* encryptionCertEncoded;

- (NSString*)encryptionCertEncoded;
- (void)setEncryptionCertEncoded :(NSString*)newEncryptionCertEncoded;

@property (nonatomic,readwrite,assign,getter=encryptionCertEncodedB,setter=setEncryptionCertEncodedB:) NSData* encryptionCertEncodedB;

- (NSData*)encryptionCertEncodedB;
- (void)setEncryptionCertEncodedB :(NSData*)newEncryptionCertEncoded;
 

Default Value

0

Remarks

This property is used to provide the certificate used for encryption. Note that this certificate need not have a private key associated with it, but the intended recipient of the encrypted document does.

Note: Encryption for multiple recipients is currently unsupported.

EncryptMetadata Property (PDFEncrypt Module)

Whether to encrypt the document metadata.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=encryptMetadata,setter=setEncryptMetadata:) BOOL encryptMetadata;

- (BOOL)encryptMetadata;
- (void)setEncryptMetadata :(BOOL)newEncryptMetadata;

Default Value

True

Remarks

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

InputData Property (PDFEncrypt 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 (PDFEncrypt 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 (PDFEncrypt 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 (PDFEncrypt 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 (PDFEncrypt 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 (PDFEncrypt Module)

The password to encrypt 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 encryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

Permissions Property (PDFEncrypt Module)

The document permissions associated with the encryption.

Syntax

• Swift
• Objective-C

public var permissions: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=permissions,setter=setPermissions:) int permissions;

- (int)permissions;
- (void)setPermissions :(int)newPermissions;

Default Value

0

Remarks

This property is used to specify the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents, but note that it is a policy-like requirement rather than an enforcement.

Its value should be provided as a bitmask of the following flags:

Close Method (PDFEncrypt 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 (PDFEncrypt 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.

Encrypt Method (PDFEncrypt Module)

Encrypts a PDF document.

Syntax

• Swift
• Objective-C

public func encrypt() throws -> Void

- (void)encrypt;

Remarks

This method is used to encrypt the PDF document specified in InputFile, InputData, or SetInputStream. The document will be encrypted using EncryptionAlgorithm and either Password (for password-based encryption) or EncryptionCert (for certificate-based encryption), then saved in OutputFile, OutputData, or the stream set in SetOutputStream.

Example: pdfencrypt.InputFile = "input.pdf"; pdfencrypt.OutputFile = "encrypted.pdf"; pdfencrypt.Password = "password"; pdfencrypt.EncryptionAlgorithm = "AES256"; pdfencrypt.Encrypt(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Encrypted Method (PDFEncrypt 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: pdfencrypt.InputFile = "input.pdf"; if (!pdfencrypt.Encrypted()) { pdfencrypt.OutputFile = "encrypted.pdf"; // Set Password or EncryptionCert pdfencrypt.Encrypt(); } Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Open Method (PDFEncrypt 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 encryption. When finished, call Close to complete or discard the operation.

It is recommended to use this method (alongside Close) when performing multiple operations on the document at once.

Automatic Decryption Functionality

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

PDFEncrypt Config Settings

Base Config Settings

Trappable Errors (PDFEncrypt Module)

PDFEncrypt Errors

PDF Errors

Parsing Errors