PDF Permissions ​

PDF Permissions are employed to ensure the security of PDF documents, offering encryption, document permissions, decryption, and password removal features. This ensures users have secure control and effective management over the document.

Encrypt function consists of two parts: User Password and Owner Password.

The User Password is utilized to open the document, ensuring that only authorized users can access its content. When a user password is set, it typically restricts certain document permissions such as modification, copying, or printing. On the other hand, the Owner Password not only opens the document but also unlocks all restricted permissions, allowing users to modify, copy, or print the document. The dual-password system aims to provide a more flexible and secure approach to document access and management.

ComPDFKit offers a variety of encryption algorithms and permission settings. Depending on your requirements, you can use the appropriate algorithm and configure custom permissions to safeguard your document.

The steps to encrypt are as follows:

1. Set distinct user passwords and owner passwords.

2. Create a permissions information class.

3. Specify the encryption algorithm.

4. Encrypt the document using the user password, owner password, permission information, and the chosen algorithm.

5. Save the document

This sample shows how to encrypt a document:

// Open document from file path.
CPDFDocument document = new CPDFDocument(context);
document.open(pdfPath);
// Set user password.
document.setUserPassword(user_password);
// Set encrypt algorithm type.
document.setEncryptAlgorithm(PDFDocumentEncryptAlgo.PDFDocumentAES256);
// Set owner password.
document.setOwnerPassword(owner_password);
// Set permission info.
CPDFDocumentPermissionInfo info = document.getPermissionsInfo();
info.setAllowsPrinting(false);
info.setAllowsCopying(true);
document.setPermissionsInfo(info);
// Save document.
document.save();

val document = CPDFDocument(context).apply {
  // Open document from file path.
  open(pdfPath)
  // Set user password.
  setUserPassword(user_password)
  // Set encrypt algorithm type.
  encryptAlgorithm = PDFDocumentEncryptAlgo.PDFDocumentAES256
  // Set owner password.
  setOwnerPassword(owner_password)
  // Set permission info.
  permissionsInfo.apply {
    isAllowsPrinting = false
    isAllowsCopying = true
  }
  save()
}

Encryption Algorithm and its Description:

PDF Permissions ​

In the PDF specification, there is support for configuring various permissions for a document. By configuring these permissions, it is possible to restrict users to perform only the expected actions.

The PDF specification defines the following permissions:

• Print: Allows printing of the document.
• High-Quality Print: Permits high-fidelity printing of the document.
• Copy: Enables copying of the document content.
• Modify Document: Allows modification of the document content, excluding document properties.
• Assemble Document: Permits insertion, deletion, and rotation of pages.
• Annotate: Enables the creation or modification of document annotations, including form field entries.
• Form Field Input: Allows modification of form field entries, even if document annotations are not editable.

The steps to view document permissions are as follows:

1. Retrieve document permission information.

2. Use the document permission information to view specific permissions.

This example shows how to view document permissions:

// Open document from file path.
CPDFDocument document = new CPDFDocument(context);
document.open(pdfPath);
// get permission info.
CPDFDocumentPermissionInfo info = document.getPermissionsInfo();
System.out.println("Allows Printing:" + info.isAllowsPrinting());
System.out.println("Allows Copying:" + info.isAllowsCopying());

// Open document from file path.
val document = CPDFDocument(context)
document.open(pdfPath)
// get permission info.
val info = document.getPermissionsInfo()
println("Allows Printing:${info.isAllowsPrinting}")
println("Allows Copying:${info.isAllowsCopying}")

Decrypt ​

Accessing a password-protected PDF document requires entering the password. Different levels of passwords provide varying levels of permission.

The steps for decryption are as follows:

1. When opening the document, check if it is encrypted.

2. For encrypted documents, entering either the user password or the owner password allows the document to be opened.

This example shows how to decrypt a document:

// Open document from file path.
CPDFDocument document = new CPDFDocument(context);
CPDFDocument.PDFDocumentError error = document.open(pdfPath);
if (error == CPDFDocument.PDFDocumentError.PDFDocumentErrorPassword) {
    // Password required.
  	document.open(pdfFath, password);
}

// Open document from file path.
val document = CPDFDocument(context)
val error: PDFDocumentError = document.open(pdfPath)
if (error == PDFDocumentError.PDFDocumentErrorPassword) {
  // Password required.
  document.open(pdfPath, password)
}

Remove passwords ​

Removing passwords means deleting the owner passwords and user passwords from a document and saving it as a new document, which will no longer require a password to open and will have all permissions available by default.

The steps to remove passwords are as follows:

1. Unlock the document to obtain all permissions.
2. Save the unlocked document.

This example shows how to remove passwords:

// Open document from file path.
CPDFDocument document = new CPDFDocument(context);
document.open(pdfPath, password);
// Remove password.
try {
  document.save(CPDFDocument.PDFDocumentSaveType.PDFDocumentSaveRemoveSecurity);
} catch (CPDFDocumentException e) {
  e.printStackTrace();
}

// Open document from file path.
val document = CPDFDocument(context)
document.open(pdfPath, password)
// Remove password.
try {
  document.save(CPDFDocument.PDFDocumentSaveType.PDFDocumentSaveRemoveSecurity)
} catch (e: CPDFDocumentException) {
  e.printStackTrace()
}