Table of Contents

Class AuditOptions

Namespace
Excalibur.Data.ElasticSearch.Security
Assembly
Excalibur.Data.ElasticSearch.dll

Configures security auditing and compliance reporting.

public sealed class AuditOptions
Inheritance
AuditOptions
Inherited Members

Properties

AuditAuthentication

Gets a value indicating whether to audit authentication events.

public bool AuditAuthentication { get; init; }

Property Value

bool

True to log all authentication attempts and results, false otherwise.

AuditConfigurationChanges

Gets a value indicating whether to audit configuration changes.

public bool AuditConfigurationChanges { get; init; }

Property Value

bool

True to log security configuration modifications, false otherwise.

AuditDataAccess

Gets a value indicating whether to audit data access events.

public bool AuditDataAccess { get; init; }

Property Value

bool

True to log data access patterns and queries, false otherwise.

ComplianceFrameworks

Gets the compliance frameworks to support.

public List<ComplianceFramework> ComplianceFrameworks { get; init; }

Property Value

List<ComplianceFramework>

List of compliance standards to generate reports for.

Enabled

Gets a value indicating whether security auditing is enabled.

public bool Enabled { get; init; }

Property Value

bool

True to enable comprehensive security auditing, false otherwise.

EnsureLogIntegrity

Gets a value indicating whether to ensure audit log integrity.

public bool EnsureLogIntegrity { get; init; }

Property Value

bool

True to use cryptographic signatures for audit log integrity, false otherwise.

MaskPiiInAuditEvents

Gets a value indicating whether personally identifiable information (PII) on recorded security-audit events is masked before the event is enqueued for indexing.

public bool MaskPiiInAuditEvents { get; init; }

Property Value

bool

true to mask PII before enqueue (default); false to persist raw fields.

Remarks

When enabled (the default), sensitive fields — source IP address, user agent, authentication failure reasons, and free-form context/details — are routed through the framework's ITelemetrySanitizer before enqueue, so raw PII and secret-shaped values never reach the long-retention searchable index or archive. Set to false only as an explicit opt-out when the audit store is itself a trusted, access-controlled PII sink.

MaxPendingAuditEvents

Gets the maximum number of audit events that may be buffered in memory awaiting flush. When the buffer is full, event producers apply backpressure (they await, never drop) so a slow or failed audit sink throttles callers rather than losing audit records.

public int MaxPendingAuditEvents { get; init; }

Property Value

int

The bounded in-memory audit buffer capacity. Defaults to 10,000.

MaxQueryResultSize

Gets the maximum number of results to return from Elasticsearch queries used for audit report generation, integrity validation, and archival operations.

public int MaxQueryResultSize { get; init; }

Property Value

int

The maximum query result size. Defaults to 10,000.