public class

DigitalSignatureField

extends Object
implements __Delete
java.lang.Object
   ↳ com.pdftron.pdf.DigitalSignatureField

Class Overview

The class DigitalSignatureField. A class representing a digital signature form field.

Summary

Nested Classes
enum DigitalSignatureField.DocumentPermissions  
enum DigitalSignatureField.FieldPermissions  
enum DigitalSignatureField.SubFilterType  
Public Constructors
DigitalSignatureField(Field in_field)
Constructs a DigitalSignatureField from a Field.
Public Methods
static DigitalSignatureField __Create(long impl, Object ref)
long __GetHandle()
Object __GetRefHandle()
void certifyOnNextSave(String in_pkcs12_keyfile_path, String in_password)
Must be called to prepare a signature for certification, which is done afterwards by calling Save.
void certifyOnNextSave(byte[] in_pkcs12_buffer, String in_password)
Must be called to prepare a signature for certification, which is done afterwards by calling Save.
void certifyOnNextSaveWithCustomHandler(long in_signature_handler_id)
Must be called to prepare a signature for certification, which is done afterwards by calling Save.
void clearSignature()
Clears cryptographic signature, if present.
void destroy()
Frees the native memory of the object.
byte[] getCert(int in_index)
Gets a certificate in the certificate chain (Cert entry) of the digital signature dictionary by index.
int getCertCount()
Gets number of certificates in certificate chain (Cert entry of digital signature dictionary).
String getContactInfo()
Should not be called when SubFilter is ETSI.RFC3161 (i.e.
DigitalSignatureField.DocumentPermissions getDocumentPermissions()
If HasCryptographicSignature, returns most restrictive permissions found in any reference entries in this digital signature.
String getLocation()
Should not be called when SubFilter is ETSI.RFC3161 (i.e.
String[] getLockedFields()
Returns the fully-qualified names of all fields locked by this signature using the field permissions feature.
String getReason()
Should not be called when SubFilter is ETSI.RFC3161 (i.e.
Obj getSDFObj()
Retrieves the SDF Obj of the digital signature field.
String getSignatureName()
Should not be called when SubFilter is ETSI.RFC3161 (i.e.
Date getSigningTime()
Should not be called when SubFilter is ETSI.RFC3161 (i.e.
DigitalSignatureField.SubFilterType getSubFilter()
Returns the SubFilter type of the digital signature.
boolean hasCryptographicSignature()
Returns whether the digital signature field has been cryptographically signed.
boolean hasVisibleAppearance()
Returns whether the field has a visible appearance.
boolean isLockedByDigitalSignature()
Returns whether this digital signature field is locked against modifications by any digital signatures.
void setContactInfo(String in_contact_info)
Should not be called when SubFilter is ETSI.RFC3161 (i.e.
void setDocumentPermissions(DigitalSignatureField.DocumentPermissions in_perms)
Sets the document locking permission level for this digital signature field.
void setFieldPermissions(DigitalSignatureField.FieldPermissions in_action)
void setFieldPermissions(DigitalSignatureField.FieldPermissions in_action, String[] in_field_names)
Tentatively sets which fields are to be locked by this digital signature upon signing.
void setLocation(String in_location)
Should not be called when SubFilter is ETSI.RFC3161 (i.e.
void setReason(String in_reason)
Should not be called when SubFilter is ETSI.RFC3161 (i.e.
void signOnNextSave(String in_pkcs12_keyfile_path, String in_password)
Must be called to prepare a signature for signing, which is done afterwards by calling Save.
void signOnNextSave(byte[] in_pkcs12_buffer, String in_password)
Must be called to prepare a signature for signing, which is done afterwards by calling Save.
void signOnNextSaveWithCustomHandler(long in_signature_handler_id)
Must be called to prepare a signature for signing, which is done afterwards by calling Save.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.pdftron.pdf.__Delete

Public Constructors

public DigitalSignatureField (Field in_field)

Constructs a DigitalSignatureField from a Field.

Public Methods

public static DigitalSignatureField __Create (long impl, Object ref)

public long __GetHandle ()

public Object __GetRefHandle ()

public void certifyOnNextSave (String in_pkcs12_keyfile_path, String in_password)

Must be called to prepare a signature for certification, which is done afterwards by calling Save. Throws if document already certified. Default document permission level is e_annotating_formfilling_signing_allowed. Throws if signature field already has a digital signature dictionary.

Parameters
in_pkcs12_keyfile_path -- The path to the PKCS #12 private keyfile to use to certify this digital signature.
in_password -- The password to use to parse the PKCS #12 keyfile.

public void certifyOnNextSave (byte[] in_pkcs12_buffer, String in_password)

Must be called to prepare a signature for certification, which is done afterwards by calling Save. Throws if document already certified. Default document permission level is e_annotating_formfilling_signing_allowed. Throws if signature field already has a digital signature dictionary.

Parameters
in_pkcs12_buffer -- A buffer of bytes containing the PKCS #12 private key certificate store to use to certify this digital signature.
in_password -- The password to use to parse the PKCS #12 buffer.

public void certifyOnNextSaveWithCustomHandler (long in_signature_handler_id)

Must be called to prepare a signature for certification, which is done afterwards by calling Save. Throws if document already certified. Default document permission level is e_annotating_formfilling_signing_allowed. Throws if signature field already has a digital signature dictionary.

Parameters
in_signature_handler_id -- The unique id of the signature handler to use to certify this digital signature.

public void clearSignature ()

Clears cryptographic signature, if present. Otherwise, does nothing. Do not need to call HasCryptographicSignature before calling this. After clearing, other signatures should still pass validation. Clears the appearance as well.

public void destroy ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

public byte[] getCert (int in_index)

Gets a certificate in the certificate chain (Cert entry) of the digital signature dictionary by index. Throws if Cert is not Array or String, throws if index is out of range and Cert is Array, throws if index is > 1 and Cert is string, otherwise retrieves the certificate.

Parameters
in_index -- An integral index which must be greater than 0 and less than the cert count as retrieved using GetCertCount.
Returns
  • A vector of bytes containing the certificate at the index. Returns empty vector if Cert is missing.

public int getCertCount ()

Gets number of certificates in certificate chain (Cert entry of digital signature dictionary). Must call HasCryptographicSignature first and use it to check whether the signature is signed.

Returns
  • An integer value - the number of certificates in the Cert entry of the digital signature dictionary.

public String getContactInfo ()

Should not be called when SubFilter is ETSI.RFC3161 (i.e. on a DocTimeStamp). Returns the contact information of the signer from the digital signature dictionary. Must call HasCryptographicSignature first and use it to check whether the signature is signed.

Returns
  • A String containing the contact information of the signer from within the digital signature dictionary. Empty if ContactInfo entry not present.

public DigitalSignatureField.DocumentPermissions getDocumentPermissions ()

If HasCryptographicSignature, returns most restrictive permissions found in any reference entries in this digital signature. Returns Lock-resident (i.e. tentative) permissions otherwise. Throws if invalid permission value is found.

Returns
  • An enumeration value representing the level of restrictions (potentially) placed on the document by this signature.

public String getLocation ()

Should not be called when SubFilter is ETSI.RFC3161 (i.e. on a DocTimeStamp). Returns the Location of the signature from the digital signature dictionary. Must call HasCryptographicSignature first and use it to check whether the signature is signed.

Returns
  • A String containing the signing location from within the digital signature dictionary. Empty if Location entry not present.

public String[] getLockedFields ()

Returns the fully-qualified names of all fields locked by this signature using the field permissions feature. Retrieves from the digital signature dictionary if the form field HasCryptographicSignature. Otherwise, retrieves from the Lock entry of the digital signature form field. Result is invalidated by any field additions or removals. Does not take document permissions restrictions into account.

Returns
  • A vector of UStrings representing the fully-qualified names of all fields locked by this signature.

public String getReason ()

Should not be called when SubFilter is ETSI.RFC3161 (i.e. on a DocTimeStamp). Returns the Reason for the signature from the digital signature dictionary. Must call HasCryptographicSignature first and use it to check whether the signature is signed.

Returns
  • A String containing the reason for the signature from within the digital signature dictionary. Empty if Reason entry not present.

public Obj getSDFObj ()

Retrieves the SDF Obj of the digital signature field.

Returns
  • the underlying SDF/Cos object.

public String getSignatureName ()

Should not be called when SubFilter is ETSI.RFC3161 (i.e. on a DocTimeStamp). Returns the name of the signer of the signature from the digital signature dictionary. Must call HasCryptographicSignature first and use it to check whether the signature is signed.

Returns
  • A String containing the name of the signer from within the digital signature dictionary. Empty if Name entry not present.

public Date getSigningTime ()

Should not be called when SubFilter is ETSI.RFC3161 (i.e. on a DocTimeStamp). Returns the "M" entry from the digital signature dictionary, which represents the signing date/time. Must call HasCryptographicSignature first and use it to check whether the signature is signed.

Returns
  • A Date object holding the signing date/time from within the digital signature dictionary. Returns a default-constructed Date if no date is present.

public DigitalSignatureField.SubFilterType getSubFilter ()

Returns the SubFilter type of the digital signature. Specification says that one must check the SubFilter before using various getters. Must call HasCryptographicSignature first and use it to check whether the signature is signed.

Returns
  • An enumeration describing what the SubFilter of the digital signature is from within the digital signature dictionary

public boolean hasCryptographicSignature ()

Returns whether the digital signature field has been cryptographically signed. Checks whether there is a digital signature dictionary in the field and whether it has a Contents entry. Must be called before using various digital signature dictionary-related functions. Does not check validity - will return true even if a valid hash has not yet been generated (which will be the case after [Certify/Sign]OnNextSave[WithCustomHandler] has been called on the signature but even before Save is called on the document).

Returns
  • A boolean value representing whether the digital signature field has a digital signature dictionary with a Contents entry.

public boolean hasVisibleAppearance ()

Returns whether the field has a visible appearance. Can be called without checking HasCryptographicSignature first, since it operates on the surrounding Field dictionary, not the "V" entry (i.e. digital signature dictionary). Performs the zero-width+height check, the Hidden bit check, and the NoView bit check as described by the PDF 2.0 specification, section 12.7.5.5 "Signature fields".

Returns
  • A boolean representing whether or not the signature field has a visible signature.

public boolean isLockedByDigitalSignature ()

Returns whether this digital signature field is locked against modifications by any digital signatures. Can be called when this field is unsigned.

Returns
  • A boolean representing whether this digital signature field is locked against modifications by any digital signatures in the document.

public void setContactInfo (String in_contact_info)

Should not be called when SubFilter is ETSI.RFC3161 (i.e. on a DocTimeStamp). Sets the ContactInfo entry in the digital signature dictionary. Must create a digital signature dictionary first using [Certify/Sign]OnNextSave[WithCustomHandler]. If this function is called on a digital signature field that has already been cryptographically signed with a valid hash, the hash will no longer be valid, so do not call Save (to sign/create the hash) until after you call this function, if you need to call this function in the first place. Essentially, call this function after [Certify/Sign]OnNextSave[WithCustomHandler] and before Save.

Parameters
in_contact_info -- A String containing the ContactInfo to be set.

public void setDocumentPermissions (DigitalSignatureField.DocumentPermissions in_perms)

Sets the document locking permission level for this digital signature field. Call only on unsigned signatures, otherwise a valid hash will be invalidated.

Parameters
in_perms -- An enumerated value representing the document locking permission level to set.

public void setFieldPermissions (DigitalSignatureField.FieldPermissions in_action)

public void setFieldPermissions (DigitalSignatureField.FieldPermissions in_action, String[] in_field_names)

Tentatively sets which fields are to be locked by this digital signature upon signing. It is not necessary to call HasCryptographicSignature before using this function. Throws if non-empty array of field names is passed along with FieldPermissions Action == e_lock_all.

Parameters
in_action -- An enumerated value representing which sort of field locking should be done. Options are All (lock all fields), Include (lock listed fields), and Exclude (lock all fields except listed fields).
in_field_names -- A list of field names; can be empty (and must be empty, if Action is set to All). Empty by default.

public void setLocation (String in_location)

Should not be called when SubFilter is ETSI.RFC3161 (i.e. on a DocTimeStamp). Sets the Location entry in the digital signature dictionary. Must create a digital signature dictionary first using [Certify/Sign]OnNextSave[WithCustomHandler]. If this function is called on a digital signature field that has already been cryptographically signed with a valid hash, the hash will no longer be valid, so do not call Save (to sign/create the hash) until after you call this function, if you need to call this function in the first place. Essentially, call this function after [Certify/Sign]OnNextSave[WithCustomHandler] and before Save.

Parameters
in_location -- A String containing the Location to be set.

public void setReason (String in_reason)

Should not be called when SubFilter is ETSI.RFC3161 (i.e. on a DocTimeStamp). Sets the Reason entry in the digital signature dictionary. Must create a digital signature dictionary first using [Certify/Sign]OnNextSave[WithCustomHandler]. If this function is called on a digital signature field that has already been cryptographically signed with a valid hash, the hash will no longer be valid, so do not call Save (to sign/create the hash) until after you call this function, if you need to call this function in the first place. Essentially, call this function after [Certify/Sign]OnNextSave[WithCustomHandler] and before Save.

Parameters
in_reason -- A String containing the Reason to be set.

public void signOnNextSave (String in_pkcs12_keyfile_path, String in_password)

Must be called to prepare a signature for signing, which is done afterwards by calling Save. Cannot sign two signatures during one save (throws). Default document permission level is e_annotating_formfilling_signing_allowed. Throws if signature field already has a digital signature dictionary.

Parameters
in_pkcs12_keyfile_path -- The path to the PKCS #12 private keyfile to use to sign this digital signature.
in_password -- The password to use to parse the PKCS #12 keyfile.

public void signOnNextSave (byte[] in_pkcs12_buffer, String in_password)

Must be called to prepare a signature for signing, which is done afterwards by calling Save. Cannot sign two signatures during one save (throws). Default document permission level is e_annotating_formfilling_signing_allowed. Throws if signature field already has a digital signature dictionary.

Parameters
in_pkcs12_buffer -- A buffer of bytes containing the PKCS #12 private key certificate store to use to sign this digital signature.
in_password -- The password to use to parse the PKCS #12 buffer.

public void signOnNextSaveWithCustomHandler (long in_signature_handler_id)

Must be called to prepare a signature for signing, which is done afterwards by calling Save. Cannot sign two signatures during one save (throws). Default document permission level is e_annotating_formfilling_signing_allowed. Throws if signature field already has a digital signature dictionary.

Parameters
in_signature_handler_id -- The unique id of the signature handler to use to sign this digital signature.