# PDFVerify Class The PDFVerify class verifies PDF signatures. ## Syntax ```text securepdf.PDFVerify ``` ## Remarks The PDFVerify class verifies electronic signatures over PDF documents. Basic Adobe and PAdES signatures are supported. PDFVerify validates each signature from two perspectives: the integrity and validity of the signature (i.e., its correspondence to the document data it covers), and the validity and trustworthiness of the signing certificate chain. These two signature aspects are generally independent of each other - the signature may be valid but the chain may not be trusted, or the chain may be trusted but the integrity of the signature may be violated. Under normal circumstances, both the signature **and** the chain must be valid for the signature to be considered good. ### Preparing the Validation To initiate the validation, first provide the signed PDF document as a file ([InputFile](#inputfile-property-pdfverify-class)), byte array ([InputData](#inputdata-property-pdfverify-class)), or stream ([SetInputStream](#setinputstream-method-pdfverify-class)). Then adjust any chain validation parameters as necessary (please see the [Chain Validation Setup](#chain-validation-setup) section for more details) and call [Verify](#verify-method-pdfverify-class). For every signature in the document, PDFVerify fires the [SignatureInfo](#signatureinfo-event-pdfverify-class) event, allowing you to specify whether you want the class to validate the signature, the chain, or both. Once [SignatureInfo](#signatureinfo-event-pdfverify-class) returns, PDFVerify proceeds to the signature validation routine in accordance with the provided settings. ### Validation Results Upon completion of the validation, the [SignatureProcessed](#signatureprocessed-event-pdfverify-class) event is fired, and the validation results are published here as well as in the following fields of the associated [PDFSignature](#pdfsignature-type) object: - [ValidationResult](#PDFSignature_f_ValidationResult) contains the outcome of the signature validation: valid, corrupted, the signing certificate was missing, or failed. - [ChainValidationResult](#PDFSignature_f_ChainValidationResult) contains the primary result of the chain validation routine: valid, valid but untrusted, invalid, or undefined. - [ChainValidationDetails](#PDFSignature_f_ChainValidationDetails) provides the details of the factors that contributed to the chain validation result, such as an outdated certificate, a missing CRL, or a missing CA certificate. Other information about the signature can be accessed using the [Signatures](#signatures-property-pdfverify-class) property. ### Checking Signature Coverage The PDF format uses incremental updates to introduce changes to the document. This implies that a signature may not cover the whole document, but rather a certain revision of it. Strictly speaking, every signature in a PDF document, apart from potentially the last one, covers just some part of the document. In most cases, that part matches the revision of the document that existed before all the subsequent signatures were added. Because of these specifics of the PDF format, it is crucially important to understand which part of the document is covered by a specific signature. Use the [CoverageEndsAt](#PDFSignature_f_CoverageEndsAt) field of the associated [PDFSignature](#pdfsignature-type) object to establish the scope of a signature. The revision of the document covered by that specific signature ranges from byte *0* to [CoverageEndsAt](#PDFSignature_f_CoverageEndsAt). Alternatively, you can use the [GetSignedVersion](#getsignedversion-method-pdfverify-class) method to extract the signed revision to a file. ### Chain Validation Setup Chain validation is a sophisticated, multifaceted 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: These parameters apply to [Sign](PDFSign.md#PDFSign_m_Sign) and [Update](PDFSign.md#PDFSign_m_Update) in PDFSign as well as [Verify](#verify-method-pdfverify-class) in PDFVerify, as all three methods execute the chain validation procedure (if it is enabled). **Validation Policy** The [ValidationPolicy](#validationpolicy-property-pdfverify-class) property dictates how thoroughly the chain is validated. It includes options to control which checks the class performs, 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](#revocationcheck-property-pdfverify-class) property, which allows you to choose between and prioritize revocation origins. NOTE: 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](#trustsources-property-pdfverify-class) property, which allows you to specify the locations in which the class searches for trust anchors. Local system stores, your own trusted root certificates (through the [TrustedCerts](#trustedcerts-property-pdfverify-class) property), and Trusted Lists (through the [TrustedLists](#trustedlists-property-pdfverify-class) property) are all supported. **Offline Mode** The [OfflineMode](#offlinemode-property-pdfverify-class) property provides the ability to sign or verify the document without contacting online sources. If this property is enabled, the class only uses [KnownCerts](#knowncerts-property-pdfverify-class), [TrustedCerts](#trustedcerts-property-pdfverify-class), data structures within the document, 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.* | | | | --- | --- | | [Attachments](#attachments-property-pdfverify-class) | A collection of all attached files found in the document. | | [BlockedCerts](#blockedcerts-property-pdfverify-class) | The certificates that must be rejected as trust anchors. | | [DecryptionCert](#decryptioncert-property-pdfverify-class) | The decryption certificate. | | [DocumentCerts](#documentcerts-property-pdfverify-class) | A collection of certificates read from the document during processing. | | [Firewall](#firewall-property-pdfverify-class) | A set of properties related to firewall access. | | [InputData](#inputdata-property-pdfverify-class) | A byte array containing the PDF document to process. | | [InputFile](#inputfile-property-pdfverify-class) | The PDF file to process. | | [KnownCerts](#knowncerts-property-pdfverify-class) | A collection of additional certificates for chain validation. | | [OfflineMode](#offlinemode-property-pdfverify-class) | Whether the class is operating in offline mode. | | [OutputData](#outputdata-property-pdfverify-class) | A byte array containing the PDF document after processing. | | [OutputFile](#outputfile-property-pdfverify-class) | The path to a local file where the output is written. | | [Overwrite](#overwrite-property-pdfverify-class) | Whether the class should overwrite files. | | [Password](#password-property-pdfverify-class) | The password to decrypt the document with. | | [Proxy](#proxy-property-pdfverify-class) | A set of properties related to proxy access. | | [RevocationCheck](#revocationcheck-property-pdfverify-class) | The kind(s) of revocation check to perform for all chain certificates. | | [Signatures](#signatures-property-pdfverify-class) | A collection of all the signatures and empty fields found in the document. | | [TrustedCerts](#trustedcerts-property-pdfverify-class) | A collection of trusted certificates for chain validation. | | [TrustedLists](#trustedlists-property-pdfverify-class) | A list of known Trusted Lists for chain validation. | | [TrustSources](#trustsources-property-pdfverify-class) | The trust sources to use during chain validation. | | [ValidationFlags](#validationflags-property-pdfverify-class) | Additional chain validation settings. | | [ValidationPolicy](#validationpolicy-property-pdfverify-class) | The level at which to perform chain validation. | | [ValidationTime](#validationtime-property-pdfverify-class) | The time point at which the signature should be validated. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Close](#close-method-pdfverify-class) | Closes the opened document. | | [Config](#config-method-pdfverify-class) | Sets or retrieves a configuration setting. | | [Encrypted](#encrypted-method-pdfverify-class) | Checks whether the document is encrypted. | | [GetPageProperty](#getpageproperty-method-pdfverify-class) | Returns the value of a page property. | | [GetSignedVersion](#getsignedversion-method-pdfverify-class) | Returns the part of the signed document that is covered by a signature. | | [Interrupt](#interrupt-method-pdfverify-class) | Interrupts the current action. | | [Open](#open-method-pdfverify-class) | Opens the document for processing. | | [Reset](#reset-method-pdfverify-class) | Resets the class. | | [SaveAttachment](#saveattachment-method-pdfverify-class) | Saves a PDF attachment to a file. | | [SetInputStream](#setinputstream-method-pdfverify-class) | Sets the stream containing the PDF document to process. | | [SetOutputStream](#setoutputstream-method-pdfverify-class) | Sets the stream to write the processed document to. | | [Signed](#signed-method-pdfverify-class) | Checks whether the document is signed. | | [Unsign](#unsign-method-pdfverify-class) | Removes a signature from the document. | | [Verify](#verify-method-pdfverify-class) | Verifies the signed document. | ## 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.* | | | | --- | --- | | [ChainCert](#chaincert-event-pdfverify-class) | Fired when the class encounters a chain certificate. | | [DocumentInfo](#documentinfo-event-pdfverify-class) | Fired when the document has been loaded into memory. | | [Error](#error-event-pdfverify-class) | Fired when information is available about errors during data delivery. | | [Log](#log-event-pdfverify-class) | Fired once for each log message. | | [Password](#password-event-pdfverify-class) | Fired when the class detects that the document is encrypted with a password. | | [RecipientInfo](#recipientinfo-event-pdfverify-class) | Fired for each recipient certificate of the encrypted document. | | [SignatureInfo](#signatureinfo-event-pdfverify-class) | Fired when the class finds a signature in the document. | | [SignatureProcessed](#signatureprocessed-event-pdfverify-class) | Fired after a signature has been processed. | | [SSLServerAuthentication](#sslserverauthentication-event-pdfverify-class) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-pdfverify-class) | Fired when secure connection progress messages are available. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CacheRevocationInfo](#CacheRevocationInfo) | Whether to cache revocation information. | | [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) | Whether to close the input stream after processing. | | [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) | Whether to close the output stream after processing. | | [ContactInfo\[Index\]](#ContactInfo[Index]) | The signer's contact information. | | [EnforcePDFA](#EnforcePDFA) | Whether to enforce PDF/A compliance. | | [FilterName\[Index\]](#FilterName[Index]) | The signature filter name. | | [FullSignatureName\[Index\]](#FullSignatureName[Index]) | The full name of the signature field. | | [HTTPRetryCount](#HTTPRetryCount) | The number of HTTP request retries. | | [HTTPRetryInterval](#HTTPRetryInterval) | A time interval to apply between HTTP request retries. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [OwnerPassword](#OwnerPassword) | The owner password to decrypt the document with. | | [PDFALevel](#PDFALevel) | The PDF/A conformance level to enforce. | | [PDFAPolicy](#PDFAPolicy) | The PDF/A policy to follow. | | [Permissions](#Permissions) | The document permissions associated with the encryption. | | [PreferEmbeddedRevocationInfo](#PreferEmbeddedRevocationInfo) | Whether to prioritize revocation information that is embedded into the document. | | [RevisionOffsets](#RevisionOffsets) | The offsets of the document revisions. | | [SaveChanges](#SaveChanges) | Whether to save changes made to the document. | | [SignatureAllowedChanges\[Index\]](#SignatureAllowedChanges[Index]) | The changes allowed by the signature. | | [SignatureData\[Index\]](#SignatureData[Index]) | The hex-encoded representation of the underlying PKCS#7/CMS signature container. | | [SignatureInvertedLock\[Index\]](#SignatureInvertedLock[Index]) | Whether the locked field list should be treated as containing unlocked fields instead. | | [SignatureLockedFields\[Index\]](#SignatureLockedFields[Index]) | The list of form fields that are locked by the signature. | | [TempPath](#TempPath) | The location where temporary files are stored. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | | [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. | # Attachments Property ([PDFVerify](#pdfverify-class) Class) A collection of all attached files found in the document. ## Syntax ```text public PDFAttachmentList getAttachments(); ``` ## Remarks This property is used to access the details of all the attached files identified in the document. Use [SaveAttachment](#saveattachment-method-pdfverify-class) to save attachments from this collection. This property is not available at design time. Please refer to the [PDFAttachment](#pdfattachment-type) type for a complete list of fields. # BlockedCerts Property ([PDFVerify](#pdfverify-class) Class) The certificates that must be rejected as trust anchors. ## Syntax ```text public CertificateList getBlockedCerts(); ``` ## 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](#certificate-type) type for a complete list of fields. # DecryptionCert Property ([PDFVerify](#pdfverify-class) Class) The decryption certificate. ## Syntax ```text 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](#certificate-type) type for a complete list of fields. # DocumentCerts Property ([PDFVerify](#pdfverify-class) Class) A collection of certificates read from the document during processing. ## Syntax ```text 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 is populated automatically during chain validation. This property is read-only and not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # Firewall Property ([PDFVerify](#pdfverify-class) Class) A set of properties related to firewall access. ## Syntax ```text public Firewall getFirewall(); public void setFirewall(Firewall firewall); ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # InputData Property ([PDFVerify](#pdfverify-class) Class) A byte array containing the PDF document to process. ## Syntax ```text 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 ([PDFVerify](#pdfverify-class) Class) The PDF file to process. ## Syntax ```text 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 ([PDFVerify](#pdfverify-class) Class) A collection of additional certificates for chain validation. ## Syntax ```text public CertificateList getKnownCerts(); ``` ## 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](#trustedcerts-property-pdfverify-class) instead. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # OfflineMode Property ([PDFVerify](#pdfverify-class) Class) Whether the class is operating in offline mode. ## Syntax ```text 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](#knowncerts-property-pdfverify-class). # OutputData Property ([PDFVerify](#pdfverify-class) Class) A byte array containing the PDF document after processing. ## Syntax ```text public byte[] getOutputData(); ``` ## Remarks This property is used to read the byte array containing the produced output after the operation has completed. It is only set if an output file and output stream have not been assigned via [OutputFile](#outputfile-property-pdfverify-class) and [SetOutputStream](#setoutputstream-method-pdfverify-class) respectively. This property is read-only and not available at design time. # OutputFile Property ([PDFVerify](#pdfverify-class) Class) The path to a local file where the output is written. ## Syntax ```text public String getOutputFile(); public void setOutputFile(String outputFile); ``` ## Default Value "" ## Remarks This property is used to provide a path where the resulting PDF document is saved after the operation has completed. # Overwrite Property ([PDFVerify](#pdfverify-class) Class) Whether the class should overwrite files. ## Syntax ```text public boolean isOverwrite(); public void setOverwrite(boolean overwrite); ``` ## Default Value False ## Remarks This property indicates whether the class overwrites [OutputFile](#outputfile-property-pdfverify-class). If set to *false*, an error is thrown whenever [OutputFile](#outputfile-property-pdfverify-class) exists before an operation. # Password Property ([PDFVerify](#pdfverify-class) Class) The password to decrypt the document with. ## Syntax ```text 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](#OwnerPassword), most implementations use the same value for both. # Proxy Property ([PDFVerify](#pdfverify-class) Class) A set of properties related to proxy access. ## Syntax ```text 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](#proxy-type) type for a complete list of fields. # RevocationCheck Property ([PDFVerify](#pdfverify-class) Class) The kind(s) of revocation check to perform for all chain certificates. ## Syntax ```text 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 uses 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: | | | | --- | --- | | 0 (rcAllCRL) | All provided CRL endpoints are checked, and all checks must succeed. | | 1 (rcAllOCSP) | All provided OCSP endpoints are checked, and all checks must succeed. | | 2 (rcAllCRLAndOCSP) | All provided CRL and OCSP endpoints are checked, and all checks must succeed. | | 3 (rcAnyCRL) | All provided CRL endpoints are checked, and at least one check must succeed. | | 4 (rcAnyOCSP) | All provided OCSP endpoints are checked, and at least one check must succeed. | | 5 (rcAnyCRLOrOCSP) | All provided CRL and OCSP endpoints are checked, and at least one check must succeed. CRL endpoints are checked first. | | 6 (rcAnyOCSPOrCRL - default) | All provided CRL and OCSP endpoints are checked, and at least one check must succeed. OCSP endpoints are checked first. | 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 is 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. # Signatures Property ([PDFVerify](#pdfverify-class) Class) A collection of all the signatures and empty fields found in the document. ## Syntax ```text 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](#pdfsignature-type) type for a complete list of fields. # TrustedCerts Property ([PDFVerify](#pdfverify-class) Class) A collection of trusted certificates for chain validation. ## Syntax ```text public CertificateList getTrustedCerts(); ``` ## 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 forged 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](#certificate-type) type for a complete list of fields. # TrustedLists Property ([PDFVerify](#pdfverify-class) Class) A list of known Trusted Lists for chain validation. ## Syntax ```text 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 consults 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](https://ec.europa.eu/tools/lotl/eu-lotl.xml). Custom values can be appended: ```csharp component.TrustedLists = "%EUTL%;http://my.company/tsl;c:\tsls\mytsl.xml"; ``` NOTE: The class caches 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 retrieves the cached data and reuses it in the current validation. If the data is invalid, the class downloads a fresh Trusted List and adds it to the cache. # TrustSources Property ([PDFVerify](#pdfverify-class) Class) The trust sources to use during chain validation. ## Syntax ```text 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 uses 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: | | | | --- | --- | | 0 (tsManual) | The class consults [TrustedCerts](#trustedcerts-property-pdfverify-class) only. | | 1 (tsLocal) | The class consults local system stores (e.g., Windows Trusted Root Certification Authorities) as well as [TrustedCerts](#trustedcerts-property-pdfverify-class). | | 2 (tsTrustedLists) | The class consults [TrustedLists](#trustedlists-property-pdfverify-class) only. | | 3 (tsLocalAndTrustedLists - default) | The class consults local system stores, [TrustedCerts](#trustedcerts-property-pdfverify-class), and [TrustedLists](#trustedlists-property-pdfverify-class). | # ValidationFlags Property ([PDFVerify](#pdfverify-class) Class) Additional chain validation settings. ## Syntax ```text 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: | | | | --- | --- | | 0x001 (cvfForceCompleteChainValidationForTrusted) | Perform full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce the completeness of the collected revocation information. It often makes sense to omit this flag when validating signatures to reduce validation time and avoid issues with poorly configured environments. | | 0x002 (cvfIgnoreChainLoops) | Currently unsupported. | | 0x004 (cvfIgnoreOCSPNoCheckExtension) | Currently unsupported. | | 0x008 (cvfTolerateMinorChainIssues) | Currently unsupported. | # ValidationPolicy Property ([PDFVerify](#pdfverify-class) Class) The level at which to perform chain validation. ## Syntax ```text 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 follows. Possible values are: | | | | --- | --- | | 0 (vpNone) | No chain validation is attempted at all. | | 1 (vpFull - default) | Revocation and trust checks must succeed for all chains. | | 2 (vpFullNoTrust) | Revocation checks must succeed, but trust checks will not occur. | | 3 (vpFullNoRevocation) | Trust checks must succeed, but revocation checks will not occur. | | 4 (vpBestEffort) | Currently unsupported. | ### Validation Policy Heuristics The choice of validation policy depends 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 ([PDFVerify](#pdfverify-class) Class) The time point at which the signature should be validated. ## Syntax ```text 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 then prioritizes: - The signature creation time if the signature contains a signature timestamp ([ValidatedSigningTime](#PDFSignature_f_ValidatedSigningTime)), or - The local time included in the signature by the signer ([ClaimedSigningTime](#PDFSignature_f_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. # Close Method ([PDFVerify](#pdfverify-class) Class) Closes the opened document. ## Syntax ```text public void close(); ``` ## Remarks This method is used to close the previously opened document. It should always be preceded by a call to [Open](#open-method-pdfverify-class). **Example:** ```csharp component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close(); ``` If any changes are made to the document, they are saved automatically to [OutputFile](#outputfile-property-pdfverify-class), [OutputData](#outputdata-property-pdfverify-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfverify-class) when this method is called. To configure this saving behavior, set [SaveChanges](#SaveChanges). # Config Method ([PDFVerify](#pdfverify-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text public String config(String configurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-pdfverify-class) 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](#config-settings-pdfverify-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # Encrypted Method ([PDFVerify](#pdfverify-class) Class) Checks whether the document is encrypted. ## Syntax ```text public boolean encrypted(); ``` ## Remarks This method is used to determine whether the document is encrypted. It returns *false* if the document is pseudo-encrypted with an empty password. **Example:** ```csharp 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 opens it, performs the operation, then closes it. # GetPageProperty Method ([PDFVerify](#pdfverify-class) Class) Returns the value of a page property. ## Syntax ```text public String getPageProperty(int pageIndex, String pageProperty); ``` ## Remarks This method is used to obtain general information about the pages of the document, such as their dimensions and content positioning details. *PageIndex* specifies the page to read information about (with a valid range from *0* to *PageCount - 1*), and *PageProperty* specifies the page property to read. Possible values are: | Page property | Default value | Description | | --- | --- | --- | | CropLowerLeftX | 0 | The lower-left X coordinate of the page crop area in points. | | CropLowerLeftY | 0 | The lower-left Y coordinate of the page crop area in points. | | CropUpperRightX | 0 | The upper-right X coordinate of the page crop area in points. | | CropUpperRightY | 0 | The upper-right Y coordinate of the page crop area in points. | | Height | 0 | The height of the page in points. | | MediaLowerLeftX | 0 | The lower-left X coordinate of the page media area in points. | | MediaLowerLeftY | 0 | The lower-left Y coordinate of the page media area in points. | | MediaUpperRightX | 0 | The upper-right X coordinate of the page media area in points. | | MediaUpperRightY | 0 | The upper-right Y coordinate of the page media area in points. | | Rotation | 0 | The rotation angle of the page in degrees clockwise. Supported values: 0, 90, 180, 270. | | Width | 0 | The width of the page in points. | **Example:** ```csharp int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 0; 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: ```csharp int x = int.Parse(pdfsign.GetPageProperty(0, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(0, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); ``` NOTE: Each page property is only populated once the document has been loaded, which is reported by the [DocumentInfo](#documentinfo-event-pdfverify-class) event. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # GetSignedVersion Method ([PDFVerify](#pdfverify-class) Class) Returns the part of the signed document that is covered by a signature. ## Syntax ```text public void getSignedVersion(int signatureIndex); ``` ## Remarks This method is used to obtain the revision of the document that is covered by a signature. *SignatureIndex* is the index of the signature of interest in the [Signatures](#signatures-property-pdfverify-class) collection. **Example:** ```csharp pdfverify.InputFile = "signed.pdf"; pdfverify.OutputFile = "revision0.pdf"; pdfverify.GetSignedVersion(0); ``` PDF documents often use an incremental update approach, with any changes being appended to the document without altering the existing revision. This may lead to situations where a signature only covers part of the document (one of the past revisions), but not subsequent changes. This method provides a means to extract the revision that is actually certified by the signature. It is recommended to use this method when validating signatures to make sure the signature covers the byte range it is expected to cover. An alternative to this method is to check the [CoverageEndsAt](#PDFSignature_f_CoverageEndsAt) field of the signature object and match it to the document length. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # Interrupt Method ([PDFVerify](#pdfverify-class) Class) Interrupts the current action. ## Syntax ```text public void interrupt(); ``` ## Remarks This method interrupts the current action. It can be used, for example, within the [ChainCert](#chaincert-event-pdfverify-class) event to abort the chain validation procedure. If there is no action in progress, this method simply returns, doing nothing. # Open Method ([PDFVerify](#pdfverify-class) Class) Opens the document for processing. ## Syntax ```text public void open(); ``` ## Remarks This method is used to open the document specified in [InputFile](#inputfile-property-pdfverify-class), [InputData](#inputdata-property-pdfverify-class), or [SetInputStream](#setinputstream-method-pdfverify-class) before performing some operation on it, such as verifying or removing signatures. When finished, call [Close](#close-method-pdfverify-class) to complete or discard the operation. It is recommended to use this method (alongside [Close](#close-method-pdfverify-class)) when performing multiple operations on the document at once. NOTE: This method populates the [Attachments](#attachments-property-pdfverify-class), [DocumentCerts](#documentcerts-property-pdfverify-class), and [Signatures](#signatures-property-pdfverify-class) collections with any corresponding objects found in the document. ### Automatic Decryption Functionality If this method is called on an encrypted document, the [Password](#password-event-pdfverify-class) or [RecipientInfo](#recipientinfo-event-pdfverify-class) event fires (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 then attempts 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 [Decrypt](PDFDecrypt.md#PDFDecrypt_m_Decrypt) to save a decrypted copy of the document instead. # Reset Method ([PDFVerify](#pdfverify-class) Class) Resets the class. ## Syntax ```text public void reset(); ``` ## Remarks This method is used to reset the class's properties and configuration settings to their default values. # SaveAttachment Method ([PDFVerify](#pdfverify-class) Class) Saves a PDF attachment to a file. ## Syntax ```text public void saveAttachment(int index, String fileName); ``` ## Remarks This method is used to retrieve the contents of an attachment from the document and save it to a file. It does not modify the contents of the [Attachments](#attachments-property-pdfverify-class) collection. *Index* is the index of the attachment in the [Attachments](#attachments-property-pdfverify-class) collection to be saved. *FileName* specifies the filename that the attachment will be saved to. **Example:** ```csharp component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); ``` **Example (saving to a stream):** ```csharp component.InputFile = "input_with_attachment.pdf"; component.Attachments[0].OutputStream = myStream; component.SaveAttachment(0, null); // null means use the OutputStream field if it's set ``` NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # SetInputStream Method ([PDFVerify](#pdfverify-class) Class) Sets the stream containing the PDF document to process. ## Syntax ```text public void setInputStream(java.io.InputStream inputStream); ``` ## Remarks This method is used to set the stream from which the class reads the PDF document to be processed. If an input stream is set before the class attempts to perform operations on the document, the class reads the data from the input stream instead of from the [InputFile](#inputfile-property-pdfverify-class) or [InputData](#inputdata-property-pdfverify-class) properties. NOTE: It may be useful to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) to *true* when using input streams. # SetOutputStream Method ([PDFVerify](#pdfverify-class) Class) Sets the stream to write the processed document to. ## Syntax ```text public void setOutputStream(java.io.OutputStream outputStream); ``` ## Remarks This method is used to set the stream to which the class writes the resulting PDF document. If an output stream is set before the class attempts to perform operations on the document, the class writes the data to the output stream instead of writing to [OutputFile](#outputfile-property-pdfverify-class) or populating [OutputData](#outputdata-property-pdfverify-class). NOTE: It may be useful to additionally set [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) to *true* when using output streams. # Signed Method ([PDFVerify](#pdfverify-class) Class) Checks whether the document is signed. ## Syntax ```text public boolean signed(); ``` ## Remarks This method is used to determine whether the document is signed. It returns *false* if the document contains only empty signature fields. **Example:** ```csharp 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 opens it, performs the operation, then closes it. # Unsign Method ([PDFVerify](#pdfverify-class) Class) Removes a signature from the document. ## Syntax ```text public void unsign(int signatureIndex, int unsignKind); ``` ## Remarks This method is used to remove an existing signature from the document. *SignatureIndex* is the index of the signature in the [Signatures](#signatures-property-pdfverify-class) collection to be removed. *UnsignKind* specifies the kind of unsign to perform. Possible values are: | | | | --- | --- | | 0 (uskFull) | Remove the signature fully. | | 1 (uskKeepField) | Remove the signature, but keep the form field it is in. | | 2 (uskKeepAppearance) | Remove the signature, but keep the form field and its widget. | **Example:** ```csharp pdfverify.InputFile = "signed.pdf"; pdfverify.OutputFile = "unsigned.pdf"; pdfverify.Open(); int idx = pdfverify.Signatures.Count - 1; pdfverify.Unsign(idx, 0); // uskFull pdfverify.Close(); ``` Note that unsigning is different from [GetSignedVersion](#getsignedversion-method-pdfverify-class). The latter returns the revision of the document **including** the mentioned signature (thus removing anything after that signature was created). Unsign removes the signature completely by carving it out of the document. NOTE: *SignatureIndex* set to *-1* removes all signatures in the document. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # Verify Method ([PDFVerify](#pdfverify-class) Class) Verifies the signed document. ## Syntax ```text public void verify(); ``` ## Remarks This method is used to validate all signatures in the document. This method walks through the signed document and reports every signature via the [SignatureInfo](#signatureinfo-event-pdfverify-class) event. Subscribe to the event to be notified about the signatures and adjust validation settings on the fly. Upon completion of this method, the signature details will be published in the [Signatures](#signatures-property-pdfverify-class) property. **Example:** ```csharp pdfverify.InputFile = "signed.pdf"; pdfverify.Verify(); PDFSignature signature = pdfverify.Signatures[0]; if (signature.ValidationResult == SignatureValidationResults.svrValid) Console.WriteLine("Signature is good"); if (signature.ChainValidationResult == ChainValidationResults.cvrValid) Console.WriteLine("Chain is good"); ``` This method only validates the signatures and does not check their coverage. It is a good idea to use mechanisms such as [GetSignedVersion](#getsignedversion-method-pdfverify-class) or [CoverageEndsAt](#PDFSignature_f_CoverageEndsAt) to ensure that the signature covers the expected document revision. To control individual signature validation, subscribe to the [SignatureInfo](#signatureinfo-event-pdfverify-class) event and set the *ValidateSignature* and *ValidateChain* parameters accordingly. The results are reported via the [SignatureProcessed](#signatureprocessed-event-pdfverify-class) event. Use the following properties to adjust chain validation parameters: - [BlockedCerts](#blockedcerts-property-pdfverify-class) - [KnownCerts](#knowncerts-property-pdfverify-class) - [OfflineMode](#offlinemode-property-pdfverify-class) - [RevocationCheck](#revocationcheck-property-pdfverify-class) - [TrustedCerts](#trustedcerts-property-pdfverify-class) - [TrustedLists](#trustedlists-property-pdfverify-class) - [TrustSources](#trustsources-property-pdfverify-class) - [ValidationFlags](#validationflags-property-pdfverify-class) - [ValidationPolicy](#validationpolicy-property-pdfverify-class) - [ValidationTime](#validationtime-property-pdfverify-class) NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # ChainCert Event ([PDFVerify](#pdfverify-class) Class) Fired when the class encounters a chain certificate. ## Syntax ```text public class DefaultPDFVerifyEventListener implements PDFVerifyEventListener { ... public void chainCert(PDFVerifyChainCertEvent e) {} ... } public class PDFVerifyChainCertEvent { 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 tries to retrieve all required chain certificates automatically. *CertEncoded* specifies the PEM (Base64-encoded) public certificate. *CertSubject* and *CertIssuer* specify the distinguished names of the certificate owner and issuer respectively. *ValidationTime* specifies the time point (in UTC) at which the certificate validity was established. *ValidationResult* reports the outcome of the individual certificate validation and can be one of the following values: | | | | --- | --- | | 0 (cvrUnknown - default) | Certificate validity is unknown. | | 1 (cvrValid) | The certificate is valid. | | 2 (cvrValidButUntrusted) | The certificate is valid but not trusted. | | 3 (cvrInvalid) | The certificate is not valid (it is revoked, expired, or contains an invalid signature). | | 4 (cvrCantBeEstablished) | The validity of the certificate cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses). | In the case of a failure, *ValidationDetails* provides more details on its reasons. Its value is a bitmask of the following flags: | | | | --- | --- | | 0x001 (cvdRevoked) | The certificate is revoked. | | 0x002 (cvdExpiredOrNotYetValid) | The certificate is expired or not yet valid. | | 0x004 (cvdUnknownCA) | A CA certificate for the certificate has not been found, is not trusted, or has a wrong public key (chain incomplete). | | 0x008 (cvdPolicyViolated) | One of the CA certificates is not authorized to act as a CA, a mandatory key usage is not enabled, or a weak algorithm is used in the certificate. | | 0x010 (cvdRevocationCheckFailed) | One or more CRLs or OCSP responses could not be verified. | | 0x020 (cvdBlocked) | The certificate is blocked. | | 0x040 (cvdFailure) | General validation failure. | ### Overridable Chain Validation While the class follows 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 continues or aborts 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 ([PDFVerify](#pdfverify-class) Class) Fired when the document has been loaded into memory. ## Syntax ```text public class DefaultPDFVerifyEventListener implements PDFVerifyEventListener { ... public void documentInfo(PDFVerifyDocumentInfoEvent e) {} ... } public class PDFVerifyDocumentInfoEvent { 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, [GetPageProperty](#getpageproperty-method-pdfverify-class) can be used to find the optimal position for the signature widget. *PageCount* reports the number of pages in the document. *SignatureCount* reports the number of signatures in the document. This event is fired when [Open](#open-method-pdfverify-class) is called, but only after [Password](#password-event-pdfverify-class) or [RecipientInfo](#recipientinfo-event-pdfverify-class) is fired (if applicable) and the document has been decrypted. # Error Event ([PDFVerify](#pdfverify-class) Class) Fired when information is available about errors during data delivery. ## Syntax ```text public class DefaultPDFVerifyEventListener implements PDFVerifyEventListener { ... public void error(PDFVerifyErrorEvent e) {} ... } public class PDFVerifyErrorEvent { 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](#trappable-errors-pdfverify-class) section. # Log Event ([PDFVerify](#pdfverify-class) Class) Fired once for each log message. ## Syntax ```text public class DefaultPDFVerifyEventListener implements PDFVerifyEventListener { ... public void log(PDFVerifyLogEvent e) {} ... } public class PDFVerifyLogEvent { 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](#LogLevel) configuration setting. *LogLevel* indicates the detail level of the message. Possible values are: | | | | --- | --- | | 0 (None) | No messages are logged. | | 1 (Info - default) | Informational events such as the basics of the chain validation procedure are logged. | | 2 (Verbose) | Detailed data such as HTTP requests are logged. | | 3 (Debug) | Debug data including the full chain validation procedure are logged. | *Message* is the log message. *LogType* identifies the type of log entry. Possible values are: - CertValidator - Font - HTTP - PDFInvalidSignature - PDFRevocationInfo - Timestamp - TSL # Password Event ([PDFVerify](#pdfverify-class) Class) Fired when the class detects that the document is encrypted with a password. ## Syntax ```text public class DefaultPDFVerifyEventListener implements PDFVerifyEventListener { ... public void password(PDFVerifyPasswordEvent e) {} ... } public class PDFVerifyPasswordEvent { 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 [Password](#password-property-pdfverify-class). *Available* indicates whether the decryption password is already available to the class or still needs to be set. If this parameter is *false*, the correct password must be provided for the decryption attempt to succeed. *Cancel* determines whether the class will stop firing this event to request a password. # RecipientInfo Event ([PDFVerify](#pdfverify-class) Class) Fired for each recipient certificate of the encrypted document. ## Syntax ```text public class DefaultPDFVerifyEventListener implements PDFVerifyEventListener { ... public void recipientInfo(PDFVerifyRecipientInfoEvent e) {} ... } public class PDFVerifyRecipientInfoEvent { 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 [DecryptionCert](#decryptioncert-property-pdfverify-class). *Issuer* specifies the subject of the issuer certificate. *SerialNumber* specifies the serial number of the encryption certificate. *SubjectKeyIdentifier* specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string. *Available* indicates whether the decryption certificate is already available to the class or still needs to be set. If this parameter is *false*, the correct certificate must be provided for the decryption attempt to succeed. *Cancel* 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 causes its own invocation of this event. # SignatureInfo Event ([PDFVerify](#pdfverify-class) Class) Fired when the class finds a signature in the document. ## Syntax ```text public class DefaultPDFVerifyEventListener implements PDFVerifyEventListener { ... public void signatureInfo(PDFVerifySignatureInfoEvent e) {} ... } public class PDFVerifySignatureInfoEvent { 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 it is about to be validated. *SignatureIndex* is the index of the signature in the [Signatures](#signatures-property-pdfverify-class) collection. Signature validation consists of two independent stages: cryptographic signature validation and chain validation. *ValidateSignature* and *ValidateChain* 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](#verify-method-pdfverify-class)). To skip validation entirely, set both parameters to *false*. Use the following properties to adjust chain validation parameters: - [BlockedCerts](#blockedcerts-property-pdfverify-class) - [KnownCerts](#knowncerts-property-pdfverify-class) - [OfflineMode](#offlinemode-property-pdfverify-class) - [RevocationCheck](#revocationcheck-property-pdfverify-class) - [TrustedCerts](#trustedcerts-property-pdfverify-class) - [TrustedLists](#trustedlists-property-pdfverify-class) - [TrustSources](#trustsources-property-pdfverify-class) - [ValidationFlags](#validationflags-property-pdfverify-class) - [ValidationPolicy](#validationpolicy-property-pdfverify-class) - [ValidationTime](#validationtime-property-pdfverify-class) # SignatureProcessed Event ([PDFVerify](#pdfverify-class) Class) Fired after a signature has been processed. ## Syntax ```text public class DefaultPDFVerifyEventListener implements PDFVerifyEventListener { ... public void signatureProcessed(PDFVerifySignatureProcessedEvent e) {} ... } public class PDFVerifySignatureProcessedEvent { 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 it has completed validation. It is fired after [SignatureInfo](#signatureinfo-event-pdfverify-class) if that event's *ValidateSignature* parameter is set to *true*. *SignatureIndex* is the index of the signature in the [Signatures](#signatures-property-pdfverify-class) collection. Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each in *SignatureValidationResult* and *ChainValidationResult*. The former reports the validity of the signature and can be one of the following values: | | | | --- | --- | | 0 (svrUnknown - default) | Signature validity is unknown. | | 1 (svrValid) | The signature is valid. | | 2 (svrCorrupted) | The signature is corrupted. | | 3 (svrSignerNotFound) | Failed to acquire the signing certificate. The signature cannot be validated. | | 4 (svrFailure) | General failure. | The latter reports the validity of the chain and can be one of the following values: | | | | --- | --- | | 0 (cvrUnknown - default) | Chain validity is unknown. | | 1 (cvrValid) | The chain is valid. | | 2 (cvrValidButUntrusted) | The chain is valid, but the root certificate is not trusted. | | 3 (cvrInvalid) | The chain is not valid (some of the certificates are revoked, expired, or contain an invalid signature). | | 4 (cvrCantBeEstablished) | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses). | In the case of a failure, *ChainValidationDetails* provides more details on its reasons. Its value is a bitmask of the following flags: | | | | --- | --- | | 0x001 (cvdRevoked) | One or more certificates are revoked. | | 0x002 (cvdExpiredOrNotYetValid) | One or more certificates are expired or not yet valid. | | 0x004 (cvdUnknownCA) | A CA certificate for one or more certificates has not been found, is not trusted, or has a wrong public key (chain incomplete). | | 0x008 (cvdPolicyViolated) | One of the CA certificates is not authorized to act as a CA, a mandatory key usage is not enabled in one of the chain certificates, or a weak algorithm is used in one of the certificates or revocation elements. | | 0x010 (cvdRevocationCheckFailed) | One or more CRLs or OCSP responses could not be verified. | | 0x020 (cvdBlocked) | One or more certificates are blocked. | | 0x040 (cvdFailure) | General validation failure. | NOTE: *SignatureValidationResult*, *ChainValidationResult*, and *ChainValidationDetails* are also available as fields in the [PDFSignature](#pdfsignature-type) type. # SSLServerAuthentication Event ([PDFVerify](#pdfverify-class) Class) Fired after the server presents its certificate to the client. ## Syntax ```text public class DefaultPDFVerifyEventListener implements PDFVerifyEventListener { ... public void SSLServerAuthentication(PDFVerifySSLServerAuthenticationEvent e) {} ... } public class PDFVerifySSLServerAuthenticationEvent { 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 to continue with the connection process. *Accept* 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 to continue. When *Accept* is *false*, *Status* 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 *Accept* to *true*. # SSLStatus Event ([PDFVerify](#pdfverify-class) Class) Fired when secure connection progress messages are available. ## Syntax ```text public class DefaultPDFVerifyEventListener implements PDFVerifyEventListener { ... public void SSLStatus(PDFVerifySSLStatusEvent e) {} ... } public class PDFVerifySSLStatusEvent { 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. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **ExpirationDate** *String (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *String (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *String (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *String (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *String* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys. NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling [PrivateKey](#Certificate_f_PrivateKey). **PrivateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *int (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *String (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *byte[]* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *int* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This field can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *String (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *String (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *String (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *int (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *byte[]* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # 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](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType). The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. Connection information will first be obtained from Java system properties, such as *http.proxyHost* and *https.proxyHost*. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified. If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems). **FirewallType** *int* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. | **Host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting. If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception. **Password** *String* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception. **Port** *int* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details. NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details. **User** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class throws an exception. ## Constructors ```text public Firewall(); ``` # PDFAttachment Type The file being attached to the PDF document. ## Remarks This type contains information about the file that is being attached to the document. The following fields are available: - [ContentType](#PDFAttachment_f_ContentType) - [CreationDate](#PDFAttachment_f_CreationDate) - [Data](#PDFAttachment_f_Data) - [Description](#PDFAttachment_f_Description) - [FileName](#PDFAttachment_f_FileName) - [InputStream](#PDFAttachment_f_InputStream) - [ModificationDate](#PDFAttachment_f_ModificationDate) - [Name](#PDFAttachment_f_Name) - [OutputStream](#PDFAttachment_f_OutputStream) - [Size](#PDFAttachment_f_Size) ## Fields **ContentType** *String* *Default Value: ""* The content type of the attachment. **CreationDate** *String* *Default Value: ""* The creation date of the attachment. **Data** *String* *Default Value: ""* The raw data of the attachment. If [OutputStream](#PDFAttachment_f_OutputStream) is not set to a valid stream, the class writes to this field when an empty string is passed to SaveAttachment. **DataB** *byte[]* *Default Value: ""* The raw data of the attachment. If [OutputStream](#PDFAttachment_f_OutputStream) is not set to a valid stream, the class writes to this field when an empty string is passed to SaveAttachment. **Description** *String* *Default Value: ""* A textual description of the attachment. **FileName** *String* *Default Value: ""* The path and filename of the attachment. **InputStream** *java.io.InputStream* *Default Value: ""* A stream containing the attachment. If this field is set to a valid stream, the class attaches the data from the stream as the current attachment. **ModificationDate** *String* *Default Value: ""* The date and time of the file's last modification. **Name** *String* *Default Value: ""* The name of the attachment. **OutputStream** *java.io.OutputStream* *Default Value: ""* The stream to write the attachment to. If this field is set to a valid stream, the class writes to the stream when an empty string is passed to SaveAttachment. **Size** *long (read-only)* *Default Value: 0* The attachment's size in bytes. ## Constructors ```text public PDFAttachment(); ``` ```text public PDFAttachment(String fileName); ``` ```text public PDFAttachment(String fileName, String description); ``` ```text public PDFAttachment(byte[] data, String name, String description); ``` ```text public PDFAttachment(java.io.InputStream inputStream, String name, String 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. The following fields are available: - [AuthorName](#PDFSignature_f_AuthorName) - [ChainValidationDetails](#PDFSignature_f_ChainValidationDetails) - [ChainValidationResult](#PDFSignature_f_ChainValidationResult) - [ClaimedSigningTime](#PDFSignature_f_ClaimedSigningTime) - [CoverageEndsAt](#PDFSignature_f_CoverageEndsAt) - [HashAlgorithm](#PDFSignature_f_HashAlgorithm) - [Profile](#PDFSignature_f_Profile) - [Reason](#PDFSignature_f_Reason) - [SignatureType](#PDFSignature_f_SignatureType) - [SignerCertIndex](#PDFSignature_f_SignerCertIndex) - [TimestampCertIndex](#PDFSignature_f_TimestampCertIndex) - [Timestamped](#PDFSignature_f_Timestamped) - [ValidatedSigningTime](#PDFSignature_f_ValidatedSigningTime) - [ValidationResult](#PDFSignature_f_ValidationResult) - [WidgetHeight](#PDFSignature_f_WidgetHeight) - [WidgetOffsetX](#PDFSignature_f_WidgetOffsetX) - [WidgetOffsetY](#PDFSignature_f_WidgetOffsetY) - [WidgetPages](#PDFSignature_f_WidgetPages) - [WidgetWidth](#PDFSignature_f_WidgetWidth) ## Fields **AuthorName** *String (read-only)* *Default Value: ""* The human-readable name of the signer. **ChainValidationDetails** *int (read-only)* *Default Value: 0* The details of the certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result in [ChainValidationResult](#PDFSignature_f_ChainValidationResult). The value of this field is a bitmask of the following flags: | | | | --- | --- | | 0x001 (cvdRevoked) | One or more certificates are revoked. | | 0x002 (cvdExpiredOrNotYetValid) | One or more certificates are expired or not yet valid. | | 0x004 (cvdUnknownCA) | A CA certificate for one or more certificates has not been found, is not trusted, or has a wrong public key (chain incomplete). | | 0x008 (cvdPolicyViolated) | One of the CA certificates is not authorized to act as a CA, a mandatory key usage is not enabled in one of the chain certificates, or a weak algorithm is used in one of the certificates or revocation elements. | | 0x010 (cvdRevocationCheckFailed) | One or more CRLs or OCSP responses could not be verified. | | 0x020 (cvdBlocked) | One or more certificates are blocked. | | 0x040 (cvdFailure) | General validation failure. | Subscribe to the [Log](PDFSign.md#PDFSign_e_Log) event to access the detailed validation log. This field is also available as a parameter of the [SignatureProcessed](PDFSign.md#PDFSign_e_SignatureProcessed) event. **ChainValidationResult** *int (read-only)* *Default Value: 0* The outcome of the certificate chain validation routine. Possible values are: | | | | --- | --- | | 0 (cvrUnknown - default) | Chain validity is unknown. | | 1 (cvrValid) | The chain is valid. | | 2 (cvrValidButUntrusted) | The chain is valid, but the root certificate is not trusted. | | 3 (cvrInvalid) | The chain is not valid (some of the certificates are revoked, expired, or contain an invalid signature). | | 4 (cvrCantBeEstablished) | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses). | Subscribe to the [Log](PDFSign.md#PDFSign_e_Log) event to access the detailed validation log. This field is also available as a parameter of the [SignatureProcessed](PDFSign.md#PDFSign_e_SignatureProcessed) event. **ClaimedSigningTime** *String (read-only)* *Default Value: ""* The signature's creation time in UTC. Use this field to get the signature creation time from the signer's computer. Note that the claimed time, unlike [ValidatedSigningTime](#PDFSignature_f_ValidatedSigningTime), does not originate from a trusted TSA and may be forged or wrong. **CoverageEndsAt** *int (read-only)* *Default Value: 0* The byte offset in the PDF file where the signature coverage ends. PDF generators often use incremental updates to make changes in documents. This may result in the signature only covering a part of the document (one of the past revisions), but not the subsequent changes. Use this field to identify the offset where the signature coverage ends. One option is to compare it to the length of the whole document to ensure that the signature covers the entire document. Alternatively, use [GetSignedVersion](#getsignedversion-method-pdfverify-class) to extract the exact revision that was signed. A value of *0* indicates that the class could not determine the coverage offset. **HashAlgorithm** *String (read-only)* *Default Value: "SHA256"* The hash algorithm that was used for signing. Possible values are: - SHA1 - SHA224 - SHA256 - SHA384 - SHA512 - MD5 **Profile** *int (read-only)* *Default Value: 0* The pre-defined PAdES profile that was applied 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. Possible values are: | | | | --- | --- | | 0 (pfNone - default) | No profile | | 1 (pfBaselineB) | PAdES B-B profile | | 2 (pfBaselineT) | PAdES B-T profile | | 3 (pfBaselineLT) | PAdES B-LT profile | | 4 (pfBaselineLTA) | PAdES B-LTA profile | Note that when verifying a signature, the LTV modifier may be affected by the validation settings. These include [OfflineMode](#offlinemode-property-pdfverify-class) (set it to *true* to obtain the clean LTV capability) and [CacheRevocationInfo](#CacheRevocationInfo) (set it to *false* to prevent earlier validations from affecting the current validation). **Reason** *String (read-only)* *Default Value: ""* The reason for signing. **SignatureType** *int (read-only)* *Default Value: 0* The type of the signature that was created. Possible values are: | | | | --- | --- | | 0 (stLegacy - default) | Legacy Adobe signature (adbe.pkcs7.detached) | | 1 (stAdvanced) | PAdES-compliant signature (ETSI.CAdES.detached) | | 2 (stDTS) | Document timestamp (ETSI.RFC3161) | | 3 (stEmptyField) | Empty signature field (signature placeholder) | **SignerCertIndex** *int (read-only)* *Default Value: -1* The index of the signer certificate in the [DocumentCerts](PDFSign.md#PDFSign_p_DocumentCerts) collection. **TimestampCertIndex** *int (read-only)* *Default Value: -1* The index of the timestamping certificate in the [DocumentCerts](PDFSign.md#PDFSign_p_DocumentCerts) collection (if applicable). **Timestamped** *boolean (read-only)* *Default Value: False* Whether the signature contains an embedded timestamp. **ValidatedSigningTime** *String (read-only)* *Default Value: ""* The certified signing time in UTC. Use this field to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This field is only non-empty if there is a valid timestamp included in the signature. Note that the validated time, unlike [ClaimedSigningTime](#PDFSignature_f_ClaimedSigningTime), is the trusted signing time. **ValidationResult** *int (read-only)* *Default Value: 0* The outcome of the cryptographic signature validation. Possible values are: | | | | --- | --- | | 0 (svrUnknown - default) | Signature validity is unknown. | | 1 (svrValid) | The signature is valid. | | 2 (svrCorrupted) | The signature is corrupted. | | 3 (svrSignerNotFound) | Failed to acquire the signing certificate. The signature cannot be validated. | | 4 (svrFailure) | General failure. | This field is also available as the *SignatureValidationResult* parameter of the [SignatureProcessed](PDFSign.md#PDFSign_e_SignatureProcessed) event. **WidgetHeight** *String (read-only)* *Default Value: "70"* The height of the signature widget in points. **WidgetOffsetX** *String (read-only)* *Default Value: "0"* The signature widget offset from the left-hand page border in points. **WidgetOffsetY** *String (read-only)* *Default Value: "0"* The signature widget offset from the bottom page border in points. **WidgetPages** *String (read-only)* *Default Value: ""* The pages that the signature and its widget are placed on. **WidgetWidth** *String (read-only)* *Default Value: "70"* The width of the signature widget in points. ## Constructors ```text 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](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme). The following fields are available: - [AuthScheme](#Proxy_f_AuthScheme) - [AutoDetect](#Proxy_f_AutoDetect) - [Password](#Proxy_f_Password) - [Port](#Proxy_f_Port) - [Server](#Proxy_f_Server) - [SSL](#Proxy_f_SSL) - [User](#Proxy_f_User) ## Fields **AuthScheme** *int* *Default Value: 0* The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set. [AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected. By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set, the class will attempt basic authentication. If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead. If [AuthScheme](#Proxy_f_AuthScheme) is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If [AuthScheme](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this field will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password). **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use proxy system settings, if available. The default value is *false*. Note: This setting is applicable only in Windows. **Password** *String* *Default Value: ""* A password if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation. **Port** *int* *Default Value: 80* The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) field for details. **Server** *String* *Default Value: ""* If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [Server](#Proxy_f_Server) field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) field is set to the corresponding address. If the search is not successful, an error is returned. **SSL** *int* *Default Value: 0* When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | **User** *String* *Default Value: ""* A username if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation. ## Constructors ```text public Proxy(); ``` ```text public Proxy(String server, int port); ``` ```text public Proxy(String server, int port, String user, String password); ``` # Config Settings ([PDFVerify](#pdfverify-class) 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](#config-method-pdfverify-class) method. ### PDFVerify Config Settings **CacheRevocationInfo**: Whether to cache revocation information.This setting specifies whether the class caches revocation information. If set to *true*, the class preserves downloaded CRLs and OCSP responses in memory and reuses them in subsequent chain validations. If set to *false*, the class always collects revocation information from scratch (when applicable). The default value is *true*. **CloseInputStreamAfterProcessing**: Whether to close the input stream after processing.This setting determines whether the input stream specified in [SetInputStream](#setinputstream-method-pdfverify-class) will be closed after processing is complete. The default value is *true*. **CloseOutputStreamAfterProcessing**: Whether to close the output stream after processing.This setting determines whether the output stream specified in [SetOutputStream](#setoutputstream-method-pdfverify-class) will be closed after processing is complete. The default value is *true*. **ContactInfo[Index]**: The signer's contact information.This indexed setting returns the signer's contact information for a signature. *Index* is the index of the signature in the [Signatures](#signatures-property-pdfverify-class) collection. This setting is read-only. **EnforcePDFA**: Whether to enforce PDF/A compliance.This setting specifies whether the class enforces PDF/A compliance when operating on the document. If set to *true*, [PDFALevel](#PDFALevel) and [PDFAPolicy](#PDFAPolicy) are used to establish the level of PDF/A compliance to apply. The default value is *false*. **FilterName[Index]**: The signature filter name.This indexed setting returns the signature filter name. *Index* is the index of the signature in the [Signatures](#signatures-property-pdfverify-class) collection. This setting is read-only. **FullSignatureName[Index]**: The full name of the signature field.This indexed setting returns the full name of the signature field. It is an internal identifier of a signature (such as *Signature1*) and is not meant to be human-readable. *Index* is the index of the signature in the [Signatures](#signatures-property-pdfverify-class) collection. This setting is read-only. **HTTPRetryCount**: The number of HTTP request retries.This setting specifies the number of times to retry an HTTP request. It can be useful in the case of timestamping or CRL/OCSP retrieval failures. **HTTPRetryInterval**: A time interval to apply between HTTP request retries.This setting specifies the time interval (in seconds) to apply between successive HTTP request retries. It can be useful in the case of timestamping or CRL/OCSP retrieval failures. **LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [Log](#log-event-pdfverify-class) event. Possible values are: | | | | --- | --- | | 0 (None) | No messages are logged. | | 1 (Info - default) | Informational events such as the basics of the chain validation procedure are logged. | | 2 (Verbose) | Detailed data such as HTTP requests are logged. | | 3 (Debug) | Debug data including the full chain validation procedure are logged. | **OwnerPassword**: The owner password to decrypt the document with.This setting is used to provide the document owner password for decryption. Though it may be different from [Password](#password-property-pdfverify-class), most implementations use the same value for both. **PDFALevel**: The PDF/A conformance level to enforce.This setting specifies the desired PDF/A conformance level that the class attempts to enforce when [EnforcePDFA](#EnforcePDFA) is set to *true*. Possible values are: | | | | --- | --- | | 1 | PDF/A-1 | | 2 | PDF/A-2 | | 3 (default) | PDF/A-3 | **PDFAPolicy**: The PDF/A policy to follow.This setting specifies the PDF/A policy the class follows when [EnforcePDFA](#EnforcePDFA) is set to *true*. Possible values are: | | | | --- | --- | | Default | Maps to Preserve. | | Preserve | Keep existing document features and only write PDF/A-compliant pieces. If the class needs to write a non-compliant piece, it throws an exception. | | Enforce | Preserve PDF/A-compliant pieces and attempt to fix violations in the original document. | **Permissions**: The document permissions associated with the encryption.This setting returns the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents, but note that it is a policy-like requirement rather than an enforcement. This setting is read-only. Its value is a bitmask of the following flags: | | | | --- | --- | | 0x001 (pepAnnotations) | Annotating is allowed. | | 0x002 (pepAssemble) | Assembling a new document on the basis of the processed one is allowed. | | 0x004 (pepExtract) | Extraction/copying of the pictures and text from the document is allowed. | | 0x008 (pepExtractAcc) | Content extraction is allowed for accessibility purposes only. | | 0x010 (pepFillInForms) | Filling in forms is allowed. | | 0x020 (pepHighQualityPrint) | High quality printing is allowed. | | 0x040 (pepLowQualityPrint) | Low quality printing is allowed. | | 0x080 (pepModify) | Modifications are allowed. | **PreferEmbeddedRevocationInfo**: Whether to prioritize revocation information that is embedded into the document.This setting specifies whether the class uses revocation information that is embedded into the document when checking revocation status. If set to *true*, the class does not download CRLs or OCSP responses from online sources unnecessarily. If set to *false* or no embedded revocation information is present, the class retrieves it as normal based on the value of [RevocationCheck](#revocationcheck-property-pdfverify-class). The default value is *true*. **RevisionOffsets**: The offsets of the document revisions.This setting returns a comma-separated list of the byte offsets of all the revisions in the document. It may be used to obtain the number of revisions or extract a particular revision. This setting is read-only. **SaveChanges**: Whether to save changes made to the document.This setting specifies whether and how changes made to the PDF document are saved when [Close](#close-method-pdfverify-class) is called. Possible values are: | | | | --- | --- | | 0 | Discard all changes. | | 1 | Save the document to [OutputFile](#outputfile-property-pdfverify-class), [OutputData](#outputdata-property-pdfverify-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfverify-class), even if it has not been modified. | | 2 (default) | Save the document to [OutputFile](#outputfile-property-pdfverify-class), [OutputData](#outputdata-property-pdfverify-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfverify-class), but only if it has been modified. | **SignatureAllowedChanges[Index]**: The changes allowed by the signature.This indexed setting returns the scope of further changes to the document allowed by the signature. *Index* is the index of the signature in the [Signatures](#signatures-property-pdfverify-class) collection. This setting is read-only. Its value is a bitmask of the following flags: | | | | --- | --- | | 0x001 (PDF_SIGNATURE_ALLOWED_CHANGE_FILL_IN_FORMS) | The signature allows filling in forms. | | 0x002 (PDF_SIGNATURE_ALLOWED_CHANGE_COMMENT) | The signature allows adding comments. | A value of *0* indicates that no changes are allowed. **SignatureData[Index]**: The hex-encoded representation of the underlying PKCS#7/CMS signature container.This indexed setting returns the hex-encoded representation of the underlying PKCS#7/CMS signature container, or the timestamp token for document timestamps. *Index* is the index of the signature in the [Signatures](#signatures-property-pdfverify-class) collection. This setting is read-only. **SignatureInvertedLock[Index]**: Whether the locked field list should be treated as containing unlocked fields instead.This indexed setting indicates whether the list returned by [SignatureLockedFields\[Index\]](#SignatureLockedFields[Index]) should be treated in the opposite way, as a list of the only **unlocked** form fields. All other fields that are not present in the list are locked. This setting can only return *true* if an explicit list of field names is returned. *Index* is the index of the signature in the [Signatures](#signatures-property-pdfverify-class) collection. This setting is read-only. **SignatureLockedFields[Index]**: The list of form fields that are locked by the signature.This indexed setting returns a list of form fields that are locked for modification by the signature. *Index* is the index of the signature in the [Signatures](#signatures-property-pdfverify-class) collection. This setting is read-only. Depending on the method chosen by the author of the document, this setting may return one of the following values: - A comma-separated list of field names (see also [SignatureInvertedLock\[Index\]](#SignatureInvertedLock[Index])). - An asterisk character (***), to indicate that all the form fields are locked. - An empty string, to indicate that no locking information is provided in the document. **TempPath**: The location where temporary files are stored.This setting specifies an absolute path to the location on disk where temporary files are stored. It can be useful to reduce memory usage. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events. **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. **UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*. # Trappable Errors ([PDFVerify](#pdfverify-class) Class) ### PDFVerify Errors | | | | --- | --- | | 802 | HTTP download failed. The error description contains the detailed message. | | 803 | The document is not signed. | | 816 | Invalid signature. The error description contains the detailed message. | | 827 | Invalid timestamp data. The error description contains the detailed message. | | 829 | Bad signing certificate attribute. | | 830 | Chain validation failed. The error description contains the detailed message. | | 833 | Trusted List processing error. The error description contains the detailed message. | | 834 | Cannot parse Trusted List data. | | 837 | Invalid revocation information. | | 839 | Failed to process Trusted List. The error description contains the detailed message. | | 844 | No signer certificate found. | | 845 | Invalid signing certificate chain. The error description contains the detailed message. | | 851 | Unsupported hash algorithm. | | 853 | Invalid digest. | | 854 | Invalid signature reference. | | 855 | Invalid signature contents. | | 856 | Invalid signature byte range. | | 857 | Byte range does not cover the entire document. | ### PDF Errors | | | | --- | --- | | 804 | PDF decompression failed. | | 805 | Cannot add entry to cross-reference table. | | 806 | Unsupported field size. | | 807 | Unsupported Encoding filter. | | 808 | Unsupported predictor algorithm. | | 809 | Unsupported document version. | | 812 | Cannot read PDF file stream. | | 813 | Cannot write to PDF file stream. | | 814 | [OutputFile](#outputfile-property-pdfverify-class) already exists and [Overwrite](#overwrite-property-pdfverify-class) is false. | | 815 | Invalid parameter. | | 817 | Bad cross-reference entry. | | 818 | Invalid object or generation number. | | 819 | Invalid object stream. | | 820 | Invalid stream dictionary. | | 821 | Invalid AcroForm entry. | | 822 | Invalid Root entry. | | 823 | Invalid annotation. | | 824 | The input document is empty. | | 826 | OpenType font error. The error description contains the detailed message. | | 828 | Invalid CMS data. The error description contains the detailed message. | | 835 | Cannot change decryption mode for opened document. | | 836 | Unsupported Date string. | | 838 | Cryptographic error. The error description contains the detailed message. | | 840 | [DecryptionCert](#decryptioncert-property-pdfverify-class) error. The error description contains the detailed message. | | 841 | Encryption failed. The error description contains the detailed message. | | 842 | No proper certificate for encryption found. | | 846 | Unsupported revision. | | 847 | Unsupported security handler SubFilter. | | 848 | Failed to verify permissions. | | 849 | Invalid password. | | 850 | Invalid password information. | | 852 | Unsupported encryption algorithm. | | 859 | Cannot encrypt encrypted document. | | 864 | Cannot modify document after signature update. | | 868 | Cannot encrypt or decrypt object. | | 869 | Invalid security handler information. | | 870 | Invalid encrypted data. | | 871 | Invalid block cipher padding. | | 872 | Failed to reload signature. | | 873 | Object is not encrypted. | | 874 | Unexpected cipher information. | | 877 | Invalid document. Bad document catalog. | | 878 | Invalid document Id. | | 880 | Invalid document. Invalid requirements dictionary. | | 881 | Invalid linearization dictionary. | | 882 | Invalid signature information. | | 883 | Unsupported document format. | | 890 | Unsupported feature. | | 891 | Internal error. The error description contains the detailed message. | | 892 | Unsupported color. | | 893 | This operation is not supported for this PDF/A level. | | 894 | Interactive features ([Action](#PDFField_f_Action)) are not supported by PDF/A. Set [EnforcePDFA](#EnforcePDFA) to false or clear the [Action](#PDFField_f_Action) property of the field. | | 895 | Font file not found. | ### Parsing Errors | | | | --- | --- | | 1001 | Bad object. | | 1002 | Bad document trailer. | | 1003 | Illegal stream dictionary. | | 1004 | Illegal string. | | 1005 | Indirect object expected. | | 1007 | Invalid reference. | | 1008 | Invalid reference table. | | 1009 | Invalid stream data. | | 1010 | Unexpected character. | | 1011 | Unexpected EOF. | | 1012 | Unexpected indirect object in cross-reference table. | | 1013 | RDF object not found. | | 1014 | Invalid RDF object. | | 1015 | Cannot create element with unknown prefix. | | 1021 | Invalid type in Root object list. | ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in URL. | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the LocalHost at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 303 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |