Table of Contents

Class EvidencePackageOptions

Namespace
Excalibur.Compliance
Assembly
Excalibur.Compliance.Abstractions.dll

Options for evidence package exports.

public record EvidencePackageOptions : IEquatable<EvidencePackageOptions>
Inheritance
EvidencePackageOptions
Implements
Inherited Members

Properties

CompressionLevel

Compression level for the package.

public CompressionLevel CompressionLevel { get; init; }

Property Value

CompressionLevel

EncryptionPassword

Password to encrypt the package.

public string? EncryptionPassword { get; init; }

Property Value

string

Remarks

Not supported by the in-box exporter, and refused rather than ignored. The package is a standard ZIP archive written with ZipArchive, which offers no encryption of any kind, so a password given here cannot be applied. Setting it makes ExportWithEvidenceAsync(Soc2Report, IReadOnlyList<AuditEvidence>, EvidencePackageOptions?, CancellationToken) throw NotSupportedException instead of returning an evidence package that is not encrypted while the caller believes it is.

To deliver an encrypted package, leave this unset and encrypt Data yourself before it leaves the process.

IncludeChecksums

Whether to include checksums for all files.

public bool IncludeChecksums { get; init; }

Property Value

bool

IncludeManifest

Whether to include a manifest file.

public bool IncludeManifest { get; init; }

Property Value

bool

ReportFormats

Report formats to include in the package.

public ExportFormat[] ReportFormats { get; init; }

Property Value

ExportFormat[]

Remarks

Pdf is not included by default because PDF export requires the separate Excalibur.Compliance.Pdf package. Add it explicitly once that package is installed and registered.