Package com.itextpdf.signatures
Class PdfTwoPhaseSigner
java.lang.Object
com.itextpdf.signatures.PdfTwoPhaseSigner
Class that prepares document and adds the signature to it while performing signing operation in two steps
(see
PadesTwoPhaseSigningHelper
for more info).
Firstly, this class allows to prepare the document for signing and calculate the document digest to sign. Secondly, it adds an existing signature to a PDF where space was already reserved.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private IExternalDigest
private final OutputStream
private final PdfReader
private StampingProperties
-
Constructor Summary
ConstructorsConstructorDescriptionPdfTwoPhaseSigner
(PdfReader reader, OutputStream outputStream) Creates newPdfTwoPhaseSigner
instance. -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addSignatureToPreparedDocument
(PdfDocument document, String fieldName, OutputStream outs, byte[] signedContent) Adds an existing signature to a PDF where space was already reserved.static void
addSignatureToPreparedDocument
(PdfDocument document, String fieldName, OutputStream outs, CMSContainer cmsContainer) Adds an existing signature to a PDF where space was already reserved.(package private) PdfSigner
createPdfSigner
(SignerProperties signerProperties) byte[]
prepareDocumentForSignature
(SignerProperties signerProperties, String digestAlgorithm, PdfName filter, PdfName subFilter, int estimatedSize, boolean includeDate) Prepares document for signing, calculates the document digest to sign and closes the document.private byte[]
prepareDocumentForSignature
(SignerProperties signerProperties, MessageDigest messageDigest, PdfName filter, PdfName subFilter, int estimatedSize, boolean includeDate) setExternalDigest
(IExternalDigest externalDigest) Use the external digest to inject specific digest implementationssetStampingProperties
(StampingProperties stampingProperties) Set stamping properties to be used during main signing operation.
-
Field Details
-
reader
-
outputStream
-
externalDigest
-
stampingProperties
-
closed
private boolean closed
-
-
Constructor Details
-
PdfTwoPhaseSigner
Creates newPdfTwoPhaseSigner
instance.- Parameters:
reader
-PdfReader
instance to read the original PDF fileoutputStream
-OutputStream
output stream to write the resulting PDF file into
-
-
Method Details
-
prepareDocumentForSignature
public byte[] prepareDocumentForSignature(SignerProperties signerProperties, String digestAlgorithm, PdfName filter, PdfName subFilter, int estimatedSize, boolean includeDate) throws IOException, GeneralSecurityException Prepares document for signing, calculates the document digest to sign and closes the document.- Parameters:
signerProperties
-SignerProperties
properties to be used for main signing operationdigestAlgorithm
- the algorithm to generate the digest withfilter
- PdfName of the signature handler to use when validating this signaturesubFilter
- PdfName that describes the encoding of the signatureestimatedSize
- the estimated size of the signature, this is the size of the space reserved for the Cryptographic Message ContainerincludeDate
- specifies if the signing date should be set to the signature dictionary- Returns:
- the message digest of the prepared document.
- Throws:
IOException
- if some I/O problem occurs.GeneralSecurityException
- if some problem during apply security algorithms occurs.
-
addSignatureToPreparedDocument
public static void addSignatureToPreparedDocument(PdfDocument document, String fieldName, OutputStream outs, CMSContainer cmsContainer) throws IOException, GeneralSecurityException Adds an existing signature to a PDF where space was already reserved.- Parameters:
document
- the original PDFfieldName
- the field to sign. It must be the last fieldouts
- the output PDFcmsContainer
- the finalized CMS container- Throws:
IOException
- if some I/O problem occurs.GeneralSecurityException
- if some problem during apply security algorithms occurs.
-
addSignatureToPreparedDocument
public static void addSignatureToPreparedDocument(PdfDocument document, String fieldName, OutputStream outs, byte[] signedContent) throws IOException, GeneralSecurityException Adds an existing signature to a PDF where space was already reserved.- Parameters:
document
- the original PDFfieldName
- the field to sign. It must be the last fieldouts
- the output PDFsignedContent
- the bytes for the signed data- Throws:
IOException
- if some I/O problem occurs.GeneralSecurityException
- if some problem during apply security algorithms occurs.
-
setExternalDigest
Use the external digest to inject specific digest implementations- Parameters:
externalDigest
- the IExternalDigest instance to use to generate Digests- Returns:
- same instance of
PdfTwoPhaseSigner
-
setStampingProperties
Set stamping properties to be used during main signing operation.If none is set, stamping properties with append mode enabled will be used
- Parameters:
stampingProperties
-StampingProperties
instance to be used during main signing operation- Returns:
- same instance of
PdfTwoPhaseSigner
-
createPdfSigner
- Throws:
IOException
-
prepareDocumentForSignature
private byte[] prepareDocumentForSignature(SignerProperties signerProperties, MessageDigest messageDigest, PdfName filter, PdfName subFilter, int estimatedSize, boolean includeDate) throws IOException - Throws:
IOException
-