PDFSign Class

Properties   Methods   Events   Config Settings   Errors  

The PDFSign class signs PDF documents.

Syntax

securepdf.PDFSign

Remarks

The PDFSign class can sign PDF documents in accordance with a selection of PDF and PAdES signature standards, including basic Adobe signatures (ISO 32000) and PAdES signatures (ETSI EN 319 142-1).

Preparing the Signature

To configure PDFSign to produce the desired signature, first provide the input document as a file (InputFile), byte array (InputData), or stream (SetInputStream) and assign your signing certificate to the SigningCert property. Then indicate where to save the output document by setting OutputFile or calling SetOutputStream.

Optionally specify the Signature* properties and the TimestampServer property, and adjust any chain validation parameters as necessary (please see the Chain Validation Setup section for more details). Finally, call the Sign method.

PDFSign also provides means to customize the appearance of the signature widget to be shown on the document page. You can create your very own signatures (e.g., in the form of your company's logo) by adjusting the widget properties available in the SetWidgetProperty method. Alternatively, you can choose not to associate any widget with your signature by setting the Invisible widget property to true.

The Signing Process

Depending on the configuration, the signing process may be as straightforward as calculating the document hash and signing it with the private key, or it may involve the advanced chain validation routine. During the latter, the class may contact external revocation (i.e., CRL and OCSP endpoints) and trust sources to establish the validity of the signing certificate.

If an external TSA server was provided via the TimestampServer property, the class will also contact it to timestamp the new signature.

During signing, PDFSign may fire events to notify your code about certain conditions. For example, if the input document is encrypted but no decryption parameters were found in the Password or DecryptionCert properties, the class will fire either the Password or RecipientInfo event to tell your code that it needs decryption information to be able to continue with the signing. Additionally, the SSLServerAuthentication event will fire if one of the HTTP endpoints involved during the operation (which may be a TSA, CRL, OCSP, or Trusted List service) operates over TLS and needs its certificate to be validated.

Basic Adobe Signatures

A basic (also known as legacy) Adobe signature is an original Adobe Acrobat document signature. This is an outdated form of PDF signature - while PAdES is loosely built on it, this signature type does not support extended features and is not compliant with PAdES. Unless the recipient of your signed documents expects you to specifically use this kind of signature, it is unlikely that you will ever need it.

PAdES Signatures and Profiles

In PAdES, a given signature's profile describes the level of "completeness" of the validation material (i.e., certificates, CRLs, and OCSP responses) included in the signature. For example, signatures compliant with the PAdES B-B or PAdES B-T profiles do not require any validation material at all, whereas signatures compliant with the PAdES B-LTA profile must contain complete validation material.

PAdES B-B

The PAdES B-B profile is the baseline profile that uses the PAdES-BES signature level by default, meaning the signature only contains the signing time and signer information.

Use the following code to create a B-B signature: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineB; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); PAdES-EPES

To instead create a PAdES-EPES signature that includes the signature-policy-identifier attribute, set the PolicyHash, PolicyHashAlgorithm, and PolicyId configuration settings before calling the Sign method.

This profile, in both the BES and EPES settings, creates a basic signature that remains valid as long as the signing certificate has not expired or been revoked. Signatures at this level need not contain any validation material.

PAdES B-T

The PAdES B-T profile extends the basic BES or EPES signature by adding a signature timestamp. This timestamp certifies that the signature was created at a specific moment in time. Similar to the B-B profile, signatures at this level need not contain any validation material.

Use the following code to create a B-T signature: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineT; pdfsign.TimestampServer = "https://freetsa.org/tsr"; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); PAdES B-LTA

The PAdES B-LTA profile is used to achieve signatures that are equipped with long-term archival (LTA) or long-term validation (LTV) capabilities. It incorporates into the signature all the material required to validate the signature, including signing certificates, timestamping certificates, and revocation information. It also adds a document timestamp, which certifies the integrity of both the document and the complete validation material at a specific moment in time. This guarantees that no relevant certificates were expired or revoked at the signature creation time, and enables the signature to be verified offline.

Creating a B-LTA signature with PDFSign is a two-step process. First Sign the document and add a signature timestamp, setting SignatureProfile appropriately. Then Update the signature to take care of the rest (collect and embed the validation material, and add a document timestamp): pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineLTA; pdfsign.TimestampServer = "https://freetsa.org/tsr"; pdfsign.Sign(); // Update the signature to LTV - this will retrieve the necessary revocation // elements, embed them into the document, and add a document timestamp pdfsign.Reset(); pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "updated.pdf"; pdfsign.TimestampServer = "https://freetsa.org/tsr"; pdfsign.Update(); Note that validation material "completeness" can be subjective and depends on several factors, including:

• The working environment. For example, your organization may explicitly trust its own self-signed TSA certificate. Signatures timestamped with this certificate will be considered B-LTA by your organization, but for any external bodies, those signatures would be rendered as B-LT or even B-B, as they do not know or trust the custom TSA certificate.
• The time that has passed since the last document timestamp. If an archived (B-LTA) document is not re-timestamped before its last timestamp expires, it will drop back to a lower signature level.

Chain Validation Setup

Chain validation is a sophisticated, multi-faceted procedure that involves a lot of variables. Depending on the configuration of your operating environment, the specifics of the PKI framework being used, and the validation policy you need to follow, you may want to adjust your chain validation parameters to best fit your requirements. A summary of these parameters is given below.

Note that these parameters apply to the Sign and Update methods in PDFSign as well as the Verify method in PDFVerify, as all three methods execute the chain validation procedure (if it is enabled).

Validation Policy

The ValidationPolicy property dictates how thoroughly the chain will be validated. It includes options to control which checks the class will perform, allowing you to tailor the validation process to meet your specific security needs. For example, if it is not essential to check each certificate's revocation status, set this property to vpFullNoRevocation.

Revocation

The revocation aspect of chain validation is controlled by the RevocationCheck property, which allows you to choose between and prioritize revocation origins. Note that OCSP sources are often preferred to CRL endpoints because of their real-time capability and the smaller size of the responses they produce.

Trust

The trust aspect of chain validation is controlled by the TrustSources property, which allows you to specify the locations in which the class will search for trust anchors. Local system stores, your own trusted root certificates (via the TrustedCerts property), and Trusted Lists (via the TrustedLists property) are all supported.

Offline Mode

The OfflineMode property provides the ability to verify the document without contacting online sources. If this property is enabled, the class will only use KnownCerts, TrustedCerts, data structures within the document itself, and revocation and Trusted List data that it previously saved to its internal cache when looking for missing validation material.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Attachments Property (PDFSign Class)

A collection of all attached files found in the PDF document.

Syntax

public PDFAttachmentList getAttachments();


public void setAttachments(PDFAttachmentList attachments);

Remarks

This property is used to access the details of all the attached files identified in the document. Use the AddAttachment, RemoveAttachment, and SaveAttachment methods to add, remove, and save attachments to/from this collection respectively.

This property is not available at design time.

Please refer to the PDFAttachment type for a complete list of fields.

BlockedCerts Property (PDFSign Class)

The certificates that must be rejected as trust anchors.

Syntax

public CertificateList getBlockedCerts();


public void setBlockedCerts(CertificateList blockedCerts);

Remarks

This property is used to supply a list of compromised or blocked certificates to the class. Note that any chain containing a blocked certificate will fail validation.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

DecryptionCert Property (PDFSign Class)

The decryption certificate.

Syntax

public Certificate getDecryptionCert();


public void setDecryptionCert(Certificate decryptionCert);

Remarks

This property is used to provide the certificate used for decryption. Note that this certificate must have a private key associated with it.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

DocumentCerts Property (PDFSign Class)

A collection of certificates read from the document during processing.

Syntax

public CertificateList getDocumentCerts();

Remarks

This property is used to access all certificates encountered during document processing and embedded into the signature(s). When signing or verifying, this collection will be populated automatically during chain validation.

This property is read-only and not available at design time.

Please refer to the Certificate type for a complete list of fields.

Firewall Property (PDFSign Class)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();


public void setFirewall(Firewall firewall);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Please refer to the Firewall type for a complete list of fields.

InputData Property (PDFSign Class)

A byte array containing the PDF document to process.

Syntax

public byte[] getInputData();


public void setInputData(byte[] inputData);

Remarks

This property is used to assign a byte array containing the PDF document to be processed.

This property is not available at design time.

InputFile Property (PDFSign Class)

The PDF file to process.

Syntax

public String getInputFile();


public void setInputFile(String inputFile);

Default Value

""

Remarks

This property is used to provide a path to the PDF document to be processed.

KnownCerts Property (PDFSign Class)

A collection of additional certificates for chain validation.

Syntax

public CertificateList getKnownCerts();


public void setKnownCerts(CertificateList knownCerts);

Remarks

This property is used to supply a list of additional certificates to the class that might be needed for chain validation. For instance, intermediary CA certificates may be absent from the standard system locations (or there may be no standard system locations) and therefore should be supplied to the class manually.

The purpose of this certificate collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Note: Do not add trust anchors or root certificates to this collection; add them to TrustedCerts instead.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

OfflineMode Property (PDFSign Class)

Whether the class is operating in offline mode.

Syntax

public boolean isOfflineMode();


public void setOfflineMode(boolean offlineMode);

Default Value

False

Remarks

This property indicates whether the class should operate in offline mode.

In offline mode, the class restricts itself from accessing online Trusted Lists and revocation information sources such as CRLs or OCSP responders. It may be useful to set this property to true if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCerts.

OutputData Property (PDFSign Class)

A byte array containing the PDF document after processing.

Syntax

public byte[] getOutputData();

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It will only be set if an output file and output stream have not been assigned via OutputFile and SetOutputStream respectively.

This property is read-only and not available at design time.

OutputFile Property (PDFSign Class)

The path to a local file where the output will be written.

Syntax

public String getOutputFile();


public void setOutputFile(String outputFile);

Default Value

""

Remarks

This property is used to provide a path where the resulting PDF document will be saved after the operation has completed.

Overwrite Property (PDFSign Class)

Whether or not the class should overwrite files.

Syntax

public boolean isOverwrite();


public void setOverwrite(boolean overwrite);

Default Value

False

Remarks

This property indicates whether or not the class will overwrite OutputFile, OutputData, or the stream set in SetOutputStream. If set to false, an error will be thrown whenever OutputFile, OutputData, or the stream set in SetOutputStream exists before an operation.

Password Property (PDFSign Class)

The password to decrypt the document with.

Syntax

public String getPassword();


public void setPassword(String password);

Default Value

""

Remarks

This property is used to provide the user password for decryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

Proxy Property (PDFSign Class)

A set of properties related to proxy access.

Syntax

public Proxy getProxy();


public void setProxy(Proxy proxy);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Please refer to the Proxy type for a complete list of fields.

RevocationCheck Property (PDFSign Class)

The kind(s) of revocation check to perform for all chain certificates.

Syntax

public int getRevocationCheck();


public void setRevocationCheck(int revocationCheck);


Enumerated values:
  public final static int rcAllCRL = 0;
  public final static int rcAllOCSP = 1;
  public final static int rcAllCRLAndOCSP = 2;
  public final static int rcAnyCRL = 3;
  public final static int rcAnyOCSP = 4;
  public final static int rcAnyCRLOrOCSP = 5;
  public final static int rcAnyOCSPOrCRL = 6;

Default Value

6

Remarks

This property is used to specify the revocation sources and preferences the class will use during chain validation. Revocation checking is necessary to ensure the integrity of the chain and to obtain up-to-date certificate validity and trust information.

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate has not been revoked by the Certificate Authority (CA) at the time of use. Depending on the circumstances and security policy requirements, either one or both of the revocation information source types may be used.

Possible values are:

This property controls the way revocation checks are performed for every certificate in the chain. Typically, certificates come with two types of revocation information sources: CRLs (Certificate Revocation Lists) and OCSP responses. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally a delay between the time at which a certificate was revoked and the time at which the subsequent CRL mentioning that revocation is published. The benefits of CRLs are that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This property allows the validation course to be adjusted by including or excluding certain types of revocation sources from the validation process. The rcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The rcAll* modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

SignatureAuthorName Property (PDFSign Class)

The human-readable name of the signer.

Syntax

public String getSignatureAuthorName();


public void setSignatureAuthorName(String signatureAuthorName);

Default Value

""

Remarks

This property is used to specify the human-readable name of the signer.

Note: This property only applies when creating a new signature.

SignatureClaimedSigningTime Property (PDFSign Class)

The signature's creation time.

Syntax

public String getSignatureClaimedSigningTime();


public void setSignatureClaimedSigningTime(String signatureClaimedSigningTime);

Default Value

""

Remarks

This property is used to specify the signature creation time from the signer's computer. The time should be provided in UTC in yyyyMMddHHmmssZ format.

Note: This property only applies when creating a new signature.

SignatureField Property (PDFSign Class)

The index of the empty signature field to sign.

Syntax

public int getSignatureField();


public void setSignatureField(int signatureField);

Default Value

-1

Remarks

This property is used to specify the empty signature field that should be signed. If the default value of -1 is assigned to this property, a new signature field will be created.

Example: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "emptyfield.pdf"; pdfsign.SignatureType = PDFSignSignatureTypes.stEmptyField; pdfsign.Sign(); // Later pdfsign.Reset(); pdfsign.InputFile = "emptyfield.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureField = 0; // Configure signature properties as desired pdfsign.Sign();

SignatureHashAlgorithm Property (PDFSign Class)

The hash algorithm to be used for signing.

Syntax

public String getSignatureHashAlgorithm();


public void setSignatureHashAlgorithm(String signatureHashAlgorithm);

Default Value

"SHA256"

Remarks

This property is used to specify the hash algorithm to be used for signing.

Possible values are:

• SHA1
• SHA224
• SHA256
• SHA384
• SHA512
• MD5

Note: This property only applies when creating a new signature.

SignatureProfile Property (PDFSign Class)

The PAdES profile to apply when creating the signature.

Syntax

public int getSignatureProfile();


public void setSignatureProfile(int signatureProfile);


Enumerated values:
  public final static int pfNone = 0;
  public final static int pfBaselineB = 1;
  public final static int pfBaselineT = 2;
  public final static int pfBaselineLT = 3;
  public final static int pfBaselineLTA = 4;

Default Value

0

Remarks

This property is used to specify a pre-defined PAdES profile to apply when creating the signature, as defined by ETSI.

Advanced signatures come in many variants, and they are often defined by parties that need to process them or by local standards. Profiles are sets of pre-defined configurations that correspond to particular signature variants. Specifying a profile pre-configures the class to make it produce the signature that matches the configuration corresponding to that profile.

Possible values are:

To apply a custom profile that is not defined by ETSI, set the CustomProfile configuration setting.

Note: This property only applies when creating a new signature.

SignatureReason Property (PDFSign Class)

The reason for signing.

Syntax

public String getSignatureReason();


public void setSignatureReason(String signatureReason);

Default Value

""

Remarks

This property is used to specify the reason for signing.

Note: This property only applies when creating a new signature.

Signatures Property (PDFSign Class)

A collection of all the signatures and empty fields found in the PDF document.

Syntax

public PDFSignatureList getSignatures();

Remarks

This property is used to access the details of all the signatures and empty signature fields identified in the document.

This property is read-only and not available at design time.

Please refer to the PDFSignature type for a complete list of fields.

SignatureType Property (PDFSign Class)

The type of signature to create.

Syntax

public int getSignatureType();


public void setSignatureType(int signatureType);


Enumerated values:
  public final static int stLegacy = 0;
  public final static int stAdvanced = 1;
  public final static int stDTS = 2;
  public final static int stEmptyField = 3;

Default Value

0

Remarks

This property is used to specify the type of the signature.

Possible values are:

Note: This property only applies when creating a new signature.

SignatureWidgetHeight Property (PDFSign Class)

The height of the signature widget.

Syntax

public String getSignatureWidgetHeight();


public void setSignatureWidgetHeight(String signatureWidgetHeight);

Default Value

"70"

Remarks

This property is used to specify the height of the signature widget in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

SignatureWidgetOffsetX Property (PDFSign Class)

The signature widget offset from the left-hand page border.

Syntax

public String getSignatureWidgetOffsetX();


public void setSignatureWidgetOffsetX(String signatureWidgetOffsetX);

Default Value

"0"

Remarks

This property is used to specify the signature widget offset from the left-hand page border in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

SignatureWidgetOffsetY Property (PDFSign Class)

The signature widget offset from the bottom page border.

Syntax

public String getSignatureWidgetOffsetY();


public void setSignatureWidgetOffsetY(String signatureWidgetOffsetY);

Default Value

"0"

Remarks

This property is used to specify the signature widget offset from the bottom page border in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

SignatureWidgetPages Property (PDFSign Class)

The pages to place the signature and its widget on.

Syntax

public String getSignatureWidgetPages();


public void setSignatureWidgetPages(String signatureWidgetPages);

Default Value

""

Remarks

This property is used to specify the pages on which the signature and its widget will be placed.

A variety of syntaxes are supported:

• A single page number: 3
• A comma-separated list of page numbers: 1,2,5,7
• The asterisk character (*) indicates that the widget should be placed on all pages in the document.
• The first and last placeholders specify that the signature should be placed on the respective page, independently of its number.

Note: This property only applies when creating a new signature.

SignatureWidgetWidth Property (PDFSign Class)

The width of the signature widget.

Syntax

public String getSignatureWidgetWidth();


public void setSignatureWidgetWidth(String signatureWidgetWidth);

Default Value

"70"

Remarks

This property is used to specify the width of the signature widget in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

SigningCert Property (PDFSign Class)

The certificate to be used for signing.

Syntax

public Certificate getSigningCert();


public void setSigningCert(Certificate signingCert);

Remarks

This property is used to provide the certificate used for signing the document. Note that this certificate must have a private key associated with it.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

TimestampServer Property (PDFSign Class)

The address of the timestamping server.

Syntax

public String getTimestampServer();


public void setTimestampServer(String timestampServer);

Default Value

""

Remarks

This property is used to specify the address of the TSA (Timestamping Authority) server to use for timestamping the signature (normal signing) or the document (LTV update).

If the timestamping service enforces credential-based user authentication (basic or digest), the credentials can be provided in the same URL. For example: pdfsign.TimestampServer = "http://user:password@timestamp.server.com/TsaService"; If the TSA requires TLS client authentication, provide the client certificate via the TSATLSClientCertStoreType, TSATLSClientCertStore, TSATLSClientCertSubject, and TSATLSClientCertStorePassword configuration settings.

TrustedCerts Property (PDFSign Class)

A collection of trusted certificates for chain validation.

Syntax

public CertificateList getTrustedCerts();


public void setTrustedCerts(CertificateList trustedCerts);

Remarks

This property is used to supply a list of trusted certificates to the class that might be needed for chain validation. For instance, root CA certificates may be absent from the standard system locations (or there may be no standard system locations) and therefore should be supplied to the class manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the list of trusted certificates may result in bad chains being accepted and forfeited signatures being recognized as genuine. Only add certificates that originate from parties that are known and trusted.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

TrustedLists Property (PDFSign Class)

A list of known Trusted Lists for chain validation.

Syntax

public String getTrustedLists();


public void setTrustedLists(String trustedLists);

Default Value

"%EUTL%"

Remarks

This property is used to supply a semicolon-separated list of URLs or paths of known Trusted Lists to the class for chain validation.

A Trusted List is an XML document that contains a government-issued list of CAs that have passed regulated compliance checks. When validating the chain, the class will consult the Trusted List to establish certificate trust, ensuring that the CA is legitimate and entitled to issue certificates of the kind being checked.

The default value is the special %EUTL% macro, which, if applicable, instructs the class to check the root certificate against up-to-date versions of the primary EU Trusted Lists from the EU LOTL. Custom values can be appended: component.TrustedLists = "%EUTL%;http://my.company/tsl;c:\tsls\mytsl.xml"; Note: The class will cache all Trusted Lists it downloads and uses during chain validation. This cache is shared between class instances within the same process. If this property contains a URL that is also present in the cache, the class will retrieve the cached data and reuse them in the current validation. If the data are invalid, the class will download a fresh Trusted List and add it to the cache.

TrustSources Property (PDFSign Class)

The trust sources to use during chain validation.

Syntax

public int getTrustSources();


public void setTrustSources(int trustSources);


Enumerated values:
  public final static int tsManual = 0;
  public final static int tsLocal = 1;
  public final static int tsTrustedLists = 2;
  public final static int tsLocalAndTrustedLists = 3;

Default Value

3

Remarks

This property is used to specify the sources the class will use to establish certificate trust during chain validation.

Establishing trust for a particular certificate, when either signing or verifying, involves building a chain up to a valid trust anchor. This trust anchor is a root certificate that typically resides on the local system. If the certificate does not eventually chain up to a valid trust anchor, the chain is considered untrusted and therefore invalid.

Possible values are:

ValidationFlags Property (PDFSign Class)

Additional chain validation settings.

Syntax

public int getValidationFlags();


public void setValidationFlags(int validationFlags);

Default Value

0

Remarks

This property is used to specify additional settings that affect the overall flow of the chain validation.

Its value should be provided as a bitmask of the following flags:

ValidationPolicy Property (PDFSign Class)

The level at which to perform chain validation.

Syntax

public int getValidationPolicy();


public void setValidationPolicy(int validationPolicy);


Enumerated values:
  public final static int vpNone = 0;
  public final static int vpFull = 1;
  public final static int vpFullNoTrust = 2;
  public final static int vpFullNoRevocation = 3;
  public final static int vpBestEffort = 4;

Default Value

1

Remarks

This property is used to specify the overall validation policy the class will follow.

Possible values are:

Validation Policy Heuristics

The choice of validation policy will depend on the scenario for which the chain is validated.

Creating a new signature:

• For a basic signature with or without a timestamp, chain validation is not required, so it is recommended to use vpNone. This policy may also be used in test environments or on offline systems.
• For an LTV signature, use vpFull or vpFullNoTrust depending on whether trust checks are necessary in the current environment. If the signature is being created in an environment that does not match the prospective validation environment, consider vpFullNoTrust to validate the chain properly and fully without expecting good trust.

Updating or extending an existing signature:

• When updating a basic signature to LTV, similarly use vpFull or vpFullNoTrust as above.
• When extending an LTV signature, similarly use vpFull or vpFullNoTrust as above.

Validating an existing signature:

• For basic signature validation, use vpFullNoRevocation if trust checks, but not revocation checks, are necessary in the current environment. This policy may also be used on offline systems if the trust anchor is already available to the class.
• For archival validation, use vpFull to validate the chain properly and fully. This policy expects the trust anchor and all the revocation material to be available.

ValidationTime Property (PDFSign Class)

The time point at which the signature should be validated.

Syntax

public String getValidationTime();


public void setValidationTime(String validationTime);

Default Value

""

Remarks

This property is used to specify the moment in time at which the signature validity should be established. The time should be provided in UTC in yyyyMMddHHmmssZ format.

Leave this property empty to stick to the default time point. The class will then prioritize:

• The signature creation time if the signature contains a signature timestamp (ValidatedSigningTime), or
• The local time included in the signature by the signer (ClaimedSigningTime).

Note: The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.

AddAttachment Method (PDFSign Class)

Adds an attachment to a PDF document.

Syntax

public void addAttachment(String fileName, String description);

Remarks

This method is used to add an attachment (embedded file) to the document specified in InputFile, InputData, or SetInputStream and to the Attachments collection.

The document containing the newly added attachment will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

The FileName and Description parameters specify the filename and description of the attachment respectively.

Example: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "input_with_attachment.pdf"; pdfsign.Open(); pdfsign.AddAttachment("foo.txt", "desc"); // Alternatively, create a PDFAttachment object and add it to Attachments manually: PDFAttachment attachment = new PDFAttachment(); attachment.FileName = "foo.txt"; // or attachment.DataB = new byte[] { ... }; // or attachment.InputStream = new FileStream(...); attachment.Description = "desc"; pdfsign.Attachments.Add(attachment); // Or using one of the constructors: pdfsign.Attachments.Add(new PDFAttachment("foo.txt", "desc")); pdfsign.Close(); The full list of attachments is contained in the Attachments property.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

AddDocumentTimestamp Method (PDFSign Class)

Adds a document timestamp to a PDF document.

Syntax

public void addDocumentTimestamp();

Remarks

This method is used to obtain a document timestamp and embed it into the document specified in InputFile, InputData, or SetInputStream. The document containing the newly added document timestamp will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

A document timestamp is a fully independent signature that is added to the PDF document after the initial signature. Unlike the main signature, the document timestamp is made by a TSA, and its purpose is to preserve the document's long-term validity. Typically, adding a document timestamp is done close to the expiration date of the certificate that produced the last timestamp (which is either embedded in the main signature, or is a previous document timestamp). An LTV document therefore contains a chain of document timestamps updated periodically to keep its long-term status.

Example: pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "signed_with_dts.pdf"; pdfsign.TimestampServer = "https://freetsa.org/tsr"; pdfsign.AddDocumentTimestamp(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Close Method (PDFSign Class)

Closes an opened PDF document.

Syntax

public void close();

Remarks

This method is used to close the previously opened document specified in InputFile, InputData, or SetInputStream. It should always be preceded by a call to the Open method.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close();

If any changes are made to the document, they will be saved automatically to OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

Config Method (PDFSign Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Encrypted Method (PDFSign Class)

Checks whether a PDF document is encrypted.

Syntax

public boolean encrypted();

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is encrypted. It will return false if the document is pseudo-encrypted with an empty password.

Example: component.InputFile = "input.pdf"; if (component.Encrypted()) { // Set Password or DecryptionCert } component.Open(); // Some operation component.Close(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

GetPageProperty Method (PDFSign Class)

Retrieves the value of a page property.

Syntax

public String getPageProperty(int page, String property);

Remarks

This method is used to read general information about the pages of the document specified in InputFile, InputData, or SetInputStream, such as their dimensions and content positioning details.

The Page parameter specifies the page to read information about, and the Property parameter specifies the page property to read. The latter can take one of the following values:

Note: Each page property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

Example: int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 1; i <= pageCount; i++) component.GetPageProperty(i, "Height"); component.Close(); The page properties can be used to adjust the position of the signature widget based on the page dimensions. For example: int x = int.Parse(pdfsign.GetPageProperty(1, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(1, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

GetWidgetProperty Method (PDFSign Class)

Retrieves the value of a signature widget property.

Syntax

public String getWidgetProperty(int signatureIndex, String property);

Remarks

This method is used to retrieve the value of a signature widget property. Together with SetWidgetProperty, this method provides an extensible way of managing the widget settings that are not available through the primary properties of the class. The list of settings below may be extended in the future.

The SignatureIndex parameter is the index of the signature of interest in the Signatures collection, and the Property parameter specifies the widget property to read. The latter can take one of the following values:

Example: pdfsign.InputFile = "signed.pdf"; pdfsign.Open(); bool invisible = bool.Parse(pdfsign.GetWidgetProperty(0, "Invisible")); pdfsign.Close(); Note: Each widget property is only populated after the document has been signed and the signature widget has been generated.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Interrupt Method (PDFSign Class)

Interrupts the current action.

Syntax

public void interrupt();

Remarks

This method interrupts the current action. It can be used, for example, within the ChainCert event to abort the chain validation procedure.

If there is no action in progress, this method simply returns, doing nothing.

Open Method (PDFSign Class)

Opens a PDF document for processing.

Syntax

public void open();

Remarks

This method is used to open the document specified in InputFile, InputData, or SetInputStream before performing some operation on it, such as signing, updating, verifying signatures, or removing signatures. When finished, call Close to complete or discard the operation.

It is recommended to use this method (alongside Close) when performing multiple operations on the document at once.

Automatic Decryption Functionality

If this method is called on an encrypted document, the Password or RecipientInfo event will fire (depending on the encryption type) as a notification that the document must be decrypted before processing can continue.

Once the correct decryption material is supplied, the class will then attempt to decrypt the document automatically within this method. When this occurs, the decrypted content is kept in memory so that the document's encrypted status is preserved when it is saved later. Use the Decrypt method to save a decrypted copy of the document instead.

RemoveAttachment Method (PDFSign Class)

Removes an attachment from a PDF document.

Syntax

public void removeAttachment(int index);

Remarks

This method is used to remove an attachment from the document specified in InputFile, InputData, or SetInputStream and from the Attachments collection.

The document without the attachment will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

The Index parameter is the index of the attachment in the Attachments collection to be removed.

Example: pdfsign.InputFile = "input_with_attachment.pdf"; pdfsign.OutputFile = "attachment_removed.pdf"; pdfsign.Open(); pdfsign.RemoveAttachment(0); // Alternatively, remove an attachment from Attachments manually: PDFAttachment attachment = pdfsign.Attachments[0]; pdfsign.Attachments.Remove(attachment); pdfsign.Close(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Reset Method (PDFSign Class)

Resets the class.

Syntax

public void reset();

Remarks

This method is used to reset the class's properties and configuration settings to their default values.

SaveAttachment Method (PDFSign Class)

Saves a PDF attachment to a file.

Syntax

public void saveAttachment(int index, String fileName);

Remarks

This method is used to retrieve the contents of an attachment from the document specified in InputFile, InputData, or SetInputStream and save it to the file specified by FileName. It does not modify the existence of the Attachments collection's contents.

The Index parameter is the index of the attachment in the Attachments collection to be saved.

The FileName parameter specifies the filename that the attachment will be saved to.

Example: component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); Example (saving to a stream): component.InputFile = "input_with_attachment.pdf"; component.Attachments[0].OutputStream = myStream; component.SaveAttachment(0, null); // null means use the OutputStream field if it's not null Note: If the document is not already opened, this method will open it, perform the operation, then close it.

SetInputStream Method (PDFSign Class)

Sets the stream containing the PDF document to process.

Syntax

public void setInputStream(java.io.InputStream inputStream);

Remarks

This method is used to set the stream from which the class will read the PDF document to be processed. If an input stream is set before the class attempts to perform operations on the document, the class will read the data from the input stream instead of from the InputFile or InputData properties.

Note: It may be useful to additionally set the CloseInputStreamAfterProcessing configuration setting to true when using input streams.

SetOutputStream Method (PDFSign Class)

Sets the stream to write the processed document to.

Syntax

public void setOutputStream(java.io.OutputStream outputStream);

Remarks

This method is used to set the stream to which the class will write the resulting PDF document. If an output stream is set before the class attempts to perform operations on the document, the class will write the data to the output stream instead of writing to OutputFile or populating OutputData.

Note: It may be useful to additionally set the CloseOutputStreamAfterProcessing configuration setting to true when using output streams.

SetWidgetProperty Method (PDFSign Class)

Sets the value of a signature widget property.

Syntax

public void setWidgetProperty(String property, String value);

Remarks

This method is used to adjust the look of the signature widget when creating a signature. Together with GetWidgetProperty, this method provides an extensible way of managing the widget settings that are not available through the primary properties of the class. The list of settings below may be extended in the future.

The Property and Value parameters specify the widget property and value to set respectively. The former can take one of the following values:

Example: pdfsign.SetWidgetProperty("Width", "100"); pdfsign.SetWidgetProperty("Height", "100"); pdfsign.SetWidgetProperty("ShowDate", "false"); pdfsign.SetWidgetProperty("SignerInfo", "Hello\r\nworld!"); pdfsign.SetWidgetProperty("TitleFontSize", "11"); pdfsign.Sign();

Sign Method (PDFSign Class)

Signs a PDF document.

Syntax

public void sign();

Remarks

This method is used to sign the document specified in InputFile, InputData, or SetInputStream. The document will be signed with SigningCert and saved in OutputFile, OutputData, or the stream set in SetOutputStream.

Use the following properties to adjust new signature settings:

• SignatureAuthorName
• SignatureClaimedSigningTime
• SignatureHashAlgorithm
• SignatureProfile
• SignatureReason
• SignatureType
• SignatureWidgetHeight
• SignatureWidgetOffsetX
• SignatureWidgetOffsetY
• SignatureWidgetPages
• SignatureWidgetWidth

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

During signing, the chain validation log will be available via the Log event if applicable.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Signed Method (PDFSign Class)

Checks whether a PDF document is signed.

Syntax

public boolean signed();

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is signed. It will return false if the document contains only empty signature fields.

Example: pdfverify.InputFile = "input.pdf"; if (pdfverify.Signed()) { // Configure validation-related properties as desired pdfverify.Verify(); } Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Update Method (PDFSign Class)

Updates the most recent signature.

Syntax

public void update();

Remarks

This method is used to update the most recent signature by embedding newer or missing revocation information into the signed document specified in InputFile, InputData, or SetInputStream. The updated document will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

Updating a signature starts with its cryptographic validation. Before any new validation material is inserted, the signature's integrity must be validated. If the signature is found to be correct, the class will proceed with chain validation and the retrieval of any missing chain elements. If the signature is cryptographically wrong, the class will throw an exception.

The update approach is typically used to extend the validity of an LTV signature. For LTA signatures, updating is typically accompanied with a document timestamping operation. Set TimestampServer to have the class obtain and embed a document timestamp automatically.

Further validation material and document timestamps may be added to a document over time to maintain its authenticity and integrity.

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

Note: To choose a different signature to update, set the UpdateIndex configuration setting.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

ChainCert Event (PDFSign Class)

Fired when the class encounters a chain certificate.

Syntax

public class DefaultPDFSignEventListener implements PDFSignEventListener {
  ...
  public void chainCert(PDFSignChainCertEvent e) {}
  ...
}

public class PDFSignChainCertEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String validationTime;
  public int validationResult; //read-write
  public int validationDetails; //read-write
}

Remarks

This event is fired once for each certificate encountered during chain validation to report that it is about to be processed. The class will try to retrieve all required chain certificates automatically.

The CertEncoded parameter specifies the PEM (Base64-encoded) public certificate.

The CertSubject and CertIssuer parameters specify the distinguished names of the certificate owner and issuer respectively.

The ValidationTime parameter specifies the time point (in UTC) at which the certificate validity was established.

The ValidationResult parameter reports the outcome of the individual certificate validation and can be one of the following values:

In the case of a failure, the ValidationDetails parameter provides more details on its reasons. Its value is a bitmask of the following flags:

Overridable Chain Validation

While the class will follow the validation rules defined by the X.509 standard to the best of its ability, minor technical issues may arise when validating the chain. The ValidationResult and ValidationDetails parameters can be overridden to relax such requirements on a per-certificate basis.

For example, set ValidationResult to cvrValid and ValidationDetails to 0 in order to:

• Ignore CA or TLS key usage requirements
• Ignore the AuthorityKeyId extension in certificate-issuing CAs (helps with incorrectly renewed certificates)
• Ignore the Basic Constraints or Name Constraints extensions of CA certificates
• Tolerate some weaker algorithms
• Implicitly trust self-signed certificates
• Skip validity period checks for trusted certificates (helps with older devices that have expired root certificates)
• Ignore chain loops (helps with buggy CAs that include subchains that sign themselves)

Based on the adjusted validity of the certificate that is currently being processed, the class will continue or abort the chain validation procedure accordingly as if it had arrived at the chosen validation result itself.

Note: The user code is ultimately responsible for certificate validity decisions made via these two parameters. If their values are modified within this event, the resulting chain validation procedure may deviate from the standard.

DocumentInfo Event (PDFSign Class)

Fired when the document has been loaded into memory.

Syntax

public class DefaultPDFSignEventListener implements PDFSignEventListener {
  ...
  public void documentInfo(PDFSignDocumentInfoEvent e) {}
  ...
}

public class PDFSignDocumentInfoEvent {
  public int pageCount;
  public int signatureCount;
}

Remarks

This event is fired once per document processing routine to report that the document has been processed and loaded into memory.

The handler for this event is a good place to check the document structure and access document-related information such as page number and document file details. These may be useful when preparing the signature. For example, the GetPageProperty method can be used to find the optimal position for the signature widget.

The PageCount parameter reports the number of pages in the document.

The SignatureCount parameter reports the number of signatures in the document.

This event is fired when the Open method is called, but only after Password or RecipientInfo is fired (if applicable) and the document has been decrypted.

This event will populate the Attachments, DocumentCerts, and Signatures collections with any corresponding objects found in the document.

Error Event (PDFSign Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultPDFSignEventListener implements PDFSignEventListener {
  ...
  public void error(PDFSignErrorEvent e) {}
  ...
}

public class PDFSignErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (PDFSign Class)

Fired once for each log message.

Syntax

public class DefaultPDFSignEventListener implements PDFSignEventListener {
  ...
  public void log(PDFSignLogEvent e) {}
  ...
}

public class PDFSignLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel configuration setting.

The LogLevel parameter indicates the detail level of the message. Possible values are:

The Message parameter is the log message.

The LogType parameter identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

Password Event (PDFSign Class)

Fired when the class detects that the PDF document is encrypted with a password.

Syntax

public class DefaultPDFSignEventListener implements PDFSignEventListener {
  ...
  public void password(PDFSignPasswordEvent e) {}
  ...
}

public class PDFSignPasswordEvent {
  public boolean available;
  public boolean cancel; //read-write
}

Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to the Password property.

The Available parameter indicates whether the decryption password is already available to the class or still needs to be set. If this parameter is set to false, the correct password must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the class will stop firing this event to request a password.

RecipientInfo Event (PDFSign Class)

Fired for each recipient certificate of the encrypted PDF document.

Syntax

public class DefaultPDFSignEventListener implements PDFSignEventListener {
  ...
  public void recipientInfo(PDFSignRecipientInfoEvent e) {}
  ...
}

public class PDFSignRecipientInfoEvent {
  public String issuer;
  public String serialNumber;
  public String subjectKeyIdentifier;
  public boolean available;
  public boolean cancel; //read-write
}

Remarks

This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to the DecryptionCert property.

The Issuer parameter specifies the subject of the issuer certificate.

The SerialNumber parameter specifies the serial number of the encryption certificate.

The SubjectKeyIdentifier parameter specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

The Available parameter indicates whether the decryption certificate is already available to the class or still needs to be set. If this parameter is set to false, the correct certificate must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the class will stop firing this event to request a certificate.

Note: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will cause its own invocation of this event.

SignatureInfo Event (PDFSign Class)

Fired when the class finds a signature in the document.

Syntax

public class DefaultPDFSignEventListener implements PDFSignEventListener {
  ...
  public void signatureInfo(PDFSignSignatureInfoEvent e) {}
  ...
}

public class PDFSignSignatureInfoEvent {
  public int signatureIndex;
  public boolean validateSignature; //read-write
  public boolean validateChain; //read-write
}

Remarks

This event is fired once for each signature found in the document to report that the signature specified by SignatureIndex is about to be validated.

The SignatureIndex parameter is the index of the signature in the Signatures collection.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. The ValidateSignature and ValidateChain parameters determine whether each stage should be included in the validation. They can be overridden to modify the validation policy on a per-signature basis, allowing signatures to be verified individually instead of all at once (via Verify). To skip validation entirely, set both parameters to false.

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

SignatureProcessed Event (PDFSign Class)

Fired after a signature has been processed.

Syntax

public class DefaultPDFSignEventListener implements PDFSignEventListener {
  ...
  public void signatureProcessed(PDFSignSignatureProcessedEvent e) {}
  ...
}

public class PDFSignSignatureProcessedEvent {
  public int signatureIndex;
  public int signatureValidationResult;
  public int chainValidationResult;
  public int chainValidationDetails;
}

Remarks

This event is fired once for each signature found in the document to report that the signature specified by SignatureIndex has completed validation. It is fired after SignatureInfo if that event's ValidateSignature parameter is set to true.

The SignatureIndex parameter is the index of the signature in the Signatures collection.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each in the SignatureValidationResult and ChainValidationResult parameters.

The former reports the validity of the signature and can be one of the following values:

The latter reports the validity of the chain and can be one of the following values:

In the case of a failure, the ChainValidationDetails parameter provides more details on its reasons. Its value is a bitmask of the following flags:

Note: SignatureValidationResult, ChainValidationResult, and ChainValidationDetails are also available as fields in the PDFSignature type.

SSLServerAuthentication Event (PDFSign Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultPDFSignEventListener implements PDFSignEventListener {
  ...
  public void SSLServerAuthentication(PDFSignSSLServerAuthenticationEvent e) {}
  ...
}

public class PDFSignSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept; //read-write
}

Remarks

This event is fired during timestamping or chain validation after the server presents its SSL/TLS certificate to the class. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When the Accept parameter is false, the Status parameter shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to true.

SSLStatus Event (PDFSign Class)

Fired when secure connection progress messages are available.

Syntax

public class DefaultPDFSignEventListener implements PDFSignEventListener {
  ...
  public void SSLStatus(PDFSignSSLStatusEvent e) {}
  ...
}

public class PDFSignSSLStatusEvent {
  public String message;
}

Remarks

This event is fired during timestamping or chain validation for informational and logging purposes only. This event tracks the progress of the SSL/TLS connection. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

public Certificate( certificateFile);

public Certificate( encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

Firewall Type

The firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

public Firewall();

PDFAttachment Type

This describes the file being attached to the PDF document.

Remarks

This type contains information about the file that is being attached to the document.

Fields

Constructors

public PDFAttachment();

public PDFAttachment( fileName);

public PDFAttachment( fileName,  description);

public PDFAttachment( data,  name,  description);

public PDFAttachment( inputStream,  name,  description);

PDFSignature Type

A container for PDF signature details.

Remarks

This type contains details about the signature. Use it to read information about the signature when processing it.

Fields

Constructors

public PDFSignature();

Proxy Type

The proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

public Proxy();

public Proxy( server,  port);

public Proxy( server,  port,  user,  password);

Config Settings (PDFSign Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

PDFSign Config Settings

Base Config Settings

Trappable Errors (PDFSign Class)

PDFSign Errors

PDF Errors

Parsing Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors