PDFVerifier Class
Properties Methods Events Configuration Settings Errors
The PDFVerifier class verifies signatures over PDF documents.
Syntax
PDFVerifier
Remarks
Use PDFVerifier to validate electronic signatures over PDF documents. Generic and PAdES signatures are supported.
PDFVerifier validates each signature from two perspectives: the integrity and validity of the signature itself (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 other way round, 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.
To initiate the validation, assign the path to the signed PDF file to the InputFile property (alternatively, you can provide it in a memory buffer via InputBytes property), and call Verify method. For every signature located in the document, PDFVerifier will fire the SignatureFound event. This event lets you specify whether you want PDFVerifier to validate the signature, the chain, or both.
Note: it does not mean that any of the two is optional. This API lets you be flexible in how you validate documents in your code in accordance with the specifics of your application and its usage scenarios. For example, if your trust environment relies on certificate pinning, validating the chain by PDFVerifier internally may cause unnecessary burden on the system, in which case it may be reasonable to disable it in the event handler.
Once SignatureFound returns, PDFVerifier proceeds to the signature validation routine in accordance with the provided settings. Upon completion of the validation, SignatureValidated event is fired, and the validation results are separately provided via SignatureValidationResult and ChainValidationResult properties. Other information about the signature can be accessed via the Signature property.
PDF format uses incremental updates to introduce changes to the document. This implies that a signature may cover not the whole document but, rather, a certain revision of it. Strictly speaking, every signature in a PDF document apart from, perhaps, 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 had been added.
Because of this specifics of PDF format it is crucially important to understand what part of the document is covered by a specific signature. Use the to establish the scope of a signature. The revision of the document covered by that specific signature ranges from byte 0 to CoverageEndsAt. Alternatively, you can use the GetSignedVersion method to extract the signed revision to a file.
Useful settings and properties
The following properties of PDFVerifier may be handy when working with this component:
- OfflineMode lets you validate the document without contacting online revocation sources. Paired with switched off system trust settings, it can be used to establish the long-term validity of the document and the completeness of validation material included in it.
- RevocationCheck lets you adjust the revocation checking preferences.
- ValidatedSigningTime returns the signing time as recorded in the embedded signature timestamp. This is in contrast to ClaimedSigningTime, which returns the signing time as specified by the signer.
- ValidationLog is a great way to find out the details of chain validation failures. This property returns a comprehensive validation log that reports all the issues encountered during the validation.
- If the document is encrypted (in addition to being signed), DecryptionInfoNeeded event will fire, asking you for the decryption certificate or password.
By default, PDFVerifier uses the system trust settings to establish certificate chain validity. You can configure it to use your own, custom validation environment by providing the necessary trust elements via KnownCertificates, TrustedCertificates, KnownCRLs, and other similar properties.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| AllSignaturesValid | The cumulative validity of all signatures. |
| BlockedCertCount | The number of records in the BlockedCert arrays. |
| BlockedCertBytes | Returns raw certificate data in DER format. |
| BlockedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| CertCount | The number of records in the Cert arrays. |
| CertBytes | Returns raw certificate data in DER format. |
| CertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| CertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| CertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| CertCurve | Specifies the elliptic curve of the EC public key. |
| CertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| CertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| CertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| CertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
| CertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| CertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| CertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| CertKeyBits | Returns the length of the public key. |
| CertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| CertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| CertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| CertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| CertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| CertPublicKeyBytes | Contains the certificate's public key in DER format. |
| CertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| CertSerialNumber | Returns the certificate's serial number. |
| CertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| CertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| CertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| CertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| CertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| CertValidTo | The time point at which the certificate expires, in UTC. |
| ChainValidationDetails | The details of a certificate chain validation outcome. |
| ChainValidationResult | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. |
| ClaimedSigningTime | Returns a signature's claimed signing time. |
| CRLCount | The number of records in the CRL arrays. |
| CRLBytes | Returns raw CRL data in DER format. |
| CRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| CRLIssuer | The common name of the CRL issuer (CA), typically a company name. |
| CRLIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
| CRLLocation | The URL that the CRL was downloaded from. |
| CRLNextUpdate | The planned time and date of the next version of this CRL to be published. |
| CRLThisUpdate | The date and time at which this version of the CRL was published. |
| CurrentCACertBytes | Returns raw certificate data in DER format. |
| CurrentCACertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| CurrentCACertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| CurrentCACertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| CurrentCACertCurve | Specifies the elliptic curve of the EC public key. |
| CurrentCACertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| CurrentCACertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| CurrentCACertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| CurrentCACertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
| CurrentCACertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| CurrentCACertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| CurrentCACertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| CurrentCACertKeyBits | Returns the length of the public key. |
| CurrentCACertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| CurrentCACertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| CurrentCACertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| CurrentCACertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| CurrentCACertOCSPNoCheck | TBD. |
| CurrentCACertOrigin | Returns the origin of this certificate. |
| CurrentCACertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| CurrentCACertPrivateKeyBytes | Contains the certificate's private key. |
| CurrentCACertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
| CurrentCACertPrivateKeyExtractable | Indicates whether the private key is extractable. |
| CurrentCACertPublicKeyBytes | Contains the certificate's public key in DER format. |
| CurrentCACertQualifiedStatements | TBD. |
| CurrentCACertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| CurrentCACertSerialNumber | Returns the certificate's serial number. |
| CurrentCACertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| CurrentCACertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| CurrentCACertSubjectAlternativeName | TBD. |
| CurrentCACertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| CurrentCACertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| CurrentCACertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| CurrentCACertValidTo | The time point at which the certificate expires, in UTC. |
| CurrentCertBytes | Returns raw certificate data in DER format. |
| CurrentCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| CurrentCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| CurrentCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| CurrentCertCurve | Specifies the elliptic curve of the EC public key. |
| CurrentCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| CurrentCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| CurrentCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| CurrentCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
| CurrentCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| CurrentCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| CurrentCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| CurrentCertKeyBits | Returns the length of the public key. |
| CurrentCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| CurrentCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| CurrentCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| CurrentCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| CurrentCertOCSPNoCheck | TBD. |
| CurrentCertOrigin | Returns the origin of this certificate. |
| CurrentCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| CurrentCertPrivateKeyBytes | Contains the certificate's private key. |
| CurrentCertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
| CurrentCertPrivateKeyExtractable | Indicates whether the private key is extractable. |
| CurrentCertPublicKeyBytes | Contains the certificate's public key in DER format. |
| CurrentCertQualifiedStatements | TBD. |
| CurrentCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| CurrentCertSerialNumber | Returns the certificate's serial number. |
| CurrentCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| CurrentCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| CurrentCertSubjectAlternativeName | TBD. |
| CurrentCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| CurrentCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| CurrentCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| CurrentCertValidTo | The time point at which the certificate expires, in UTC. |
| DecryptionCertificateBytes | Returns raw certificate data in DER format. |
| DecryptionCertificateHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| DecryptionCertCount | The number of records in the DecryptionCert arrays. |
| DecryptionCertBytes | Returns raw certificate data in DER format. |
| DecryptionCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| Encrypted | Indicates if the PDF document is encrypted. |
| EncryptionAlgorithm | The symmetric algorithm used to encrypt the document. |
| EncryptionType | The document encryption type. |
| FIPSMode | Reserved. |
| IgnoreChainValidationErrors | Makes the class tolerant to chain validation errors. |
| InputBytes | Use this property to pass the input to class in the byte array form. |
| InputFile | A path to the signed PDF file. |
| InterimValidationDetails | Contains the validation details of the moment. |
| InterimValidationResult | Contains the validation status of the moment. |
| KnownCertCount | The number of records in the KnownCert arrays. |
| KnownCertBytes | Returns raw certificate data in DER format. |
| KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| KnownCRLCount | The number of records in the KnownCRL arrays. |
| KnownCRLBytes | Returns raw CRL data in DER format. |
| KnownCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| KnownOCSPCount | The number of records in the KnownOCSP arrays. |
| KnownOCSPBytes | Buffer containing raw OCSP response data. |
| KnownOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| MetadataEncrypted | Indicates if the document metadata is encrypted. |
| OCSPCount | The number of records in the OCSP arrays. |
| OCSPBytes | Buffer containing raw OCSP response data. |
| OCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| OCSPIssuer | Indicates the issuer of this response (a CA or its authorized representative). |
| OCSPIssuerRDN | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
| OCSPLocation | Location of the OCSP responder. |
| OCSPProducedAt | Specifies the time when the response was produced, in UTC. |
| OfflineMode | Switches the class to the offline mode. |
| Password | The decryption password. |
| PermsAnnotations | Indicates whether the viewer may add annotations to the document. |
| PermsAssemble | Indicates if the viewer may assemble a new document on the basis of the encrypted one. |
| PermsExtract | Indicates if the user may extract (copy) pictures and text from the encrypted document. |
| PermsExtractAcc | Indicates if the user may extract pictures/text from the document for accessibility purposes. |
| PermsFillInForms | Indicates if the user may fill in forms in the document. |
| PermsHighQualityPrint | Indicates if the document may be printed in high quality. |
| PermsLowQualityPrint | Indicates if the document may be printed in low quality. |
| PermsModify | Indicates if the document may be modified. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| ProxyAddress | The IP address of the proxy server. |
| ProxyAuthentication | The authentication type used by the proxy server. |
| ProxyPassword | The password to authenticate to the proxy server. |
| ProxyPort | The port on the proxy server to connect to. |
| ProxyProxyType | The type of the proxy server. |
| ProxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| ProxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| ProxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| ProxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
| ProxyUseProxy | Enables or disables proxy-driven connection. |
| ProxyUsername | Specifies the username credential for proxy authentication. |
| Qualified | Indicates a qualified electronic signature. |
| RevocationCheck | Specifies the kind(s) of revocation check to perform. |
| SigAllowedChanges | The changes to the document are allowed by the signature. |
| SigAuthorName | A human-readable signer name. |
| SigCertification | Specifies whether this is a Certification (MDP) signature. |
| SigChainValidationDetails | The details of a certificate chain validation outcome. |
| SigChainValidationResult | The outcome of a certificate chain validation routine. |
| SigClaimedSigningTime | Returns or sets signature's creation time. |
| SigContactInfo | Contains signer's contact information. |
| SigCoverageEndsAt | Indicates the offset in the PDF file where signature coverage ends. |
| SigCustomData | A uninterpreted custom data to save with the signature. |
| SigEmptyField | Indicates whether or not the signature created/read is an empty property (a signature placeholder). |
| SigFilterName | The signature filter name. |
| SigFullSignatureName | Specifies the full name of the signature property. |
| SigHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SigHashAlgorithm | Specifies the hash algorithm to be used for signing. |
| SigHeight | Specifies the height of the signature widget. |
| SigInvisible | Controls whether the signature widget is visible on the page. |
| SigLevel | Specifies the signature kind and level. |
| SigLocation | Specifies the host name or the physical location of the signing entity. |
| SigOffsetX | Specifies the signature widget offset from the left-hand page border when AutoPos is False. |
| SigOffsetY | Specifies the signature widget offset from the bottom page border when AutoPos is False. |
| SigPage | The index of the page on which to place the signature. |
| SigPolicyHashAlgorithm | The algorithm that was used to calculate the signature policy hash. |
| SigPrint | Whether the signature shall appear in printed documents. |
| SigQualified | Indicates a qualified electronic signature. |
| SigReadOnly | Controls the ReadOnly flag of the widget. |
| SigReason | Specifies the reason for signing. |
| SigSignatureName | Specifies the unique signature identifier to use. |
| SigSignatureValidationResult | The outcome of the cryptographic signature validation. |
| SigSignerInfo | Provides custom signer information to put on the signature widget. |
| SigSubjectRDN | Contains the RDN of the owner of the signing certificate. |
| SigTimestamped | Indicates if the signature is timestamped. |
| SigValidatedSigningTime | Contains the certified signing time. |
| SigValidationLog | Contains the signing certificate's chain validation log. |
| SigWidth | Specifies the width of the signature widget. |
| SignatureCount | The number of records in the Signature arrays. |
| SignatureChainValidationDetails | The details of a certificate chain validation outcome. |
| SignatureChainValidationResult | The outcome of a certificate chain validation routine. |
| SignatureClaimedSigningTime | Returns or sets signature's creation time. |
| SignatureHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SignatureLevel | Specifies the signature kind and level. |
| SignatureSignatureValidationResult | The outcome of the cryptographic signature validation. |
| SignatureSubjectRDN | Contains the RDN of the owner of the signing certificate. |
| SignatureTimestamped | Indicates if the signature is timestamped. |
| SignatureValidatedSigningTime | Contains the certified signing time. |
| SignatureValidationLog | Contains the signing certificate's chain validation log. |
| SignatureValidationResult | The signature validation result. |
| SigningCertBytes | Returns raw certificate data in DER format. |
| SigningCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| SigningCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| SigningCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| SigningCertCurve | Specifies the elliptic curve of the EC public key. |
| SigningCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| SigningCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SigningCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
| SigningCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| SigningCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| SigningCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| SigningCertKeyBits | Returns the length of the public key. |
| SigningCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| SigningCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| SigningCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| SigningCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| SigningCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| SigningCertPublicKeyBytes | Contains the certificate's public key in DER format. |
| SigningCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| SigningCertSerialNumber | Returns the certificate's serial number. |
| SigningCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| SigningCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| SigningCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| SigningCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| SigningCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| SigningCertValidTo | The time point at which the certificate expires, in UTC. |
| SocketDNSMode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
| SocketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
| SocketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
| SocketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
| SocketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
| SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
| SocketLocalAddress | The local network interface to bind the socket to. |
| SocketLocalPort | The local port number to bind the socket to. |
| SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
| SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| SocketUseIPv6 | Enables or disables IP protocol version 6. |
| TimestampAccuracy | This property indicates the accuracy of the included time mark, in microseconds. |
| TimestampBytes | Returns raw timestamp data in DER format. |
| TimestampChainValidationDetails | The details of a certificate chain validation outcome. |
| TimestampChainValidationResult | The outcome of a certificate chain validation routine. |
| TimestampHashAlgorithm | Returns the timestamp's hash algorithm SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
| TimestampSerialNumber | Returns the timestamp's serial number. |
| TimestampTime | The time point incorporated into the timestamp. |
| TimestampTimestampType | Returns the timestamp type. |
| TimestampTSAName | This value uniquely identifies the Timestamp Authority (TSA). |
| TimestampValidationLog | Contains the TSA certificate chain validation log. |
| TimestampValidationResult | Contains timestamp validation outcome. |
| Timestamped | Indicates whether or not the signature is timestamped. |
| TLSClientCertCount | The number of records in the TLSClientCert arrays. |
| TLSClientCertBytes | Returns raw certificate data in DER format. |
| TLSClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| TLSServerCertCount | The number of records in the TLSServerCert arrays. |
| TLSServerCertBytes | Returns raw certificate data in DER format. |
| TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
| TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
| TLSECCurves | Defines the elliptic curves to enable. |
| TLSExtensions | Provides access to TLS extensions. |
| TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
| TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
| TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
| TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
| TLSTLSMode | Specifies the TLS mode to use. |
| TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
| TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
| TLSVersions | Th SSL/TLS versions to enable by default. |
| TrustedCertCount | The number of records in the TrustedCert arrays. |
| TrustedCertBytes | Returns raw certificate data in DER format. |
| TrustedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| TSACertBytes | Returns raw certificate data in DER format. |
| TSACertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| TSACertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| TSACertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| TSACertCurve | Specifies the elliptic curve of the EC public key. |
| TSACertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| TSACertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| TSACertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| TSACertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
| TSACertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| TSACertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| TSACertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| TSACertKeyBits | Returns the length of the public key. |
| TSACertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| TSACertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| TSACertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| TSACertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| TSACertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| TSACertPublicKeyBytes | Contains the certificate's public key in DER format. |
| TSACertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| TSACertSerialNumber | Returns the certificate's serial number. |
| TSACertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| TSACertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| TSACertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| TSACertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| TSACertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| TSACertValidTo | The time point at which the certificate expires, in UTC. |
| ValidatedSigningTime | Contains the certified signing time. |
| ValidationLog | Contains the complete log of the certificate validation routine. |
| ValidationMoment | The time point at which signature validity is to be established. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| GetSignedVersion | Returns the part of the document that is covered by the signature. |
| Verify | Verifies a signed PDF 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.
| ChainElementDownload | TBD. |
| ChainElementNeeded | TBD. |
| ChainValidated | Reports the completion of a certificate chain validation. |
| DecryptionInfoNeeded | Requests decryption information during decryption, signing, or validation. |
| Error | Information about errors during signing/validation. |
| Notification | This event notifies the application about an underlying control flow event. |
| RecipientFound | Provides recipient certificate details to the application. |
| SignatureFound | Signifies the start of signature validation. |
| SignatureValidated | Marks the completion of the signature validation routine. |
| TimestampFound | Signifies the start of a timestamp validation routine. |
| TimestampValidated | Reports the completion of the timestamp validation routine. |
| TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| ValidationProgress | TBD. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| CustomTSLs | Specifies the custom TSLs. |
| EmptySignatureFieldAddRevInfo[Index] | Specifies if revocation checking should be performed. |
| EmptySignatureFieldAlternateName[Index] | Contains an alternate field name. |
| EmptySignatureFieldCount | The number of empty signature form fields. |
| EmptySignatureFieldFlags[Index] | The field flags of the signature form field. |
| EmptySignatureFieldHeight[Index] | The Height of the empty signature form field. |
| EmptySignatureFieldInvisible[Index] | The visibility status of the field. |
| EmptySignatureFieldLegalAttestations[Index] | Specifies the legal attestations that are associated with the signature. |
| EmptySignatureFieldMappingName[Index] | The mapping name to be used when exporting form field data from the document. |
| EmptySignatureFieldName[Index] | Textual field name. |
| EmptySignatureFieldOffsetX[Index] | The field's offset from the left page border. |
| EmptySignatureFieldOffsetY[Index] | The field's offset from the bottom page border. |
| EmptySignatureFieldPage[Index] | The index of the form field's page in the document. |
| EmptySignatureFieldRequiredAllowedChanges[Index] | Specifies the changes allowed by the signature. |
| EmptySignatureFieldRequiredConstraints[Index] | Specifies the required Seed Value Dictionary (SVD) constraints. |
| EmptySignatureFieldRequiredDigestAlgorithms[Index] | Specifies the required digest algorithms. |
| EmptySignatureFieldRequiredFilter[Index] | Specifies the required filter. |
| EmptySignatureFieldRequiredLockAction[Index] | Indicates which set of fields shall be locked. |
| EmptySignatureFieldRequiredLockFields[Index] | Indicates the fields that shall be locked on signing. |
| EmptySignatureFieldRequiredReasons[Index] | Specifies the required reasons. |
| EmptySignatureFieldRequiredSubfilters[Index] | Specifies the required subfilters. |
| EmptySignatureFieldTimestampRequired[Index] | Specifies if the signature should be time-stamped. |
| EmptySignatureFieldTSPURL[Index] | URL for a TSP server. |
| EmptySignatureFieldWidth[Index] | The Width of the empty signature form field. |
| EncryptionHandlerName | Specifies the custom security handler PDF-name. |
| ForceCompleteChainValidation | Whether to check issuer (CA) certificates when the signing certificate is invalid. |
| ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| GracePeriod | Specifies a grace period to apply during revocation information checks. |
| HardenedKeyGeneration | Specifies if hardened Key generation should be used. |
| IgnoreOCSPNoCheckExtension | Whether OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| PageInfoCount | The number of pages. |
| PageInfoCropBoxEmpty[Index] | Check if the page's crop box is empty or not. |
| PageInfoCropLLX[Index] | Defines the X coordinate of the lower left corner of the crop box. |
| PageInfoCropLLY[Index] | Defines the Y coordinate of the lower left corner of the crop box. |
| PageInfoCropURX[Index] | Defines the X coordinate of the upper right corner of the crop box. |
| PageInfoCropURY[Index] | Defines the Y coordinate of the upper right corner of the crop box. |
| PageInfoHeight[Index] | The Height of the page. |
| PageInfoMediaLLX[Index] | Defines the X coordinate of the lower left corner of the media box. |
| PageInfoMediaLLY[Index] | Defines the Y coordinate of the lower left corner of the media box. |
| PageInfoMediaURX[Index] | Defines the X coordinate of the upper right corner of the media box. |
| PageInfoMediaURY[Index] | Defines the Y coordinate of the upper right corner of the media box. |
| PageInfoRotate[Index] | The Rotate value of the page. |
| PageInfoUserUnit[Index] | Defines the size of default user space units. |
| PageInfoWidth[Index] | The Width of the page. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| PSSUsed | Whether RSASSA-PSS mode was used. |
| QualifiedStatus | Indicates a qualified electronic signature. |
| RC4KeyBits | Specifies the number of key bits used for RC4 algorithm. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| TSLDistributionPoints | Contains XML content of distribution points of the TSL used. |
| TSLDistributionPoints[Idx] | Contains distribution point of the specified index of the TSL used. |
| TSLHistoricalInformationPeriod | Contains historical information period of the TSL used. |
| TSLLegalNotices | Contains XML content of legal notices of the TSL used. |
| TSLLegalNotices[lang] | Contains legal notices for the specified language of the TSL used. |
| TSLListIssueDateTime | Contains list issue date and time of the TSL used. |
| TSLNextUpdate | Contains next update date and time of the TSL used. |
| TSLPolicies | Contains XML content of policies of the TSL used. |
| TSLPolicies[lang] | Contains policies for the specified language of the TSL used. |
| TSLSchemeExtensions | Contains XML content of scheme extensions of the TSL used. |
| TSLSchemeExtensions[Idx] | Contains XML content of scheme extension of the specified index of the TSL used. |
| TSLSchemeInformationURI | Contains XML content of scheme information URI of the TSL used. |
| TSLSchemeInformationURI[lang] | Contains scheme information URI for the specified language of the TSL used. |
| TSLSchemeName | Contains XML content of scheme name of the TSL used. |
| TSLSchemeName[lang] | Contains scheme name for the specified language of the TSL used. |
| TSLSchemeOperatorAddress | Contains XML content of scheme operator address of the TSL used. |
| TSLSchemeOperatorName | Contains XML content of scheme operator name of the TSL used. |
| TSLSchemeOperatorName[lang] | Contains scheme operator name for the specified language of the TSL used. |
| TSLSchemeTerritory | Contains scheme territory of the TSL used. |
| TSLSchemeTypeCommunityRules | Contains XML content of scheme type/community/rules of the TSL used. |
| TSLSchemeTypeCommunityRules[lang] | Contains scheme type/community/rules for the specified language of the TSL used. |
| TSLSequenceNumber | Contains sequence number of the TSL used. |
| TSLsRetrieveLog | Contains the complete log of the TSLs retrieve. |
| TSLStatusDeterminationApproach | Contains status determination approach of the TSL used. |
| TSLsValidationLog | Contains the complete log of the TSLs validation. |
| TSLTSPAdditionalServiceInformation | Contains addtional service information of the TSP service used. |
| TSLTSPAddress | Contains XML content of the address of the TSP used. |
| TSLTSPHistoryInstance | Indicates that TSP service history instance used. |
| TSLTSPHistoryInstanceAdditionalServiceInformation | Contains addtional service information of the TSP service history instance used. |
| TSLTSPHistoryInstanceQualifiers | Contains list of qualifiers of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceInformationExtensions | Contains XML content of information extensions of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceName | Contains XML content of name of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceName[lang] | Contains name for the specified language of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceStatus | Contains status of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceStatusStartingTime | Contains status starting time of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceTypeIdentifier | Contains type identifier of the TSP service history instance used. |
| TSLTSPHistoryInstanceXML | Contains XML content of the TSP service history instance used. |
| TSLTSPInformationExtensions | Contains XML content of information extensions of the TSP used. |
| TSLTSPInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP used. |
| TSLTSPInformationURI | Contains XML content of information URI of the TSP used. |
| TSLTSPInformationURI[lang] | Contains information URI for the specified language of the TSP used. |
| TSLTSPName | Contains XML content of name of the TSP used. |
| TSLTSPName[lang] | Contains name for the specified language of the TSP used. |
| TSLTSPSchemeServiceDefinitionURI | Contains XML content of scheme service definition URI of the TSP service used. |
| TSLTSPSchemeServiceDefinitionURI[lang] | Contains scheme service definition URI for the specified language of the TSP service used. |
| TSLTSPServiceDefinitionURI | Contains XML content of definition URI of the TSP service used. |
| TSLTSPServiceDefinitionURI[lang] | Contains definition URI for the specified language of the TSP service used. |
| TSLTSPServiceInformationExtensions | Contains XML content of information extensions of the TSP service used. |
| TSLTSPServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service used. |
| TSLTSPServiceName | Contains XML content of name of the TSP service used. |
| TSLTSPServiceName[lang] | Contains name for the specified language of the TSP service used. |
| TSLTSPServiceQualifiers | Contains list of qualifiers of the TSP service used. |
| TSLTSPServiceStatus | Contains status of the TSP service used. |
| TSLTSPServiceStatusStartingTime | Contains status starting time of the TSP service used. |
| TSLTSPServiceSupplyPoints | Contains XML content of the supply points of the TSP service used. |
| TSLTSPServiceTypeIdentifier | Contains type identifier of the TSP service used. |
| TSLTSPServiceXML | Contains XML content of the TSP service used. |
| TSLTSPTradeName | Contains XML content of trade name of the TSP used. |
| TSLTSPTradeName[lang] | Contains trade name for the specified language of the TSP used. |
| TSLTSPXML | Contains XML content of the TSP used. |
| TSLType | Contains TSL type of the TSL used. |
| TSLVersionIdentifier | Contains version identifier of the TSL used. |
| TSLXML | Contains XML content of the TSL used. |
| UseDefaultTSLs | Enables or disables the use of the default TSLs. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| Tag | Allows to store any custom data. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
AllSignaturesValid Property (PDFVerifier Class)
The cumulative validity of all signatures.
Syntax
bool GetAllSignaturesValid();
Default Value
false
Remarks
Use this property to check if all the signatures found in the message or document are valid.
This property is read-only and not available at design time.
Data Type
Boolean
BlockedCertCount Property (PDFVerifier Class)
The number of records in the BlockedCert arrays.
Syntax
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at BlockedCertCount - 1.This property is not available at design time.
Data Type
Integer
BlockedCertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetBlockedCertBytes(int iBlockedCertIndex);
Remarks
Returns raw certificate data in DER format.
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
BlockedCertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is not available at design time.
Data Type
Long64
CertCount Property (PDFVerifier Class)
The number of records in the Cert arrays.
Syntax
int GetCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- CertBytes
- CertCA
- CertCAKeyID
- CertCRLDistributionPoints
- CertCurve
- CertFingerprint
- CertFriendlyName
- CertHandle
- CertHashAlgorithm
- CertIssuer
- CertIssuerRDN
- CertKeyAlgorithm
- CertKeyBits
- CertKeyFingerprint
- CertKeyUsage
- CertKeyValid
- CertOCSPLocations
- CertPolicyIDs
- CertPublicKeyBytes
- CertSelfSigned
- CertSerialNumber
- CertSigAlgorithm
- CertSubject
- CertSubjectKeyID
- CertSubjectRDN
- CertValidFrom
- CertValidTo
This property is read-only and not available at design time.
Data Type
Integer
CertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetCertBytes(int iCertIndex);
Remarks
Returns raw certificate data in DER format.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertCA Property (PDFVerifier Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
bool GetCertCA(int iCertIndex);
Default Value
false
Remarks
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CertCAKeyID Property (PDFVerifier Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetCertCAKeyID(int iCertIndex);
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertCRLDistributionPoints Property (PDFVerifier Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
QString GetCertCRLDistributionPoints(int iCertIndex);
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertCurve Property (PDFVerifier Class)
Specifies the elliptic curve of the EC public key.
Syntax
QString GetCertCurve(int iCertIndex);
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertFingerprint Property (PDFVerifier Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetCertFingerprint(int iCertIndex);
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertFriendlyName Property (PDFVerifier Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
QString GetCertFriendlyName(int iCertIndex);
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetCertHandle(int iCertIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Long64
CertHashAlgorithm Property (PDFVerifier Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
QString GetCertHashAlgorithm(int iCertIndex);
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertIssuer Property (PDFVerifier Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetCertIssuer(int iCertIndex);
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertIssuerRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetCertIssuerRDN(int iCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertKeyAlgorithm Property (PDFVerifier Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetCertKeyAlgorithm(int iCertIndex);
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertKeyBits Property (PDFVerifier Class)
Returns the length of the public key.
Syntax
int GetCertKeyBits(int iCertIndex);
Default Value
0
Remarks
Returns the length of the public key.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Integer
CertKeyFingerprint Property (PDFVerifier Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetCertKeyFingerprint(int iCertIndex);
Remarks
Returns a fingerprint of the public key contained in the certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertKeyUsage Property (PDFVerifier Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetCertKeyUsage(int iCertIndex);
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Integer
CertKeyValid Property (PDFVerifier Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
bool GetCertKeyValid(int iCertIndex);
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CertOCSPLocations Property (PDFVerifier Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
QString GetCertOCSPLocations(int iCertIndex);
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertPolicyIDs Property (PDFVerifier Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
QString GetCertPolicyIDs(int iCertIndex);
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertPublicKeyBytes Property (PDFVerifier Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetCertPublicKeyBytes(int iCertIndex);
Remarks
Contains the certificate's public key in DER format.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertSelfSigned Property (PDFVerifier Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetCertSelfSigned(int iCertIndex);
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CertSerialNumber Property (PDFVerifier Class)
Returns the certificate's serial number.
Syntax
QByteArray GetCertSerialNumber(int iCertIndex);
Remarks
Returns the certificate's serial number.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertSigAlgorithm Property (PDFVerifier Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetCertSigAlgorithm(int iCertIndex);
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertSubject Property (PDFVerifier Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetCertSubject(int iCertIndex);
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertSubjectKeyID Property (PDFVerifier Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetCertSubjectKeyID(int iCertIndex);
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CertSubjectRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetCertSubjectRDN(int iCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertValidFrom Property (PDFVerifier Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetCertValidFrom(int iCertIndex);
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
CertValidTo Property (PDFVerifier Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetCertValidTo(int iCertIndex);
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only and not available at design time.
Data Type
String
ChainValidationDetails Property (PDFVerifier Class)
The details of a certificate chain validation outcome.
Syntax
int GetChainValidationDetails();
Default Value
0
Remarks
Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
Data Type
Integer
ChainValidationResult Property (PDFVerifier Class)
The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
Syntax
int GetChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only and not available at design time.
Data Type
Integer
ClaimedSigningTime Property (PDFVerifier Class)
Returns a signature's claimed signing time.
Syntax
QString GetClaimedSigningTime();
Default Value
""
Remarks
Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by the signature and may be forfeited or wrong. Use ValidatedSigningTime to obtain the signing time figure verified by a trusted timestamping authority. The time is in UTC.
This property is read-only and not available at design time.
Data Type
String
CRLCount Property (PDFVerifier Class)
The number of records in the CRL arrays.
Syntax
int GetCRLCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at CRLCount - 1.This property is read-only and not available at design time.
Data Type
Integer
CRLBytes Property (PDFVerifier Class)
Returns raw CRL data in DER format.
Syntax
QByteArray GetCRLBytes(int iCRLIndex);
Remarks
Returns raw CRL data in DER format.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
CRLHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetCRLHandle(int iCRLIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
Long64
CRLIssuer Property (PDFVerifier Class)
The common name of the CRL issuer (CA), typically a company name.
Syntax
QString GetCRLIssuer(int iCRLIndex);
Default Value
""
Remarks
The common name of the CRL issuer (CA), typically a company name.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
String
CRLIssuerRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Syntax
QString GetCRLIssuerRDN(int iCRLIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
String
CRLLocation Property (PDFVerifier Class)
The URL that the CRL was downloaded from.
Syntax
QString GetCRLLocation(int iCRLIndex);
Default Value
""
Remarks
The URL that the CRL was downloaded from.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
String
CRLNextUpdate Property (PDFVerifier Class)
The planned time and date of the next version of this CRL to be published.
Syntax
QString GetCRLNextUpdate(int iCRLIndex);
Default Value
""
Remarks
The planned time and date of the next version of this CRL to be published.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
String
CRLThisUpdate Property (PDFVerifier Class)
The date and time at which this version of the CRL was published.
Syntax
QString GetCRLThisUpdate(int iCRLIndex);
Default Value
""
Remarks
The date and time at which this version of the CRL was published.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetCurrentCACertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertCA Property (PDFVerifier Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
bool GetCurrentCACertCA();
Default Value
false
Remarks
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCACertCAKeyID Property (PDFVerifier Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetCurrentCACertCAKeyID();
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertCRLDistributionPoints Property (PDFVerifier Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
QString GetCurrentCACertCRLDistributionPoints();
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertCurve Property (PDFVerifier Class)
Specifies the elliptic curve of the EC public key.
Syntax
QString GetCurrentCACertCurve();
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
This property is read-only and not available at design time.
Data Type
String
CurrentCACertFingerprint Property (PDFVerifier Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetCurrentCACertFingerprint();
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertFriendlyName Property (PDFVerifier Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
QString GetCurrentCACertFriendlyName();
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetCurrentCACertHandle();
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
CurrentCACertHashAlgorithm Property (PDFVerifier Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
QString GetCurrentCACertHashAlgorithm();
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is read-only and not available at design time.
Data Type
String
CurrentCACertIssuer Property (PDFVerifier Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetCurrentCACertIssuer();
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertIssuerRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetCurrentCACertIssuerRDN();
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertKeyAlgorithm Property (PDFVerifier Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetCurrentCACertKeyAlgorithm();
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
This property is read-only and not available at design time.
Data Type
String
CurrentCACertKeyBits Property (PDFVerifier Class)
Returns the length of the public key.
Syntax
int GetCurrentCACertKeyBits();
Default Value
0
Remarks
Returns the length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertKeyFingerprint Property (PDFVerifier Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetCurrentCACertKeyFingerprint();
Remarks
Returns a fingerprint of the public key contained in the certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertKeyUsage Property (PDFVerifier Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetCurrentCACertKeyUsage();
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertKeyValid Property (PDFVerifier Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
bool GetCurrentCACertKeyValid();
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCACertOCSPLocations Property (PDFVerifier Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
QString GetCurrentCACertOCSPLocations();
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertOCSPNoCheck Property (PDFVerifier Class)
TBD.
Syntax
bool GetCurrentCACertOCSPNoCheck();
Default Value
false
Remarks
TBD.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCACertOrigin Property (PDFVerifier Class)
Returns the origin of this certificate.
Syntax
int GetCurrentCACertOrigin();
Default Value
0
Remarks
Returns the origin of this certificate.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertPolicyIDs Property (PDFVerifier Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
QString GetCurrentCACertPolicyIDs();
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertPrivateKeyBytes Property (PDFVerifier Class)
Contains the certificate's private key.
Syntax
QByteArray GetCurrentCACertPrivateKeyBytes();
Remarks
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertPrivateKeyExists Property (PDFVerifier Class)
Indicates whether the certificate has an associated private key.
Syntax
bool GetCurrentCACertPrivateKeyExists();
Default Value
false
Remarks
Indicates whether the certificate has an associated private key.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCACertPrivateKeyExtractable Property (PDFVerifier Class)
Indicates whether the private key is extractable.
Syntax
bool GetCurrentCACertPrivateKeyExtractable();
Default Value
false
Remarks
Indicates whether the private key is extractable
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCACertPublicKeyBytes Property (PDFVerifier Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetCurrentCACertPublicKeyBytes();
Remarks
Contains the certificate's public key in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertQualifiedStatements Property (PDFVerifier Class)
TBD.
Syntax
int GetCurrentCACertQualifiedStatements();
Possible Values
QST_NON_QUALIFIED(0),
QST_QUALIFIED_HARDWARE(1),
QST_QUALIFIED_SOFTWARE(2)
Default Value
0
Remarks
TBD
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertSelfSigned Property (PDFVerifier Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetCurrentCACertSelfSigned();
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCACertSerialNumber Property (PDFVerifier Class)
Returns the certificate's serial number.
Syntax
QByteArray GetCurrentCACertSerialNumber();
Remarks
Returns the certificate's serial number.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertSigAlgorithm Property (PDFVerifier Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetCurrentCACertSigAlgorithm();
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertSubject Property (PDFVerifier Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetCurrentCACertSubject();
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertSubjectAlternativeName Property (PDFVerifier Class)
TBD.
Syntax
QString GetCurrentCACertSubjectAlternativeName();
Default Value
""
Remarks
TBD.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertSubjectKeyID Property (PDFVerifier Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetCurrentCACertSubjectKeyID();
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertSubjectRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetCurrentCACertSubjectRDN();
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
This property is read-only and not available at design time.
Data Type
String
CurrentCACertValidFrom Property (PDFVerifier Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetCurrentCACertValidFrom();
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertValidTo Property (PDFVerifier Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetCurrentCACertValidTo();
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
This property is read-only and not available at design time.
Data Type
String
CurrentCertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetCurrentCertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertCA Property (PDFVerifier Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
bool GetCurrentCertCA();
Default Value
false
Remarks
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCertCAKeyID Property (PDFVerifier Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetCurrentCertCAKeyID();
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertCRLDistributionPoints Property (PDFVerifier Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
QString GetCurrentCertCRLDistributionPoints();
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
This property is read-only and not available at design time.
Data Type
String
CurrentCertCurve Property (PDFVerifier Class)
Specifies the elliptic curve of the EC public key.
Syntax
QString GetCurrentCertCurve();
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
This property is read-only and not available at design time.
Data Type
String
CurrentCertFingerprint Property (PDFVerifier Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetCurrentCertFingerprint();
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertFriendlyName Property (PDFVerifier Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
QString GetCurrentCertFriendlyName();
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
This property is read-only and not available at design time.
Data Type
String
CurrentCertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetCurrentCertHandle();
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
CurrentCertHashAlgorithm Property (PDFVerifier Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
QString GetCurrentCertHashAlgorithm();
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is read-only and not available at design time.
Data Type
String
CurrentCertIssuer Property (PDFVerifier Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetCurrentCertIssuer();
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
This property is read-only and not available at design time.
Data Type
String
CurrentCertIssuerRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetCurrentCertIssuerRDN();
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
This property is read-only and not available at design time.
Data Type
String
CurrentCertKeyAlgorithm Property (PDFVerifier Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetCurrentCertKeyAlgorithm();
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
This property is read-only and not available at design time.
Data Type
String
CurrentCertKeyBits Property (PDFVerifier Class)
Returns the length of the public key.
Syntax
int GetCurrentCertKeyBits();
Default Value
0
Remarks
Returns the length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCertKeyFingerprint Property (PDFVerifier Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetCurrentCertKeyFingerprint();
Remarks
Returns a fingerprint of the public key contained in the certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertKeyUsage Property (PDFVerifier Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetCurrentCertKeyUsage();
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
This property is read-only and not available at design time.
Data Type
Integer
CurrentCertKeyValid Property (PDFVerifier Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
bool GetCurrentCertKeyValid();
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCertOCSPLocations Property (PDFVerifier Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
QString GetCurrentCertOCSPLocations();
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
This property is read-only and not available at design time.
Data Type
String
CurrentCertOCSPNoCheck Property (PDFVerifier Class)
TBD.
Syntax
bool GetCurrentCertOCSPNoCheck();
Default Value
false
Remarks
TBD.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCertOrigin Property (PDFVerifier Class)
Returns the origin of this certificate.
Syntax
int GetCurrentCertOrigin();
Default Value
0
Remarks
Returns the origin of this certificate.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCertPolicyIDs Property (PDFVerifier Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
QString GetCurrentCertPolicyIDs();
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
This property is read-only and not available at design time.
Data Type
String
CurrentCertPrivateKeyBytes Property (PDFVerifier Class)
Contains the certificate's private key.
Syntax
QByteArray GetCurrentCertPrivateKeyBytes();
Remarks
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertPrivateKeyExists Property (PDFVerifier Class)
Indicates whether the certificate has an associated private key.
Syntax
bool GetCurrentCertPrivateKeyExists();
Default Value
false
Remarks
Indicates whether the certificate has an associated private key.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCertPrivateKeyExtractable Property (PDFVerifier Class)
Indicates whether the private key is extractable.
Syntax
bool GetCurrentCertPrivateKeyExtractable();
Default Value
false
Remarks
Indicates whether the private key is extractable
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCertPublicKeyBytes Property (PDFVerifier Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetCurrentCertPublicKeyBytes();
Remarks
Contains the certificate's public key in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertQualifiedStatements Property (PDFVerifier Class)
TBD.
Syntax
int GetCurrentCertQualifiedStatements();
Possible Values
QST_NON_QUALIFIED(0),
QST_QUALIFIED_HARDWARE(1),
QST_QUALIFIED_SOFTWARE(2)
Default Value
0
Remarks
TBD
This property is read-only and not available at design time.
Data Type
Integer
CurrentCertSelfSigned Property (PDFVerifier Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetCurrentCertSelfSigned();
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCertSerialNumber Property (PDFVerifier Class)
Returns the certificate's serial number.
Syntax
QByteArray GetCurrentCertSerialNumber();
Remarks
Returns the certificate's serial number.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertSigAlgorithm Property (PDFVerifier Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetCurrentCertSigAlgorithm();
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
This property is read-only and not available at design time.
Data Type
String
CurrentCertSubject Property (PDFVerifier Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetCurrentCertSubject();
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
This property is read-only and not available at design time.
Data Type
String
CurrentCertSubjectAlternativeName Property (PDFVerifier Class)
TBD.
Syntax
QString GetCurrentCertSubjectAlternativeName();
Default Value
""
Remarks
TBD.
This property is read-only and not available at design time.
Data Type
String
CurrentCertSubjectKeyID Property (PDFVerifier Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetCurrentCertSubjectKeyID();
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertSubjectRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetCurrentCertSubjectRDN();
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
This property is read-only and not available at design time.
Data Type
String
CurrentCertValidFrom Property (PDFVerifier Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetCurrentCertValidFrom();
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
This property is read-only and not available at design time.
Data Type
String
CurrentCertValidTo Property (PDFVerifier Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetCurrentCertValidTo();
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
This property is read-only and not available at design time.
Data Type
String
DecryptionCertificateBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetDecryptionCertificateBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
DecryptionCertificateHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetDecryptionCertificateHandle();
int SetDecryptionCertificateHandle(qint64 lDecryptionCertificateHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
DecryptionCertCount Property (PDFVerifier Class)
The number of records in the DecryptionCert arrays.
Syntax
int GetDecryptionCertCount();
int SetDecryptionCertCount(int iDecryptionCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at DecryptionCertCount - 1.This property is not available at design time.
Data Type
Integer
DecryptionCertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetDecryptionCertBytes(int iDecryptionCertIndex);
Remarks
Returns raw certificate data in DER format.
The DecryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
DecryptionCertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetDecryptionCertHandle(int iDecryptionCertIndex);
int SetDecryptionCertHandle(int iDecryptionCertIndex, qint64 lDecryptionCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The DecryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.
This property is not available at design time.
Data Type
Long64
Encrypted Property (PDFVerifier Class)
Indicates if the PDF document is encrypted.
Syntax
bool GetEncrypted();
Default Value
false
Remarks
Use this property to check if the PDF document is encrypted.
This property is read-only and not available at design time.
Data Type
Boolean
EncryptionAlgorithm Property (PDFVerifier Class)
The symmetric algorithm used to encrypt the document.
Syntax
QString GetEncryptionAlgorithm();
Default Value
""
Remarks
This property contains the encryption algorithm that was used to encrypt the PDF document.
Supported values:
| SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
| SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
| SB_SYMMETRIC_ALGORITHM_AES256 | AES256 |
This property is read-only and not available at design time.
Data Type
String
EncryptionType Property (PDFVerifier Class)
The document encryption type.
Syntax
int GetEncryptionType();
Possible Values
PET_NONE(0),
PET_PASSWORD(1),
PET_CERTIFICATE(2)
Default Value
1
Remarks
This property indicates the kind of encryption that was used to encrypt the PDF document.
Supported values:
| petPassword | 1 | The document is encrypted with a password. |
| petCertificate | 2 | The document is encrypted with a certificate. |
This property is read-only and not available at design time.
Data Type
Integer
FIPSMode Property (PDFVerifier Class)
Reserved.
Syntax
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
IgnoreChainValidationErrors Property (PDFVerifier Class)
Makes the class tolerant to chain validation errors.
Syntax
bool GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(bool bIgnoreChainValidationErrors);
Default Value
false
Remarks
If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.
Data Type
Boolean
InputBytes Property (PDFVerifier Class)
Use this property to pass the input to class in the byte array form.
Syntax
QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);
Remarks
Assign a byte array containing the data to be processed to this property.
This property is not available at design time.
Data Type
Byte Array
InputFile Property (PDFVerifier Class)
A path to the signed PDF file.
Syntax
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
Assign the path to the PDF file to be verified to this property.
Data Type
String
InterimValidationDetails Property (PDFVerifier Class)
Contains the validation details of the moment.
Syntax
int GetInterimValidationDetails();
int SetInterimValidationDetails(int iInterimValidationDetails);
Default Value
0
Remarks
Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.
Use this property to check the interim validity details mid-flight.
The value of this property is a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is not available at design time.
Data Type
Integer
InterimValidationResult Property (PDFVerifier Class)
Contains the validation status of the moment.
Syntax
int GetInterimValidationResult();
int SetInterimValidationResult(int iInterimValidationResult);
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.
Use this property to check the interim validity status mid-flight.
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
This property is not available at design time.
Data Type
Integer
KnownCertCount Property (PDFVerifier Class)
The number of records in the KnownCert arrays.
Syntax
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownCertCount - 1.This property is not available at design time.
Data Type
Integer
KnownCertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetKnownCertBytes(int iKnownCertIndex);
Remarks
Returns raw certificate data in DER format.
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownCertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is not available at design time.
Data Type
Long64
KnownCRLCount Property (PDFVerifier Class)
The number of records in the KnownCRL arrays.
Syntax
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownCRLCount - 1.This property is not available at design time.
Data Type
Integer
KnownCRLBytes Property (PDFVerifier Class)
Returns raw CRL data in DER format.
Syntax
QByteArray GetKnownCRLBytes(int iKnownCRLIndex);
Remarks
Returns raw CRL data in DER format.
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownCRLHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is not available at design time.
Data Type
Long64
KnownOCSPCount Property (PDFVerifier Class)
The number of records in the KnownOCSP arrays.
Syntax
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownOCSPCount - 1.This property is not available at design time.
Data Type
Integer
KnownOCSPBytes Property (PDFVerifier Class)
Buffer containing raw OCSP response data.
Syntax
QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);
Remarks
Buffer containing raw OCSP response data.
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownOCSPHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is not available at design time.
Data Type
Long64
MetadataEncrypted Property (PDFVerifier Class)
Indicates if the document metadata is encrypted.
Syntax
bool GetMetadataEncrypted();
Default Value
true
Remarks
Use this property to check if document metadata is encrypted.
Metadata contains additional information about document such as its name and author.
This property is read-only and not available at design time.
Data Type
Boolean
OCSPCount Property (PDFVerifier Class)
The number of records in the OCSP arrays.
Syntax
int GetOCSPCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at OCSPCount - 1.This property is read-only and not available at design time.
Data Type
Integer
OCSPBytes Property (PDFVerifier Class)
Buffer containing raw OCSP response data.
Syntax
QByteArray GetOCSPBytes(int iOCSPIndex);
Remarks
Buffer containing raw OCSP response data.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
OCSPHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetOCSPHandle(int iOCSPIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
Long64
OCSPIssuer Property (PDFVerifier Class)
Indicates the issuer of this response (a CA or its authorized representative).
Syntax
QString GetOCSPIssuer(int iOCSPIndex);
Default Value
""
Remarks
Indicates the issuer of this response (a CA or its authorized representative).
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
String
OCSPIssuerRDN Property (PDFVerifier Class)
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Syntax
QString GetOCSPIssuerRDN(int iOCSPIndex);
Default Value
""
Remarks
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
String
OCSPLocation Property (PDFVerifier Class)
Location of the OCSP responder.
Syntax
QString GetOCSPLocation(int iOCSPIndex);
Default Value
""
Remarks
Location of the OCSP responder.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
String
OCSPProducedAt Property (PDFVerifier Class)
Specifies the time when the response was produced, in UTC.
Syntax
QString GetOCSPProducedAt(int iOCSPIndex);
Default Value
""
Remarks
Specifies the time when the response was produced, in UTC.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only and not available at design time.
Data Type
String
OfflineMode Property (PDFVerifier Class)
Switches the class to the offline mode.
Syntax
bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);
Default Value
false
Remarks
When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.
Data Type
Boolean
Password Property (PDFVerifier Class)
The decryption password.
Syntax
QString GetPassword();
int SetPassword(QString qsPassword);
Default Value
""
Remarks
Use this property to provide the decryption password.
Data Type
String
PermsAnnotations Property (PDFVerifier Class)
Indicates whether the viewer may add annotations to the document.
Syntax
bool GetPermsAnnotations();
Default Value
true
Remarks
Indicates whether the viewer may add annotations to the document.
This property is read-only and not available at design time.
Data Type
Boolean
PermsAssemble Property (PDFVerifier Class)
Indicates if the viewer may assemble a new document on the basis of the encrypted one.
Syntax
bool GetPermsAssemble();
Default Value
true
Remarks
Indicates if the viewer may assemble a new document on the basis of the encrypted one.
This property is read-only and not available at design time.
Data Type
Boolean
PermsExtract Property (PDFVerifier Class)
Indicates if the user may extract (copy) pictures and text from the encrypted document.
Syntax
bool GetPermsExtract();
Default Value
true
Remarks
Indicates if the user may extract (copy) pictures and text from the encrypted document.
This property is read-only and not available at design time.
Data Type
Boolean
PermsExtractAcc Property (PDFVerifier Class)
Indicates if the user may extract pictures/text from the document for accessibility purposes.
Syntax
bool GetPermsExtractAcc();
Default Value
true
Remarks
Indicates if the user may extract pictures/text from the document for accessibility purposes.
This property is read-only and not available at design time.
Data Type
Boolean
PermsFillInForms Property (PDFVerifier Class)
Indicates if the user may fill in forms in the document.
Syntax
bool GetPermsFillInForms();
Default Value
true
Remarks
Indicates if the user may fill in forms in the document.
This property is read-only and not available at design time.
Data Type
Boolean
PermsHighQualityPrint Property (PDFVerifier Class)
Indicates if the document may be printed in high quality.
Syntax
bool GetPermsHighQualityPrint();
Default Value
true
Remarks
Indicates if the document may be printed in high quality.
This property is read-only and not available at design time.
Data Type
Boolean
PermsLowQualityPrint Property (PDFVerifier Class)
Indicates if the document may be printed in low quality.
Syntax
bool GetPermsLowQualityPrint();
Default Value
true
Remarks
Indicates if the document may be printed in low quality.
This property is read-only and not available at design time.
Data Type
Boolean
PermsModify Property (PDFVerifier Class)
Indicates if the document may be modified.
Syntax
bool GetPermsModify();
Default Value
true
Remarks
Indicates if the document may be modified.
This property is read-only and not available at design time.
Data Type
Boolean
Profile Property (PDFVerifier Class)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
QString GetProfile();
int SetProfile(QString qsProfile);
Default Value
""
Remarks
Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.
Data Type
String
ProxyAddress Property (PDFVerifier Class)
The IP address of the proxy server.
Syntax
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);
Default Value
""
Remarks
The IP address of the proxy server.
Data Type
String
ProxyAuthentication Property (PDFVerifier Class)
The authentication type used by the proxy server.
Syntax
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);
Possible Values
PAT_NO_AUTHENTICATION(0),
PAT_BASIC(1),
PAT_DIGEST(2),
PAT_NTLM(3)
Default Value
0
Remarks
The authentication type used by the proxy server.
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |
Data Type
Integer
ProxyPassword Property (PDFVerifier Class)
The password to authenticate to the proxy server.
Syntax
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);
Default Value
""
Remarks
The password to authenticate to the proxy server.
Data Type
String
ProxyPort Property (PDFVerifier Class)
The port on the proxy server to connect to.
Syntax
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
0
Remarks
The port on the proxy server to connect to.
Data Type
Integer
ProxyProxyType Property (PDFVerifier Class)
The type of the proxy server.
Syntax
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);
Possible Values
CPT_NONE(0),
CPT_SOCKS_4(1),
CPT_SOCKS_5(2),
CPT_WEB_TUNNEL(3),
CPT_HTTP(4)
Default Value
0
Remarks
The type of the proxy server.
The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |
Data Type
Integer
ProxyRequestHeaders Property (PDFVerifier Class)
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
Data Type
String
ProxyResponseBody Property (PDFVerifier Class)
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Data Type
String
ProxyResponseHeaders Property (PDFVerifier Class)
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Data Type
String
ProxyUseIPv6 Property (PDFVerifier Class)
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);
Default Value
false
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
Data Type
Boolean
ProxyUseProxy Property (PDFVerifier Class)
Enables or disables proxy-driven connection.
Syntax
bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);
Default Value
false
Remarks
Enables or disables proxy-driven connection.
Data Type
Boolean
ProxyUsername Property (PDFVerifier Class)
Specifies the username credential for proxy authentication.
Syntax
QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
Data Type
String
Qualified Property (PDFVerifier Class)
Indicates a qualified electronic signature.
Syntax
int GetQualified();
Possible Values
SQS_UNKNOWN(0),
SQS_NONE(1),
SQS_GRANTED(2),
SQS_WITHDRAWN(3),
SQS_SET_BY_NATIONAL_LAW(4),
SQS_DEPRECATED_BY_NATIONAL_LAW(5),
SQS_RECOGNIZED_AT_NATIONAL_LEVEL(6),
SQS_DEPRECATED_AT_NATIONAL_LEVEL(7),
SQS_UNDER_SUPERVISION(8),
SQS_SUPERVISION_IN_CESSATION(9),
SQS_SUPERVISION_CEASED(10),
SQS_SUPERVISION_REVOKED(11),
SQS_ACCREDITED(12),
SQS_ACCREDITATION_CEASED(13),
SQS_ACCREDITATION_REVOKED(14),
SQS_IN_ACCORDANCE(15),
SQS_EXPIRED(16),
SQS_SUSPENDED(17),
SQS_REVOKED(18),
SQS_NOT_IN_ACCORDANCE(19)
Default Value
0
Remarks
Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate.
Adjust UseDefaultTSLs property and/or CustomTSLs property before validating the signature/certificate to properly obtain TSP (Trust Service Provider) service status. Use Qualified* and TSL* config properties to obtain extended information.
The following qualified statuses are supported:
| sqsUnknown | 0 | Qualified status unknown. Use config's QualifiedInfo setting to obtain service status URI. |
| sqsNone | 1 | None |
| sqsGranted | 2 | Granted |
| sqsWithdrawn | 3 | Withdrawn |
| sqsSetByNationalLaw | 4 | Set by national law |
| sqsDeprecatedByNationalLaw | 5 | Deprecated by national law |
| sqsRecognizedAtNationalLevel | 6 | Recognized at national level |
| sqsDeprecatedAtNationalLevel | 7 | Deprecated at national level |
| sqsUnderSupervision | 8 | Under supervision |
| sqsSupervisionInCessation | 9 | Supervision in cessation |
| sqsSupervisionCeased | 10 | Supervision ceased |
| sqsSupervisionRevoked | 11 | Supervision revoked |
| sqsAccredited | 12 | Accredited |
| sqsAccreditationCeased | 13 | Accreditation ceased |
| sqsAccreditationRevoked | 14 | Accreditation revoked |
| sqsInAccordance | 15 | Deprecated. The subject service is in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
| sqsExpired | 16 | Deprecated. The subject service is no longer overseen by the scheme, e.g. due to nonrenewal or withdrawal by the TSP, or cessation of the service or the scheme's operations. |
| sqsSuspended | 17 | Deprecated. The subject service's status is temporarily uncertain whilst checks are made by the scheme operator (typically e.g. while a revocation request is being investigated or if action is required to resolve a deficiency in the service fulfilling the scheme's criteria. |
| sqsRevoked | 18 | Deprecated. The subject service's approved status has been revoked because it is no longer in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
| sqsNotInAccordance | 19 | Deprecated. The subject service is not in accordance with the scheme's specific status determination criteria (only for use in negative approval schemes). |
This property is read-only and not available at design time.
Data Type
Integer
RevocationCheck Property (PDFVerifier Class)
Specifies the kind(s) of revocation check to perform.
Syntax
int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
Default Value
1
Remarks
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
Certificate Revocation Lists (CRL) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.
| crcNone (0) | No revocation checking |
| crcAuto (1) | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL (2) | Check all provided CRL endpoints for all chain certificates. |
| crcAllOCSP (3) | Check all provided OCSP endpoints for all chain certificates. |
| crcAllCRLAndOCSP (4) | Check all CRL and OCSP endpoints for all chain certificates. |
| crcAnyCRL (5) | At least one CRL check for every certificate in the chain must succeed. |
| crcAnyOCSP (6) | At least one OCSP check for every certificate in the chain must succeed. |
| crcAnyCRLOrOCSP (7) | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL (8) | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. 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 some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is 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 setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Data Type
Integer
SigAllowedChanges Property (PDFVerifier Class)
The changes to the document are allowed by the signature.
Syntax
int GetSigAllowedChanges();
Possible Values
PSAC_NONE(0),
PSAC_FILL_IN_FORMS(1),
PSAC_COMMENT(2),
PSAC_ALL(3)
Default Value
0
Remarks
The changes to the document are allowed by the signature.
This property is only applicable to MDP/certification signatures and has no effect for any other kinds of signatures (regular or document timestamps).
| psacNone | 0 | No changes are allowed by the signature |
| psacFillInForms | 1 | Only form fill-in is allowed |
| psacComment | 2 | Commenting is allowed |
| psacAll | 3 | Form fill-in and commenting are allowed |
This property is read-only and not available at design time.
Data Type
Integer
SigAuthorName Property (PDFVerifier Class)
A human-readable signer name.
Syntax
QString GetSigAuthorName();
Default Value
""
Remarks
A human-readable signer name. This is a PDF document property.
This property is read-only and not available at design time.
Data Type
String
SigCertification Property (PDFVerifier Class)
Specifies whether this is a Certification (MDP) signature.
Syntax
bool GetSigCertification();
Default Value
false
Remarks
Specifies whether this is a Certification (MDP) signature.
Certification signatures is a feature that was used by earlier Acrobat versions. It has little use these days.
This property is read-only and not available at design time.
Data Type
Boolean
SigChainValidationDetails Property (PDFVerifier Class)
The details of a certificate chain validation outcome.
Syntax
int GetSigChainValidationDetails();
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
Data Type
Integer
SigChainValidationResult Property (PDFVerifier Class)
The outcome of a certificate chain validation routine.
Syntax
int GetSigChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only and not available at design time.
Data Type
Integer
SigClaimedSigningTime Property (PDFVerifier Class)
Returns or sets signature's creation time.
Syntax
QString GetSigClaimedSigningTime();
Default Value
""
Remarks
Returns or sets signature's creation time.
Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike SigValidatedSigningTime does not originate from a trusted TSA and may be forfeited or wrong.
The time is provided in UTC.
This property is read-only and not available at design time.
Data Type
String
SigContactInfo Property (PDFVerifier Class)
Contains signer's contact information.
Syntax
QString GetSigContactInfo();
Default Value
""
Remarks
Contains signer's contact information. This is a PDF document property.
This property is read-only and not available at design time.
Data Type
String
SigCoverageEndsAt Property (PDFVerifier Class)
Indicates the offset in the PDF file where signature coverage ends.
Syntax
int GetSigCoverageEndsAt();
Default Value
0
Remarks
Indicates the offset in the PDF file where signature coverage ends.
PDF generators often use incremental updates to make changes in the 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. Alternatively, use the GetSignedVersion() method of the PDFVerifier class to extract the exact revision that was signed.
This property is read-only and not available at design time.
Data Type
Integer
SigCustomData Property (PDFVerifier Class)
A uninterpreted custom data to save with the signature.
Syntax
QByteArray GetSigCustomData();
Remarks
A uninterpreted custom data to save with the signature.
This property is read-only and not available at design time.
Data Type
Byte Array
SigEmptyField Property (PDFVerifier Class)
Indicates whether or not the signature created/read is an empty property (a signature placeholder).
Syntax
bool GetSigEmptyField();
Default Value
false
Remarks
Indicates whether or not the signature created/read is an empty field (a signature placeholder).
This property is read-only and not available at design time.
Data Type
Boolean
SigFilterName Property (PDFVerifier Class)
The signature filter name.
Syntax
QString GetSigFilterName();
Default Value
""
Remarks
The signature filter name.
This property is read-only and not available at design time.
Data Type
String
SigFullSignatureName Property (PDFVerifier Class)
Specifies the full name of the signature property.
Syntax
QString GetSigFullSignatureName();
Default Value
""
Remarks
Specifies the full name of the signature field.
This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.
This property is read-only and not available at design time.
Data Type
String
SigHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSigHandle();
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
SigHashAlgorithm Property (PDFVerifier Class)
Specifies the hash algorithm to be used for signing.
Syntax
QString GetSigHashAlgorithm();
Default Value
"SHA256"
Remarks
Specifies the hash algorithm to be used for signing.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is read-only and not available at design time.
Data Type
String
SigHeight Property (PDFVerifier Class)
Specifies the height of the signature widget.
Syntax
int GetSigHeight();
Default Value
70
Remarks
Specifies the height of the signature widget.
The SigAutoSize property should be switched off for this to apply.
This property is read-only and not available at design time.
Data Type
Integer
SigInvisible Property (PDFVerifier Class)
Controls whether the signature widget is visible on the page.
Syntax
bool GetSigInvisible();
Default Value
false
Remarks
Controls whether the signature widget is visible on the page.
This property is read-only and not available at design time.
Data Type
Boolean
SigLevel Property (PDFVerifier Class)
Specifies the signature kind and level.
Syntax
int GetSigLevel();
Possible Values
PSL_LEGACY(0),
PSL_BES(1),
PSL_EPES(2),
PSL_LTV(3),
PSL_DOCUMENT_TIMESTAMP(4)
Default Value
0
Remarks
Specifies the signature kind and level.
| pslLegacy | 0 | Legacy Adobe signature (adbe.pkcs7.detached or adbe.pkcs7.sha1) |
| pslBES | 1 | PAdES-BES signature (ETSI.CAdES.detached) |
| pslEPES | 2 | PAdES-EPES signature (ETSI.CAdES.detached + embedded policy) |
| pslLTV | 3 | PAdES-LTV signature (ETSI.CAdES.detached + revocation info) |
| pslDocumentTimestamp | 4 | Document timestamp (ETSI.RFC3161) |
This property is read-only and not available at design time.
Data Type
Integer
SigLocation Property (PDFVerifier Class)
Specifies the host name or the physical location of the signing entity.
Syntax
QString GetSigLocation();
Default Value
""
Remarks
Specifies the host name or the physical location of the signing entity. This is a PDF property.
This property is read-only and not available at design time.
Data Type
String
SigOffsetX Property (PDFVerifier Class)
Specifies the signature widget offset from the left-hand page border when AutoPos is False.
Syntax
int GetSigOffsetX();
Default Value
0
Remarks
Specifies the signature widget offset from the left-hand page border when SigAutoPos is False.
This property is read-only and not available at design time.
Data Type
Integer
SigOffsetY Property (PDFVerifier Class)
Specifies the signature widget offset from the bottom page border when AutoPos is False.
Syntax
int GetSigOffsetY();
Default Value
0
Remarks
Specifies the signature widget offset from the bottom page border when SigAutoPos is False.
This property is read-only and not available at design time.
Data Type
Integer
SigPage Property (PDFVerifier Class)
The index of the page on which to place the signature.
Syntax
int GetSigPage();
Default Value
0
Remarks
The index of the page on which to place the signature.
To place the signature widget on multiple pages, use SigPagesToPlaceOn and SigShowOnAllPages properties.
This property is read-only and not available at design time.
Data Type
Integer
SigPolicyHashAlgorithm Property (PDFVerifier Class)
The algorithm that was used to calculate the signature policy hash.
Syntax
QString GetSigPolicyHashAlgorithm();
Default Value
""
Remarks
The algorithm that was used to calculate the signature policy hash.
This property is read-only and not available at design time.
Data Type
String
SigPrint Property (PDFVerifier Class)
Whether the signature shall appear in printed documents.
Syntax
bool GetSigPrint();
Default Value
true
Remarks
Whether the signature shall appear in printed documents.
This property is read-only and not available at design time.
Data Type
Boolean
SigQualified Property (PDFVerifier Class)
Indicates a qualified electronic signature.
Syntax
int GetSigQualified();
Possible Values
SQS_UNKNOWN(0),
SQS_NONE(1),
SQS_GRANTED(2),
SQS_WITHDRAWN(3),
SQS_SET_BY_NATIONAL_LAW(4),
SQS_DEPRECATED_BY_NATIONAL_LAW(5),
SQS_RECOGNIZED_AT_NATIONAL_LEVEL(6),
SQS_DEPRECATED_AT_NATIONAL_LEVEL(7),
SQS_UNDER_SUPERVISION(8),
SQS_SUPERVISION_IN_CESSATION(9),
SQS_SUPERVISION_CEASED(10),
SQS_SUPERVISION_REVOKED(11),
SQS_ACCREDITED(12),
SQS_ACCREDITATION_CEASED(13),
SQS_ACCREDITATION_REVOKED(14),
SQS_IN_ACCORDANCE(15),
SQS_EXPIRED(16),
SQS_SUSPENDED(17),
SQS_REVOKED(18),
SQS_NOT_IN_ACCORDANCE(19)
Default Value
0
Remarks
Indicates a qualified electronic signature.
Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate.
Adjust UseDefaultTSLs property and/or CustomTSLs property before validating the signature/certificate to properly obtain TSP (Trust Service Provider) service status. Use Qualified* and TSL* config properties to obtain extended information.
The following qualified statuses are supported:
| sqsUnknown | 0 | Qualified status unknown. Use config's QualifiedInfo setting to obtain service status URI. |
| sqsNone | 1 | None |
| sqsGranted | 2 | Granted |
| sqsWithdrawn | 3 | Withdrawn |
| sqsSetByNationalLaw | 4 | Set by national law |
| sqsDeprecatedByNationalLaw | 5 | Deprecated by national law |
| sqsRecognizedAtNationalLevel | 6 | Recognized at national level |
| sqsDeprecatedAtNationalLevel | 7 | Deprecated at national level |
| sqsUnderSupervision | 8 | Under supervision |
| sqsSupervisionInCessation | 9 | Supervision in cessation |
| sqsSupervisionCeased | 10 | Supervision ceased |
| sqsSupervisionRevoked | 11 | Supervision revoked |
| sqsAccredited | 12 | Accredited |
| sqsAccreditationCeased | 13 | Accreditation ceased |
| sqsAccreditationRevoked | 14 | Accreditation revoked |
| sqsInAccordance | 15 | Deprecated. The subject service is in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
| sqsExpired | 16 | Deprecated. The subject service is no longer overseen by the scheme, e.g. due to nonrenewal or withdrawal by the TSP, or cessation of the service or the scheme's operations. |
| sqsSuspended | 17 | Deprecated. The subject service's status is temporarily uncertain whilst checks are made by the scheme operator (typically e.g. while a revocation request is being investigated or if action is required to resolve a deficiency in the service fulfilling the scheme's criteria. |
| sqsRevoked | 18 | Deprecated. The subject service's approved status has been revoked because it is no longer in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
| sqsNotInAccordance | 19 | Deprecated. The subject service is not in accordance with the scheme's specific status determination criteria (only for use in negative approval schemes). |
This property is read-only and not available at design time.
Data Type
Integer
SigReadOnly Property (PDFVerifier Class)
Controls the ReadOnly flag of the widget.
Syntax
bool GetSigReadOnly();
Default Value
false
Remarks
Controls the ReadOnly flag of the widget.
This property is read-only and not available at design time.
Data Type
Boolean
SigReason Property (PDFVerifier Class)
Specifies the reason for signing.
Syntax
QString GetSigReason();
Default Value
""
Remarks
Specifies the reason for signing. This is a PDF document property.
This property is read-only and not available at design time.
Data Type
String
SigSignatureName Property (PDFVerifier Class)
Specifies the unique signature identifier to use.
Syntax
QString GetSigSignatureName();
Default Value
""
Remarks
Specifies the unique signature identifier to use.
This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.
This property is read-only and not available at design time.
Data Type
String
SigSignatureValidationResult Property (PDFVerifier Class)
The outcome of the cryptographic signature validation.
Syntax
int GetSigSignatureValidationResult();
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
This property is read-only and not available at design time.
Data Type
Integer
SigSignerInfo Property (PDFVerifier Class)
Provides custom signer information to put on the signature widget.
Syntax
QString GetSigSignerInfo();
Default Value
""
Remarks
Provides custom signer information to put on the signature widget.
This property is only considered if SigAutoText is set to False. The standard signature widget allows for several short strings separated by CRLF.
This property is read-only and not available at design time.
Data Type
String
SigSubjectRDN Property (PDFVerifier Class)
Contains the RDN of the owner of the signing certificate.
Syntax
QString GetSigSubjectRDN();
Default Value
""
Remarks
Contains the RDN of the owner of the signing certificate.
RDN is a number of OID=Value pairs declared in the certificate and providing the owner's details.
This property is read-only and not available at design time.
Data Type
String
SigTimestamped Property (PDFVerifier Class)
Indicates if the signature is timestamped.
Syntax
bool GetSigTimestamped();
Default Value
false
Remarks
Indicates if the signature is timestamped.
This property is read-only and not available at design time.
Data Type
Boolean
SigValidatedSigningTime Property (PDFVerifier Class)
Contains the certified signing time.
Syntax
QString GetSigValidatedSigningTime();
Default Value
""
Remarks
Contains the certified signing time.
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 was a valid timestamp included in the signature.
ClaimedSigningTime returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
This property is read-only and not available at design time.
Data Type
String
SigValidationLog Property (PDFVerifier Class)
Contains the signing certificate's chain validation log.
Syntax
QString GetSigValidationLog();
Default Value
""
Remarks
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.
This property is read-only and not available at design time.
Data Type
String
SigWidth Property (PDFVerifier Class)
Specifies the width of the signature widget.
Syntax
int GetSigWidth();
Default Value
70
Remarks
Specifies the width of the signature widget.
The SigAutoSize property should be switched off for this to apply. Note that the dimensions of the widget are provided in document-specific points, not pixels.
This property is read-only and not available at design time.
Data Type
Integer
SignatureCount Property (PDFVerifier Class)
The number of records in the Signature arrays.
Syntax
int GetSignatureCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- SignatureChainValidationDetails
- SignatureChainValidationResult
- SignatureClaimedSigningTime
- SignatureHandle
- SignatureLevel
- SignatureSignatureValidationResult
- SignatureSubjectRDN
- SignatureTimestamped
- SignatureValidatedSigningTime
- SignatureValidationLog
This property is read-only and not available at design time.
Data Type
Integer
SignatureChainValidationDetails Property (PDFVerifier Class)
The details of a certificate chain validation outcome.
Syntax
int GetSignatureChainValidationDetails(int iSignatureIndex);
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureChainValidationResult Property (PDFVerifier Class)
The outcome of a certificate chain validation routine.
Syntax
int GetSignatureChainValidationResult(int iSignatureIndex);
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureClaimedSigningTime Property (PDFVerifier Class)
Returns or sets signature's creation time.
Syntax
QString GetSignatureClaimedSigningTime(int iSignatureIndex);
Default Value
""
Remarks
Returns or sets signature's creation time.
Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike SignatureValidatedSigningTime does not originate from a trusted TSA and may be forfeited or wrong.
The time is provided in UTC.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSignatureHandle(int iSignatureIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Long64
SignatureLevel Property (PDFVerifier Class)
Specifies the signature kind and level.
Syntax
int GetSignatureLevel(int iSignatureIndex);
Possible Values
PSL_LEGACY(0),
PSL_BES(1),
PSL_EPES(2),
PSL_LTV(3),
PSL_DOCUMENT_TIMESTAMP(4)
Default Value
0
Remarks
Specifies the signature kind and level.
| pslLegacy | 0 | Legacy Adobe signature (adbe.pkcs7.detached or adbe.pkcs7.sha1) |
| pslBES | 1 | PAdES-BES signature (ETSI.CAdES.detached) |
| pslEPES | 2 | PAdES-EPES signature (ETSI.CAdES.detached + embedded policy) |
| pslLTV | 3 | PAdES-LTV signature (ETSI.CAdES.detached + revocation info) |
| pslDocumentTimestamp | 4 | Document timestamp (ETSI.RFC3161) |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureSignatureValidationResult Property (PDFVerifier Class)
The outcome of the cryptographic signature validation.
Syntax
int GetSignatureSignatureValidationResult(int iSignatureIndex);
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureSubjectRDN Property (PDFVerifier Class)
Contains the RDN of the owner of the signing certificate.
Syntax
QString GetSignatureSubjectRDN(int iSignatureIndex);
Default Value
""
Remarks
Contains the RDN of the owner of the signing certificate.
RDN is a number of OID=Value pairs declared in the certificate and providing the owner's details.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureTimestamped Property (PDFVerifier Class)
Indicates if the signature is timestamped.
Syntax
bool GetSignatureTimestamped(int iSignatureIndex);
Default Value
false
Remarks
Indicates if the signature is timestamped.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureValidatedSigningTime Property (PDFVerifier Class)
Contains the certified signing time.
Syntax
QString GetSignatureValidatedSigningTime(int iSignatureIndex);
Default Value
""
Remarks
Contains the certified signing time.
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 was a valid timestamp included in the signature.
ClaimedSigningTime returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureValidationLog Property (PDFVerifier Class)
Contains the signing certificate's chain validation log.
Syntax
QString GetSignatureValidationLog(int iSignatureIndex);
Default Value
""
Remarks
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureValidationResult Property (PDFVerifier Class)
The signature validation result.
Syntax
int GetSignatureValidationResult();
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
Default Value
0
Remarks
Use this property to check the result of the most recent signature validation.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
This property is read-only and not available at design time.
Data Type
Integer
SigningCertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetSigningCertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertCA Property (PDFVerifier Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
bool GetSigningCertCA();
Default Value
false
Remarks
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
This property is read-only and not available at design time.
Data Type
Boolean
SigningCertCAKeyID Property (PDFVerifier Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetSigningCertCAKeyID();
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertCRLDistributionPoints Property (PDFVerifier Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
QString GetSigningCertCRLDistributionPoints();
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
This property is read-only and not available at design time.
Data Type
String
SigningCertCurve Property (PDFVerifier Class)
Specifies the elliptic curve of the EC public key.
Syntax
QString GetSigningCertCurve();
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
This property is read-only and not available at design time.
Data Type
String
SigningCertFingerprint Property (PDFVerifier Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetSigningCertFingerprint();
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertFriendlyName Property (PDFVerifier Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
QString GetSigningCertFriendlyName();
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
This property is read-only and not available at design time.
Data Type
String
SigningCertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSigningCertHandle();
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
SigningCertHashAlgorithm Property (PDFVerifier Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
QString GetSigningCertHashAlgorithm();
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is read-only and not available at design time.
Data Type
String
SigningCertIssuer Property (PDFVerifier Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetSigningCertIssuer();
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
This property is read-only and not available at design time.
Data Type
String
SigningCertIssuerRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetSigningCertIssuerRDN();
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
This property is read-only and not available at design time.
Data Type
String
SigningCertKeyAlgorithm Property (PDFVerifier Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetSigningCertKeyAlgorithm();
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
This property is read-only and not available at design time.
Data Type
String
SigningCertKeyBits Property (PDFVerifier Class)
Returns the length of the public key.
Syntax
int GetSigningCertKeyBits();
Default Value
0
Remarks
Returns the length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
SigningCertKeyFingerprint Property (PDFVerifier Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetSigningCertKeyFingerprint();
Remarks
Returns a fingerprint of the public key contained in the certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertKeyUsage Property (PDFVerifier Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetSigningCertKeyUsage();
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
This property is read-only and not available at design time.
Data Type
Integer
SigningCertKeyValid Property (PDFVerifier Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
bool GetSigningCertKeyValid();
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
SigningCertOCSPLocations Property (PDFVerifier Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
QString GetSigningCertOCSPLocations();
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
This property is read-only and not available at design time.
Data Type
String
SigningCertPolicyIDs Property (PDFVerifier Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
QString GetSigningCertPolicyIDs();
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
This property is read-only and not available at design time.
Data Type
String
SigningCertPublicKeyBytes Property (PDFVerifier Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetSigningCertPublicKeyBytes();
Remarks
Contains the certificate's public key in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertSelfSigned Property (PDFVerifier Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetSigningCertSelfSigned();
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
This property is read-only and not available at design time.
Data Type
Boolean
SigningCertSerialNumber Property (PDFVerifier Class)
Returns the certificate's serial number.
Syntax
QByteArray GetSigningCertSerialNumber();
Remarks
Returns the certificate's serial number.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertSigAlgorithm Property (PDFVerifier Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetSigningCertSigAlgorithm();
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
This property is read-only and not available at design time.
Data Type
String
SigningCertSubject Property (PDFVerifier Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetSigningCertSubject();
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
This property is read-only and not available at design time.
Data Type
String
SigningCertSubjectKeyID Property (PDFVerifier Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetSigningCertSubjectKeyID();
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertSubjectRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetSigningCertSubjectRDN();
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
This property is read-only and not available at design time.
Data Type
String
SigningCertValidFrom Property (PDFVerifier Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetSigningCertValidFrom();
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
This property is read-only and not available at design time.
Data Type
String
SigningCertValidTo Property (PDFVerifier Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetSigningCertValidTo();
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
This property is read-only and not available at design time.
Data Type
String
SocketDNSMode Property (PDFVerifier Class)
Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
Syntax
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);
Possible Values
DM_AUTO(0),
DM_PLATFORM(1),
DM_OWN(2),
DM_OWN_SECURE(3)
Default Value
0
Remarks
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |
Data Type
Integer
SocketDNSPort Property (PDFVerifier Class)
Specifies the port number to be used for sending queries to the DNS server.
Syntax
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);
Default Value
0
Remarks
Specifies the port number to be used for sending queries to the DNS server.
Data Type
Integer
SocketDNSQueryTimeout Property (PDFVerifier Class)
The timeout (in milliseconds) for each DNS query.
Syntax
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);
Default Value
0
Remarks
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.
Data Type
Integer
SocketDNSServers Property (PDFVerifier Class)
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);
Default Value
""
Remarks
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Data Type
String
SocketDNSTotalTimeout Property (PDFVerifier Class)
The timeout (in milliseconds) for the whole resolution process.
Syntax
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);
Default Value
0
Remarks
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.
Data Type
Integer
SocketIncomingSpeedLimit Property (PDFVerifier Class)
The maximum number of bytes to read from the socket, per second.
Syntax
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (PDFVerifier Class)
The local network interface to bind the socket to.
Syntax
QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (PDFVerifier Class)
The local port number to bind the socket to.
Syntax
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (PDFVerifier Class)
The maximum number of bytes to write to the socket, per second.
Syntax
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (PDFVerifier Class)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
Data Type
Integer
SocketUseIPv6 Property (PDFVerifier Class)
Enables or disables IP protocol version 6.
Syntax
bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
TimestampAccuracy Property (PDFVerifier Class)
This property indicates the accuracy of the included time mark, in microseconds.
Syntax
qint64 GetTimestampAccuracy();
Default Value
0
Remarks
This field indicates the accuracy of the included time mark, in microseconds.
This property is read-only and not available at design time.
Data Type
Long64
TimestampBytes Property (PDFVerifier Class)
Returns raw timestamp data in DER format.
Syntax
QByteArray GetTimestampBytes();
Remarks
Returns raw timestamp data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
TimestampChainValidationDetails Property (PDFVerifier Class)
The details of a certificate chain validation outcome.
Syntax
int GetTimestampChainValidationDetails();
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
Data Type
Integer
TimestampChainValidationResult Property (PDFVerifier Class)
The outcome of a certificate chain validation routine.
Syntax
int GetTimestampChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only and not available at design time.
Data Type
Integer
TimestampHashAlgorithm Property (PDFVerifier Class)
Returns the timestamp's hash algorithm SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
QString GetTimestampHashAlgorithm();
Default Value
""
Remarks
Returns the timestamp's hash algorithm
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is read-only and not available at design time.
Data Type
String
TimestampSerialNumber Property (PDFVerifier Class)
Returns the timestamp's serial number.
Syntax
QByteArray GetTimestampSerialNumber();
Remarks
Returns the timestamp's serial number.
This property is read-only and not available at design time.
Data Type
Byte Array
TimestampTime Property (PDFVerifier Class)
The time point incorporated into the timestamp.
Syntax
QString GetTimestampTime();
Default Value
""
Remarks
The time point incorporated into the timestamp.
This property is read-only and not available at design time.
Data Type
String
TimestampTimestampType Property (PDFVerifier Class)
Returns the timestamp type.
Syntax
int GetTimestampTimestampType();
Possible Values
TST_UNKNOWN(0),
TST_LEGACY(1),
TST_TRUSTED(2),
TST_GENERIC(3),
TST_ESC(4),
TST_CONTENT(5),
TST_CERTS_AND_CRLS(6),
TST_ARCHIVE(7),
TST_ARCHIVE_2(8),
TST_ARCHIVE_3(9),
TST_INDIVIDUAL_DATA_OBJECTS(10),
TST_ALL_DATA_OBJECTS(11),
TST_SIGNATURE(12),
TST_REFS_ONLY(13),
TST_SIG_AND_REFS(14)
Default Value
0
Remarks
Returns the timestamp type.
Available options:
| tstUnknown | 0 | |
| tstLegacy | 1 | Supported by: AuthenticodeVerifier |
| tstTrusted | 2 | Supported by: AuthenticodeVerifier |
| tstGeneric | 3 | Supported by: CAdESVerifier |
| tstESC | 4 | Supported by: CAdESVerifier |
| tstContent | 5 | Supported by: CAdESVerifier |
| tstCertsAndCRLs | 6 | Supported by: CAdESVerifier |
| tstArchive | 7 | Archive timestamp. Supported by: CAdESVerifier, OfficeVerifier, SOAPVerifier, XAdESVerifier |
| tstArchive2 | 8 | Archive v2 timestamp. Supported by: CAdESVerifier |
| tstArchive3 | 9 | Archive v3 timestamp. Supported by: CAdESVerifier |
| tstIndividualDataObjects | 10 | Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier |
| tstAllDataObjects | 11 | Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier |
| tstSignature | 12 | Signature timestamp. Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier |
| tstRefsOnly | 13 | RefsOnly timestamp. Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier |
| tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier |
This property is read-only and not available at design time.
Data Type
Integer
TimestampTSAName Property (PDFVerifier Class)
This value uniquely identifies the Timestamp Authority (TSA).
Syntax
QString GetTimestampTSAName();
Default Value
""
Remarks
This value uniquely identifies the Timestamp Authority (TSA).
This property provides information about the entity that manages the TSA.
This property is read-only and not available at design time.
Data Type
String
TimestampValidationLog Property (PDFVerifier Class)
Contains the TSA certificate chain validation log.
Syntax
QString GetTimestampValidationLog();
Default Value
""
Remarks
Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.
This property is read-only and not available at design time.
Data Type
String
TimestampValidationResult Property (PDFVerifier Class)
Contains timestamp validation outcome.
Syntax
int GetTimestampValidationResult();
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
Default Value
0
Remarks
Contains timestamp validation outcome.
Use this property to check the result of the most recent timestamp validation.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
This property is read-only and not available at design time.
Data Type
Integer
Timestamped Property (PDFVerifier Class)
Indicates whether or not the signature is timestamped.
Syntax
bool GetTimestamped();
Default Value
false
Remarks
This property returns True if the signature is timestamped, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
TLSClientCertCount Property (PDFVerifier Class)
The number of records in the TLSClientCert arrays.
Syntax
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSClientCertCount - 1.This property is not available at design time.
Data Type
Integer
TLSClientCertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex);
Remarks
Returns raw certificate data in DER format.
The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TLSClientCertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.
This property is not available at design time.
Data Type
Long64
TLSServerCertCount Property (PDFVerifier Class)
The number of records in the TLSServerCert arrays.
Syntax
int GetTLSServerCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSServerCertCount - 1.This property is read-only and not available at design time.
Data Type
Integer
TLSServerCertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);
Remarks
Returns raw certificate data in DER format.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TLSServerCertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
TLSAutoValidateCertificates Property (PDFVerifier Class)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (PDFVerifier Class)
Selects the base configuration for the TLS settings.
Syntax
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);
Possible Values
STPC_DEFAULT(0),
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
| stpcDefault | 0 | |
| stpcCompatible | 1 | |
| stpcComprehensiveInsecure | 2 | |
| stpcHighlySecure | 3 |
Data Type
Integer
TLSCiphersuites Property (PDFVerifier Class)
A list of ciphersuites separated with commas or semicolons.
Syntax
QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);
Default Value
""
Remarks
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
Data Type
String
TLSECCurves Property (PDFVerifier Class)
Defines the elliptic curves to enable.
Syntax
QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);
Default Value
""
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (PDFVerifier Class)
Provides access to TLS extensions.
Syntax
QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (PDFVerifier Class)
Whether to force TLS session resumption when the destination address changes.
Syntax
bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (PDFVerifier Class)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is not available at design time.
Data Type
String
TLSPreSharedKey Property (PDFVerifier Class)
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);
Default Value
""
Remarks
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
This property is not available at design time.
Data Type
String
TLSPreSharedKeyCiphersuite Property (PDFVerifier Class)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (PDFVerifier Class)
Selects renegotiation attack prevention mechanism.
Syntax
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);
Possible Values
CRAPM_COMPATIBLE(0),
CRAPM_STRICT(1),
CRAPM_AUTO(2)
Default Value
0
Remarks
Selects renegotiation attack prevention mechanism.
The following options are available:
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
Data Type
Integer
TLSRevocationCheck Property (PDFVerifier Class)
Specifies the kind(s) of revocation check to perform.
Syntax
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
Default Value
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
| crcNone (0) | No revocation checking |
| crcAuto (1) | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL (2) | Check all provided CRL endpoints for all chain certificates. |
| crcAllOCSP (3) | Check all provided OCSP endpoints for all chain certificates. |
| crcAllCRLAndOCSP (4) | Check all CRL and OCSP endpoints for all chain certificates. |
| crcAnyCRL (5) | At least one CRL check for every certificate in the chain must succeed. |
| crcAnyOCSP (6) | At least one OCSP check for every certificate in the chain must succeed. |
| crcAnyCRLOrOCSP (7) | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL (8) | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. 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 some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is 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 setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
This property is not available at design time.
Data Type
Integer
TLSSSLOptions Property (PDFVerifier Class)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);
Default Value
16
Remarks
Various SSL (TLS) protocol options, set of
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (not send) signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (PDFVerifier Class)
Specifies the TLS mode to use.
Syntax
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);
Possible Values
SM_DEFAULT(0),
SM_NO_TLS(1),
SM_EXPLICIT_TLS(2),
SM_IMPLICIT_TLS(3),
SM_MIXED_TLS(4)
Default Value
0
Remarks
Specifies the TLS mode to use.
| smDefault | 0 | |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (PDFVerifier Class)
Enables Extended Master Secret Extension, as defined in RFC 7627.
Syntax
bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);
Default Value
false
Remarks
Enables Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (PDFVerifier Class)
Enables or disables TLS session resumption capability.
Syntax
bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);
Default Value
false
Remarks
Enables or disables TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (PDFVerifier Class)
Th SSL/TLS versions to enable by default.
Syntax
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Default Value
16
Remarks
Th SSL/TLS versions to enable by default.
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |
Data Type
Integer
TrustedCertCount Property (PDFVerifier Class)
The number of records in the TrustedCert arrays.
Syntax
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TrustedCertCount - 1.This property is not available at design time.
Data Type
Integer
TrustedCertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetTrustedCertBytes(int iTrustedCertIndex);
Remarks
Returns raw certificate data in DER format.
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TrustedCertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is not available at design time.
Data Type
Long64
TSACertBytes Property (PDFVerifier Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetTSACertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
TSACertCA Property (PDFVerifier Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
bool GetTSACertCA();
Default Value
false
Remarks
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
This property is read-only and not available at design time.
Data Type
Boolean
TSACertCAKeyID Property (PDFVerifier Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetTSACertCAKeyID();
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
This property is read-only and not available at design time.
Data Type
Byte Array
TSACertCRLDistributionPoints Property (PDFVerifier Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
QString GetTSACertCRLDistributionPoints();
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
This property is read-only and not available at design time.
Data Type
String
TSACertCurve Property (PDFVerifier Class)
Specifies the elliptic curve of the EC public key.
Syntax
QString GetTSACertCurve();
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
This property is read-only and not available at design time.
Data Type
String
TSACertFingerprint Property (PDFVerifier Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetTSACertFingerprint();
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
TSACertFriendlyName Property (PDFVerifier Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
QString GetTSACertFriendlyName();
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
This property is read-only and not available at design time.
Data Type
String
TSACertHandle Property (PDFVerifier Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetTSACertHandle();
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
TSACertHashAlgorithm Property (PDFVerifier Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
QString GetTSACertHashAlgorithm();
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is read-only and not available at design time.
Data Type
String
TSACertIssuer Property (PDFVerifier Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetTSACertIssuer();
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
This property is read-only and not available at design time.
Data Type
String
TSACertIssuerRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetTSACertIssuerRDN();
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
This property is read-only and not available at design time.
Data Type
String
TSACertKeyAlgorithm Property (PDFVerifier Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetTSACertKeyAlgorithm();
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
This property is read-only and not available at design time.
Data Type
String
TSACertKeyBits Property (PDFVerifier Class)
Returns the length of the public key.
Syntax
int GetTSACertKeyBits();
Default Value
0
Remarks
Returns the length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
TSACertKeyFingerprint Property (PDFVerifier Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetTSACertKeyFingerprint();
Remarks
Returns a fingerprint of the public key contained in the certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
TSACertKeyUsage Property (PDFVerifier Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetTSACertKeyUsage();
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
This property is read-only and not available at design time.
Data Type
Integer
TSACertKeyValid Property (PDFVerifier Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
bool GetTSACertKeyValid();
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
TSACertOCSPLocations Property (PDFVerifier Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
QString GetTSACertOCSPLocations();
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
This property is read-only and not available at design time.
Data Type
String
TSACertPolicyIDs Property (PDFVerifier Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
QString GetTSACertPolicyIDs();
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
This property is read-only and not available at design time.
Data Type
String
TSACertPublicKeyBytes Property (PDFVerifier Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetTSACertPublicKeyBytes();
Remarks
Contains the certificate's public key in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
TSACertSelfSigned Property (PDFVerifier Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetTSACertSelfSigned();
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
This property is read-only and not available at design time.
Data Type
Boolean
TSACertSerialNumber Property (PDFVerifier Class)
Returns the certificate's serial number.
Syntax
QByteArray GetTSACertSerialNumber();
Remarks
Returns the certificate's serial number.
This property is read-only and not available at design time.
Data Type
Byte Array
TSACertSigAlgorithm Property (PDFVerifier Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetTSACertSigAlgorithm();
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
This property is read-only and not available at design time.
Data Type
String
TSACertSubject Property (PDFVerifier Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetTSACertSubject();
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
This property is read-only and not available at design time.
Data Type
String
TSACertSubjectKeyID Property (PDFVerifier Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetTSACertSubjectKeyID();
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
This property is read-only and not available at design time.
Data Type
Byte Array
TSACertSubjectRDN Property (PDFVerifier Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetTSACertSubjectRDN();
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
This property is read-only and not available at design time.
Data Type
String
TSACertValidFrom Property (PDFVerifier Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetTSACertValidFrom();
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
This property is read-only and not available at design time.
Data Type
String
TSACertValidTo Property (PDFVerifier Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetTSACertValidTo();
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
This property is read-only and not available at design time.
Data Type
String
ValidatedSigningTime Property (PDFVerifier Class)
Contains the certified signing time.
Syntax
QString GetValidatedSigningTime();
Default Value
""
Remarks
Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.
This property is read-only and not available at design time.
Data Type
String
ValidationLog Property (PDFVerifier Class)
Contains the complete log of the certificate validation routine.
Syntax
QString GetValidationLog();
Default Value
""
Remarks
Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
This property is read-only and not available at design time.
Data Type
String
ValidationMoment Property (PDFVerifier Class)
The time point at which signature validity is to be established.
Syntax
QString GetValidationMoment();
int SetValidationMoment(QString qsValidationMoment);
Default Value
""
Remarks
Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either signature creation time, or current time).
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
Config Method (PDFVerifier Class)
Sets or retrieves a configuration setting.
Syntax
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (PDFVerifier Class)
Performs an additional action.
Syntax
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetSignedVersion Method (PDFVerifier Class)
Returns the part of the document that is covered by the signature.
Syntax
int GetSignedVersion(int iSigIndex, const QString& qsFilename);
Remarks
Use this method to retrieve the revision of the document that is covered by the SigIndex signature.
PDF documents often use incremental updates approach, with any changes being appended to the document without altering the existing revision. This may lead to situations where a signature only covers a part of the document (one of the past revisions), but not the subsequent changes. GetSignedVersion method provides means to extract the revision that is actually certified by the signature.
It is recommended that you use this method when validating signatures to make sure the signature covers what you expect it to cover.
An alternative to this method is to check the CoverageEndsAt field of the signature object and match it to the document length.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Verify Method (PDFVerifier Class)
Verifies a signed PDF document.
Syntax
int Verify();
Remarks
Use this method to validate all signatures in a PDF document.
This method walks through a signed document and reports every signature via a SignatureFound 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 Signatures property.
This method only validates the signatures, but does not check their coverage. It is a good idea to use mechanisms such as GetSignedVersion or CoverageEndsAt to ensure that the signature covers the expected document revision.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ChainElementDownload Event (PDFVerifier Class)
TBD.
Syntax
class PDFVerifierChainElementDownloadEventParams {
public:
const QString &Cert();
const QString &CACert();
const QString &Location();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void ChainElementDownload(PDFVerifierChainElementDownloadEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireChainElementDownload(PDFVerifierChainElementDownloadEventParams *e) {...}
Remarks
TBD.
ChainElementNeeded Event (PDFVerifier Class)
TBD.
Syntax
class PDFVerifierChainElementNeededEventParams {
public:
const QString &Cert();
const QString &CACert();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void ChainElementNeeded(PDFVerifierChainElementNeededEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireChainElementNeeded(PDFVerifierChainElementNeededEventParams *e) {...}
Remarks
TBD.
ChainValidated Event (PDFVerifier Class)
Reports the completion of a certificate chain validation.
Syntax
class PDFVerifierChainValidatedEventParams {
public:
const QString &SubjectRDN();
int ValidationResult();
int ValidationDetails();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void ChainValidated(PDFVerifierChainValidatedEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireChainValidated(PDFVerifierChainValidatedEventParams *e) {...}
Remarks
This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.
ValidationResult set to 0 (zero) indicates successful chain validation.
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
DecryptionInfoNeeded Event (PDFVerifier Class)
Requests decryption information during decryption, signing, or validation.
Syntax
class PDFVerifierDecryptionInfoNeededEventParams {
public:
bool CancelDecryption();
void SetCancelDecryption(bool bCancelDecryption);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void DecryptionInfoNeeded(PDFVerifierDecryptionInfoNeededEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireDecryptionInfoNeeded(PDFVerifierDecryptionInfoNeededEventParams *e) {...}
Remarks
This event is fired when the component needs decryption information to be provided by the user.
Use EncryptionType property to identify the document encryption type used, and then set Password or DecryptionCertificate (DecryptionCertificates) properties accordingly.
The class fires this event repeatedly until suitable decryption information is provided. To terminate the operation, set CancelDecryption to true.
Error Event (PDFVerifier Class)
Information about errors during signing/validation.
Syntax
class PDFVerifierErrorEventParams {
public:
int ErrorCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Error(PDFVerifierErrorEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireError(PDFVerifierErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during PDF processing.
ErrorCode contains an error code and Description contains a textual description of the error.
Notification Event (PDFVerifier Class)
This event notifies the application about an underlying control flow event.
Syntax
class PDFVerifierNotificationEventParams {
public:
const QString &EventID();
const QString &EventParam();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Notification(PDFVerifierNotificationEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireNotification(PDFVerifierNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
RecipientFound Event (PDFVerifier Class)
Provides recipient certificate details to the application.
Syntax
class PDFVerifierRecipientFoundEventParams {
public:
const QString &IssuerRDN();
const QByteArray &SerialNumber();
const QByteArray &SubjectKeyID();
bool CertFound();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void RecipientFound(PDFVerifierRecipientFoundEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireRecipientFound(PDFVerifierRecipientFoundEventParams *e) {...}
Remarks
The class fires this event when processing encrypted documents to report encryption certificate details to the user.
Subscribe to this event to obtain encryption certificate information and pass the corresponding certificate to the class via DecryptionCertificate (DecryptionCertificates) property.
SignatureFound Event (PDFVerifier Class)
Signifies the start of signature validation.
Syntax
class PDFVerifierSignatureFoundEventParams {
public:
const QString &IssuerRDN();
const QByteArray &SerialNumber();
const QByteArray &SubjectKeyID();
bool CertFound();
bool ValidateSignature();
void SetValidateSignature(bool bValidateSignature);
bool ValidateChain();
void SetValidateChain(bool bValidateChain);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void SignatureFound(PDFVerifierSignatureFoundEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireSignatureFound(PDFVerifierSignatureFoundEventParams *e) {...}
Remarks
This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.
The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
SignatureValidated Event (PDFVerifier Class)
Marks the completion of the signature validation routine.
Syntax
class PDFVerifierSignatureValidatedEventParams {
public:
const QString &IssuerRDN();
const QByteArray &SerialNumber();
const QByteArray &SubjectKeyID();
int ValidationResult();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void SignatureValidated(PDFVerifierSignatureValidatedEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireSignatureValidated(PDFVerifierSignatureValidatedEventParams *e) {...}
Remarks
This event is fired upon the completion of the signature validation routine, and reports the respective validation result.
Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
TimestampFound Event (PDFVerifier Class)
Signifies the start of a timestamp validation routine.
Syntax
class PDFVerifierTimestampFoundEventParams {
public:
const QString &IssuerRDN();
const QByteArray &SerialNumber();
const QByteArray &SubjectKeyID();
bool CertFound();
bool ValidateTimestamp();
void SetValidateTimestamp(bool bValidateTimestamp);
bool ValidateChain();
void SetValidateChain(bool bValidateChain);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void TimestampFound(PDFVerifierTimestampFoundEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireTimestampFound(PDFVerifierTimestampFoundEventParams *e) {...}
Remarks
This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.
The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
TimestampValidated Event (PDFVerifier Class)
Reports the completion of the timestamp validation routine.
Syntax
class PDFVerifierTimestampValidatedEventParams {
public:
const QString &IssuerRDN();
const QByteArray &SerialNumber();
const QByteArray &SubjectKeyID();
const QString &Time();
int ValidationResult();
int ChainValidationResult();
int ChainValidationDetails();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void TimestampValidated(PDFVerifierTimestampValidatedEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireTimestampValidated(PDFVerifierTimestampValidatedEventParams *e) {...}
Remarks
This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
TLSCertValidate Event (PDFVerifier Class)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
class PDFVerifierTLSCertValidateEventParams {
public:
const QString &ServerHostname();
const QString &ServerIP();
bool Accept();
void SetAccept(bool bAccept);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void TLSCertValidate(PDFVerifierTLSCertValidateEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireTLSCertValidate(PDFVerifierTLSCertValidateEventParams *e) {...}
Remarks
This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.
ValidationProgress Event (PDFVerifier Class)
TBD.
Syntax
class PDFVerifierValidationProgressEventParams {
public:
const QString &ValidationEventType();
const QString &Cert();
const QString &CACert();
bool DoContinue();
void SetDoContinue(bool bDoContinue);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void ValidationProgress(PDFVerifierValidationProgressEventParams *e);
// Or, subclass PDFVerifier and override this emitter function.
virtual int FireValidationProgress(PDFVerifierValidationProgressEventParams *e) {...}
Remarks
TBD.
Configuration Settings (PDFVerifier Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.PDFVerifier Configuration Settings | ||||||||||||||||||||||||||||||
| CustomTSLs: Specifies the custom TSLs.Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldAddRevInfo[Index]: Specifies if revocation checking should be performed.This property contains the True value if the viewing application should check the signing certificate revocation info, and include the revocation information within the signature value. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldAlternateName[Index]: Contains an alternate field name.This property contains an alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldCount: The number of empty signature form fields.Returns the number of the empty signature form fields available. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldFlags[Index]: The field flags of the signature form field.This property contains the empty signature form field flags ("Ff" entry in the signature field dictionary). | ||||||||||||||||||||||||||||||
| EmptySignatureFieldHeight[Index]: The Height of the empty signature form field.This property contains the height of the empty signature form field. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldInvisible[Index]: The visibility status of the field.This property contains the True value if the empty signature form field is visible. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldLegalAttestations[Index]: Specifies the legal attestations that are associated with the signature.This property contains the legal attestations that are associated with the signature. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldMappingName[Index]: The mapping name to be used when exporting form field data from the document.This property contains the name to be used when exporting form field data from the document. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldName[Index]: Textual field name.This property contains the empty signature field name. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldOffsetX[Index]: The field's offset from the left page border.This property contains the horizontal offset of the empty signature form field. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldOffsetY[Index]: The field's offset from the bottom page border.This property contains the vertical offset of the empty signature form field. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldPage[Index]: The index of the form field's page in the document.This property contains the index of the empty signature form field's page in the document. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldRequiredAllowedChanges[Index]: Specifies the changes allowed by the signature.This property contains which changes are allowed to the document when the signature field is signed. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldRequiredConstraints[Index]: Specifies the required Seed Value Dictionary (SVD) constraints.This property contains the required SVD constraints. If certain bit in RequiredConstraints is switched on, the corresponding data item is constrained. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldRequiredDigestAlgorithms[Index]: Specifies the required digest algorithms.This property contains the list of the digest algorithms used for signature generation. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldRequiredFilter[Index]: Specifies the required filter.This property contains the required filter (name of the preferred signature handler) to use for signature generation. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldRequiredLockAction[Index]: Indicates which set of fields shall be locked.This property contains a set of form fields that shall be locked when the current signature field is signed. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldRequiredLockFields[Index]: Indicates the fields that shall be locked on signing.This property contains the list of form field names that shall be locked when the current signature field is signed. Whether this list shall be included or excluded is defined by EmptySignatureFieldRequiredLockAction[Index] property. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldRequiredReasons[Index]: Specifies the required reasons.This property contains the required reasons used for signature generation. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldRequiredSubfilters[Index]: Specifies the required subfilters.This property contains the list of subfilters required by the signature. A subfilter represents the encoding to use when signing the PDF form. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldTimestampRequired[Index]: Specifies if the signature should be time-stamped.This property contains the True value if the signature should be time-stamped. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldTSPURL[Index]: URL for a TSP server.This property contains the TSP server URL. | ||||||||||||||||||||||||||||||
| EmptySignatureFieldWidth[Index]: The Width of the empty signature form field.This property contains the width of the empty signature form field. | ||||||||||||||||||||||||||||||
| EncryptionHandlerName: Specifies the custom security handler PDF-name.Specifies the custom security handler PDF-name for encryption handler. | ||||||||||||||||||||||||||||||
| ForceCompleteChainValidation: Whether to check issuer (CA) certificates when the signing certificate is invalid.Specifies whether to check issuer (CA) certificates when the signing certificate is invalid. | ||||||||||||||||||||||||||||||
| ForceCompleteChainValidationForTrusted: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments. | ||||||||||||||||||||||||||||||
| GracePeriod: Specifies a grace period to apply during revocation information checks.Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated. | ||||||||||||||||||||||||||||||
| HardenedKeyGeneration: Specifies if hardened Key generation should be used.Specifies if hardened Key generation should be used when an AES-256 encryption algorithm and password encryption are used. | ||||||||||||||||||||||||||||||
| IgnoreOCSPNoCheckExtension: Whether OCSP NoCheck extension should be ignored.Set this property to false to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues. | ||||||||||||||||||||||||||||||
| IgnoreSystemTrust:
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted. |
||||||||||||||||||||||||||||||
| ImplicitlyTrustSelfSignedCertificates: Whether to trust self-signed certificates. Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows to emulate the verifying environment without actually changing its security settings. | ||||||||||||||||||||||||||||||
| PageInfoCount: The number of pages.Returns the number of the page infos available. | ||||||||||||||||||||||||||||||
| PageInfoCropBoxEmpty[Index]: Check if the page's crop box is empty or not.This property contains True if the crop box is empty, and False otherwise. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. | ||||||||||||||||||||||||||||||
| PageInfoCropLLX[Index]: Defines the X coordinate of the lower left corner of the crop box.This property contains the X coordinate of the lower left corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. | ||||||||||||||||||||||||||||||
| PageInfoCropLLY[Index]: Defines the Y coordinate of the lower left corner of the crop box.This property contains the Y coordinate of the lower left corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. | ||||||||||||||||||||||||||||||
| PageInfoCropURX[Index]: Defines the X coordinate of the upper right corner of the crop box.This property contains the X coordinate of the upper right corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. | ||||||||||||||||||||||||||||||
| PageInfoCropURY[Index]: Defines the Y coordinate of the upper right corner of the crop box.This property contains the Y coordinate of the upper right corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. | ||||||||||||||||||||||||||||||
| PageInfoHeight[Index]: The Height of the page.This property contains the page height value. | ||||||||||||||||||||||||||||||
| PageInfoMediaLLX[Index]: Defines the X coordinate of the lower left corner of the media box.This property contains the X coordinate of the lower left corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed. | ||||||||||||||||||||||||||||||
| PageInfoMediaLLY[Index]: Defines the Y coordinate of the lower left corner of the media box.This property contains the Y coordinate of the lower left corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed. | ||||||||||||||||||||||||||||||
| PageInfoMediaURX[Index]: Defines the X coordinate of the upper right corner of the media box.This property contains the X coordinate of the upper right corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed. | ||||||||||||||||||||||||||||||
| PageInfoMediaURY[Index]: Defines the Y coordinate of the upper right corner of the media box.This property contains the Y coordinate of the upper right corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed. | ||||||||||||||||||||||||||||||
| PageInfoRotate[Index]: The Rotate value of the page.This property contains the page rotation angle. | ||||||||||||||||||||||||||||||
| PageInfoUserUnit[Index]: Defines the size of default user space units.This property contains a positive number that shall give the size of default user space units, in multiples of 1/72 inch. The default value is 1.0 (user space unit is 1/72 inch). | ||||||||||||||||||||||||||||||
| PageInfoWidth[Index]: The Width of the page.This property contains the page width value. | ||||||||||||||||||||||||||||||
| PromoteLongOCSPResponses: Whether long OCSP responses are requested. Set this property to True to force the class to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted. | ||||||||||||||||||||||||||||||
| PSSUsed: Whether RSASSA-PSS mode was used.Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations. | ||||||||||||||||||||||||||||||
| QualifiedStatus: Indicates a qualified electronic signature.Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate. This property return TSP service status URI. | ||||||||||||||||||||||||||||||
| RC4KeyBits: Specifies the number of key bits used for RC4 algorithm.Specifies the number of key bits used for RC4 encryption algorithm. | ||||||||||||||||||||||||||||||
| TolerateMinorChainIssues: Whether to tolerate minor chain issues.TBD | ||||||||||||||||||||||||||||||
| TSLDistributionPoints: Contains XML content of distribution points of the TSL used.Use this property to get XML content of distribution points of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLDistributionPoints[Idx]: Contains distribution point of the specified index of the TSL used.Use this property to get distribution point of the specified index of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLHistoricalInformationPeriod: Contains historical information period of the TSL used.Use this property to get historical information period of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLLegalNotices: Contains XML content of legal notices of the TSL used.Use this property to get XML content of multilingual legal notices of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLLegalNotices[lang]: Contains legal notices for the specified language of the TSL used.Use this property to get legal notices for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLListIssueDateTime: Contains list issue date and time of the TSL used.Use this property to get list issue date and time of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLNextUpdate: Contains next update date and time of the TSL used.Use this property to get next update date and time of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLPolicies: Contains XML content of policies of the TSL used.Use this property to get XML content of multilingual policies of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLPolicies[lang]: Contains policies for the specified language of the TSL used.Use this property to get policies for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeExtensions: Contains XML content of scheme extensions of the TSL used.Use this property to get XML content of scheme extensions of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeExtensions[Idx]: Contains XML content of scheme extension of the specified index of the TSL used.Use this property to get XML content of scheme extension of the specified index of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeInformationURI: Contains XML content of scheme information URI of the TSL used.Use this property to get XML content of multilingual scheme information URI of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeInformationURI[lang]: Contains scheme information URI for the specified language of the TSL used.Use this property to get scheme information URI for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeName: Contains XML content of scheme name of the TSL used.Use this property to get XML content of multilingual scheme name of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeName[lang]: Contains scheme name for the specified language of the TSL used.Use this property to get scheme name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeOperatorAddress: Contains XML content of scheme operator address of the TSL used.Use this property to get XML content of scheme operator address of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeOperatorName: Contains XML content of scheme operator name of the TSL used.Use this property to get XML content of multilingual scheme operator name of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeOperatorName[lang]: Contains scheme operator name for the specified language of the TSL used.Use this property to get scheme operator name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeTerritory: Contains scheme territory of the TSL used.Use this property to get scheme territory of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeTypeCommunityRules: Contains XML content of scheme type/community/rules of the TSL used.Use this property to get XML content of multilingual scheme type/community/rules of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeTypeCommunityRules[lang]: Contains scheme type/community/rules for the specified language of the TSL used.Use this property to get scheme type/community/rules for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSequenceNumber: Contains sequence number of the TSL used.Use this property to get sequence number of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLsRetrieveLog: Contains the complete log of the TSLs retrieve.Use this property to access the TSLs retrieve log produced by the class. The log can be very useful when investigating issues with TSL retrieve. | ||||||||||||||||||||||||||||||
| TSLStatusDeterminationApproach: Contains status determination approach of the TSL used.Use this property to get status determination approach of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLsValidationLog: Contains the complete log of the TSLs validation.Use this property to access the TSLs validation log produced by the class. The log can be very useful when investigating issues with TSL validation. | ||||||||||||||||||||||||||||||
| TSLTSPAdditionalServiceInformation: Contains addtional service information of the TSP service used.Use this property to get the list of addtional service information of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated. | ||||||||||||||||||||||||||||||
| TSLTSPAddress: Contains XML content of the address of the TSP used.Use this property to get XML content of the address of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstance: Indicates that TSP service history instance used.Indicates whether or not the qualified status was obtained from the TSP (Trust Service Provider) service history instance. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceAdditionalServiceInformation: Contains addtional service information of the TSP service history instance used.Use this property to get the list of addtional service information of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceQualifiers: Contains list of qualifiers of the TSP service history instance used.Use this property to get the list of qualifiers of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceInformationExtensions: Contains XML content of information extensions of the TSP service history instance used.Use this property to get XML content of information extensions of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceInformationExtensions[Idx]: Contains XML content of information extension of the specified index of the TSP service history instance used.Use this property to get XML content of information extension of the specified index of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceName: Contains XML content of name of the TSP service history instance used.Use this property to get XML content of multilingual name of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceName[lang]: Contains name for the specified language of the TSP service history instance used.Use this property to get the name for the specified language code (e.g. 'en') of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceStatus: Contains status of the TSP service history instance used.Use this property to get the status of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceStatusStartingTime: Contains status starting time of the TSP service history instance used.Use this property to get the status starting time of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceTypeIdentifier: Contains type identifier of the TSP service history instance used.Use this property to get type identifier of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceXML: Contains XML content of the TSP service history instance used.Use this property to get XML content of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPInformationExtensions: Contains XML content of information extensions of the TSP used.Use this property to get XML content of information extensions of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPInformationExtensions[Idx]: Contains XML content of information extension of the specified index of the TSP used.Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPInformationURI: Contains XML content of information URI of the TSP used.Use this property to get XML content of multilingual information URI of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPInformationURI[lang]: Contains information URI for the specified language of the TSP used.Use this property to get the information URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPName: Contains XML content of name of the TSP used.Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPName[lang]: Contains name for the specified language of the TSP used.Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPSchemeServiceDefinitionURI: Contains XML content of scheme service definition URI of the TSP service used.Use this property to get XML content of multilingual scheme service definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPSchemeServiceDefinitionURI[lang]: Contains scheme service definition URI for the specified language of the TSP service used.Use this property to get the scheme service definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceDefinitionURI: Contains XML content of definition URI of the TSP service used.Use this property to get XML content of multilingual definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceDefinitionURI[lang]: Contains definition URI for the specified language of the TSP service used.Use this property to get the definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceInformationExtensions: Contains XML content of information extensions of the TSP service used.Use this property to get XML content of information extensions of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceInformationExtensions[Idx]: Contains XML content of information extension of the specified index of the TSP service used.Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceName: Contains XML content of name of the TSP service used.Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceName[lang]: Contains name for the specified language of the TSP service used.Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceQualifiers: Contains list of qualifiers of the TSP service used.Use this property to get the list of qualifiers of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated. | ||||||||||||||||||||||||||||||
| TSLTSPServiceStatus: Contains status of the TSP service used.Use this property to get the status of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceStatusStartingTime: Contains status starting time of the TSP service used.Use this property to get the status starting time of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceSupplyPoints: Contains XML content of the supply points of the TSP service used.Use this property to get XML content of the supply points of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceTypeIdentifier: Contains type identifier of the TSP service used.Use this property to get type identifier of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceXML: Contains XML content of the TSP service used.Use this property to get XML content of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPTradeName: Contains XML content of trade name of the TSP used.Use this property to get XML content of multilingual trade name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPTradeName[lang]: Contains trade name for the specified language of the TSP used.Use this property to get the trade name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPXML: Contains XML content of the TSP used.Use this property to get XML content of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLType: Contains TSL type of the TSL used.Use this property to get TSL type of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLVersionIdentifier: Contains version identifier of the TSL used.Use this property to get version identifier of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLXML: Contains XML content of the TSL used.Use this property to get XML content of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| UseDefaultTSLs:
Enables or disables the use of the default TSLs.Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).
The result of this check reported in Qualified property.
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists). |
||||||||||||||||||||||||||||||
| UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. | ||||||||||||||||||||||||||||||
| UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (PDFVerifier Class)
PDFVerifier Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
| 26214401 Input file does not exist (SB_ERROR_PDF_INPUTFILE_NOT_EXISTS) | |
| 26214402 Document is encrypted (SB_ERROR_PDF_ENCRYPTED) | |
| 26214403 Document not encrypted (SB_ERROR_PDF_NOT_ENCRYPTED) | |
| 26214404 Unknown certificate type (SB_ERROR_PDF_UNKNOWN_ENCRYPTION_TYPE) | |
| 26214405 Invalid password (SB_ERROR_PDF_INVALID_PASSWORD) | |
| 26214406 Decryption failed (SB_ERROR_PDF_DECRYPTION_FAILED) | |
| 26214407 Document is signed (SB_ERROR_PDF_SIGNED) | |
| 26214408 Document is not signed (SB_ERROR_PDF_NOT_SIGNED) | |
| 26214409 Inappropriate signature (SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE) | |
| 26214410 Not supported (SB_ERROR_PDF_NOT_SUPPORTED) |