# PDFVerify Class The PDFVerify class verifies PDF signatures. ## Class Name **SecurePDF_PDFVerify** ## Procedural Interface ```text securepdf_pdfverify_open(); securepdf_pdfverify_close($res); securepdf_pdfverify_register_callback($res, $id, $function); securepdf_pdfverify_get_last_error($res); securepdf_pdfverify_get_last_error_code($res); securepdf_pdfverify_set($res, $id, $index, $value); securepdf_pdfverify_get($res, $id, $index); securepdf_pdfverify_do_close($res); securepdf_pdfverify_do_config($res, $configurationstring); securepdf_pdfverify_do_encrypted($res); securepdf_pdfverify_do_getpageproperty($res, $pageindex, $pageproperty); securepdf_pdfverify_do_getsignedversion($res, $signatureindex); securepdf_pdfverify_do_interrupt($res); securepdf_pdfverify_do_open($res); securepdf_pdfverify_do_reset($res); securepdf_pdfverify_do_saveattachment($res, $index, $filename); securepdf_pdfverify_do_signed($res); securepdf_pdfverify_do_unsign($res, $signatureindex, $unsignkind); securepdf_pdfverify_do_verify($res); ``` ## 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-securepdf_pdfverify-class)), byte array ([InputData](#inputdata-property-securepdf_pdfverify-class)), or stream (SetInputStream). 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-securepdf_pdfverify-class). For every signature in the document, PDFVerify fires the [SignatureInfo](#signatureinfo-event-securepdf_pdfverify-class) event, allowing you to specify whether you want the class to validate the signature, the chain, or both. Once [SignatureInfo](#signatureinfo-event-securepdf_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-securepdf_pdfverify-class) event is fired, and the validation results are published here as well as in the following properties of the associated PDFSignature object: - contains the outcome of the signature validation: valid, corrupted, the signing certificate was missing, or failed. - contains the primary result of the chain validation routine: valid, valid but untrusted, invalid, or undefined. - 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 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 property of the associated PDFSignature object to establish the scope of a signature. The revision of the document covered by that specific signature ranges from byte *0* to . Alternatively, you can use the [GetSignedVersion](#getsignedversion-method-securepdf_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-securepdf_pdfverify-class) in PDFVerify, as all three methods execute the chain validation procedure (if it is enabled). **Validation Policy** The [ValidationPolicy](#validationpolicy-property-securepdf_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-securepdf_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-securepdf_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 property), and Trusted Lists (through the [TrustedLists](#trustedlists-property-securepdf_pdfverify-class) property) are all supported. **Offline Mode** The [OfflineMode](#offlinemode-property-securepdf_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, TrustedCerts, 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.* | | | | --- | --- | | [AttachmentCount](#attachmentcount-property-securepdf_pdfverify-class) | The number of records in the Attachment arrays. | | [AttachmentContentType](#attachmentcontenttype-property-securepdf_pdfverify-class) | The content type of the attachment. | | [AttachmentCreationDate](#attachmentcreationdate-property-securepdf_pdfverify-class) | The creation date of the attachment. | | [AttachmentData](#attachmentdata-property-securepdf_pdfverify-class) | The raw data of the attachment. | | [AttachmentDescription](#attachmentdescription-property-securepdf_pdfverify-class) | A textual description of the attachment. | | [AttachmentFileName](#attachmentfilename-property-securepdf_pdfverify-class) | The path and filename of the attachment. | | [AttachmentModificationDate](#attachmentmodificationdate-property-securepdf_pdfverify-class) | The date and time of the file's last modification. | | [AttachmentName](#attachmentname-property-securepdf_pdfverify-class) | The name of the attachment. | | [AttachmentSize](#attachmentsize-property-securepdf_pdfverify-class) | The attachment's size in bytes. | | [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) | The number of records in the BlockedCert arrays. | | [BlockedCertEffectiveDate](#blockedcerteffectivedate-property-securepdf_pdfverify-class) | The date on which this certificate becomes valid. | | [BlockedCertExpirationDate](#blockedcertexpirationdate-property-securepdf_pdfverify-class) | The date on which the certificate expires. | | [BlockedCertExtendedKeyUsage](#blockedcertextendedkeyusage-property-securepdf_pdfverify-class) | A comma-delimited list of extended key usage identifiers. | | [BlockedCertFingerprint](#blockedcertfingerprint-property-securepdf_pdfverify-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [BlockedCertFingerprintSHA1](#blockedcertfingerprintsha1-property-securepdf_pdfverify-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [BlockedCertFingerprintSHA256](#blockedcertfingerprintsha256-property-securepdf_pdfverify-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [BlockedCertIssuer](#blockedcertissuer-property-securepdf_pdfverify-class) | The issuer of the certificate. | | [BlockedCertPrivateKey](#blockedcertprivatekey-property-securepdf_pdfverify-class) | The private key of the certificate (if available). | | [BlockedCertPrivateKeyAvailable](#blockedcertprivatekeyavailable-property-securepdf_pdfverify-class) | Whether a PrivateKey is available for the selected certificate. | | [BlockedCertPrivateKeyContainer](#blockedcertprivatekeycontainer-property-securepdf_pdfverify-class) | The name of the PrivateKey container for the certificate (if available). | | [BlockedCertPublicKey](#blockedcertpublickey-property-securepdf_pdfverify-class) | The public key of the certificate. | | [BlockedCertPublicKeyAlgorithm](#blockedcertpublickeyalgorithm-property-securepdf_pdfverify-class) | The textual description of the certificate's public key algorithm. | | [BlockedCertPublicKeyLength](#blockedcertpublickeylength-property-securepdf_pdfverify-class) | The length of the certificate's public key (in bits). | | [BlockedCertSerialNumber](#blockedcertserialnumber-property-securepdf_pdfverify-class) | The serial number of the certificate encoded as a string. | | [BlockedCertSignatureAlgorithm](#blockedcertsignaturealgorithm-property-securepdf_pdfverify-class) | The text description of the certificate's signature algorithm. | | [BlockedCertStore](#blockedcertstore-property-securepdf_pdfverify-class) | The name of the certificate store for the client certificate. | | [BlockedCertStorePassword](#blockedcertstorepassword-property-securepdf_pdfverify-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [BlockedCertStoreType](#blockedcertstoretype-property-securepdf_pdfverify-class) | The type of certificate store for this certificate. | | [BlockedCertSubjectAltNames](#blockedcertsubjectaltnames-property-securepdf_pdfverify-class) | Comma-separated lists of alternative subject names for the certificate. | | [BlockedCertThumbprintMD5](#blockedcertthumbprintmd5-property-securepdf_pdfverify-class) | The MD5 hash of the certificate. | | [BlockedCertThumbprintSHA1](#blockedcertthumbprintsha1-property-securepdf_pdfverify-class) | The SHA-1 hash of the certificate. | | [BlockedCertThumbprintSHA256](#blockedcertthumbprintsha256-property-securepdf_pdfverify-class) | The SHA-256 hash of the certificate. | | [BlockedCertUsage](#blockedcertusage-property-securepdf_pdfverify-class) | The text description of UsageFlags . | | [BlockedCertUsageFlags](#blockedcertusageflags-property-securepdf_pdfverify-class) | The flags that show intended use for the certificate. | | [BlockedCertVersion](#blockedcertversion-property-securepdf_pdfverify-class) | The certificate's version number. | | [BlockedCertSubject](#blockedcertsubject-property-securepdf_pdfverify-class) | The subject of the certificate used for client authentication. | | [BlockedCertEncoded](#blockedcertencoded-property-securepdf_pdfverify-class) | The certificate (PEM/Base64 encoded). | | [DecryptionCertEffectiveDate](#decryptioncerteffectivedate-property-securepdf_pdfverify-class) | The date on which this certificate becomes valid. | | [DecryptionCertExpirationDate](#decryptioncertexpirationdate-property-securepdf_pdfverify-class) | The date on which the certificate expires. | | [DecryptionCertExtendedKeyUsage](#decryptioncertextendedkeyusage-property-securepdf_pdfverify-class) | A comma-delimited list of extended key usage identifiers. | | [DecryptionCertFingerprint](#decryptioncertfingerprint-property-securepdf_pdfverify-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [DecryptionCertFingerprintSHA1](#decryptioncertfingerprintsha1-property-securepdf_pdfverify-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [DecryptionCertFingerprintSHA256](#decryptioncertfingerprintsha256-property-securepdf_pdfverify-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [DecryptionCertIssuer](#decryptioncertissuer-property-securepdf_pdfverify-class) | The issuer of the certificate. | | [DecryptionCertPrivateKey](#decryptioncertprivatekey-property-securepdf_pdfverify-class) | The private key of the certificate (if available). | | [DecryptionCertPrivateKeyAvailable](#decryptioncertprivatekeyavailable-property-securepdf_pdfverify-class) | Whether a PrivateKey is available for the selected certificate. | | [DecryptionCertPrivateKeyContainer](#decryptioncertprivatekeycontainer-property-securepdf_pdfverify-class) | The name of the PrivateKey container for the certificate (if available). | | [DecryptionCertPublicKey](#decryptioncertpublickey-property-securepdf_pdfverify-class) | The public key of the certificate. | | [DecryptionCertPublicKeyAlgorithm](#decryptioncertpublickeyalgorithm-property-securepdf_pdfverify-class) | The textual description of the certificate's public key algorithm. | | [DecryptionCertPublicKeyLength](#decryptioncertpublickeylength-property-securepdf_pdfverify-class) | The length of the certificate's public key (in bits). | | [DecryptionCertSerialNumber](#decryptioncertserialnumber-property-securepdf_pdfverify-class) | The serial number of the certificate encoded as a string. | | [DecryptionCertSignatureAlgorithm](#decryptioncertsignaturealgorithm-property-securepdf_pdfverify-class) | The text description of the certificate's signature algorithm. | | [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfverify-class) | The name of the certificate store for the client certificate. | | [DecryptionCertStorePassword](#decryptioncertstorepassword-property-securepdf_pdfverify-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [DecryptionCertStoreType](#decryptioncertstoretype-property-securepdf_pdfverify-class) | The type of certificate store for this certificate. | | [DecryptionCertSubjectAltNames](#decryptioncertsubjectaltnames-property-securepdf_pdfverify-class) | Comma-separated lists of alternative subject names for the certificate. | | [DecryptionCertThumbprintMD5](#decryptioncertthumbprintmd5-property-securepdf_pdfverify-class) | The MD5 hash of the certificate. | | [DecryptionCertThumbprintSHA1](#decryptioncertthumbprintsha1-property-securepdf_pdfverify-class) | The SHA-1 hash of the certificate. | | [DecryptionCertThumbprintSHA256](#decryptioncertthumbprintsha256-property-securepdf_pdfverify-class) | The SHA-256 hash of the certificate. | | [DecryptionCertUsage](#decryptioncertusage-property-securepdf_pdfverify-class) | The text description of UsageFlags . | | [DecryptionCertUsageFlags](#decryptioncertusageflags-property-securepdf_pdfverify-class) | The flags that show intended use for the certificate. | | [DecryptionCertVersion](#decryptioncertversion-property-securepdf_pdfverify-class) | The certificate's version number. | | [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfverify-class) | The subject of the certificate used for client authentication. | | [DecryptionCertEncoded](#decryptioncertencoded-property-securepdf_pdfverify-class) | The certificate (PEM/Base64 encoded). | | [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) | The number of records in the DocumentCert arrays. | | [DocumentCertEffectiveDate](#documentcerteffectivedate-property-securepdf_pdfverify-class) | The date on which this certificate becomes valid. | | [DocumentCertExpirationDate](#documentcertexpirationdate-property-securepdf_pdfverify-class) | The date on which the certificate expires. | | [DocumentCertExtendedKeyUsage](#documentcertextendedkeyusage-property-securepdf_pdfverify-class) | A comma-delimited list of extended key usage identifiers. | | [DocumentCertFingerprint](#documentcertfingerprint-property-securepdf_pdfverify-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [DocumentCertFingerprintSHA1](#documentcertfingerprintsha1-property-securepdf_pdfverify-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [DocumentCertFingerprintSHA256](#documentcertfingerprintsha256-property-securepdf_pdfverify-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [DocumentCertIssuer](#documentcertissuer-property-securepdf_pdfverify-class) | The issuer of the certificate. | | [DocumentCertPrivateKey](#documentcertprivatekey-property-securepdf_pdfverify-class) | The private key of the certificate (if available). | | [DocumentCertPrivateKeyAvailable](#documentcertprivatekeyavailable-property-securepdf_pdfverify-class) | Whether a PrivateKey is available for the selected certificate. | | [DocumentCertPrivateKeyContainer](#documentcertprivatekeycontainer-property-securepdf_pdfverify-class) | The name of the PrivateKey container for the certificate (if available). | | [DocumentCertPublicKey](#documentcertpublickey-property-securepdf_pdfverify-class) | The public key of the certificate. | | [DocumentCertPublicKeyAlgorithm](#documentcertpublickeyalgorithm-property-securepdf_pdfverify-class) | The textual description of the certificate's public key algorithm. | | [DocumentCertPublicKeyLength](#documentcertpublickeylength-property-securepdf_pdfverify-class) | The length of the certificate's public key (in bits). | | [DocumentCertSerialNumber](#documentcertserialnumber-property-securepdf_pdfverify-class) | The serial number of the certificate encoded as a string. | | [DocumentCertSignatureAlgorithm](#documentcertsignaturealgorithm-property-securepdf_pdfverify-class) | The text description of the certificate's signature algorithm. | | [DocumentCertStore](#documentcertstore-property-securepdf_pdfverify-class) | The name of the certificate store for the client certificate. | | [DocumentCertStorePassword](#documentcertstorepassword-property-securepdf_pdfverify-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [DocumentCertStoreType](#documentcertstoretype-property-securepdf_pdfverify-class) | The type of certificate store for this certificate. | | [DocumentCertSubjectAltNames](#documentcertsubjectaltnames-property-securepdf_pdfverify-class) | Comma-separated lists of alternative subject names for the certificate. | | [DocumentCertThumbprintMD5](#documentcertthumbprintmd5-property-securepdf_pdfverify-class) | The MD5 hash of the certificate. | | [DocumentCertThumbprintSHA1](#documentcertthumbprintsha1-property-securepdf_pdfverify-class) | The SHA-1 hash of the certificate. | | [DocumentCertThumbprintSHA256](#documentcertthumbprintsha256-property-securepdf_pdfverify-class) | The SHA-256 hash of the certificate. | | [DocumentCertUsage](#documentcertusage-property-securepdf_pdfverify-class) | The text description of UsageFlags . | | [DocumentCertUsageFlags](#documentcertusageflags-property-securepdf_pdfverify-class) | The flags that show intended use for the certificate. | | [DocumentCertVersion](#documentcertversion-property-securepdf_pdfverify-class) | The certificate's version number. | | [DocumentCertSubject](#documentcertsubject-property-securepdf_pdfverify-class) | The subject of the certificate used for client authentication. | | [DocumentCertEncoded](#documentcertencoded-property-securepdf_pdfverify-class) | The certificate (PEM/Base64 encoded). | | [FirewallAutoDetect](#firewallautodetect-property-securepdf_pdfverify-class) | Whether to automatically detect and use firewall system settings, if available. | | [FirewallType](#firewalltype-property-securepdf_pdfverify-class) | The type of firewall to connect through. | | [FirewallHost](#firewallhost-property-securepdf_pdfverify-class) | The name or IP address of the firewall (optional). | | [FirewallPassword](#firewallpassword-property-securepdf_pdfverify-class) | A password if authentication is to be used when connecting through the firewall. | | [FirewallPort](#firewallport-property-securepdf_pdfverify-class) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [FirewallUser](#firewalluser-property-securepdf_pdfverify-class) | A username if authentication is to be used when connecting through a firewall. | | [InputData](#inputdata-property-securepdf_pdfverify-class) | A byte array containing the PDF document to process. | | [InputFile](#inputfile-property-securepdf_pdfverify-class) | The PDF file to process. | | [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) | The number of records in the KnownCert arrays. | | [KnownCertEffectiveDate](#knowncerteffectivedate-property-securepdf_pdfverify-class) | The date on which this certificate becomes valid. | | [KnownCertExpirationDate](#knowncertexpirationdate-property-securepdf_pdfverify-class) | The date on which the certificate expires. | | [KnownCertExtendedKeyUsage](#knowncertextendedkeyusage-property-securepdf_pdfverify-class) | A comma-delimited list of extended key usage identifiers. | | [KnownCertFingerprint](#knowncertfingerprint-property-securepdf_pdfverify-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [KnownCertFingerprintSHA1](#knowncertfingerprintsha1-property-securepdf_pdfverify-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [KnownCertFingerprintSHA256](#knowncertfingerprintsha256-property-securepdf_pdfverify-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [KnownCertIssuer](#knowncertissuer-property-securepdf_pdfverify-class) | The issuer of the certificate. | | [KnownCertPrivateKey](#knowncertprivatekey-property-securepdf_pdfverify-class) | The private key of the certificate (if available). | | [KnownCertPrivateKeyAvailable](#knowncertprivatekeyavailable-property-securepdf_pdfverify-class) | Whether a PrivateKey is available for the selected certificate. | | [KnownCertPrivateKeyContainer](#knowncertprivatekeycontainer-property-securepdf_pdfverify-class) | The name of the PrivateKey container for the certificate (if available). | | [KnownCertPublicKey](#knowncertpublickey-property-securepdf_pdfverify-class) | The public key of the certificate. | | [KnownCertPublicKeyAlgorithm](#knowncertpublickeyalgorithm-property-securepdf_pdfverify-class) | The textual description of the certificate's public key algorithm. | | [KnownCertPublicKeyLength](#knowncertpublickeylength-property-securepdf_pdfverify-class) | The length of the certificate's public key (in bits). | | [KnownCertSerialNumber](#knowncertserialnumber-property-securepdf_pdfverify-class) | The serial number of the certificate encoded as a string. | | [KnownCertSignatureAlgorithm](#knowncertsignaturealgorithm-property-securepdf_pdfverify-class) | The text description of the certificate's signature algorithm. | | [KnownCertStore](#knowncertstore-property-securepdf_pdfverify-class) | The name of the certificate store for the client certificate. | | [KnownCertStorePassword](#knowncertstorepassword-property-securepdf_pdfverify-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [KnownCertStoreType](#knowncertstoretype-property-securepdf_pdfverify-class) | The type of certificate store for this certificate. | | [KnownCertSubjectAltNames](#knowncertsubjectaltnames-property-securepdf_pdfverify-class) | Comma-separated lists of alternative subject names for the certificate. | | [KnownCertThumbprintMD5](#knowncertthumbprintmd5-property-securepdf_pdfverify-class) | The MD5 hash of the certificate. | | [KnownCertThumbprintSHA1](#knowncertthumbprintsha1-property-securepdf_pdfverify-class) | The SHA-1 hash of the certificate. | | [KnownCertThumbprintSHA256](#knowncertthumbprintsha256-property-securepdf_pdfverify-class) | The SHA-256 hash of the certificate. | | [KnownCertUsage](#knowncertusage-property-securepdf_pdfverify-class) | The text description of UsageFlags . | | [KnownCertUsageFlags](#knowncertusageflags-property-securepdf_pdfverify-class) | The flags that show intended use for the certificate. | | [KnownCertVersion](#knowncertversion-property-securepdf_pdfverify-class) | The certificate's version number. | | [KnownCertSubject](#knowncertsubject-property-securepdf_pdfverify-class) | The subject of the certificate used for client authentication. | | [KnownCertEncoded](#knowncertencoded-property-securepdf_pdfverify-class) | The certificate (PEM/Base64 encoded). | | [OfflineMode](#offlinemode-property-securepdf_pdfverify-class) | Whether the class is operating in offline mode. | | [OutputData](#outputdata-property-securepdf_pdfverify-class) | A byte array containing the PDF document after processing. | | [OutputFile](#outputfile-property-securepdf_pdfverify-class) | The path to a local file where the output is written. | | [Overwrite](#overwrite-property-securepdf_pdfverify-class) | Whether the class should overwrite files. | | [Password](#password-property-securepdf_pdfverify-class) | The password to decrypt the document with. | | [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) | The type of authorization to perform when connecting to the proxy. | | [ProxyAutoDetect](#proxyautodetect-property-securepdf_pdfverify-class) | Whether to automatically detect and use proxy system settings, if available. | | [ProxyPassword](#proxypassword-property-securepdf_pdfverify-class) | A password if authentication is to be used for the proxy. | | [ProxyPort](#proxyport-property-securepdf_pdfverify-class) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). | | [ProxyServer](#proxyserver-property-securepdf_pdfverify-class) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. | | [ProxySSL](#proxyssl-property-securepdf_pdfverify-class) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. | | [ProxyUser](#proxyuser-property-securepdf_pdfverify-class) | A username if authentication is to be used for the proxy. | | [RevocationCheck](#revocationcheck-property-securepdf_pdfverify-class) | The kind(s) of revocation check to perform for all chain certificates. | | [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) | The number of records in the PDFSignature arrays. | | [PDFSignatureAuthorName](#pdfsignatureauthorname-property-securepdf_pdfverify-class) | The human-readable name of the signer. | | [PDFSignatureChainValidationDetails](#pdfsignaturechainvalidationdetails-property-securepdf_pdfverify-class) | The details of the certificate chain validation outcome. | | [PDFSignatureChainValidationResult](#pdfsignaturechainvalidationresult-property-securepdf_pdfverify-class) | The outcome of the certificate chain validation routine. | | [PDFSignatureClaimedSigningTime](#pdfsignatureclaimedsigningtime-property-securepdf_pdfverify-class) | The signature's creation time in UTC. | | [PDFSignatureCoverageEndsAt](#pdfsignaturecoverageendsat-property-securepdf_pdfverify-class) | The byte offset in the PDF file where the signature coverage ends. | | [PDFSignatureHashAlgorithm](#pdfsignaturehashalgorithm-property-securepdf_pdfverify-class) | The hash algorithm that was used for signing. | | [PDFSignatureProfile](#pdfsignatureprofile-property-securepdf_pdfverify-class) | The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI. | | [PDFSignatureReason](#pdfsignaturereason-property-securepdf_pdfverify-class) | The reason for signing. | | [PDFSignatureType](#pdfsignaturetype-property-securepdf_pdfverify-class) | The type of the signature that was created. | | [PDFSignatureSignerCertIndex](#pdfsignaturesignercertindex-property-securepdf_pdfverify-class) | The index of the signer certificate in the DocumentCerts collection. | | [PDFSignatureTimestampCertIndex](#pdfsignaturetimestampcertindex-property-securepdf_pdfverify-class) | The index of the timestamping certificate in the DocumentCerts collection (if applicable). | | [PDFSignatureTimestamped](#pdfsignaturetimestamped-property-securepdf_pdfverify-class) | Whether the signature contains an embedded timestamp. | | [PDFSignatureValidatedSigningTime](#pdfsignaturevalidatedsigningtime-property-securepdf_pdfverify-class) | The certified signing time in UTC. | | [PDFSignatureValidationResult](#pdfsignaturevalidationresult-property-securepdf_pdfverify-class) | The outcome of the cryptographic signature validation. | | [PDFSignatureWidgetHeight](#pdfsignaturewidgetheight-property-securepdf_pdfverify-class) | The height of the signature widget in points. | | [PDFSignatureWidgetOffsetX](#pdfsignaturewidgetoffsetx-property-securepdf_pdfverify-class) | The signature widget offset from the left-hand page border in points. | | [PDFSignatureWidgetOffsetY](#pdfsignaturewidgetoffsety-property-securepdf_pdfverify-class) | The signature widget offset from the bottom page border in points. | | [PDFSignatureWidgetPages](#pdfsignaturewidgetpages-property-securepdf_pdfverify-class) | The pages that the signature and its widget are placed on. | | [PDFSignatureWidgetWidth](#pdfsignaturewidgetwidth-property-securepdf_pdfverify-class) | The width of the signature widget in points. | | [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) | The number of records in the TrustedCert arrays. | | [TrustedCertEffectiveDate](#trustedcerteffectivedate-property-securepdf_pdfverify-class) | The date on which this certificate becomes valid. | | [TrustedCertExpirationDate](#trustedcertexpirationdate-property-securepdf_pdfverify-class) | The date on which the certificate expires. | | [TrustedCertExtendedKeyUsage](#trustedcertextendedkeyusage-property-securepdf_pdfverify-class) | A comma-delimited list of extended key usage identifiers. | | [TrustedCertFingerprint](#trustedcertfingerprint-property-securepdf_pdfverify-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [TrustedCertFingerprintSHA1](#trustedcertfingerprintsha1-property-securepdf_pdfverify-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [TrustedCertFingerprintSHA256](#trustedcertfingerprintsha256-property-securepdf_pdfverify-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [TrustedCertIssuer](#trustedcertissuer-property-securepdf_pdfverify-class) | The issuer of the certificate. | | [TrustedCertPrivateKey](#trustedcertprivatekey-property-securepdf_pdfverify-class) | The private key of the certificate (if available). | | [TrustedCertPrivateKeyAvailable](#trustedcertprivatekeyavailable-property-securepdf_pdfverify-class) | Whether a PrivateKey is available for the selected certificate. | | [TrustedCertPrivateKeyContainer](#trustedcertprivatekeycontainer-property-securepdf_pdfverify-class) | The name of the PrivateKey container for the certificate (if available). | | [TrustedCertPublicKey](#trustedcertpublickey-property-securepdf_pdfverify-class) | The public key of the certificate. | | [TrustedCertPublicKeyAlgorithm](#trustedcertpublickeyalgorithm-property-securepdf_pdfverify-class) | The textual description of the certificate's public key algorithm. | | [TrustedCertPublicKeyLength](#trustedcertpublickeylength-property-securepdf_pdfverify-class) | The length of the certificate's public key (in bits). | | [TrustedCertSerialNumber](#trustedcertserialnumber-property-securepdf_pdfverify-class) | The serial number of the certificate encoded as a string. | | [TrustedCertSignatureAlgorithm](#trustedcertsignaturealgorithm-property-securepdf_pdfverify-class) | The text description of the certificate's signature algorithm. | | [TrustedCertStore](#trustedcertstore-property-securepdf_pdfverify-class) | The name of the certificate store for the client certificate. | | [TrustedCertStorePassword](#trustedcertstorepassword-property-securepdf_pdfverify-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [TrustedCertStoreType](#trustedcertstoretype-property-securepdf_pdfverify-class) | The type of certificate store for this certificate. | | [TrustedCertSubjectAltNames](#trustedcertsubjectaltnames-property-securepdf_pdfverify-class) | Comma-separated lists of alternative subject names for the certificate. | | [TrustedCertThumbprintMD5](#trustedcertthumbprintmd5-property-securepdf_pdfverify-class) | The MD5 hash of the certificate. | | [TrustedCertThumbprintSHA1](#trustedcertthumbprintsha1-property-securepdf_pdfverify-class) | The SHA-1 hash of the certificate. | | [TrustedCertThumbprintSHA256](#trustedcertthumbprintsha256-property-securepdf_pdfverify-class) | The SHA-256 hash of the certificate. | | [TrustedCertUsage](#trustedcertusage-property-securepdf_pdfverify-class) | The text description of UsageFlags . | | [TrustedCertUsageFlags](#trustedcertusageflags-property-securepdf_pdfverify-class) | The flags that show intended use for the certificate. | | [TrustedCertVersion](#trustedcertversion-property-securepdf_pdfverify-class) | The certificate's version number. | | [TrustedCertSubject](#trustedcertsubject-property-securepdf_pdfverify-class) | The subject of the certificate used for client authentication. | | [TrustedCertEncoded](#trustedcertencoded-property-securepdf_pdfverify-class) | The certificate (PEM/Base64 encoded). | | [TrustedLists](#trustedlists-property-securepdf_pdfverify-class) | A list of known Trusted Lists for chain validation. | | [TrustSources](#trustsources-property-securepdf_pdfverify-class) | The trust sources to use during chain validation. | | [ValidationFlags](#validationflags-property-securepdf_pdfverify-class) | Additional chain validation settings. | | [ValidationPolicy](#validationpolicy-property-securepdf_pdfverify-class) | The level at which to perform chain validation. | | [ValidationTime](#validationtime-property-securepdf_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-securepdf_pdfverify-class) | Closes the opened document. | | [Config](#config-method-securepdf_pdfverify-class) | Sets or retrieves a configuration setting. | | [Encrypted](#encrypted-method-securepdf_pdfverify-class) | Checks whether the document is encrypted. | | [GetPageProperty](#getpageproperty-method-securepdf_pdfverify-class) | Returns the value of a page property. | | [GetSignedVersion](#getsignedversion-method-securepdf_pdfverify-class) | Returns the part of the signed document that is covered by a signature. | | [Interrupt](#interrupt-method-securepdf_pdfverify-class) | Interrupts the current action. | | [Open](#open-method-securepdf_pdfverify-class) | Opens the document for processing. | | [Reset](#reset-method-securepdf_pdfverify-class) | Resets the class. | | [SaveAttachment](#saveattachment-method-securepdf_pdfverify-class) | Saves a PDF attachment to a file. | | [Signed](#signed-method-securepdf_pdfverify-class) | Checks whether the document is signed. | | [Unsign](#unsign-method-securepdf_pdfverify-class) | Removes a signature from the document. | | [Verify](#verify-method-securepdf_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-securepdf_pdfverify-class) | Fired when the class encounters a chain certificate. | | [DocumentInfo](#documentinfo-event-securepdf_pdfverify-class) | Fired when the document has been loaded into memory. | | [Error](#error-event-securepdf_pdfverify-class) | Fired when information is available about errors during data delivery. | | [Log](#log-event-securepdf_pdfverify-class) | Fired once for each log message. | | [Password](#password-event-securepdf_pdfverify-class) | Fired when the class detects that the document is encrypted with a password. | | [RecipientInfo](#recipientinfo-event-securepdf_pdfverify-class) | Fired for each recipient certificate of the encrypted document. | | [SignatureInfo](#signatureinfo-event-securepdf_pdfverify-class) | Fired when the class finds a signature in the document. | | [SignatureProcessed](#signatureprocessed-event-securepdf_pdfverify-class) | Fired after a signature has been processed. | | [SSLServerAuthentication](#sslserverauthentication-event-securepdf_pdfverify-class) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-securepdf_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. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AttachmentCount Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The number of records in the Attachment arrays. ## Object Oriented Interface ```text public function getAttachmentCount(); public function setAttachmentCount($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 1 ); securepdf_pdfverify_set($res, 1, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [AttachmentContentType](#attachmentcontenttype-property-securepdf_pdfverify-class) - [AttachmentCreationDate](#attachmentcreationdate-property-securepdf_pdfverify-class) - [AttachmentData](#attachmentdata-property-securepdf_pdfverify-class) - [AttachmentDescription](#attachmentdescription-property-securepdf_pdfverify-class) - [AttachmentFileName](#attachmentfilename-property-securepdf_pdfverify-class) - [AttachmentModificationDate](#attachmentmodificationdate-property-securepdf_pdfverify-class) - [AttachmentName](#attachmentname-property-securepdf_pdfverify-class) - [AttachmentSize](#attachmentsize-property-securepdf_pdfverify-class) The array indices start at *0* and end at *AttachmentCount - 1*. This property is not available at design time. ## Data Type Integer # AttachmentContentType Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The content type of the attachment. ## Object Oriented Interface ```text public function getAttachmentContentType($attachmentindex); public function setAttachmentContentType($attachmentindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 2 , $attachmentindex); securepdf_pdfverify_set($res, 2, $value , $attachmentindex); ``` ## Default Value '' ## Remarks The content type of the attachment. The *$attachmentindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachmentcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # AttachmentCreationDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The creation date of the attachment. ## Object Oriented Interface ```text public function getAttachmentCreationDate($attachmentindex); public function setAttachmentCreationDate($attachmentindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 3 , $attachmentindex); securepdf_pdfverify_set($res, 3, $value , $attachmentindex); ``` ## Default Value '' ## Remarks The creation date of the attachment. The *$attachmentindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachmentcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # AttachmentData Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The raw data of the attachment. ## Object Oriented Interface ```text public function getAttachmentData($attachmentindex); public function setAttachmentData($attachmentindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 4 , $attachmentindex); securepdf_pdfverify_set($res, 4, $value , $attachmentindex); ``` ## Default Value '' ## Remarks The raw data of the attachment. If [AttachmentOutputStream](#PDFVerify_p_AttachmentOutputStream) is not set to a valid stream, the class writes to this property when an empty string is passed to SaveAttachment. The *$attachmentindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachmentcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type Binary String # AttachmentDescription Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A textual description of the attachment. ## Object Oriented Interface ```text public function getAttachmentDescription($attachmentindex); public function setAttachmentDescription($attachmentindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 5 , $attachmentindex); securepdf_pdfverify_set($res, 5, $value , $attachmentindex); ``` ## Default Value '' ## Remarks A textual description of the attachment. The *$attachmentindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachmentcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # AttachmentFileName Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The path and filename of the attachment. ## Object Oriented Interface ```text public function getAttachmentFileName($attachmentindex); public function setAttachmentFileName($attachmentindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 6 , $attachmentindex); securepdf_pdfverify_set($res, 6, $value , $attachmentindex); ``` ## Default Value '' ## Remarks The path and filename of the attachment. The *$attachmentindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachmentcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # AttachmentModificationDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date and time of the file's last modification. ## Object Oriented Interface ```text public function getAttachmentModificationDate($attachmentindex); public function setAttachmentModificationDate($attachmentindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 8 , $attachmentindex); securepdf_pdfverify_set($res, 8, $value , $attachmentindex); ``` ## Default Value '' ## Remarks The date and time of the file's last modification. The *$attachmentindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachmentcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # AttachmentName Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the attachment. ## Object Oriented Interface ```text public function getAttachmentName($attachmentindex); public function setAttachmentName($attachmentindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 9 , $attachmentindex); securepdf_pdfverify_set($res, 9, $value , $attachmentindex); ``` ## Default Value '' ## Remarks The name of the attachment. The *$attachmentindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachmentcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # AttachmentSize Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The attachment's size in bytes. ## Object Oriented Interface ```text public function getAttachmentSize($attachmentindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 11 , $attachmentindex); ``` ## Default Value 0 ## Remarks The attachment's size in bytes. The *$attachmentindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachmentcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Long64 # BlockedCertCount Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The number of records in the BlockedCert arrays. ## Object Oriented Interface ```text public function getBlockedCertCount(); public function setBlockedCertCount($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 12 ); securepdf_pdfverify_set($res, 12, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [BlockedCertEffectiveDate](#blockedcerteffectivedate-property-securepdf_pdfverify-class) - [BlockedCertEncoded](#blockedcertencoded-property-securepdf_pdfverify-class) - [BlockedCertExpirationDate](#blockedcertexpirationdate-property-securepdf_pdfverify-class) - [BlockedCertExtendedKeyUsage](#blockedcertextendedkeyusage-property-securepdf_pdfverify-class) - [BlockedCertFingerprint](#blockedcertfingerprint-property-securepdf_pdfverify-class) - [BlockedCertFingerprintSHA1](#blockedcertfingerprintsha1-property-securepdf_pdfverify-class) - [BlockedCertFingerprintSHA256](#blockedcertfingerprintsha256-property-securepdf_pdfverify-class) - [BlockedCertIssuer](#blockedcertissuer-property-securepdf_pdfverify-class) - [BlockedCertPrivateKey](#blockedcertprivatekey-property-securepdf_pdfverify-class) - [BlockedCertPrivateKeyAvailable](#blockedcertprivatekeyavailable-property-securepdf_pdfverify-class) - [BlockedCertPrivateKeyContainer](#blockedcertprivatekeycontainer-property-securepdf_pdfverify-class) - [BlockedCertPublicKey](#blockedcertpublickey-property-securepdf_pdfverify-class) - [BlockedCertPublicKeyAlgorithm](#blockedcertpublickeyalgorithm-property-securepdf_pdfverify-class) - [BlockedCertPublicKeyLength](#blockedcertpublickeylength-property-securepdf_pdfverify-class) - [BlockedCertSerialNumber](#blockedcertserialnumber-property-securepdf_pdfverify-class) - [BlockedCertSignatureAlgorithm](#blockedcertsignaturealgorithm-property-securepdf_pdfverify-class) - [BlockedCertStore](#blockedcertstore-property-securepdf_pdfverify-class) - [BlockedCertStorePassword](#blockedcertstorepassword-property-securepdf_pdfverify-class) - [BlockedCertStoreType](#blockedcertstoretype-property-securepdf_pdfverify-class) - [BlockedCertSubject](#blockedcertsubject-property-securepdf_pdfverify-class) - [BlockedCertSubjectAltNames](#blockedcertsubjectaltnames-property-securepdf_pdfverify-class) - [BlockedCertThumbprintMD5](#blockedcertthumbprintmd5-property-securepdf_pdfverify-class) - [BlockedCertThumbprintSHA1](#blockedcertthumbprintsha1-property-securepdf_pdfverify-class) - [BlockedCertThumbprintSHA256](#blockedcertthumbprintsha256-property-securepdf_pdfverify-class) - [BlockedCertUsage](#blockedcertusage-property-securepdf_pdfverify-class) - [BlockedCertUsageFlags](#blockedcertusageflags-property-securepdf_pdfverify-class) - [BlockedCertVersion](#blockedcertversion-property-securepdf_pdfverify-class) The array indices start at *0* and end at *BlockedCertCount - 1*. This property is not available at design time. ## Data Type Integer # BlockedCertEffectiveDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date on which this certificate becomes valid. ## Object Oriented Interface ```text public function getBlockedCertEffectiveDate($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 13 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertExpirationDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date on which the certificate expires. ## Object Oriented Interface ```text public function getBlockedCertExpirationDate($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 14 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertExtendedKeyUsage Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A comma-delimited list of extended key usage identifiers. ## Object Oriented Interface ```text public function getBlockedCertExtendedKeyUsage($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 15 , $blockedcertindex); ``` ## Default Value '' ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertFingerprint Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Object Oriented Interface ```text public function getBlockedCertFingerprint($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 16 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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* The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertFingerprintSHA1 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Object Oriented Interface ```text public function getBlockedCertFingerprintSHA1($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 17 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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* The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertFingerprintSHA256 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Object Oriented Interface ```text public function getBlockedCertFingerprintSHA256($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 18 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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* The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertIssuer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The issuer of the certificate. ## Object Oriented Interface ```text public function getBlockedCertIssuer($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 19 , $blockedcertindex); ``` ## Default Value '' ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertPrivateKey Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The private key of the certificate (if available). ## Object Oriented Interface ```text public function getBlockedCertPrivateKey($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 20 , $blockedcertindex); ``` ## Default Value '' ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [BlockedCertPrivateKey](#blockedcertprivatekey-property-securepdf_pdfverify-class) may be available but not exportable. In this case, [BlockedCertPrivateKey](#blockedcertprivatekey-property-securepdf_pdfverify-class) returns an empty string. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertPrivateKeyAvailable Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Whether a PrivateKey is available for the selected certificate. ## Object Oriented Interface ```text public function getBlockedCertPrivateKeyAvailable($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 21 , $blockedcertindex); ``` ## Default Value false ## Remarks Whether a [BlockedCertPrivateKey](#blockedcertprivatekey-property-securepdf_pdfverify-class) is available for the selected certificate. If [BlockedCertPrivateKeyAvailable](#blockedcertprivatekeyavailable-property-securepdf_pdfverify-class) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Boolean # BlockedCertPrivateKeyContainer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the PrivateKey container for the certificate (if available). ## Object Oriented Interface ```text public function getBlockedCertPrivateKeyContainer($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 22 , $blockedcertindex); ``` ## Default Value '' ## Remarks The name of the [BlockedCertPrivateKey](#blockedcertprivatekey-property-securepdf_pdfverify-class) container for the certificate (if available). This functionality is available only on Windows platforms. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertPublicKey Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The public key of the certificate. ## Object Oriented Interface ```text public function getBlockedCertPublicKey($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 23 , $blockedcertindex); ``` ## Default Value '' ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertPublicKeyAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The textual description of the certificate's public key algorithm. ## Object Oriented Interface ```text public function getBlockedCertPublicKeyAlgorithm($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 24 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertPublicKeyLength Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The length of the certificate's public key (in bits). ## Object Oriented Interface ```text public function getBlockedCertPublicKeyLength($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 25 , $blockedcertindex); ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # BlockedCertSerialNumber Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The serial number of the certificate encoded as a string. ## Object Oriented Interface ```text public function getBlockedCertSerialNumber($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 26 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertSignatureAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The text description of the certificate's signature algorithm. ## Object Oriented Interface ```text public function getBlockedCertSignatureAlgorithm($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 27 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertStore Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the certificate store for the client certificate. ## Object Oriented Interface ```text public function getBlockedCertStore($blockedcertindex); public function setBlockedCertStore($blockedcertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 28 , $blockedcertindex); securepdf_pdfverify_set($res, 28, $value , $blockedcertindex); ``` ## Default Value 'MY' ## Remarks The name of the certificate store for the client certificate. The [BlockedCertStoreType](#blockedcertstoretype-property-securepdf_pdfverify-class) property denotes the type of the certificate store specified by [BlockedCertStore](#blockedcertstore-property-securepdf_pdfverify-class). If the store is password-protected, specify the password in [BlockedCertStorePassword](#blockedcertstorepassword-property-securepdf_pdfverify-class). [BlockedCertStore](#blockedcertstore-property-securepdf_pdfverify-class) is used in conjunction with the [BlockedCertSubject](#blockedcertsubject-property-securepdf_pdfverify-class) property to specify client certificates. If [BlockedCertStore](#blockedcertstore-property-securepdf_pdfverify-class) has a value, and [BlockedCertSubject](#blockedcertsubject-property-securepdf_pdfverify-class) or [BlockedCertEncoded](#blockedcertencoded-property-securepdf_pdfverify-class) is set, a search for a certificate is initiated. Please see the [BlockedCertSubject](#blockedcertsubject-property-securepdf_pdfverify-class) property 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. | 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). The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type Binary String # BlockedCertStorePassword Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Object Oriented Interface ```text public function getBlockedCertStorePassword($blockedcertindex); public function setBlockedCertStorePassword($blockedcertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 29 , $blockedcertindex); securepdf_pdfverify_set($res, 29, $value , $blockedcertindex); ``` ## Default Value '' ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # BlockedCertStoreType Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The type of certificate store for this certificate. ## Object Oriented Interface ```text public function getBlockedCertStoreType($blockedcertindex); public function setBlockedCertStoreType($blockedcertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 30 , $blockedcertindex); securepdf_pdfverify_set($res, 30, $value , $blockedcertindex); ``` ## Possible Values ```text PDFVERIFY_BLOCKEDCERTSTORETYPE_USER(0), PDFVERIFY_BLOCKEDCERTSTORETYPE_MACHINE(1), PDFVERIFY_BLOCKEDCERTSTORETYPE_PFXFILE(2), PDFVERIFY_BLOCKEDCERTSTORETYPE_PFXBLOB(3), PDFVERIFY_BLOCKEDCERTSTORETYPE_JKSFILE(4), PDFVERIFY_BLOCKEDCERTSTORETYPE_JKSBLOB(5), PDFVERIFY_BLOCKEDCERTSTORETYPE_PEMKEY_FILE(6), PDFVERIFY_BLOCKEDCERTSTORETYPE_PEMKEY_BLOB(7), PDFVERIFY_BLOCKEDCERTSTORETYPE_PUBLIC_KEY_FILE(8), PDFVERIFY_BLOCKEDCERTSTORETYPE_PUBLIC_KEY_BLOB(9), PDFVERIFY_BLOCKEDCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), PDFVERIFY_BLOCKEDCERTSTORETYPE_P7BFILE(11), PDFVERIFY_BLOCKEDCERTSTORETYPE_P7BBLOB(12), PDFVERIFY_BLOCKEDCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), PDFVERIFY_BLOCKEDCERTSTORETYPE_PPKFILE(14), PDFVERIFY_BLOCKEDCERTSTORETYPE_PPKBLOB(15), PDFVERIFY_BLOCKEDCERTSTORETYPE_XMLFILE(16), PDFVERIFY_BLOCKEDCERTSTORETYPE_XMLBLOB(17), PDFVERIFY_BLOCKEDCERTSTORETYPE_JWKFILE(18), PDFVERIFY_BLOCKEDCERTSTORETYPE_JWKBLOB(19), PDFVERIFY_BLOCKEDCERTSTORETYPE_SECURITY_KEY(20), PDFVERIFY_BLOCKEDCERTSTORETYPE_BCFKSFILE(21), PDFVERIFY_BLOCKEDCERTSTORETYPE_BCFKSBLOB(22), PDFVERIFY_BLOCKEDCERTSTORETYPE_PKCS11(23), PDFVERIFY_BLOCKEDCERTSTORETYPE_AUTO(99) ``` ## Default Value 0 ## Remarks 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 property 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](#Type_Certificate) object and pass cstPKCS11 as the [BlockedCertStoreType](#blockedcertstoretype-property-securepdf_pdfverify-class), the full path of the PKCS#11 DLL as the [BlockedCertStore](#blockedcertstore-property-securepdf_pdfverify-class), and the PIN as the [BlockedCertStorePassword](#blockedcertstorepassword-property-securepdf_pdfverify-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [BlockedCertStore](#blockedcertstore-property-securepdf_pdfverify-class) and set [BlockedCertStorePassword](#blockedcertstorepassword-property-securepdf_pdfverify-class) 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. | The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type Integer # BlockedCertSubjectAltNames Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Comma-separated lists of alternative subject names for the certificate. ## Object Oriented Interface ```text public function getBlockedCertSubjectAltNames($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 31 , $blockedcertindex); ``` ## Default Value '' ## Remarks Comma-separated lists of alternative subject names for the certificate. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertThumbprintMD5 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The MD5 hash of the certificate. ## Object Oriented Interface ```text public function getBlockedCertThumbprintMD5($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 32 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertThumbprintSHA1 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The SHA-1 hash of the certificate. ## Object Oriented Interface ```text public function getBlockedCertThumbprintSHA1($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 33 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertThumbprintSHA256 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The SHA-256 hash of the certificate. ## Object Oriented Interface ```text public function getBlockedCertThumbprintSHA256($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 34 , $blockedcertindex); ``` ## Default Value '' ## Remarks 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. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertUsage Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The text description of UsageFlags . ## Object Oriented Interface ```text public function getBlockedCertUsage($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 35 , $blockedcertindex); ``` ## Default Value '' ## Remarks The text description of [BlockedCertUsageFlags](#blockedcertusageflags-property-securepdf_pdfverify-class). 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. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertUsageFlags Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The flags that show intended use for the certificate. ## Object Oriented Interface ```text public function getBlockedCertUsageFlags($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 36 , $blockedcertindex); ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [BlockedCertUsageFlags](#blockedcertusageflags-property-securepdf_pdfverify-class) 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 [BlockedCertUsage](#blockedcertusage-property-securepdf_pdfverify-class) property for a text representation of [BlockedCertUsageFlags](#blockedcertusageflags-property-securepdf_pdfverify-class). This functionality currently is not available when the provider is OpenSSL. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # BlockedCertVersion Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certificate's version number. ## Object Oriented Interface ```text public function getBlockedCertVersion($blockedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 37 , $blockedcertindex); ``` ## Default Value '' ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # BlockedCertSubject Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The subject of the certificate used for client authentication. ## Object Oriented Interface ```text public function getBlockedCertSubject($blockedcertindex); public function setBlockedCertSubject($blockedcertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 38 , $blockedcertindex); securepdf_pdfverify_set($res, 38, $value , $blockedcertindex); ``` ## Default Value '' ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. 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. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # BlockedCertEncoded Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certificate (PEM/Base64 encoded). ## Object Oriented Interface ```text public function getBlockedCertEncoded($blockedcertindex); public function setBlockedCertEncoded($blockedcertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 39 , $blockedcertindex); securepdf_pdfverify_set($res, 39, $value , $blockedcertindex); ``` ## Default Value '' ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [BlockedCertStore](#blockedcertstore-property-securepdf_pdfverify-class) and [BlockedCertSubject](#blockedcertsubject-property-securepdf_pdfverify-class) properties also may be used to specify a certificate. When [BlockedCertEncoded](#blockedcertencoded-property-securepdf_pdfverify-class) is set, a search is initiated in the current [BlockedCertStore](#blockedcertstore-property-securepdf_pdfverify-class) for the private key of the certificate. If the key is found, [BlockedCertSubject](#blockedcertsubject-property-securepdf_pdfverify-class) is updated to reflect the full subject of the selected certificate; otherwise, [BlockedCertSubject](#blockedcertsubject-property-securepdf_pdfverify-class) is set to an empty string. The *$blockedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type Binary String # DecryptionCertEffectiveDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date on which this certificate becomes valid. ## Object Oriented Interface ```text public function getDecryptionCertEffectiveDate(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 40 ); ``` ## Default Value '' ## Remarks 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. This property is read-only and not available at design time. ## Data Type String # DecryptionCertExpirationDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date on which the certificate expires. ## Object Oriented Interface ```text public function getDecryptionCertExpirationDate(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 41 ); ``` ## Default Value '' ## Remarks 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. This property is read-only and not available at design time. ## Data Type String # DecryptionCertExtendedKeyUsage Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A comma-delimited list of extended key usage identifiers. ## Object Oriented Interface ```text public function getDecryptionCertExtendedKeyUsage(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 42 ); ``` ## Default Value '' ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only and not available at design time. ## Data Type String # DecryptionCertFingerprint Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertFingerprint(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 43 ); ``` ## Default Value '' ## Remarks 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* This property is read-only and not available at design time. ## Data Type String # DecryptionCertFingerprintSHA1 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertFingerprintSHA1(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 44 ); ``` ## Default Value '' ## Remarks 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* This property is read-only and not available at design time. ## Data Type String # DecryptionCertFingerprintSHA256 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertFingerprintSHA256(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 45 ); ``` ## Default Value '' ## Remarks 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* This property is read-only and not available at design time. ## Data Type String # DecryptionCertIssuer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The issuer of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertIssuer(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 46 ); ``` ## Default Value '' ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only and not available at design time. ## Data Type String # DecryptionCertPrivateKey Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The private key of the certificate (if available). ## Object Oriented Interface ```text public function getDecryptionCertPrivateKey(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 47 ); ``` ## Default Value '' ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [DecryptionCertPrivateKey](#decryptioncertprivatekey-property-securepdf_pdfverify-class) may be available but not exportable. In this case, [DecryptionCertPrivateKey](#decryptioncertprivatekey-property-securepdf_pdfverify-class) returns an empty string. This property is read-only and not available at design time. ## Data Type String # DecryptionCertPrivateKeyAvailable Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Whether a PrivateKey is available for the selected certificate. ## Object Oriented Interface ```text public function getDecryptionCertPrivateKeyAvailable(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 48 ); ``` ## Default Value false ## Remarks Whether a [DecryptionCertPrivateKey](#decryptioncertprivatekey-property-securepdf_pdfverify-class) is available for the selected certificate. If [DecryptionCertPrivateKeyAvailable](#decryptioncertprivatekeyavailable-property-securepdf_pdfverify-class) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only and not available at design time. ## Data Type Boolean # DecryptionCertPrivateKeyContainer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the PrivateKey container for the certificate (if available). ## Object Oriented Interface ```text public function getDecryptionCertPrivateKeyContainer(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 49 ); ``` ## Default Value '' ## Remarks The name of the [DecryptionCertPrivateKey](#decryptioncertprivatekey-property-securepdf_pdfverify-class) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only and not available at design time. ## Data Type String # DecryptionCertPublicKey Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The public key of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertPublicKey(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 50 ); ``` ## Default Value '' ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only and not available at design time. ## Data Type String # DecryptionCertPublicKeyAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The textual description of the certificate's public key algorithm. ## Object Oriented Interface ```text public function getDecryptionCertPublicKeyAlgorithm(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 51 ); ``` ## Default Value '' ## Remarks 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. This property is read-only and not available at design time. ## Data Type String # DecryptionCertPublicKeyLength Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The length of the certificate's public key (in bits). ## Object Oriented Interface ```text public function getDecryptionCertPublicKeyLength(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 52 ); ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only and not available at design time. ## Data Type Integer # DecryptionCertSerialNumber Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The serial number of the certificate encoded as a string. ## Object Oriented Interface ```text public function getDecryptionCertSerialNumber(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 53 ); ``` ## Default Value '' ## Remarks 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. This property is read-only and not available at design time. ## Data Type String # DecryptionCertSignatureAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The text description of the certificate's signature algorithm. ## Object Oriented Interface ```text public function getDecryptionCertSignatureAlgorithm(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 54 ); ``` ## Default Value '' ## Remarks 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. This property is read-only and not available at design time. ## Data Type String # DecryptionCertStore Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the certificate store for the client certificate. ## Object Oriented Interface ```text public function getDecryptionCertStore(); public function setDecryptionCertStore($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 55 ); securepdf_pdfverify_set($res, 55, $value ); ``` ## Default Value 'MY' ## Remarks The name of the certificate store for the client certificate. The [DecryptionCertStoreType](#decryptioncertstoretype-property-securepdf_pdfverify-class) property denotes the type of the certificate store specified by [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfverify-class). If the store is password-protected, specify the password in [DecryptionCertStorePassword](#decryptioncertstorepassword-property-securepdf_pdfverify-class). [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfverify-class) is used in conjunction with the [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfverify-class) property to specify client certificates. If [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfverify-class) has a value, and [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfverify-class) or [DecryptionCertEncoded](#decryptioncertencoded-property-securepdf_pdfverify-class) is set, a search for a certificate is initiated. Please see the [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfverify-class) property 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. | 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). This property is not available at design time. ## Data Type Binary String # DecryptionCertStorePassword Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Object Oriented Interface ```text public function getDecryptionCertStorePassword(); public function setDecryptionCertStorePassword($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 56 ); securepdf_pdfverify_set($res, 56, $value ); ``` ## Default Value '' ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. This property is not available at design time. ## Data Type String # DecryptionCertStoreType Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The type of certificate store for this certificate. ## Object Oriented Interface ```text public function getDecryptionCertStoreType(); public function setDecryptionCertStoreType($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 57 ); securepdf_pdfverify_set($res, 57, $value ); ``` ## Possible Values ```text PDFVERIFY_DECRYPTIONCERTSTORETYPE_USER(0), PDFVERIFY_DECRYPTIONCERTSTORETYPE_MACHINE(1), PDFVERIFY_DECRYPTIONCERTSTORETYPE_PFXFILE(2), PDFVERIFY_DECRYPTIONCERTSTORETYPE_PFXBLOB(3), PDFVERIFY_DECRYPTIONCERTSTORETYPE_JKSFILE(4), PDFVERIFY_DECRYPTIONCERTSTORETYPE_JKSBLOB(5), PDFVERIFY_DECRYPTIONCERTSTORETYPE_PEMKEY_FILE(6), PDFVERIFY_DECRYPTIONCERTSTORETYPE_PEMKEY_BLOB(7), PDFVERIFY_DECRYPTIONCERTSTORETYPE_PUBLIC_KEY_FILE(8), PDFVERIFY_DECRYPTIONCERTSTORETYPE_PUBLIC_KEY_BLOB(9), PDFVERIFY_DECRYPTIONCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), PDFVERIFY_DECRYPTIONCERTSTORETYPE_P7BFILE(11), PDFVERIFY_DECRYPTIONCERTSTORETYPE_P7BBLOB(12), PDFVERIFY_DECRYPTIONCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), PDFVERIFY_DECRYPTIONCERTSTORETYPE_PPKFILE(14), PDFVERIFY_DECRYPTIONCERTSTORETYPE_PPKBLOB(15), PDFVERIFY_DECRYPTIONCERTSTORETYPE_XMLFILE(16), PDFVERIFY_DECRYPTIONCERTSTORETYPE_XMLBLOB(17), PDFVERIFY_DECRYPTIONCERTSTORETYPE_JWKFILE(18), PDFVERIFY_DECRYPTIONCERTSTORETYPE_JWKBLOB(19), PDFVERIFY_DECRYPTIONCERTSTORETYPE_SECURITY_KEY(20), PDFVERIFY_DECRYPTIONCERTSTORETYPE_BCFKSFILE(21), PDFVERIFY_DECRYPTIONCERTSTORETYPE_BCFKSBLOB(22), PDFVERIFY_DECRYPTIONCERTSTORETYPE_PKCS11(23), PDFVERIFY_DECRYPTIONCERTSTORETYPE_AUTO(99) ``` ## Default Value 0 ## Remarks 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 property 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](#Type_Certificate) object and pass cstPKCS11 as the [DecryptionCertStoreType](#decryptioncertstoretype-property-securepdf_pdfverify-class), the full path of the PKCS#11 DLL as the [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfverify-class), and the PIN as the [DecryptionCertStorePassword](#decryptioncertstorepassword-property-securepdf_pdfverify-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfverify-class) and set [DecryptionCertStorePassword](#decryptioncertstorepassword-property-securepdf_pdfverify-class) 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. | This property is not available at design time. ## Data Type Integer # DecryptionCertSubjectAltNames Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Comma-separated lists of alternative subject names for the certificate. ## Object Oriented Interface ```text public function getDecryptionCertSubjectAltNames(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 58 ); ``` ## Default Value '' ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only and not available at design time. ## Data Type String # DecryptionCertThumbprintMD5 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The MD5 hash of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertThumbprintMD5(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 59 ); ``` ## Default Value '' ## Remarks 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. This property is read-only and not available at design time. ## Data Type String # DecryptionCertThumbprintSHA1 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The SHA-1 hash of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertThumbprintSHA1(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 60 ); ``` ## Default Value '' ## Remarks 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. This property is read-only and not available at design time. ## Data Type String # DecryptionCertThumbprintSHA256 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The SHA-256 hash of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertThumbprintSHA256(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 61 ); ``` ## Default Value '' ## Remarks 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. This property is read-only and not available at design time. ## Data Type String # DecryptionCertUsage Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The text description of UsageFlags . ## Object Oriented Interface ```text public function getDecryptionCertUsage(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 62 ); ``` ## Default Value '' ## Remarks The text description of [DecryptionCertUsageFlags](#decryptioncertusageflags-property-securepdf_pdfverify-class). 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. This property is read-only and not available at design time. ## Data Type String # DecryptionCertUsageFlags Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The flags that show intended use for the certificate. ## Object Oriented Interface ```text public function getDecryptionCertUsageFlags(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 63 ); ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [DecryptionCertUsageFlags](#decryptioncertusageflags-property-securepdf_pdfverify-class) 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 [DecryptionCertUsage](#decryptioncertusage-property-securepdf_pdfverify-class) property for a text representation of [DecryptionCertUsageFlags](#decryptioncertusageflags-property-securepdf_pdfverify-class). This functionality currently is not available when the provider is OpenSSL. This property is read-only and not available at design time. ## Data Type Integer # DecryptionCertVersion Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certificate's version number. ## Object Oriented Interface ```text public function getDecryptionCertVersion(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 64 ); ``` ## Default Value '' ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only and not available at design time. ## Data Type String # DecryptionCertSubject Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The subject of the certificate used for client authentication. ## Object Oriented Interface ```text public function getDecryptionCertSubject(); public function setDecryptionCertSubject($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 65 ); securepdf_pdfverify_set($res, 65, $value ); ``` ## Default Value '' ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. 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. This property is not available at design time. ## Data Type String # DecryptionCertEncoded Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certificate (PEM/Base64 encoded). ## Object Oriented Interface ```text public function getDecryptionCertEncoded(); public function setDecryptionCertEncoded($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 66 ); securepdf_pdfverify_set($res, 66, $value ); ``` ## Default Value '' ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfverify-class) and [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfverify-class) properties also may be used to specify a certificate. When [DecryptionCertEncoded](#decryptioncertencoded-property-securepdf_pdfverify-class) is set, a search is initiated in the current [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfverify-class) for the private key of the certificate. If the key is found, [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfverify-class) is updated to reflect the full subject of the selected certificate; otherwise, [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfverify-class) is set to an empty string. This property is not available at design time. ## Data Type Binary String # DocumentCertCount Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The number of records in the DocumentCert arrays. ## Object Oriented Interface ```text public function getDocumentCertCount(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 67 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [DocumentCertEffectiveDate](#documentcerteffectivedate-property-securepdf_pdfverify-class) - [DocumentCertEncoded](#documentcertencoded-property-securepdf_pdfverify-class) - [DocumentCertExpirationDate](#documentcertexpirationdate-property-securepdf_pdfverify-class) - [DocumentCertExtendedKeyUsage](#documentcertextendedkeyusage-property-securepdf_pdfverify-class) - [DocumentCertFingerprint](#documentcertfingerprint-property-securepdf_pdfverify-class) - [DocumentCertFingerprintSHA1](#documentcertfingerprintsha1-property-securepdf_pdfverify-class) - [DocumentCertFingerprintSHA256](#documentcertfingerprintsha256-property-securepdf_pdfverify-class) - [DocumentCertIssuer](#documentcertissuer-property-securepdf_pdfverify-class) - [DocumentCertPrivateKey](#documentcertprivatekey-property-securepdf_pdfverify-class) - [DocumentCertPrivateKeyAvailable](#documentcertprivatekeyavailable-property-securepdf_pdfverify-class) - [DocumentCertPrivateKeyContainer](#documentcertprivatekeycontainer-property-securepdf_pdfverify-class) - [DocumentCertPublicKey](#documentcertpublickey-property-securepdf_pdfverify-class) - [DocumentCertPublicKeyAlgorithm](#documentcertpublickeyalgorithm-property-securepdf_pdfverify-class) - [DocumentCertPublicKeyLength](#documentcertpublickeylength-property-securepdf_pdfverify-class) - [DocumentCertSerialNumber](#documentcertserialnumber-property-securepdf_pdfverify-class) - [DocumentCertSignatureAlgorithm](#documentcertsignaturealgorithm-property-securepdf_pdfverify-class) - [DocumentCertStore](#documentcertstore-property-securepdf_pdfverify-class) - [DocumentCertStorePassword](#documentcertstorepassword-property-securepdf_pdfverify-class) - [DocumentCertStoreType](#documentcertstoretype-property-securepdf_pdfverify-class) - [DocumentCertSubject](#documentcertsubject-property-securepdf_pdfverify-class) - [DocumentCertSubjectAltNames](#documentcertsubjectaltnames-property-securepdf_pdfverify-class) - [DocumentCertThumbprintMD5](#documentcertthumbprintmd5-property-securepdf_pdfverify-class) - [DocumentCertThumbprintSHA1](#documentcertthumbprintsha1-property-securepdf_pdfverify-class) - [DocumentCertThumbprintSHA256](#documentcertthumbprintsha256-property-securepdf_pdfverify-class) - [DocumentCertUsage](#documentcertusage-property-securepdf_pdfverify-class) - [DocumentCertUsageFlags](#documentcertusageflags-property-securepdf_pdfverify-class) - [DocumentCertVersion](#documentcertversion-property-securepdf_pdfverify-class) The array indices start at *0* and end at *DocumentCertCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # DocumentCertEffectiveDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date on which this certificate becomes valid. ## Object Oriented Interface ```text public function getDocumentCertEffectiveDate($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 68 , $documentcertindex); ``` ## Default Value '' ## Remarks 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. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertExpirationDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date on which the certificate expires. ## Object Oriented Interface ```text public function getDocumentCertExpirationDate($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 69 , $documentcertindex); ``` ## Default Value '' ## Remarks 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. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertExtendedKeyUsage Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A comma-delimited list of extended key usage identifiers. ## Object Oriented Interface ```text public function getDocumentCertExtendedKeyUsage($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 70 , $documentcertindex); ``` ## Default Value '' ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertFingerprint Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Object Oriented Interface ```text public function getDocumentCertFingerprint($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 71 , $documentcertindex); ``` ## Default Value '' ## Remarks 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* The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertFingerprintSHA1 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Object Oriented Interface ```text public function getDocumentCertFingerprintSHA1($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 72 , $documentcertindex); ``` ## Default Value '' ## Remarks 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* The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertFingerprintSHA256 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Object Oriented Interface ```text public function getDocumentCertFingerprintSHA256($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 73 , $documentcertindex); ``` ## Default Value '' ## Remarks 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* The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertIssuer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The issuer of the certificate. ## Object Oriented Interface ```text public function getDocumentCertIssuer($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 74 , $documentcertindex); ``` ## Default Value '' ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertPrivateKey Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The private key of the certificate (if available). ## Object Oriented Interface ```text public function getDocumentCertPrivateKey($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 75 , $documentcertindex); ``` ## Default Value '' ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [DocumentCertPrivateKey](#documentcertprivatekey-property-securepdf_pdfverify-class) may be available but not exportable. In this case, [DocumentCertPrivateKey](#documentcertprivatekey-property-securepdf_pdfverify-class) returns an empty string. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertPrivateKeyAvailable Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Whether a PrivateKey is available for the selected certificate. ## Object Oriented Interface ```text public function getDocumentCertPrivateKeyAvailable($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 76 , $documentcertindex); ``` ## Default Value false ## Remarks Whether a [DocumentCertPrivateKey](#documentcertprivatekey-property-securepdf_pdfverify-class) is available for the selected certificate. If [DocumentCertPrivateKeyAvailable](#documentcertprivatekeyavailable-property-securepdf_pdfverify-class) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Boolean # DocumentCertPrivateKeyContainer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the PrivateKey container for the certificate (if available). ## Object Oriented Interface ```text public function getDocumentCertPrivateKeyContainer($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 77 , $documentcertindex); ``` ## Default Value '' ## Remarks The name of the [DocumentCertPrivateKey](#documentcertprivatekey-property-securepdf_pdfverify-class) container for the certificate (if available). This functionality is available only on Windows platforms. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertPublicKey Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The public key of the certificate. ## Object Oriented Interface ```text public function getDocumentCertPublicKey($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 78 , $documentcertindex); ``` ## Default Value '' ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertPublicKeyAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The textual description of the certificate's public key algorithm. ## Object Oriented Interface ```text public function getDocumentCertPublicKeyAlgorithm($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 79 , $documentcertindex); ``` ## Default Value '' ## Remarks 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. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertPublicKeyLength Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The length of the certificate's public key (in bits). ## Object Oriented Interface ```text public function getDocumentCertPublicKeyLength($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 80 , $documentcertindex); ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # DocumentCertSerialNumber Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The serial number of the certificate encoded as a string. ## Object Oriented Interface ```text public function getDocumentCertSerialNumber($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 81 , $documentcertindex); ``` ## Default Value '' ## Remarks 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. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertSignatureAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The text description of the certificate's signature algorithm. ## Object Oriented Interface ```text public function getDocumentCertSignatureAlgorithm($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 82 , $documentcertindex); ``` ## Default Value '' ## Remarks 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. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertStore Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the certificate store for the client certificate. ## Object Oriented Interface ```text public function getDocumentCertStore($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 83 , $documentcertindex); ``` ## Default Value 'MY' ## Remarks The name of the certificate store for the client certificate. The [DocumentCertStoreType](#documentcertstoretype-property-securepdf_pdfverify-class) property denotes the type of the certificate store specified by [DocumentCertStore](#documentcertstore-property-securepdf_pdfverify-class). If the store is password-protected, specify the password in [DocumentCertStorePassword](#documentcertstorepassword-property-securepdf_pdfverify-class). [DocumentCertStore](#documentcertstore-property-securepdf_pdfverify-class) is used in conjunction with the [DocumentCertSubject](#documentcertsubject-property-securepdf_pdfverify-class) property to specify client certificates. If [DocumentCertStore](#documentcertstore-property-securepdf_pdfverify-class) has a value, and [DocumentCertSubject](#documentcertsubject-property-securepdf_pdfverify-class) or [DocumentCertEncoded](#documentcertencoded-property-securepdf_pdfverify-class) is set, a search for a certificate is initiated. Please see the [DocumentCertSubject](#documentcertsubject-property-securepdf_pdfverify-class) property 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. | 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). The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Binary String # DocumentCertStorePassword Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Object Oriented Interface ```text public function getDocumentCertStorePassword($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 84 , $documentcertindex); ``` ## Default Value '' ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertStoreType Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The type of certificate store for this certificate. ## Object Oriented Interface ```text public function getDocumentCertStoreType($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 85 , $documentcertindex); ``` ## Possible Values ```text PDFVERIFY_DOCUMENTCERTSTORETYPE_USER(0), PDFVERIFY_DOCUMENTCERTSTORETYPE_MACHINE(1), PDFVERIFY_DOCUMENTCERTSTORETYPE_PFXFILE(2), PDFVERIFY_DOCUMENTCERTSTORETYPE_PFXBLOB(3), PDFVERIFY_DOCUMENTCERTSTORETYPE_JKSFILE(4), PDFVERIFY_DOCUMENTCERTSTORETYPE_JKSBLOB(5), PDFVERIFY_DOCUMENTCERTSTORETYPE_PEMKEY_FILE(6), PDFVERIFY_DOCUMENTCERTSTORETYPE_PEMKEY_BLOB(7), PDFVERIFY_DOCUMENTCERTSTORETYPE_PUBLIC_KEY_FILE(8), PDFVERIFY_DOCUMENTCERTSTORETYPE_PUBLIC_KEY_BLOB(9), PDFVERIFY_DOCUMENTCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), PDFVERIFY_DOCUMENTCERTSTORETYPE_P7BFILE(11), PDFVERIFY_DOCUMENTCERTSTORETYPE_P7BBLOB(12), PDFVERIFY_DOCUMENTCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), PDFVERIFY_DOCUMENTCERTSTORETYPE_PPKFILE(14), PDFVERIFY_DOCUMENTCERTSTORETYPE_PPKBLOB(15), PDFVERIFY_DOCUMENTCERTSTORETYPE_XMLFILE(16), PDFVERIFY_DOCUMENTCERTSTORETYPE_XMLBLOB(17), PDFVERIFY_DOCUMENTCERTSTORETYPE_JWKFILE(18), PDFVERIFY_DOCUMENTCERTSTORETYPE_JWKBLOB(19), PDFVERIFY_DOCUMENTCERTSTORETYPE_SECURITY_KEY(20), PDFVERIFY_DOCUMENTCERTSTORETYPE_BCFKSFILE(21), PDFVERIFY_DOCUMENTCERTSTORETYPE_BCFKSBLOB(22), PDFVERIFY_DOCUMENTCERTSTORETYPE_PKCS11(23), PDFVERIFY_DOCUMENTCERTSTORETYPE_AUTO(99) ``` ## Default Value 0 ## Remarks 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 property 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](#Type_Certificate) object and pass cstPKCS11 as the [DocumentCertStoreType](#documentcertstoretype-property-securepdf_pdfverify-class), the full path of the PKCS#11 DLL as the [DocumentCertStore](#documentcertstore-property-securepdf_pdfverify-class), and the PIN as the [DocumentCertStorePassword](#documentcertstorepassword-property-securepdf_pdfverify-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [DocumentCertStore](#documentcertstore-property-securepdf_pdfverify-class) and set [DocumentCertStorePassword](#documentcertstorepassword-property-securepdf_pdfverify-class) 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. | The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # DocumentCertSubjectAltNames Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Comma-separated lists of alternative subject names for the certificate. ## Object Oriented Interface ```text public function getDocumentCertSubjectAltNames($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 86 , $documentcertindex); ``` ## Default Value '' ## Remarks Comma-separated lists of alternative subject names for the certificate. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertThumbprintMD5 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The MD5 hash of the certificate. ## Object Oriented Interface ```text public function getDocumentCertThumbprintMD5($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 87 , $documentcertindex); ``` ## Default Value '' ## Remarks 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. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertThumbprintSHA1 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The SHA-1 hash of the certificate. ## Object Oriented Interface ```text public function getDocumentCertThumbprintSHA1($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 88 , $documentcertindex); ``` ## Default Value '' ## Remarks 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. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertThumbprintSHA256 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The SHA-256 hash of the certificate. ## Object Oriented Interface ```text public function getDocumentCertThumbprintSHA256($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 89 , $documentcertindex); ``` ## Default Value '' ## Remarks 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. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertUsage Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The text description of UsageFlags . ## Object Oriented Interface ```text public function getDocumentCertUsage($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 90 , $documentcertindex); ``` ## Default Value '' ## Remarks The text description of [DocumentCertUsageFlags](#documentcertusageflags-property-securepdf_pdfverify-class). 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. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertUsageFlags Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The flags that show intended use for the certificate. ## Object Oriented Interface ```text public function getDocumentCertUsageFlags($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 91 , $documentcertindex); ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [DocumentCertUsageFlags](#documentcertusageflags-property-securepdf_pdfverify-class) 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 [DocumentCertUsage](#documentcertusage-property-securepdf_pdfverify-class) property for a text representation of [DocumentCertUsageFlags](#documentcertusageflags-property-securepdf_pdfverify-class). This functionality currently is not available when the provider is OpenSSL. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # DocumentCertVersion Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certificate's version number. ## Object Oriented Interface ```text public function getDocumentCertVersion($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 92 , $documentcertindex); ``` ## Default Value '' ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertSubject Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The subject of the certificate used for client authentication. ## Object Oriented Interface ```text public function getDocumentCertSubject($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 93 , $documentcertindex); ``` ## Default Value '' ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. 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. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # DocumentCertEncoded Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certificate (PEM/Base64 encoded). ## Object Oriented Interface ```text public function getDocumentCertEncoded($documentcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 94 , $documentcertindex); ``` ## Default Value '' ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [DocumentCertStore](#documentcertstore-property-securepdf_pdfverify-class) and [DocumentCertSubject](#documentcertsubject-property-securepdf_pdfverify-class) properties also may be used to specify a certificate. When [DocumentCertEncoded](#documentcertencoded-property-securepdf_pdfverify-class) is set, a search is initiated in the current [DocumentCertStore](#documentcertstore-property-securepdf_pdfverify-class) for the private key of the certificate. If the key is found, [DocumentCertSubject](#documentcertsubject-property-securepdf_pdfverify-class) is updated to reflect the full subject of the selected certificate; otherwise, [DocumentCertSubject](#documentcertsubject-property-securepdf_pdfverify-class) is set to an empty string. The *$documentcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DocumentCertCount](#documentcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Binary String # FirewallAutoDetect Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Whether to automatically detect and use firewall system settings, if available. ## Object Oriented Interface ```text public function getFirewallAutoDetect(); public function setFirewallAutoDetect($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 95 ); securepdf_pdfverify_set($res, 95, $value ); ``` ## Default Value false ## Remarks Whether to automatically detect and use firewall system settings, if available. ## Data Type Boolean # FirewallType Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The type of firewall to connect through. ## Object Oriented Interface ```text public function getFirewallType(); public function setFirewallType($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 96 ); securepdf_pdfverify_set($res, 96, $value ); ``` ## Possible Values ```text PDFVERIFY_FIREWALLTYPE_NONE(0), PDFVERIFY_FIREWALLTYPE_TUNNEL(1), PDFVERIFY_FIREWALLTYPE_SOCKS4(2), PDFVERIFY_FIREWALLTYPE_SOCKS5(3), PDFVERIFY_FIREWALLTYPE_SOCKS4A(10) ``` ## Default Value 0 ## Remarks 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. [FirewallPort](#firewallport-property-securepdf_pdfverify-class) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [FirewallPort](#firewallport-property-securepdf_pdfverify-class) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [FirewallPort](#firewallport-property-securepdf_pdfverify-class) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [FirewallPort](#firewallport-property-securepdf_pdfverify-class) is set to 1080. | ## Data Type Integer # FirewallHost Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name or IP address of the firewall (optional). ## Object Oriented Interface ```text public function getFirewallHost(); public function setFirewallHost($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 97 ); securepdf_pdfverify_set($res, 97, $value ); ``` ## Default Value '' ## Remarks The name or IP address of the firewall (optional). If a [FirewallHost](#firewallhost-property-securepdf_pdfverify-class) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error. ## Data Type String # FirewallPassword Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A password if authentication is to be used when connecting through the firewall. ## Object Oriented Interface ```text public function getFirewallPassword(); public function setFirewallPassword($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 98 ); securepdf_pdfverify_set($res, 98, $value ); ``` ## Default Value '' ## Remarks A password if authentication is to be used when connecting through the firewall. If [FirewallHost](#firewallhost-property-securepdf_pdfverify-class) is specified, the [FirewallUser](#firewalluser-property-securepdf_pdfverify-class) and [FirewallPassword](#firewallpassword-property-securepdf_pdfverify-class) properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. ## Data Type String # FirewallPort Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The Transmission Control Protocol (TCP) port for the firewall Host . ## Object Oriented Interface ```text public function getFirewallPort(); public function setFirewallPort($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 99 ); securepdf_pdfverify_set($res, 99, $value ); ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [FirewallHost](#firewallhost-property-securepdf_pdfverify-class). See the description of the [FirewallHost](#firewallhost-property-securepdf_pdfverify-class) property for details. NOTE: This property is set automatically when [FirewallType](#firewalltype-property-securepdf_pdfverify-class) is set to a valid value. See the description of the [FirewallType](#firewalltype-property-securepdf_pdfverify-class) property for details. ## Data Type Integer # FirewallUser Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A username if authentication is to be used when connecting through a firewall. ## Object Oriented Interface ```text public function getFirewallUser(); public function setFirewallUser($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 100 ); securepdf_pdfverify_set($res, 100, $value ); ``` ## Default Value '' ## Remarks A username if authentication is to be used when connecting through a firewall. If [FirewallHost](#firewallhost-property-securepdf_pdfverify-class) is specified, this property and the [FirewallPassword](#firewallpassword-property-securepdf_pdfverify-class) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the class fails with an error. ## Data Type String # InputData Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A byte array containing the PDF document to process. ## Object Oriented Interface ```text public function getInputData(); public function setInputData($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 101 ); securepdf_pdfverify_set($res, 101, $value ); ``` ## 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. ## Data Type Byte Array # InputFile Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The PDF file to process. ## Object Oriented Interface ```text public function getInputFile(); public function setInputFile($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 102 ); securepdf_pdfverify_set($res, 102, $value ); ``` ## Default Value '' ## Remarks This property is used to provide a path to the PDF document to be processed. ## Data Type String # KnownCertCount Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The number of records in the KnownCert arrays. ## Object Oriented Interface ```text public function getKnownCertCount(); public function setKnownCertCount($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 103 ); securepdf_pdfverify_set($res, 103, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownCertEffectiveDate](#knowncerteffectivedate-property-securepdf_pdfverify-class) - [KnownCertEncoded](#knowncertencoded-property-securepdf_pdfverify-class) - [KnownCertExpirationDate](#knowncertexpirationdate-property-securepdf_pdfverify-class) - [KnownCertExtendedKeyUsage](#knowncertextendedkeyusage-property-securepdf_pdfverify-class) - [KnownCertFingerprint](#knowncertfingerprint-property-securepdf_pdfverify-class) - [KnownCertFingerprintSHA1](#knowncertfingerprintsha1-property-securepdf_pdfverify-class) - [KnownCertFingerprintSHA256](#knowncertfingerprintsha256-property-securepdf_pdfverify-class) - [KnownCertIssuer](#knowncertissuer-property-securepdf_pdfverify-class) - [KnownCertPrivateKey](#knowncertprivatekey-property-securepdf_pdfverify-class) - [KnownCertPrivateKeyAvailable](#knowncertprivatekeyavailable-property-securepdf_pdfverify-class) - [KnownCertPrivateKeyContainer](#knowncertprivatekeycontainer-property-securepdf_pdfverify-class) - [KnownCertPublicKey](#knowncertpublickey-property-securepdf_pdfverify-class) - [KnownCertPublicKeyAlgorithm](#knowncertpublickeyalgorithm-property-securepdf_pdfverify-class) - [KnownCertPublicKeyLength](#knowncertpublickeylength-property-securepdf_pdfverify-class) - [KnownCertSerialNumber](#knowncertserialnumber-property-securepdf_pdfverify-class) - [KnownCertSignatureAlgorithm](#knowncertsignaturealgorithm-property-securepdf_pdfverify-class) - [KnownCertStore](#knowncertstore-property-securepdf_pdfverify-class) - [KnownCertStorePassword](#knowncertstorepassword-property-securepdf_pdfverify-class) - [KnownCertStoreType](#knowncertstoretype-property-securepdf_pdfverify-class) - [KnownCertSubject](#knowncertsubject-property-securepdf_pdfverify-class) - [KnownCertSubjectAltNames](#knowncertsubjectaltnames-property-securepdf_pdfverify-class) - [KnownCertThumbprintMD5](#knowncertthumbprintmd5-property-securepdf_pdfverify-class) - [KnownCertThumbprintSHA1](#knowncertthumbprintsha1-property-securepdf_pdfverify-class) - [KnownCertThumbprintSHA256](#knowncertthumbprintsha256-property-securepdf_pdfverify-class) - [KnownCertUsage](#knowncertusage-property-securepdf_pdfverify-class) - [KnownCertUsageFlags](#knowncertusageflags-property-securepdf_pdfverify-class) - [KnownCertVersion](#knowncertversion-property-securepdf_pdfverify-class) The array indices start at *0* and end at *KnownCertCount - 1*. This property is not available at design time. ## Data Type Integer # KnownCertEffectiveDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date on which this certificate becomes valid. ## Object Oriented Interface ```text public function getKnownCertEffectiveDate($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 104 , $knowncertindex); ``` ## Default Value '' ## Remarks 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. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertExpirationDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date on which the certificate expires. ## Object Oriented Interface ```text public function getKnownCertExpirationDate($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 105 , $knowncertindex); ``` ## Default Value '' ## Remarks 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. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertExtendedKeyUsage Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A comma-delimited list of extended key usage identifiers. ## Object Oriented Interface ```text public function getKnownCertExtendedKeyUsage($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 106 , $knowncertindex); ``` ## Default Value '' ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertFingerprint Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Object Oriented Interface ```text public function getKnownCertFingerprint($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 107 , $knowncertindex); ``` ## Default Value '' ## Remarks 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* The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertFingerprintSHA1 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Object Oriented Interface ```text public function getKnownCertFingerprintSHA1($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 108 , $knowncertindex); ``` ## Default Value '' ## Remarks 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* The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertFingerprintSHA256 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Object Oriented Interface ```text public function getKnownCertFingerprintSHA256($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 109 , $knowncertindex); ``` ## Default Value '' ## Remarks 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* The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertIssuer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The issuer of the certificate. ## Object Oriented Interface ```text public function getKnownCertIssuer($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 110 , $knowncertindex); ``` ## Default Value '' ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertPrivateKey Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The private key of the certificate (if available). ## Object Oriented Interface ```text public function getKnownCertPrivateKey($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 111 , $knowncertindex); ``` ## Default Value '' ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [KnownCertPrivateKey](#knowncertprivatekey-property-securepdf_pdfverify-class) may be available but not exportable. In this case, [KnownCertPrivateKey](#knowncertprivatekey-property-securepdf_pdfverify-class) returns an empty string. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertPrivateKeyAvailable Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Whether a PrivateKey is available for the selected certificate. ## Object Oriented Interface ```text public function getKnownCertPrivateKeyAvailable($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 112 , $knowncertindex); ``` ## Default Value false ## Remarks Whether a [KnownCertPrivateKey](#knowncertprivatekey-property-securepdf_pdfverify-class) is available for the selected certificate. If [KnownCertPrivateKeyAvailable](#knowncertprivatekeyavailable-property-securepdf_pdfverify-class) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Boolean # KnownCertPrivateKeyContainer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the PrivateKey container for the certificate (if available). ## Object Oriented Interface ```text public function getKnownCertPrivateKeyContainer($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 113 , $knowncertindex); ``` ## Default Value '' ## Remarks The name of the [KnownCertPrivateKey](#knowncertprivatekey-property-securepdf_pdfverify-class) container for the certificate (if available). This functionality is available only on Windows platforms. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertPublicKey Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The public key of the certificate. ## Object Oriented Interface ```text public function getKnownCertPublicKey($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 114 , $knowncertindex); ``` ## Default Value '' ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertPublicKeyAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The textual description of the certificate's public key algorithm. ## Object Oriented Interface ```text public function getKnownCertPublicKeyAlgorithm($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 115 , $knowncertindex); ``` ## Default Value '' ## Remarks 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. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertPublicKeyLength Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The length of the certificate's public key (in bits). ## Object Oriented Interface ```text public function getKnownCertPublicKeyLength($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 116 , $knowncertindex); ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # KnownCertSerialNumber Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The serial number of the certificate encoded as a string. ## Object Oriented Interface ```text public function getKnownCertSerialNumber($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 117 , $knowncertindex); ``` ## Default Value '' ## Remarks 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. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertSignatureAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The text description of the certificate's signature algorithm. ## Object Oriented Interface ```text public function getKnownCertSignatureAlgorithm($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 118 , $knowncertindex); ``` ## Default Value '' ## Remarks 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. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertStore Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the certificate store for the client certificate. ## Object Oriented Interface ```text public function getKnownCertStore($knowncertindex); public function setKnownCertStore($knowncertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 119 , $knowncertindex); securepdf_pdfverify_set($res, 119, $value , $knowncertindex); ``` ## Default Value 'MY' ## Remarks The name of the certificate store for the client certificate. The [KnownCertStoreType](#knowncertstoretype-property-securepdf_pdfverify-class) property denotes the type of the certificate store specified by [KnownCertStore](#knowncertstore-property-securepdf_pdfverify-class). If the store is password-protected, specify the password in [KnownCertStorePassword](#knowncertstorepassword-property-securepdf_pdfverify-class). [KnownCertStore](#knowncertstore-property-securepdf_pdfverify-class) is used in conjunction with the [KnownCertSubject](#knowncertsubject-property-securepdf_pdfverify-class) property to specify client certificates. If [KnownCertStore](#knowncertstore-property-securepdf_pdfverify-class) has a value, and [KnownCertSubject](#knowncertsubject-property-securepdf_pdfverify-class) or [KnownCertEncoded](#knowncertencoded-property-securepdf_pdfverify-class) is set, a search for a certificate is initiated. Please see the [KnownCertSubject](#knowncertsubject-property-securepdf_pdfverify-class) property 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. | 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). The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type Binary String # KnownCertStorePassword Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Object Oriented Interface ```text public function getKnownCertStorePassword($knowncertindex); public function setKnownCertStorePassword($knowncertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 120 , $knowncertindex); securepdf_pdfverify_set($res, 120, $value , $knowncertindex); ``` ## Default Value '' ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # KnownCertStoreType Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The type of certificate store for this certificate. ## Object Oriented Interface ```text public function getKnownCertStoreType($knowncertindex); public function setKnownCertStoreType($knowncertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 121 , $knowncertindex); securepdf_pdfverify_set($res, 121, $value , $knowncertindex); ``` ## Possible Values ```text PDFVERIFY_KNOWNCERTSTORETYPE_USER(0), PDFVERIFY_KNOWNCERTSTORETYPE_MACHINE(1), PDFVERIFY_KNOWNCERTSTORETYPE_PFXFILE(2), PDFVERIFY_KNOWNCERTSTORETYPE_PFXBLOB(3), PDFVERIFY_KNOWNCERTSTORETYPE_JKSFILE(4), PDFVERIFY_KNOWNCERTSTORETYPE_JKSBLOB(5), PDFVERIFY_KNOWNCERTSTORETYPE_PEMKEY_FILE(6), PDFVERIFY_KNOWNCERTSTORETYPE_PEMKEY_BLOB(7), PDFVERIFY_KNOWNCERTSTORETYPE_PUBLIC_KEY_FILE(8), PDFVERIFY_KNOWNCERTSTORETYPE_PUBLIC_KEY_BLOB(9), PDFVERIFY_KNOWNCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), PDFVERIFY_KNOWNCERTSTORETYPE_P7BFILE(11), PDFVERIFY_KNOWNCERTSTORETYPE_P7BBLOB(12), PDFVERIFY_KNOWNCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), PDFVERIFY_KNOWNCERTSTORETYPE_PPKFILE(14), PDFVERIFY_KNOWNCERTSTORETYPE_PPKBLOB(15), PDFVERIFY_KNOWNCERTSTORETYPE_XMLFILE(16), PDFVERIFY_KNOWNCERTSTORETYPE_XMLBLOB(17), PDFVERIFY_KNOWNCERTSTORETYPE_JWKFILE(18), PDFVERIFY_KNOWNCERTSTORETYPE_JWKBLOB(19), PDFVERIFY_KNOWNCERTSTORETYPE_SECURITY_KEY(20), PDFVERIFY_KNOWNCERTSTORETYPE_BCFKSFILE(21), PDFVERIFY_KNOWNCERTSTORETYPE_BCFKSBLOB(22), PDFVERIFY_KNOWNCERTSTORETYPE_PKCS11(23), PDFVERIFY_KNOWNCERTSTORETYPE_AUTO(99) ``` ## Default Value 0 ## Remarks 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 property 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](#Type_Certificate) object and pass cstPKCS11 as the [KnownCertStoreType](#knowncertstoretype-property-securepdf_pdfverify-class), the full path of the PKCS#11 DLL as the [KnownCertStore](#knowncertstore-property-securepdf_pdfverify-class), and the PIN as the [KnownCertStorePassword](#knowncertstorepassword-property-securepdf_pdfverify-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [KnownCertStore](#knowncertstore-property-securepdf_pdfverify-class) and set [KnownCertStorePassword](#knowncertstorepassword-property-securepdf_pdfverify-class) 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. | The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type Integer # KnownCertSubjectAltNames Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Comma-separated lists of alternative subject names for the certificate. ## Object Oriented Interface ```text public function getKnownCertSubjectAltNames($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 122 , $knowncertindex); ``` ## Default Value '' ## Remarks Comma-separated lists of alternative subject names for the certificate. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertThumbprintMD5 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The MD5 hash of the certificate. ## Object Oriented Interface ```text public function getKnownCertThumbprintMD5($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 123 , $knowncertindex); ``` ## Default Value '' ## Remarks 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. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertThumbprintSHA1 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The SHA-1 hash of the certificate. ## Object Oriented Interface ```text public function getKnownCertThumbprintSHA1($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 124 , $knowncertindex); ``` ## Default Value '' ## Remarks 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. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertThumbprintSHA256 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The SHA-256 hash of the certificate. ## Object Oriented Interface ```text public function getKnownCertThumbprintSHA256($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 125 , $knowncertindex); ``` ## Default Value '' ## Remarks 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. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertUsage Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The text description of UsageFlags . ## Object Oriented Interface ```text public function getKnownCertUsage($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 126 , $knowncertindex); ``` ## Default Value '' ## Remarks The text description of [KnownCertUsageFlags](#knowncertusageflags-property-securepdf_pdfverify-class). 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. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertUsageFlags Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The flags that show intended use for the certificate. ## Object Oriented Interface ```text public function getKnownCertUsageFlags($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 127 , $knowncertindex); ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [KnownCertUsageFlags](#knowncertusageflags-property-securepdf_pdfverify-class) 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 [KnownCertUsage](#knowncertusage-property-securepdf_pdfverify-class) property for a text representation of [KnownCertUsageFlags](#knowncertusageflags-property-securepdf_pdfverify-class). This functionality currently is not available when the provider is OpenSSL. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # KnownCertVersion Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certificate's version number. ## Object Oriented Interface ```text public function getKnownCertVersion($knowncertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 128 , $knowncertindex); ``` ## Default Value '' ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # KnownCertSubject Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The subject of the certificate used for client authentication. ## Object Oriented Interface ```text public function getKnownCertSubject($knowncertindex); public function setKnownCertSubject($knowncertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 129 , $knowncertindex); securepdf_pdfverify_set($res, 129, $value , $knowncertindex); ``` ## Default Value '' ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. 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. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # KnownCertEncoded Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certificate (PEM/Base64 encoded). ## Object Oriented Interface ```text public function getKnownCertEncoded($knowncertindex); public function setKnownCertEncoded($knowncertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 130 , $knowncertindex); securepdf_pdfverify_set($res, 130, $value , $knowncertindex); ``` ## Default Value '' ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [KnownCertStore](#knowncertstore-property-securepdf_pdfverify-class) and [KnownCertSubject](#knowncertsubject-property-securepdf_pdfverify-class) properties also may be used to specify a certificate. When [KnownCertEncoded](#knowncertencoded-property-securepdf_pdfverify-class) is set, a search is initiated in the current [KnownCertStore](#knowncertstore-property-securepdf_pdfverify-class) for the private key of the certificate. If the key is found, [KnownCertSubject](#knowncertsubject-property-securepdf_pdfverify-class) is updated to reflect the full subject of the selected certificate; otherwise, [KnownCertSubject](#knowncertsubject-property-securepdf_pdfverify-class) is set to an empty string. The *$knowncertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type Binary String # OfflineMode Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Whether the class is operating in offline mode. ## Object Oriented Interface ```text public function getOfflineMode(); public function setOfflineMode($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 131 ); securepdf_pdfverify_set($res, 131, $value ); ``` ## 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. ## Data Type Boolean # OutputData Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A byte array containing the PDF document after processing. ## Object Oriented Interface ```text public function getOutputData(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 132 ); ``` ## 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-securepdf_pdfverify-class) and SetOutputStream respectively. This property is read-only and not available at design time. ## Data Type Byte Array # OutputFile Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The path to a local file where the output is written. ## Object Oriented Interface ```text public function getOutputFile(); public function setOutputFile($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 133 ); securepdf_pdfverify_set($res, 133, $value ); ``` ## Default Value '' ## Remarks This property is used to provide a path where the resulting PDF document is saved after the operation has completed. ## Data Type String # Overwrite Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Whether the class should overwrite files. ## Object Oriented Interface ```text public function getOverwrite(); public function setOverwrite($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 134 ); securepdf_pdfverify_set($res, 134, $value ); ``` ## Default Value false ## Remarks This property indicates whether the class overwrites [OutputFile](#outputfile-property-securepdf_pdfverify-class). If set to *false*, an error is thrown whenever [OutputFile](#outputfile-property-securepdf_pdfverify-class) exists before an operation. ## Data Type Boolean # Password Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The password to decrypt the document with. ## Object Oriented Interface ```text public function getPassword(); public function setPassword($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 135 ); securepdf_pdfverify_set($res, 135, $value ); ``` ## 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. ## Data Type String # ProxyAuthScheme Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The type of authorization to perform when connecting to the proxy. ## Object Oriented Interface ```text public function getProxyAuthScheme(); public function setProxyAuthScheme($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 136 ); securepdf_pdfverify_set($res, 136, $value ); ``` ## Possible Values ```text PDFVERIFY_PROXYAUTHSCHEME_BASIC(0), PDFVERIFY_PROXYAUTHSCHEME_DIGEST(1), PDFVERIFY_PROXYAUTHSCHEME_PROPRIETARY(2), PDFVERIFY_PROXYAUTHSCHEME_NONE(3), PDFVERIFY_PROXYAUTHSCHEME_NTLM(4), PDFVERIFY_PROXYAUTHSCHEME_NEGOTIATE(5) ``` ## Default Value 0 ## Remarks The type of authorization to perform when connecting to the proxy. This is used only when the [ProxyUser](#proxyuser-property-securepdf_pdfverify-class) and [ProxyPassword](#proxypassword-property-securepdf_pdfverify-class) properties are set. [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) should be set to authNone (3) when no authentication is expected. By default, [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) is authBasic (0), and if the [ProxyUser](#proxyuser-property-securepdf_pdfverify-class) and [ProxyPassword](#proxypassword-property-securepdf_pdfverify-class) properties are set, the class will attempt basic authentication. If [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) is set to authDigest (1), digest authentication will be attempted instead. If [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) 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 [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [ProxyUser](#proxyuser-property-securepdf_pdfverify-class) and [ProxyPassword](#proxypassword-property-securepdf_pdfverify-class). ## Data Type Integer # ProxyAutoDetect Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Whether to automatically detect and use proxy system settings, if available. ## Object Oriented Interface ```text public function getProxyAutoDetect(); public function setProxyAutoDetect($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 137 ); securepdf_pdfverify_set($res, 137, $value ); ``` ## Default Value false ## Remarks Whether to automatically detect and use proxy system settings, if available. The default value is *false*. ## Data Type Boolean # ProxyPassword Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A password if authentication is to be used for the proxy. ## Object Oriented Interface ```text public function getProxyPassword(); public function setProxyPassword($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 138 ); securepdf_pdfverify_set($res, 138, $value ); ``` ## Default Value '' ## Remarks A password if authentication is to be used for the proxy. If [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) is set to Basic Authentication, the [ProxyUser](#proxyuser-property-securepdf_pdfverify-class) and [ProxyPassword](#proxypassword-property-securepdf_pdfverify-class) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) is set to Digest Authentication, the [ProxyUser](#proxyuser-property-securepdf_pdfverify-class) and [ProxyPassword](#proxypassword-property-securepdf_pdfverify-class) properties are used to respond to the Digest Authentication challenge from the server. If [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) is set to NTLM Authentication, the [ProxyUser](#proxyuser-property-securepdf_pdfverify-class) and [ProxyPassword](#proxypassword-property-securepdf_pdfverify-class) properties are used to authenticate through NTLM negotiation. ## Data Type String # ProxyPort Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The Transmission Control Protocol (TCP) port for the proxy Server (default 80). ## Object Oriented Interface ```text public function getProxyPort(); public function setProxyPort($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 139 ); securepdf_pdfverify_set($res, 139, $value ); ``` ## Default Value 80 ## Remarks The Transmission Control Protocol (TCP) port for the proxy [ProxyServer](#proxyserver-property-securepdf_pdfverify-class) (default 80). See the description of the [ProxyServer](#proxyserver-property-securepdf_pdfverify-class) property for details. ## Data Type Integer # ProxyServer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. ## Object Oriented Interface ```text public function getProxyServer(); public function setProxyServer($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 140 ); securepdf_pdfverify_set($res, 140, $value ); ``` ## Default Value '' ## Remarks If a proxy [ProxyServer](#proxyserver-property-securepdf_pdfverify-class) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [ProxyServer](#proxyserver-property-securepdf_pdfverify-class) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [ProxyServer](#proxyserver-property-securepdf_pdfverify-class) property is set to the corresponding address. If the search is not successful, an error is returned. ## Data Type String # ProxySSL Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) When to use a Secure Sockets Layer (SSL) for the connection to the proxy. ## Object Oriented Interface ```text public function getProxySSL(); public function setProxySSL($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 141 ); securepdf_pdfverify_set($res, 141, $value ); ``` ## Possible Values ```text PDFVERIFY_PROXYSSL_AUTOMATIC(0), PDFVERIFY_PROXYSSL_ALWAYS(1), PDFVERIFY_PROXYSSL_NEVER(2), PDFVERIFY_PROXYSSL_TUNNEL(3) ``` ## Default Value 0 ## Remarks 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. | ## Data Type Integer # ProxyUser Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A username if authentication is to be used for the proxy. ## Object Oriented Interface ```text public function getProxyUser(); public function setProxyUser($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 142 ); securepdf_pdfverify_set($res, 142, $value ); ``` ## Default Value '' ## Remarks A username if authentication is to be used for the proxy. If [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) is set to Basic Authentication, the [ProxyUser](#proxyuser-property-securepdf_pdfverify-class) and [ProxyPassword](#proxypassword-property-securepdf_pdfverify-class) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) is set to Digest Authentication, the [ProxyUser](#proxyuser-property-securepdf_pdfverify-class) and [ProxyPassword](#proxypassword-property-securepdf_pdfverify-class) properties are used to respond to the Digest Authentication challenge from the server. If [ProxyAuthScheme](#proxyauthscheme-property-securepdf_pdfverify-class) is set to NTLM Authentication, the [ProxyUser](#proxyuser-property-securepdf_pdfverify-class) and [ProxyPassword](#proxypassword-property-securepdf_pdfverify-class) properties are used to authenticate through NTLM negotiation. ## Data Type String # RevocationCheck Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The kind(s) of revocation check to perform for all chain certificates. ## Object Oriented Interface ```text public function getRevocationCheck(); public function setRevocationCheck($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 143 ); securepdf_pdfverify_set($res, 143, $value ); ``` ## Possible Values ```text PDFVERIFY_REVOCATIONCHECK_ALL_CRL(0), PDFVERIFY_REVOCATIONCHECK_ALL_OCSP(1), PDFVERIFY_REVOCATIONCHECK_ALL_CRLAND_OCSP(2), PDFVERIFY_REVOCATIONCHECK_ANY_CRL(3), PDFVERIFY_REVOCATIONCHECK_ANY_OCSP(4), PDFVERIFY_REVOCATIONCHECK_ANY_CRLOR_OCSP(5), PDFVERIFY_REVOCATIONCHECK_ANY_OCSPOR_CRL(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. ## Data Type Integer # PDFSignatureCount Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The number of records in the PDFSignature arrays. ## Object Oriented Interface ```text public function getPDFSignatureCount(); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 144 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [PDFSignatureAuthorName](#pdfsignatureauthorname-property-securepdf_pdfverify-class) - [PDFSignatureChainValidationDetails](#pdfsignaturechainvalidationdetails-property-securepdf_pdfverify-class) - [PDFSignatureChainValidationResult](#pdfsignaturechainvalidationresult-property-securepdf_pdfverify-class) - [PDFSignatureClaimedSigningTime](#pdfsignatureclaimedsigningtime-property-securepdf_pdfverify-class) - [PDFSignatureCoverageEndsAt](#pdfsignaturecoverageendsat-property-securepdf_pdfverify-class) - [PDFSignatureHashAlgorithm](#pdfsignaturehashalgorithm-property-securepdf_pdfverify-class) - [PDFSignatureProfile](#pdfsignatureprofile-property-securepdf_pdfverify-class) - [PDFSignatureReason](#pdfsignaturereason-property-securepdf_pdfverify-class) - [PDFSignatureSignerCertIndex](#pdfsignaturesignercertindex-property-securepdf_pdfverify-class) - [PDFSignatureTimestampCertIndex](#pdfsignaturetimestampcertindex-property-securepdf_pdfverify-class) - [PDFSignatureTimestamped](#pdfsignaturetimestamped-property-securepdf_pdfverify-class) - [PDFSignatureType](#pdfsignaturetype-property-securepdf_pdfverify-class) - [PDFSignatureValidatedSigningTime](#pdfsignaturevalidatedsigningtime-property-securepdf_pdfverify-class) - [PDFSignatureValidationResult](#pdfsignaturevalidationresult-property-securepdf_pdfverify-class) - [PDFSignatureWidgetHeight](#pdfsignaturewidgetheight-property-securepdf_pdfverify-class) - [PDFSignatureWidgetOffsetX](#pdfsignaturewidgetoffsetx-property-securepdf_pdfverify-class) - [PDFSignatureWidgetOffsetY](#pdfsignaturewidgetoffsety-property-securepdf_pdfverify-class) - [PDFSignatureWidgetPages](#pdfsignaturewidgetpages-property-securepdf_pdfverify-class) - [PDFSignatureWidgetWidth](#pdfsignaturewidgetwidth-property-securepdf_pdfverify-class) The array indices start at *0* and end at *PDFSignatureCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # PDFSignatureAuthorName Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The human-readable name of the signer. ## Object Oriented Interface ```text public function getPDFSignatureAuthorName($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 145 , $pdfsignatureindex); ``` ## Default Value '' ## Remarks The human-readable name of the signer. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # PDFSignatureChainValidationDetails Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The details of the certificate chain validation outcome. ## Object Oriented Interface ```text public function getPDFSignatureChainValidationDetails($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 146 , $pdfsignatureindex); ``` ## Default Value 0 ## Remarks The details of the certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result in [PDFSignatureChainValidationResult](#pdfsignaturechainvalidationresult-property-securepdf_pdfverify-class). The value of this property 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_e_Log) event to access the detailed validation log. This property is also available as a parameter of the [SignatureProcessed](#PDFSign_e_SignatureProcessed) event. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # PDFSignatureChainValidationResult Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The outcome of the certificate chain validation routine. ## Object Oriented Interface ```text public function getPDFSignatureChainValidationResult($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 147 , $pdfsignatureindex); ``` ## Possible Values ```text PDFVERIFY_PDFSIGNATURECHAINVALIDATIONRESULT_UNKNOWN(0), PDFVERIFY_PDFSIGNATURECHAINVALIDATIONRESULT_VALID(1), PDFVERIFY_PDFSIGNATURECHAINVALIDATIONRESULT_VALID_BUT_UNTRUSTED(2), PDFVERIFY_PDFSIGNATURECHAINVALIDATIONRESULT_INVALID(3), PDFVERIFY_PDFSIGNATURECHAINVALIDATIONRESULT_CANT_BE_ESTABLISHED(4) ``` ## Default Value 0 ## Remarks 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_e_Log) event to access the detailed validation log. This property is also available as a parameter of the [SignatureProcessed](#PDFSign_e_SignatureProcessed) event. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # PDFSignatureClaimedSigningTime Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The signature's creation time in UTC. ## Object Oriented Interface ```text public function getPDFSignatureClaimedSigningTime($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 148 , $pdfsignatureindex); ``` ## Default Value '' ## Remarks The signature's creation time in UTC. Use this property to get the signature creation time from the signer's computer. Note that the claimed time, unlike [PDFSignatureValidatedSigningTime](#pdfsignaturevalidatedsigningtime-property-securepdf_pdfverify-class), does not originate from a trusted TSA and may be forged or wrong. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # PDFSignatureCoverageEndsAt Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The byte offset in the PDF file where the signature coverage ends. ## Object Oriented Interface ```text public function getPDFSignatureCoverageEndsAt($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 149 , $pdfsignatureindex); ``` ## Default Value 0 ## Remarks 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 property 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-securepdf_pdfverify-class) to extract the exact revision that was signed. A value of *0* indicates that the class could not determine the coverage offset. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # PDFSignatureHashAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hash algorithm that was used for signing. ## Object Oriented Interface ```text public function getPDFSignatureHashAlgorithm($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 150 , $pdfsignatureindex); ``` ## Default Value 'SHA256' ## Remarks The hash algorithm that was used for signing. Possible values are: - SHA1 - SHA224 - SHA256 - SHA384 - SHA512 - MD5 The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # PDFSignatureProfile Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI. ## Object Oriented Interface ```text public function getPDFSignatureProfile($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 151 , $pdfsignatureindex); ``` ## Possible Values ```text PDFVERIFY_PDFSIGNATUREPROFILE_NONE(0), PDFVERIFY_PDFSIGNATUREPROFILE_BASELINE_B(1), PDFVERIFY_PDFSIGNATUREPROFILE_BASELINE_T(2), PDFVERIFY_PDFSIGNATUREPROFILE_BASELINE_LT(3), PDFVERIFY_PDFSIGNATUREPROFILE_BASELINE_LTA(4) ``` ## Default Value 0 ## Remarks 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-securepdf_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). The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # PDFSignatureReason Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The reason for signing. ## Object Oriented Interface ```text public function getPDFSignatureReason($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 152 , $pdfsignatureindex); ``` ## Default Value '' ## Remarks The reason for signing. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # PDFSignatureType Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The type of the signature that was created. ## Object Oriented Interface ```text public function getPDFSignatureType($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 153 , $pdfsignatureindex); ``` ## Possible Values ```text PDFVERIFY_PDFSIGNATURETYPE_LEGACY(0), PDFVERIFY_PDFSIGNATURETYPE_ADVANCED(1), PDFVERIFY_PDFSIGNATURETYPE_DTS(2), PDFVERIFY_PDFSIGNATURETYPE_EMPTY_FIELD(3) ``` ## Default Value 0 ## Remarks 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) | The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # PDFSignatureSignerCertIndex Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The index of the signer certificate in the DocumentCerts collection. ## Object Oriented Interface ```text public function getPDFSignatureSignerCertIndex($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 154 , $pdfsignatureindex); ``` ## Default Value -1 ## Remarks The index of the signer certificate in the [DocumentCerts](#PDFSign_p_DocumentCerts) collection. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # PDFSignatureTimestampCertIndex Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The index of the timestamping certificate in the DocumentCerts collection (if applicable). ## Object Oriented Interface ```text public function getPDFSignatureTimestampCertIndex($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 155 , $pdfsignatureindex); ``` ## Default Value -1 ## Remarks The index of the timestamping certificate in the [DocumentCerts](#PDFSign_p_DocumentCerts) collection (if applicable). The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # PDFSignatureTimestamped Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Whether the signature contains an embedded timestamp. ## Object Oriented Interface ```text public function getPDFSignatureTimestamped($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 156 , $pdfsignatureindex); ``` ## Default Value false ## Remarks Whether the signature contains an embedded timestamp. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Boolean # PDFSignatureValidatedSigningTime Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certified signing time in UTC. ## Object Oriented Interface ```text public function getPDFSignatureValidatedSigningTime($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 157 , $pdfsignatureindex); ``` ## Default Value '' ## Remarks The certified signing time in UTC. Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there is a valid timestamp included in the signature. Note that the validated time, unlike [PDFSignatureClaimedSigningTime](#pdfsignatureclaimedsigningtime-property-securepdf_pdfverify-class), is the trusted signing time. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # PDFSignatureValidationResult Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The outcome of the cryptographic signature validation. ## Object Oriented Interface ```text public function getPDFSignatureValidationResult($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 158 , $pdfsignatureindex); ``` ## Possible Values ```text PDFVERIFY_PDFSIGNATUREVALIDATIONRESULT_UNKNOWN(0), PDFVERIFY_PDFSIGNATUREVALIDATIONRESULT_VALID(1), PDFVERIFY_PDFSIGNATUREVALIDATIONRESULT_CORRUPTED(2), PDFVERIFY_PDFSIGNATUREVALIDATIONRESULT_SIGNER_NOT_FOUND(3), PDFVERIFY_PDFSIGNATUREVALIDATIONRESULT_FAILURE(4) ``` ## Default Value 0 ## Remarks 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 property is also available as the *[SignatureValidationResult](#)* parameter of the [SignatureProcessed](#PDFSign_e_SignatureProcessed) event. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # PDFSignatureWidgetHeight Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The height of the signature widget in points. ## Object Oriented Interface ```text public function getPDFSignatureWidgetHeight($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 159 , $pdfsignatureindex); ``` ## Default Value '70' ## Remarks The height of the signature widget in points. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # PDFSignatureWidgetOffsetX Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The signature widget offset from the left-hand page border in points. ## Object Oriented Interface ```text public function getPDFSignatureWidgetOffsetX($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 160 , $pdfsignatureindex); ``` ## Default Value '0' ## Remarks The signature widget offset from the left-hand page border in points. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # PDFSignatureWidgetOffsetY Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The signature widget offset from the bottom page border in points. ## Object Oriented Interface ```text public function getPDFSignatureWidgetOffsetY($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 161 , $pdfsignatureindex); ``` ## Default Value '0' ## Remarks The signature widget offset from the bottom page border in points. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # PDFSignatureWidgetPages Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The pages that the signature and its widget are placed on. ## Object Oriented Interface ```text public function getPDFSignatureWidgetPages($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 162 , $pdfsignatureindex); ``` ## Default Value '' ## Remarks The pages that the signature and its widget are placed on. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # PDFSignatureWidgetWidth Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The width of the signature widget in points. ## Object Oriented Interface ```text public function getPDFSignatureWidgetWidth($pdfsignatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 163 , $pdfsignatureindex); ``` ## Default Value '70' ## Remarks The width of the signature widget in points. The *$pdfsignatureindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PDFSignatureCount](#pdfsignaturecount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertCount Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The number of records in the TrustedCert arrays. ## Object Oriented Interface ```text public function getTrustedCertCount(); public function setTrustedCertCount($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 164 ); securepdf_pdfverify_set($res, 164, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TrustedCertEffectiveDate](#trustedcerteffectivedate-property-securepdf_pdfverify-class) - [TrustedCertEncoded](#trustedcertencoded-property-securepdf_pdfverify-class) - [TrustedCertExpirationDate](#trustedcertexpirationdate-property-securepdf_pdfverify-class) - [TrustedCertExtendedKeyUsage](#trustedcertextendedkeyusage-property-securepdf_pdfverify-class) - [TrustedCertFingerprint](#trustedcertfingerprint-property-securepdf_pdfverify-class) - [TrustedCertFingerprintSHA1](#trustedcertfingerprintsha1-property-securepdf_pdfverify-class) - [TrustedCertFingerprintSHA256](#trustedcertfingerprintsha256-property-securepdf_pdfverify-class) - [TrustedCertIssuer](#trustedcertissuer-property-securepdf_pdfverify-class) - [TrustedCertPrivateKey](#trustedcertprivatekey-property-securepdf_pdfverify-class) - [TrustedCertPrivateKeyAvailable](#trustedcertprivatekeyavailable-property-securepdf_pdfverify-class) - [TrustedCertPrivateKeyContainer](#trustedcertprivatekeycontainer-property-securepdf_pdfverify-class) - [TrustedCertPublicKey](#trustedcertpublickey-property-securepdf_pdfverify-class) - [TrustedCertPublicKeyAlgorithm](#trustedcertpublickeyalgorithm-property-securepdf_pdfverify-class) - [TrustedCertPublicKeyLength](#trustedcertpublickeylength-property-securepdf_pdfverify-class) - [TrustedCertSerialNumber](#trustedcertserialnumber-property-securepdf_pdfverify-class) - [TrustedCertSignatureAlgorithm](#trustedcertsignaturealgorithm-property-securepdf_pdfverify-class) - [TrustedCertStore](#trustedcertstore-property-securepdf_pdfverify-class) - [TrustedCertStorePassword](#trustedcertstorepassword-property-securepdf_pdfverify-class) - [TrustedCertStoreType](#trustedcertstoretype-property-securepdf_pdfverify-class) - [TrustedCertSubject](#trustedcertsubject-property-securepdf_pdfverify-class) - [TrustedCertSubjectAltNames](#trustedcertsubjectaltnames-property-securepdf_pdfverify-class) - [TrustedCertThumbprintMD5](#trustedcertthumbprintmd5-property-securepdf_pdfverify-class) - [TrustedCertThumbprintSHA1](#trustedcertthumbprintsha1-property-securepdf_pdfverify-class) - [TrustedCertThumbprintSHA256](#trustedcertthumbprintsha256-property-securepdf_pdfverify-class) - [TrustedCertUsage](#trustedcertusage-property-securepdf_pdfverify-class) - [TrustedCertUsageFlags](#trustedcertusageflags-property-securepdf_pdfverify-class) - [TrustedCertVersion](#trustedcertversion-property-securepdf_pdfverify-class) The array indices start at *0* and end at *TrustedCertCount - 1*. This property is not available at design time. ## Data Type Integer # TrustedCertEffectiveDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date on which this certificate becomes valid. ## Object Oriented Interface ```text public function getTrustedCertEffectiveDate($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 165 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertExpirationDate Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The date on which the certificate expires. ## Object Oriented Interface ```text public function getTrustedCertExpirationDate($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 166 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertExtendedKeyUsage Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A comma-delimited list of extended key usage identifiers. ## Object Oriented Interface ```text public function getTrustedCertExtendedKeyUsage($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 167 , $trustedcertindex); ``` ## Default Value '' ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertFingerprint Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Object Oriented Interface ```text public function getTrustedCertFingerprint($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 168 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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* The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertFingerprintSHA1 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Object Oriented Interface ```text public function getTrustedCertFingerprintSHA1($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 169 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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* The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertFingerprintSHA256 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Object Oriented Interface ```text public function getTrustedCertFingerprintSHA256($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 170 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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* The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertIssuer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The issuer of the certificate. ## Object Oriented Interface ```text public function getTrustedCertIssuer($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 171 , $trustedcertindex); ``` ## Default Value '' ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertPrivateKey Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The private key of the certificate (if available). ## Object Oriented Interface ```text public function getTrustedCertPrivateKey($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 172 , $trustedcertindex); ``` ## Default Value '' ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [TrustedCertPrivateKey](#trustedcertprivatekey-property-securepdf_pdfverify-class) may be available but not exportable. In this case, [TrustedCertPrivateKey](#trustedcertprivatekey-property-securepdf_pdfverify-class) returns an empty string. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertPrivateKeyAvailable Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Whether a PrivateKey is available for the selected certificate. ## Object Oriented Interface ```text public function getTrustedCertPrivateKeyAvailable($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 173 , $trustedcertindex); ``` ## Default Value false ## Remarks Whether a [TrustedCertPrivateKey](#trustedcertprivatekey-property-securepdf_pdfverify-class) is available for the selected certificate. If [TrustedCertPrivateKeyAvailable](#trustedcertprivatekeyavailable-property-securepdf_pdfverify-class) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Boolean # TrustedCertPrivateKeyContainer Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the PrivateKey container for the certificate (if available). ## Object Oriented Interface ```text public function getTrustedCertPrivateKeyContainer($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 174 , $trustedcertindex); ``` ## Default Value '' ## Remarks The name of the [TrustedCertPrivateKey](#trustedcertprivatekey-property-securepdf_pdfverify-class) container for the certificate (if available). This functionality is available only on Windows platforms. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertPublicKey Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The public key of the certificate. ## Object Oriented Interface ```text public function getTrustedCertPublicKey($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 175 , $trustedcertindex); ``` ## Default Value '' ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertPublicKeyAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The textual description of the certificate's public key algorithm. ## Object Oriented Interface ```text public function getTrustedCertPublicKeyAlgorithm($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 176 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertPublicKeyLength Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The length of the certificate's public key (in bits). ## Object Oriented Interface ```text public function getTrustedCertPublicKeyLength($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 177 , $trustedcertindex); ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # TrustedCertSerialNumber Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The serial number of the certificate encoded as a string. ## Object Oriented Interface ```text public function getTrustedCertSerialNumber($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 178 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertSignatureAlgorithm Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The text description of the certificate's signature algorithm. ## Object Oriented Interface ```text public function getTrustedCertSignatureAlgorithm($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 179 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertStore Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The name of the certificate store for the client certificate. ## Object Oriented Interface ```text public function getTrustedCertStore($trustedcertindex); public function setTrustedCertStore($trustedcertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 180 , $trustedcertindex); securepdf_pdfverify_set($res, 180, $value , $trustedcertindex); ``` ## Default Value 'MY' ## Remarks The name of the certificate store for the client certificate. The [TrustedCertStoreType](#trustedcertstoretype-property-securepdf_pdfverify-class) property denotes the type of the certificate store specified by [TrustedCertStore](#trustedcertstore-property-securepdf_pdfverify-class). If the store is password-protected, specify the password in [TrustedCertStorePassword](#trustedcertstorepassword-property-securepdf_pdfverify-class). [TrustedCertStore](#trustedcertstore-property-securepdf_pdfverify-class) is used in conjunction with the [TrustedCertSubject](#trustedcertsubject-property-securepdf_pdfverify-class) property to specify client certificates. If [TrustedCertStore](#trustedcertstore-property-securepdf_pdfverify-class) has a value, and [TrustedCertSubject](#trustedcertsubject-property-securepdf_pdfverify-class) or [TrustedCertEncoded](#trustedcertencoded-property-securepdf_pdfverify-class) is set, a search for a certificate is initiated. Please see the [TrustedCertSubject](#trustedcertsubject-property-securepdf_pdfverify-class) property 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. | 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). The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type Binary String # TrustedCertStorePassword Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Object Oriented Interface ```text public function getTrustedCertStorePassword($trustedcertindex); public function setTrustedCertStorePassword($trustedcertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 181 , $trustedcertindex); securepdf_pdfverify_set($res, 181, $value , $trustedcertindex); ``` ## Default Value '' ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # TrustedCertStoreType Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The type of certificate store for this certificate. ## Object Oriented Interface ```text public function getTrustedCertStoreType($trustedcertindex); public function setTrustedCertStoreType($trustedcertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 182 , $trustedcertindex); securepdf_pdfverify_set($res, 182, $value , $trustedcertindex); ``` ## Possible Values ```text PDFVERIFY_TRUSTEDCERTSTORETYPE_USER(0), PDFVERIFY_TRUSTEDCERTSTORETYPE_MACHINE(1), PDFVERIFY_TRUSTEDCERTSTORETYPE_PFXFILE(2), PDFVERIFY_TRUSTEDCERTSTORETYPE_PFXBLOB(3), PDFVERIFY_TRUSTEDCERTSTORETYPE_JKSFILE(4), PDFVERIFY_TRUSTEDCERTSTORETYPE_JKSBLOB(5), PDFVERIFY_TRUSTEDCERTSTORETYPE_PEMKEY_FILE(6), PDFVERIFY_TRUSTEDCERTSTORETYPE_PEMKEY_BLOB(7), PDFVERIFY_TRUSTEDCERTSTORETYPE_PUBLIC_KEY_FILE(8), PDFVERIFY_TRUSTEDCERTSTORETYPE_PUBLIC_KEY_BLOB(9), PDFVERIFY_TRUSTEDCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), PDFVERIFY_TRUSTEDCERTSTORETYPE_P7BFILE(11), PDFVERIFY_TRUSTEDCERTSTORETYPE_P7BBLOB(12), PDFVERIFY_TRUSTEDCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), PDFVERIFY_TRUSTEDCERTSTORETYPE_PPKFILE(14), PDFVERIFY_TRUSTEDCERTSTORETYPE_PPKBLOB(15), PDFVERIFY_TRUSTEDCERTSTORETYPE_XMLFILE(16), PDFVERIFY_TRUSTEDCERTSTORETYPE_XMLBLOB(17), PDFVERIFY_TRUSTEDCERTSTORETYPE_JWKFILE(18), PDFVERIFY_TRUSTEDCERTSTORETYPE_JWKBLOB(19), PDFVERIFY_TRUSTEDCERTSTORETYPE_SECURITY_KEY(20), PDFVERIFY_TRUSTEDCERTSTORETYPE_BCFKSFILE(21), PDFVERIFY_TRUSTEDCERTSTORETYPE_BCFKSBLOB(22), PDFVERIFY_TRUSTEDCERTSTORETYPE_PKCS11(23), PDFVERIFY_TRUSTEDCERTSTORETYPE_AUTO(99) ``` ## Default Value 0 ## Remarks 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 property 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](#Type_Certificate) object and pass cstPKCS11 as the [TrustedCertStoreType](#trustedcertstoretype-property-securepdf_pdfverify-class), the full path of the PKCS#11 DLL as the [TrustedCertStore](#trustedcertstore-property-securepdf_pdfverify-class), and the PIN as the [TrustedCertStorePassword](#trustedcertstorepassword-property-securepdf_pdfverify-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [TrustedCertStore](#trustedcertstore-property-securepdf_pdfverify-class) and set [TrustedCertStorePassword](#trustedcertstorepassword-property-securepdf_pdfverify-class) 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. | The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type Integer # TrustedCertSubjectAltNames Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Comma-separated lists of alternative subject names for the certificate. ## Object Oriented Interface ```text public function getTrustedCertSubjectAltNames($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 183 , $trustedcertindex); ``` ## Default Value '' ## Remarks Comma-separated lists of alternative subject names for the certificate. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertThumbprintMD5 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The MD5 hash of the certificate. ## Object Oriented Interface ```text public function getTrustedCertThumbprintMD5($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 184 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertThumbprintSHA1 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The SHA-1 hash of the certificate. ## Object Oriented Interface ```text public function getTrustedCertThumbprintSHA1($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 185 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertThumbprintSHA256 Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The SHA-256 hash of the certificate. ## Object Oriented Interface ```text public function getTrustedCertThumbprintSHA256($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 186 , $trustedcertindex); ``` ## Default Value '' ## Remarks 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. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertUsage Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The text description of UsageFlags . ## Object Oriented Interface ```text public function getTrustedCertUsage($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 187 , $trustedcertindex); ``` ## Default Value '' ## Remarks The text description of [TrustedCertUsageFlags](#trustedcertusageflags-property-securepdf_pdfverify-class). 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. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertUsageFlags Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The flags that show intended use for the certificate. ## Object Oriented Interface ```text public function getTrustedCertUsageFlags($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 188 , $trustedcertindex); ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [TrustedCertUsageFlags](#trustedcertusageflags-property-securepdf_pdfverify-class) 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 [TrustedCertUsage](#trustedcertusage-property-securepdf_pdfverify-class) property for a text representation of [TrustedCertUsageFlags](#trustedcertusageflags-property-securepdf_pdfverify-class). This functionality currently is not available when the provider is OpenSSL. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type Integer # TrustedCertVersion Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certificate's version number. ## Object Oriented Interface ```text public function getTrustedCertVersion($trustedcertindex); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 189 , $trustedcertindex); ``` ## Default Value '' ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is read-only and not available at design time. ## Data Type String # TrustedCertSubject Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The subject of the certificate used for client authentication. ## Object Oriented Interface ```text public function getTrustedCertSubject($trustedcertindex); public function setTrustedCertSubject($trustedcertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 190 , $trustedcertindex); securepdf_pdfverify_set($res, 190, $value , $trustedcertindex); ``` ## Default Value '' ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. 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. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type String # TrustedCertEncoded Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The certificate (PEM/Base64 encoded). ## Object Oriented Interface ```text public function getTrustedCertEncoded($trustedcertindex); public function setTrustedCertEncoded($trustedcertindex, $value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 191 , $trustedcertindex); securepdf_pdfverify_set($res, 191, $value , $trustedcertindex); ``` ## Default Value '' ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [TrustedCertStore](#trustedcertstore-property-securepdf_pdfverify-class) and [TrustedCertSubject](#trustedcertsubject-property-securepdf_pdfverify-class) properties also may be used to specify a certificate. When [TrustedCertEncoded](#trustedcertencoded-property-securepdf_pdfverify-class) is set, a search is initiated in the current [TrustedCertStore](#trustedcertstore-property-securepdf_pdfverify-class) for the private key of the certificate. If the key is found, [TrustedCertSubject](#trustedcertsubject-property-securepdf_pdfverify-class) is updated to reflect the full subject of the selected certificate; otherwise, [TrustedCertSubject](#trustedcertsubject-property-securepdf_pdfverify-class) is set to an empty string. The *$trustedcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-securepdf_pdfverify-class) property. This property is not available at design time. ## Data Type Binary String # TrustedLists Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) A list of known Trusted Lists for chain validation. ## Object Oriented Interface ```text public function getTrustedLists(); public function setTrustedLists($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 192 ); securepdf_pdfverify_set($res, 192, $value ); ``` ## 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. ## Data Type String # TrustSources Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The trust sources to use during chain validation. ## Object Oriented Interface ```text public function getTrustSources(); public function setTrustSources($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 193 ); securepdf_pdfverify_set($res, 193, $value ); ``` ## Possible Values ```text PDFVERIFY_TRUSTSOURCES_MANUAL(0), PDFVERIFY_TRUSTSOURCES_LOCAL(1), PDFVERIFY_TRUSTSOURCES_TRUSTED_LISTS(2), PDFVERIFY_TRUSTSOURCES_LOCAL_AND_TRUSTED_LISTS(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 only. | | 1 (tsLocal) | The class consults local system stores (e.g., Windows Trusted Root Certification Authorities) as well as TrustedCerts. | | 2 (tsTrustedLists) | The class consults [TrustedLists](#trustedlists-property-securepdf_pdfverify-class) only. | | 3 (tsLocalAndTrustedLists - default) | The class consults local system stores, TrustedCerts, and [TrustedLists](#trustedlists-property-securepdf_pdfverify-class). | ## Data Type Integer # ValidationFlags Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) Additional chain validation settings. ## Object Oriented Interface ```text public function getValidationFlags(); public function setValidationFlags($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 194 ); securepdf_pdfverify_set($res, 194, $value ); ``` ## 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. | ## Data Type Integer # ValidationPolicy Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The level at which to perform chain validation. ## Object Oriented Interface ```text public function getValidationPolicy(); public function setValidationPolicy($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 195 ); securepdf_pdfverify_set($res, 195, $value ); ``` ## Possible Values ```text PDFVERIFY_VALIDATIONPOLICY_NONE(0), PDFVERIFY_VALIDATIONPOLICY_FULL(1), PDFVERIFY_VALIDATIONPOLICY_FULL_NO_TRUST(2), PDFVERIFY_VALIDATIONPOLICY_FULL_NO_REVOCATION(3), PDFVERIFY_VALIDATIONPOLICY_BEST_EFFORT(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. ## Data Type Integer # ValidationTime Property ([SecurePDF_PDFVerify](#pdfverify-class) Class) The time point at which the signature should be validated. ## Object Oriented Interface ```text public function getValidationTime(); public function setValidationTime($value); ``` ## Procedural Interface ```text securepdf_pdfverify_get($res, 196 ); securepdf_pdfverify_set($res, 196, $value ); ``` ## 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 (), or - The local time included in the signature by the signer (). 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. ## Data Type String # Close Method ([SecurePDF_PDFVerify](#pdfverify-class) Class) Closes the opened document. ## Object Oriented Interface ```text public function doClose(); ``` ## Procedural Interface ```text securepdf_pdfverify_do_close($res); ``` ## Remarks This method is used to close the previously opened document. It should always be preceded by a call to [Open](#open-method-securepdf_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-securepdf_pdfverify-class), [OutputData](#outputdata-property-securepdf_pdfverify-class), or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set [SaveChanges](#SaveChanges). # Config Method ([SecurePDF_PDFVerify](#pdfverify-class) Class) Sets or retrieves a configuration setting. ## Object Oriented Interface ```text public function doConfig($configurationstring); ``` ## Procedural Interface ```text securepdf_pdfverify_do_config($res, $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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Checks whether the document is encrypted. ## Object Oriented Interface ```text public function doEncrypted(); ``` ## Procedural Interface ```text securepdf_pdfverify_do_encrypted($res); ``` ## 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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Returns the value of a page property. ## Object Oriented Interface ```text public function doGetPageProperty($pageindex, $pageproperty); ``` ## Procedural Interface ```text securepdf_pdfverify_do_getpageproperty($res, $pageindex, $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-securepdf_pdfverify-class) event. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # GetSignedVersion Method ([SecurePDF_PDFVerify](#pdfverify-class) Class) Returns the part of the signed document that is covered by a signature. ## Object Oriented Interface ```text public function doGetSignedVersion($signatureindex); ``` ## Procedural Interface ```text securepdf_pdfverify_do_getsignedversion($res, $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 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 property 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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Interrupts the current action. ## Object Oriented Interface ```text public function doInterrupt(); ``` ## Procedural Interface ```text securepdf_pdfverify_do_interrupt($res); ``` ## Remarks This method interrupts the current action. It can be used, for example, within the [ChainCert](#chaincert-event-securepdf_pdfverify-class) event to abort the chain validation procedure. If there is no action in progress, this method simply returns, doing nothing. # Open Method ([SecurePDF_PDFVerify](#pdfverify-class) Class) Opens the document for processing. ## Object Oriented Interface ```text public function doOpen(); ``` ## Procedural Interface ```text securepdf_pdfverify_do_open($res); ``` ## Remarks This method is used to open the document specified in [InputFile](#inputfile-property-securepdf_pdfverify-class), [InputData](#inputdata-property-securepdf_pdfverify-class), or SetInputStream before performing some operation on it, such as verifying or removing signatures. When finished, call [Close](#close-method-securepdf_pdfverify-class) to complete or discard the operation. It is recommended to use this method (alongside [Close](#close-method-securepdf_pdfverify-class)) when performing multiple operations on the document at once. NOTE: This method populates the Attachments, DocumentCerts, and Signatures 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-securepdf_pdfverify-class) or [RecipientInfo](#recipientinfo-event-securepdf_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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Resets the class. ## Object Oriented Interface ```text public function doReset(); ``` ## Procedural Interface ```text securepdf_pdfverify_do_reset($res); ``` ## Remarks This method is used to reset the class's properties and configuration settings to their default values. # SaveAttachment Method ([SecurePDF_PDFVerify](#pdfverify-class) Class) Saves a PDF attachment to a file. ## Object Oriented Interface ```text public function doSaveAttachment($index, $filename); ``` ## Procedural Interface ```text securepdf_pdfverify_do_saveattachment($res, $index, $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 collection. *Index* is the index of the attachment in the Attachments 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 property if it's set ``` NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # Signed Method ([SecurePDF_PDFVerify](#pdfverify-class) Class) Checks whether the document is signed. ## Object Oriented Interface ```text public function doSigned(); ``` ## Procedural Interface ```text securepdf_pdfverify_do_signed($res); ``` ## 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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Removes a signature from the document. ## Object Oriented Interface ```text public function doUnsign($signatureindex, $unsignkind); ``` ## Procedural Interface ```text securepdf_pdfverify_do_unsign($res, $signatureindex, $unsignkind); ``` ## Remarks This method is used to remove an existing signature from the document. *SignatureIndex* is the index of the signature in the Signatures 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-securepdf_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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Verifies the signed document. ## Object Oriented Interface ```text public function doVerify(); ``` ## Procedural Interface ```text securepdf_pdfverify_do_verify($res); ``` ## 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-securepdf_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 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-securepdf_pdfverify-class) or to ensure that the signature covers the expected document revision. To control individual signature validation, subscribe to the [SignatureInfo](#signatureinfo-event-securepdf_pdfverify-class) event and set the *ValidateSignature* and *ValidateChain* parameters accordingly. The results are reported via the [SignatureProcessed](#signatureprocessed-event-securepdf_pdfverify-class) event. Use the following properties to adjust chain validation parameters: - BlockedCerts - KnownCerts - [OfflineMode](#offlinemode-property-securepdf_pdfverify-class) - [RevocationCheck](#revocationcheck-property-securepdf_pdfverify-class) - TrustedCerts - [TrustedLists](#trustedlists-property-securepdf_pdfverify-class) - [TrustSources](#trustsources-property-securepdf_pdfverify-class) - [ValidationFlags](#validationflags-property-securepdf_pdfverify-class) - [ValidationPolicy](#validationpolicy-property-securepdf_pdfverify-class) - [ValidationTime](#validationtime-property-securepdf_pdfverify-class) NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # ChainCert Event ([SecurePDF_PDFVerify](#pdfverify-class) Class) Fired when the class encounters a chain certificate. ## Object Oriented Interface ```text public function fireChainCert($param); ``` ## Procedural Interface ```text securepdf_pdfverify_register_callback($res, 1, array($this, 'fireChainCert')); ``` ## Parameter List ```text 'certencoded' 'certsubject' 'certissuer' 'validationtime' 'validationresult' 'validationdetails' ``` ## 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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Fired when the document has been loaded into memory. ## Object Oriented Interface ```text public function fireDocumentInfo($param); ``` ## Procedural Interface ```text securepdf_pdfverify_register_callback($res, 2, array($this, 'fireDocumentInfo')); ``` ## Parameter List ```text 'pagecount' '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-securepdf_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-securepdf_pdfverify-class) is called, but only after [Password](#password-event-securepdf_pdfverify-class) or [RecipientInfo](#recipientinfo-event-securepdf_pdfverify-class) is fired (if applicable) and the document has been decrypted. # Error Event ([SecurePDF_PDFVerify](#pdfverify-class) Class) Fired when information is available about errors during data delivery. ## Object Oriented Interface ```text public function fireError($param); ``` ## Procedural Interface ```text securepdf_pdfverify_register_callback($res, 3, array($this, 'fireError')); ``` ## Parameter List ```text 'errorcode' 'description' ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error. 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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Fired once for each log message. ## Object Oriented Interface ```text public function fireLog($param); ``` ## Procedural Interface ```text securepdf_pdfverify_register_callback($res, 4, array($this, 'fireLog')); ``` ## Parameter List ```text 'loglevel' 'message' '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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Fired when the class detects that the document is encrypted with a password. ## Object Oriented Interface ```text public function firePassword($param); ``` ## Procedural Interface ```text securepdf_pdfverify_register_callback($res, 5, array($this, 'firePassword')); ``` ## Parameter List ```text 'available' 'cancel' ``` ## 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-securepdf_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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Fired for each recipient certificate of the encrypted document. ## Object Oriented Interface ```text public function fireRecipientInfo($param); ``` ## Procedural Interface ```text securepdf_pdfverify_register_callback($res, 6, array($this, 'fireRecipientInfo')); ``` ## Parameter List ```text 'issuer' 'serialnumber' 'subjectkeyidentifier' 'available' 'cancel' ``` ## 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. *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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Fired when the class finds a signature in the document. ## Object Oriented Interface ```text public function fireSignatureInfo($param); ``` ## Procedural Interface ```text securepdf_pdfverify_register_callback($res, 7, array($this, 'fireSignatureInfo')); ``` ## Parameter List ```text 'signatureindex' 'validatesignature' 'validatechain' ``` ## 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 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-securepdf_pdfverify-class)). To skip validation entirely, set both parameters to *false*. Use the following properties to adjust chain validation parameters: - BlockedCerts - KnownCerts - [OfflineMode](#offlinemode-property-securepdf_pdfverify-class) - [RevocationCheck](#revocationcheck-property-securepdf_pdfverify-class) - TrustedCerts - [TrustedLists](#trustedlists-property-securepdf_pdfverify-class) - [TrustSources](#trustsources-property-securepdf_pdfverify-class) - [ValidationFlags](#validationflags-property-securepdf_pdfverify-class) - [ValidationPolicy](#validationpolicy-property-securepdf_pdfverify-class) - [ValidationTime](#validationtime-property-securepdf_pdfverify-class) # SignatureProcessed Event ([SecurePDF_PDFVerify](#pdfverify-class) Class) Fired after a signature has been processed. ## Object Oriented Interface ```text public function fireSignatureProcessed($param); ``` ## Procedural Interface ```text securepdf_pdfverify_register_callback($res, 8, array($this, 'fireSignatureProcessed')); ``` ## Parameter List ```text 'signatureindex' 'signaturevalidationresult' 'chainvalidationresult' '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-securepdf_pdfverify-class) if that event's *ValidateSignature* parameter is set to *true*. *SignatureIndex* is the index of the signature in the Signatures collection. Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each in *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 properties in the PDFSignature type. # SSLServerAuthentication Event ([SecurePDF_PDFVerify](#pdfverify-class) Class) Fired after the server presents its certificate to the client. ## Object Oriented Interface ```text public function fireSSLServerAuthentication($param); ``` ## Procedural Interface ```text securepdf_pdfverify_register_callback($res, 9, array($this, 'fireSSLServerAuthentication')); ``` ## Parameter List ```text 'certencoded' 'certsubject' 'certissuer' 'status' 'accept' ``` ## 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 ([SecurePDF_PDFVerify](#pdfverify-class) Class) Fired when secure connection progress messages are available. ## Object Oriented Interface ```text public function fireSSLStatus($param); ``` ## Procedural Interface ```text securepdf_pdfverify_register_callback($res, 10, array($this, 'fireSSLStatus')); ``` ## Parameter List ```text '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. # 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-securepdf_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 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 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 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 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 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-securepdf_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-securepdf_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-securepdf_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-securepdf_pdfverify-class) is called. Possible values are: | | | | --- | --- | | 0 | Discard all changes. | | 1 | Save the document to [OutputFile](#outputfile-property-securepdf_pdfverify-class), [OutputData](#outputdata-property-securepdf_pdfverify-class), or the stream set in SetOutputStream, even if it has not been modified. | | 2 (default) | Save the document to [OutputFile](#outputfile-property-securepdf_pdfverify-class), [OutputData](#outputdata-property-securepdf_pdfverify-class), or the stream set in SetOutputStream, 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 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 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 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 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. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **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*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. **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. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # 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-securepdf_pdfverify-class) already exists and [Overwrite](#overwrite-property-securepdf_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 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 ([](#f_Action)) are not supported by PDF/A. Set [EnforcePDFA](#EnforcePDFA) to false or clear the [](#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. | The class may also return one of the following error codes, which are inherited from other classes. ### 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. | The class may also return one of the following error codes, which are inherited from other classes. ### 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. | | 302 | 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). |