Table of Contents

Class AuditIntegrityOptions

Namespace
Excalibur.AuditLogging
Assembly
Excalibur.AuditLogging.Abstractions.dll

Configures the shared audit-integrity signing key used by every audit sink's IAuditIntegrityStrategy (keyed-MAC). One key-config story across sinks — the audit-integrity key is an application-level security secret, not a per-sink concern.

public sealed class AuditIntegrityOptions
Inheritance
AuditIntegrityOptions
Inherited Members

Remarks

The key MUST be sourced from a secret manager / KMS, never hard-coded. When no key is configured and integrity is in use, the default IAuditSigningKeyProvider fails closed (it never fabricates or omits the key). A deployment needing per-sink key isolation or a KMS-backed provider registers its own IAuditSigningKeyProvider (the default is registered via TryAddSingleton, so a prior registration wins).

Properties

KeyId

Gets the identifier of the current signing key, embedded in each record's integrity tag so keys can be rotated while older records remain verifiable.

public string KeyId { get; init; }

Property Value

string

The key identifier (must be colon-free). Defaults to "default".

SigningKey

Gets the secret signing key bytes used to compute and verify the keyed-MAC integrity tag.

public byte[]? SigningKey { get; init; }

Property Value

byte[]

The key bytes, sourced from a secret manager / KMS. null by default; when null and integrity is in use, the default provider fails closed.