PDF encryption

Chromium converters, LibreOffice, and PDFEngines.merge()/PDFEngines.split() support PDF encryption via userPassword and ownerPassword:

userPassword — Required to open the PDF.
ownerPassword — Grants full access (e.g. printing, copying). If only userPassword is set, the document can still be opened with that password.

import { UrlConverter } from "chromiumly";

const buffer = await new UrlConverter().convert({
  url: "https://example.com/",
  userPassword: "open_secret",
  ownerPassword: "admin_secret",
});

Same options exist on HtmlConverter, MarkdownConverter, LibreOffice.convert(), PDFEngines.merge(), and PDFEngines.split().

Screenshot routes (UrlScreenshot, HtmlScreenshot, MarkdownScreenshot) produce an image, not a PDF, and don’t accept userPassword/ownerPassword at all.

Each route above also accepts six permission booleans (allowPrinting, allowCopying, allowModifying, allowAnnotating, allowFillingForms, allowAssembling), each defaulting to true. See PDF permissions.

Encrypting existing PDFs

There’s also a dedicated PDFEngines.encrypt() route for encrypting existing PDFs directly, without a conversion. Unlike the routes above, it requires at least one of userPassword or ownerPassword; since Gotenberg 8.34.0, an owner-password-only request produces an owner-only PDF that opens without a password but still enforces permissions.

import { PDFEngines } from "chromiumly";

const encrypted = await PDFEngines.encrypt({
  files: ["path/to/document.pdf"],
  options: {
    userPassword: "my_user_password",
    ownerPassword: "my_owner_password",
    allowPrinting: false,
  },
});

See Encrypt PDFs for the full dedicated-route reference.

Getting started

Chromium

LibreOffice

PDF engines

Advanced

Encrypting existing PDFs

​Encrypting existing PDFs

Encrypting existing PDFs