node-qpdf2

A very simple wrapper for qpdf which is a content-preserving transformations on PDF files. It includes encrypting and decrypting PDF with AES 256, AES 128, RC4 (128 & 40) encryption algorithms. This is a fork of nrhirani/node-qpdf, adding Promises and Types.

Dependencies

• qpdf

Installation

1. Install qpdf:
   • Download qpdf
2. Install node-qpdf:

   npm install node-qpdf2
   

Encryption

You can encrypt your PDF by following:

import { encrypt } from "node-qpdf2";

const pdf = {
  input: "./test/example.pdf",
  output: "/tmp/encrypted.pdf",
  password: "1234",
}

await encrypt(pdf);

Options for Encryption

interface EncryptOptions {

    // This is the location of the unencrypted pdf;
    input: string;

    // A number which defines the encryption algorithm to be used. Values can be **40, 128 and 256** only. Defaults to 256
    keyLength?: number;

    // If defined, the file location of the encrypted pdf, if not defined, encrypt() will return a Buffer.
    output?: string;

    // If defined, will determine if the encrypted pdf will overwrite an existing file. Defaults to True
    overwrite?: boolean;

    // a string containing the secret password which will be further used to unlock the PDF or an object containing `user` and `owner` for setting password for different roles.
    password?: string | {
        owner: string;
        user: string;
    };

    // See below
    restrictions?: {
        accessibility?: "y" | "n";
        annotate?: "y" | "n";
        extract?: "y" | "n";
        modify?: "y" | "n" | "all" | "annotate" | "form" | "assembly" | "none";
        print?: "y" | "n" | "full" | "low" | "none";
        useAes?: "y" | "n";
    };
}

You might want to set other options for each encryption algorithm inside restrictions: according to the keyLength you choose :-

Key Length: 40

Option	Value	Description
print:	'y', 'n'	Determines whether or not to allow printing.
modify:	'y', 'n'	Determines whether or not to allow document modification.
extract:	'y', 'n'	Determines whether or not to allow text/image extraction.
annotate:	'y', 'n'	Determines whether or not to allow comments and form fill-in and signing.

Key Length: 128

Option	Value	Description
print:	'full', 'low', 'none'	full: allow full printing. low: allow low-resolution printing only. none: disallow printing.
modify:	'all', 'annotate', 'form', 'assembly', 'none'	all: allow full document modification. annotate: allow comment authoring and form operations. form: allow form field fill-in and signing. assembly: allow document assembly only. none: allow no modifications.
extract:	'y', 'n'	Determines whether or not to allow text/image extraction.
useAes:	'y', 'n'	AES encryption will be used instead of RC4 encryption.
accessibility:	'y', 'n'	Determines whether or not to allow accessibility to visually impaired.

Key Length: 256

Option	Value	Description
print:	'full', 'low', 'none'	full: allow full printing. low: allow low-resolution printing only. none: disallow printing.
modify:	'all', 'annotate', 'form', 'assembly', 'none'	all: allow full document modification. annotate: allow comment authoring and form operations. form: allow form field fill-in and signing. assembly: allow document assembly only. none: allow no modifications.
extract:	'y', 'n'	Determines whether or not to allow text/image extraction.
accessibility:	'y', 'n'	Determines whether or not to allow accessibility to visually impaired.

Examples

Render and Save:

import { encrypt } from "node-qpdf2";

const options = {
    input: "./test/example.pdf",
    keyLength: 128,
    output: "/tmp/encrypted.pdf",
    password: 'YOUR_PASSWORD_TO_ENCRYPT',
    restrictions: {
        print: 'low',
        useAes: 'y'
    }
}

await encrypt(options);

Decryption

You can decrypt your PDF by following:

import { decrypt } from "node-qpdf2";

const options = {
  input: "/tmp/encrypted.pdf",
  output: "/tmp/decrypted.pdf",
  password: "YOUR_PASSWORD_TO_DECRYPT_PDF",
}

await decrypt(options);

Meta

Maintained by Kyle McNally

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Sparticuz/node-qpdf2.

License

The npm package is available as open source under the terms of the MIT License.