Apryse WebViewer

Class: VerificationResult

Core.PDFNet. VerificationResult

new VerificationResult()

The result of a verification operation performed on a digital signature.

Extends

Members

<static> DigestStatus

Properties:
Name Type Description
e_digest_invalid number
e_digest_verified number
e_digest_verification_disabled number
e_weak_digest_algorithm_but_digest_verifiable number
e_no_digest_status number
e_unsupported_encoding number

<static> DocumentStatus

Properties:
Name Type Description
e_no_error number
e_corrupt_file number
e_unsigned number
e_bad_byteranges number
e_corrupt_cryptographic_contents number

<static> ModificationPermissionsStatus

Properties:
Name Type Description
e_invalidated_by_disallowed_changes number
e_has_allowed_changes number
e_unmodified number
e_permissions_verification_disabled number
e_no_permissions_status number

<static> TrustStatus

Properties:
Name Type Description
e_trust_verified number
e_untrusted number
e_trust_verification_disabled number
e_no_trust_status number

Methods

destroy()

Destructor
Inherited From:
Returns:
Type
Promise.<void>

getDigestAlgorithm()

Retrieves an enumeration value representing the digest algorithm used to sign the signature that is associated with this verification result. For DocTimeStamp signatures, returns the weakest algorithm found (between the CMS and message imprint digests).
Returns:
A promise that resolves to a DigestAlgorithm enumeration value.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.DigestAlgorithm.Type = {
	e_SHA1 : 0
	e_SHA256 : 1
	e_SHA384 : 2
	e_SHA512 : 3
	e_RIPEMD160 : 4
	e_unknown_digest_algorithm : 5
}
</pre>

getDigestStatus()

Retrieves the digest-related result condition associated with a digital signature verification operation.
Returns:
A promise that resolves to a DigestStatus-type enumeration value.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.VerificationResult.DigestStatus = {
	e_digest_invalid : 0
	e_digest_verified : 1
	e_digest_verification_disabled : 2
	e_weak_digest_algorithm_but_digest_verifiable : 3
	e_no_digest_status : 4
	e_unsupported_encoding : 5
}
</pre>

getDigestStatusAsString()

Retrieves the digest-related result condition associated with a digital signature verification operation, as a descriptive string.
Returns:
A promise that resolves to a string.
Type
Promise.<string>

getDigitalSignatureField()

Returns:
A promise that resolves to an object of type: "PDFNet.DigitalSignatureField"
Type
Promise.<Core.PDFNet.DigitalSignatureField>

getDisallowedChanges()

Retrieves a list of informational structures regarding any disallowed changes that have been made to the document since the signature associated with this verification result was signed.
Returns:
A promise that resolves to a collection of DisallowedChange objects.
Type
Promise.<Array.<Core.PDFNet.DisallowedChange>>

getDocumentStatus()

Retrieves the document-related result condition associated with a digital signature verification operation.
Returns:
A promise that resolves to a DocumentStatus-type enumeration value.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.VerificationResult.DocumentStatus = {
	e_no_error : 0
	e_corrupt_file : 1
	e_unsigned : 2
	e_bad_byteranges : 3
	e_corrupt_cryptographic_contents : 4
}
</pre>

getDocumentStatusAsString()

Retrieves the document-related result condition associated with a digital signature verification operation, as a descriptive string.
Returns:
A promise that resolves to a string.
Type
Promise.<string>

getPermissionsStatus()

Retrieves the result condition about permissions checks performed on any unsigned modifications associated with a digital signature verification operation.
Returns:
A promise that resolves to a ModificationPermissionsStatus-type enumeration value.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.VerificationResult.ModificationPermissionsStatus = {
	e_invalidated_by_disallowed_changes : 0
	e_has_allowed_changes : 1
	e_unmodified : 2
	e_permissions_verification_disabled : 3
	e_no_permissions_status : 4
}
</pre>

getPermissionsStatusAsString()

Retrieves the result condition about permissions checks performed on any unsigned modifications associated with a digital signature verification operation, as a descriptive string.
Returns:
A promise that resolves to a string.
Type
Promise.<string>

getTrustStatus()

Retrieves the trust-related result condition associated with a digital signature verification operation.
Returns:
A promise that resolves to a TrustStatus-type enumeration value.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.VerificationResult.TrustStatus = {
	e_trust_verified : 0
	e_untrusted : 1
	e_trust_verification_disabled : 2
	e_no_trust_status : 3
}
</pre>

getTrustStatusAsString()

Retrieves the trust-related result condition associated with a digital signature verification operation, as a descriptive string.
Returns:
A promise that resolves to a string.
Type
Promise.<string>

getTrustVerificationResult()

Retrieves the detailed result associated with the trust step of the verification operation that returned this VerificationResult, if such a detailed trust result is available. Must call HasTrustVerificationResult first and check for a true result.
Returns:
A promise that resolves to a TrustVerificationResult object Note: This function will throw if no TrustVerificationResult is available.
Type
Promise.<Core.PDFNet.TrustVerificationResult>

getUnsupportedFeatures()

Retrieves reports about unsupported features encountered during verification. This function is the canonical source of information about all unsupported features encountered. Current possible values: "unsupported signature encoding", "usage rights signature", "legal content attestations", "unsupported digest algorithm"
Returns:
A promise that resolves to a container of strings representing unsupported features encountered during verification Note: Output may change in future versions.
Type
Promise.<Array.<string>>

getVerificationStatus()

Retrieves the main verification status. The main status is determined based on the other statuses. Verification may fail for many reasons; some of these reasons are the presence of features that are not supported yet. It may be desirable for you to report unsupported signatures differently (for example, using a question mark rather than an X mark). Any unsupported features encountered can be retrieved by the use of the function GetUnsupportedFeatures on this class.
Returns:
A promise that resolves to a boolean representing whether or not the verification operation was completely successful.
Type
Promise.<boolean>

hasTrustVerificationResult()

Returns whether there is a detailed TrustVerificationResult in this VerificationResult or not.
Returns:
A promise that resolves to a boolean.
Type
Promise.<boolean>

takeOwnership()

Take the ownership of this object, so that PDFNet.runWithCleanup won't destroy this object.
Inherited From:
Returns:
Type
void