com.itextpdf.signatures

Class SignatureUtil

java.lang.Object

com.itextpdf.signatures.SignatureUtil

public class SignatureUtil
extends Object

Utility class that provides several convenience methods concerning digital signatures.

Constructor Summary

Constructors

Constructor and Description
SignatureUtil(com.itextpdf.kernel.pdf.PdfDocument document) Creates a SignatureUtil instance.

Method Summary

Modifier and Type	Method and Description
static long[]	asLongArray(com.itextpdf.kernel.pdf.PdfArray pdfArray) Deprecated. Will be removed in 7.2. Use PdfArray.toLongArray() instead
boolean	doesSignatureFieldExist(String name) Checks whether a name exists as a signature field or not.
InputStream	extractRevision(String field) Extracts a revision from the document.
List<String>	getBlankSignatureNames() Gets the field names that have blank signatures.
int	getRevision(String field)
PdfSignature	getSignature(String name)
com.itextpdf.kernel.pdf.PdfDictionary	getSignatureDictionary(String name) Gets the signature dictionary, the one keyed by /V.
List<String>	getSignatureNames() Gets the field names that have signatures and are signed.
int	getTotalRevisions()
String	getTranslatedFieldName(String name)
boolean	signatureCoversWholeDocument(String name) Checks if the signature covers the entire document (except for signature's Contents) or just a part of it.
PdfPKCS7	verifySignature(String name) Verifies a signature.
PdfPKCS7	verifySignature(String name, String provider) Verifies a signature.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureUtil

public SignatureUtil(com.itextpdf.kernel.pdf.PdfDocument document)

Creates a SignatureUtil instance. Sets the acroForm field to the acroForm in the PdfDocument. iText will create a new AcroForm if the PdfDocument doesn't contain one.

Parameters:

document - PdfDocument to be inspected

Method Detail

asLongArray

@Deprecated
public static long[] asLongArray(com.itextpdf.kernel.pdf.PdfArray pdfArray)

Deprecated. Will be removed in 7.2. Use PdfArray.toLongArray() instead

Converts a PdfArray to an array of longs

Parameters:

pdfArray - PdfArray to be converted

Returns:

long[] containing the PdfArray values

verifySignature

public PdfPKCS7 verifySignature(String name)

Verifies a signature. Further verification can be done on the returned PdfPKCS7 object.

Parameters:

name - String the signature field name

Returns:

PdfPKCS7 object to continue the verification

verifySignature

public PdfPKCS7 verifySignature(String name,
                                String provider)

Verifies a signature. Further verification can be done on the returned PdfPKCS7 object.

Parameters:

name - the signature field name

provider - the provider or null for the default provider

Returns:

PdfPKCS7 object to continue the verification

getSignature

public PdfSignature getSignature(String name)

getSignatureDictionary

public com.itextpdf.kernel.pdf.PdfDictionary getSignatureDictionary(String name)

Gets the signature dictionary, the one keyed by /V.

Parameters:

name - the field name

Returns:

the signature dictionary keyed by /V or null if the field is not a signature

getSignatureNames

public List<String> getSignatureNames()

Gets the field names that have signatures and are signed.

Returns:

List containing the field names that have signatures and are signed

getBlankSignatureNames

public List<String> getBlankSignatureNames()

Gets the field names that have blank signatures.

Returns:

List containing the field names that have blank signatures

getTotalRevisions

public int getTotalRevisions()

getRevision

public int getRevision(String field)

getTranslatedFieldName

public String getTranslatedFieldName(String name)

extractRevision

public InputStream extractRevision(String field)
                            throws IOException

Extracts a revision from the document.

Parameters:

field - the signature field name

Returns:

an InputStream covering the revision. Returns null if it's not a signature field

Throws:

IOException

signatureCoversWholeDocument

public boolean signatureCoversWholeDocument(String name)

Checks if the signature covers the entire document (except for signature's Contents) or just a part of it.

Parameters:

name - the signature field name

Returns:

true if the signature covers the entire document, false if it doesn't

doesSignatureFieldExist

public boolean doesSignatureFieldExist(String name)

Checks whether a name exists as a signature field or not. It checks both signed fields and blank signatures.

Parameters:

name - name of the field

Returns:

boolean does the signature field exist