@documenso/pdf-sign

This package provides functionality to sign PDF documents using various signing methods, including private keys, P12 containers, and Google Cloud. It is designed to be used with the Documenso platform.

Installation

To install the package, run:

npm install @documenso/pdf-sign

Usage

Signing with a Private Key

const { signWithPrivateKey } = require('@documenso/pdf-sign');

const content = Buffer.from('...'); // PDF content
const cert = Buffer.from('...'); // Certificate in PEM format
const privateKey = Buffer.from('...'); // Private key in PEM format

const signedPdf = await signWithPrivateKey({
  content,
  cert,
  privateKey,
  // Optional fields
  signingTime: '2023-03-15T12:00:00Z', // ISO 8601 format
  timestampServer: 'http://timestamp.server',
});

Signing with a P12 Container

const { signWithP12 } = require('@documenso/pdf-sign');

const content = Buffer.from('...'); // PDF content
const p12 = Buffer.from('...'); // P12 container

const signedPdf = await signWithP12({
  content,
  cert: p12,
  // Optional fields
  password: 'p12password',
  signingTime: '2023-03-15T12:00:00Z', // ISO 8601 format
  timestampServer: 'http://timestamp.server',
});

Signing with Google Cloud

const { signWithGCloud } = require('@documenso/pdf-sign');

const content = Buffer.from('...'); // PDF content
const cert = Buffer.from('...'); // Certificate in PEM format
const keyPath = 'projects/project-id/locations/global/keyRings/keyring-name/cryptoKeys/key-name';

const signedPdf = await signWithGCloud({
  content,
  cert,
  keyPath,
  // Optional fields
  signingTime: '2023-03-15T12:00:00Z', // ISO 8601 format
  timestampServer: 'http://timestamp.server',
});

API

signWithPrivateKey(options)

• options.content (Buffer): The PDF content to be signed.
• options.cert (Buffer): The certificate in PEM format.
• options.privateKey (Buffer): The private key in PEM format.
• options.signingTime (string, optional): The signing time in ISO 8601 format.
• options.timestampServer (string, optional): The URL of the timestamp server.

Returns a Promise that resolves to a Buffer containing the signed PDF.

signWithP12(options)

• options.content (Buffer): The PDF content to be signed.
• options.cert (Buffer): The P12 container.
• options.password (string, optional): The password for the P12 container.
• options.signingTime (string, optional): The signing time in ISO 8601 format.
• options.timestampServer (string, optional): The URL of the timestamp server.

Returns a Promise that resolves to a Buffer containing the signed PDF.

signWithGCloud(options)

• options.content (Buffer): The PDF content to be signed.
• options.cert (Buffer): The certificate in PEM format.
• options.keyPath (string): The Google Cloud key path.
• options.signingTime (string, optional): The signing time in ISO 8601 format.
• options.timestampServer (string, optional): The URL of the timestamp server.

Returns a Promise that resolves to a Buffer containing the signed PDF.

License

This package is licensed under the AGPL-3.0 License.