Package com.pd4ml.pdf.sign

Class PdfSigner

java.lang.Object

com.pd4ml.pdf.sign.PdfSigner

public final class PdfSigner
extends java.lang.Object

Public entry point of the PD4ML PDF signing API.

Applies a PKCS#7/CMS ("PAdES-compatible") digital signature to a PDF document as a raw incremental update, built entirely on the pd4ml com.pd4ml.pdf.cos object model/parser (no PDFBox, no other PDF library) plus BouncyCastle for the CMS/PKCS#7 cryptography. Supports invisible and visible signatures, PDF "certification" (DocMDP), and optional RFC 3161 timestamping.

Thread-safety: a PdfSigner instance holds no mutable state and may be reused/shared across threads; each sign(...) call is independent.

Example

 CertificateUtils.SigningIdentity identity =
         CertificateUtils.loadFromPkcs12(new File("signer.p12"), "password".toCharArray());

 SigningOptions options = new SigningOptions()
         .setReason("Approved")
         .setSignerName("Jane Doe");

 new PdfSigner().sign(new File("input.pdf"), new File("signed.pdf"), identity, options);
 

Constructor Summary

Constructors

Constructor	Description
PdfSigner()

Method Summary

Modifier and Type	Method	Description
byte[]	sign(byte[] inputPdfBytes, CertificateUtils.SigningIdentity identity, SigningOptions options)	Signs an in-memory PDF, returning the signed document's bytes.
void	sign(java.io.File inputPdf, java.io.File outputPdf, CertificateUtils.SigningIdentity identity, SigningOptions options)	Signs inputPdf, writing the signed document to outputPdf.
void	sign(java.io.InputStream input, java.io.OutputStream output, CertificateUtils.SigningIdentity identity, SigningOptions options)	Signs the PDF read from input, writing the signed bytes to output.
SignResult	signForResult(byte[] inputPdfBytes, CertificateUtils.SigningIdentity identity, SigningOptions options)	Like sign(byte[], CertificateUtils.SigningIdentity, SigningOptions), but returns the full SignResult -- signed PDF bytes plus the raw CMS/PKCS#7 signature that was embedded.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PdfSigner

public PdfSigner()

Method Detail

sign

public void sign(java.io.File inputPdf,
                 java.io.File outputPdf,
                 CertificateUtils.SigningIdentity identity,
                 SigningOptions options)
          throws PdfSigningException

Signs inputPdf, writing the signed document to outputPdf. Digital signatures are always applied as an incremental update over the ENTIRE original file, so the whole input is read into memory first; outputPdf may equal inputPdf (the input is fully buffered before anything is written).

Throws:

PdfSigningException

sign

public void sign(java.io.InputStream input,
                 java.io.OutputStream output,
                 CertificateUtils.SigningIdentity identity,
                 SigningOptions options)
          throws PdfSigningException

Signs the PDF read from input, writing the signed bytes to output. Neither stream is closed by this method. The input is fully buffered in memory (a digital signature's byte-range hash covers the whole file, so streaming isn't possible).

Throws:

PdfSigningException

sign

public byte[] sign(byte[] inputPdfBytes,
                   CertificateUtils.SigningIdentity identity,
                   SigningOptions options)
            throws PdfSigningException

Signs an in-memory PDF, returning the signed document's bytes.

Throws:

PdfSigningException

signForResult

public SignResult signForResult(byte[] inputPdfBytes,
                                CertificateUtils.SigningIdentity identity,
                                SigningOptions options)
                         throws PdfSigningException

Like sign(byte[], CertificateUtils.SigningIdentity, SigningOptions), but returns the full SignResult -- signed PDF bytes plus the raw CMS/PKCS#7 signature that was embedded. Callers doing LTV (see com.pd4ml.pdf.sign.ltv) need the CMS bytes to compute the PAdES /VRI dictionary key without re-parsing the output.

Throws:

PdfSigningException