Back to Devexpress

SignatureValidationOptions Class

officefileapi-devexpress-dot-office-dot-digitalsignatures-120b6ce3.md

latest3.5 KB
Original Source

SignatureValidationOptions Class

Contains signature validation options.

Namespace : DevExpress.Office.DigitalSignatures

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

Declaration

csharp
public class SignatureValidationOptions
vb
Public Class SignatureValidationOptions

Remarks

The SignatureValidationOptions object allows you to specify signature validation options (signature or timestamp certificate policy, decryption password, etc.). Use the SignatureValidationOptions.ValidationFlags property to exclude validation steps.

If the document to be validated is encrypted, specify the SignatureValidationOptions.DecryptionPassword property to decrypt the document. Otherwise, the Result property returns PackageSignatureValidationResult.PackageOpenFailed.

The code sample below shows how to specify signature validation options:

csharp
using DevExpress.Office.DigitalSignatures;
using System.Diagnostics;
using System.Net;

static void Main(string[] args)
{
    ValidateSignature("Template_signed.xlsx");
}

private static void ValidateSignature(string path)
{
    DocumentSigner validator = new DocumentSigner();

    //In this example, certificate validation is skipped
    SignatureValidationOptions validationOptions = new SignatureValidationOptions();
    validationOptions.ValidationFlags = ~ValidationFlags.ValidateSignatureCertificate & ~ValidationFlags.ValidateTimestampCertificate;
    validationOptions.DecryptionPassword = "dxdemo";

    //Validate the signature:
    PackageSignatureValidation signatureValidation = validator.Validate(path, validationOptions);
    AnalyzeValidationResult(signatureValidation);
}
vb
Imports Microsoft.VisualBasic
Imports DevExpress.Office.DigitalSignatures
Imports System.Diagnostics
Imports System.Net

Shared Sub Main(ByVal args() As String)
  ValidateSignature("Template_signed.docx")
  ValidateSignature("Template_signed.xlsx")
End Sub

Private Shared Sub ValidateSignature(ByVal path As String)
  Dim validator As New DocumentSigner()

  'In this example, certificate validation is skipped
  Dim validationOptions As New SignatureValidationOptions()
  validationOptions.ValidationFlags = (Not ValidationFlags.ValidateSignatureCertificate) And Not ValidationFlags.ValidateTimestampCertificate
  validationOptions.DecryptionPassword = "dxdemo"

  'Validate the signature:
  Dim signatureValidation As PackageSignatureValidation = validator.Validate(path, validationOptions)
  AnalyzeValidationResult(signatureValidation)
End Sub

Inheritance

Object SignatureValidationOptions

See Also

SignatureValidationOptions Members

DevExpress.Office.DigitalSignatures Namespace