@signpdf/placeholder-pdfkit
v3.2.4
Published
Use foliojs/PDFKit 0.11+ to insert a signature placeholder.
Downloads
345
Maintainers
Readme
Helper that provides placeholder using PDFKit 0.11+
Works on top of PDFKit 0.11+
and given a PDFDocument that is in the works, adds an e-signature placeholder. When the PDF is ready you can pass it to @signpdf/signpdf
to complete the process.
Usage
You will need $ npm i -S @signpdf/signpdf @signpdf/placeholder-pdfkit node-forge
. This works in an identical way to the pdfkit010 package and the pdfkit010.js example is still relevant.
Notes
- Make sure to have a look at the docs of the @signpdf family of packages.
- Feel free to copy and paste any part of this code. See its defined Purpose.
Signature length
Signing in detached mode makes the signature length independent of the PDF's content length, but it may still vary between different signing certificates. So every time you sign using the same P12 you will get the same length of the output signature, no matter the length of the signed content. It is safe to find out the actual signature length your certificate produces and use it to properly configure the placeholder length.
PAdES compliant signatures
To produce PAdES compliant signatures, the ETSI Signature Dictionary SubFilter value must be ETSI.CAdES.detached
instead of the standard Adobe value.
This can be declared using the subFilter option argument passed to pdfkitAddPlaceholder
and plainAddPlaceholder
.
import { pdfkitAddPlaceholder } from '@signpdf/placeholder-pdfkit';
import { SUBFILTER_ETSI_CADES_DETACHED } from '@signpdf/utils';
const pdfToSign = pdfkitAddPlaceholder({
...,
subFilter: SUBFILTER_ETSI_CADES_DETACHED,
});