Class SecurityAuditor
- Namespace
- Excalibur.Data.ElasticSearch.Security
- Assembly
- Excalibur.Data.ElasticSearch.dll
Production implementation of comprehensive security auditing for Elasticsearch operations with GDPR, SOC2, and HIPAA compliance, tamper-proof logging, real-time threat detection, and automated incident response capabilities.
public sealed class SecurityAuditor : IElasticsearchSecurityAuditor, IElasticsearchSecurityAuditorCore, IElasticsearchSecurityAuditorRecording, IElasticsearchSecurityAuditorEvents, IElasticsearchSecurityAuditorReporting, IElasticsearchSecurityAuditorMaintenance, IDisposable, IAsyncDisposable
- Inheritance
-
SecurityAuditor
- Implements
- Inherited Members
Remarks
Facade that delegates to focused service classes following SRP:
- Excalibur.Data.ElasticSearch.Security.SecurityAuditWriter — event recording (authentication, data access, config changes, incidents)
- Excalibur.Data.ElasticSearch.Security.SecurityAuditQueryService — reporting and search (audit reports, compliance reports, event search)
- Excalibur.Data.ElasticSearch.Security.SecurityAuditMaintenanceService — integrity validation and archival
Owns shared infrastructure: event processing queues, timers, index initialization, and disposal.
Constructors
SecurityAuditor(ElasticsearchClient, IOptions<AuditOptions>, IOptions<SecurityMonitoringOptions>, IAuditIntegrityStrategy, ITelemetrySanitizer?, TimeProvider, ILogger<SecurityAuditor>)
Initializes a new instance of the SecurityAuditor class with an explicit audit integrity strategy. This is the dependency-injection entry point.
public SecurityAuditor(ElasticsearchClient elasticsearchClient, IOptions<AuditOptions> auditOptions, IOptions<SecurityMonitoringOptions> monitoringOptions, IAuditIntegrityStrategy integrityStrategy, ITelemetrySanitizer? sanitizer, TimeProvider timeProvider, ILogger<SecurityAuditor> logger)
Parameters
elasticsearchClientElasticsearchClientThe Elasticsearch client for audit log storage.
auditOptionsIOptions<AuditOptions>The audit configuration options.
monitoringOptionsIOptions<SecurityMonitoringOptions>The security monitoring configuration options.
integrityStrategyIAuditIntegrityStrategyThe shared keyed-MAC audit integrity strategy.
sanitizerITelemetrySanitizerThe sanitizer used to mask PII on audit events before enqueue; when null and MaskPiiInAuditEvents is enabled, construction fails closed.
timeProviderTimeProviderThe time source driving the compliance-report and audit-queue-drain schedules.
loggerILogger<SecurityAuditor>The logger for operational events.
Exceptions
- ArgumentNullException
Thrown when required dependencies are null.
SecurityAuditor(ElasticsearchClient, IOptions<AuditOptions>, IOptions<SecurityMonitoringOptions>, ILogger<SecurityAuditor>)
Initializes a new instance of the SecurityAuditor class.
public SecurityAuditor(ElasticsearchClient elasticsearchClient, IOptions<AuditOptions> auditOptions, IOptions<SecurityMonitoringOptions> monitoringOptions, ILogger<SecurityAuditor> logger)
Parameters
elasticsearchClientElasticsearchClientThe Elasticsearch client for audit log storage.
auditOptionsIOptions<AuditOptions>The audit configuration options.
monitoringOptionsIOptions<SecurityMonitoringOptions>The security monitoring configuration options.
loggerILogger<SecurityAuditor>The logger for operational events.
Exceptions
- ArgumentNullException
Thrown when required dependencies are null.
Properties
Configuration
Gets the audit configuration settings currently in use.
public AuditOptions Configuration { get; }
Property Value
- AuditOptions
The current audit configuration settings.
IntegrityProtectionEnabled
Gets a value indicating whether audit log integrity protection is enabled.
public bool IntegrityProtectionEnabled { get; }
Property Value
- bool
True if audit logs are cryptographically protected, false otherwise.
SupportedComplianceFrameworks
Gets the supported compliance frameworks for reporting.
public IReadOnlyCollection<ComplianceFramework> SupportedComplianceFrameworks { get; }
Property Value
- IReadOnlyCollection<ComplianceFramework>
A collection of compliance frameworks supported by this auditor.
Methods
ArchiveAuditEventsAsync(AuditArchiveRequest, CancellationToken)
Archives old audit events according to retention policies and compliance requirements.
public Task<AuditArchiveResult> ArchiveAuditEventsAsync(AuditArchiveRequest archiveRequest, CancellationToken cancellationToken)
Parameters
archiveRequestAuditArchiveRequestThe archive request with retention criteria.
cancellationTokenCancellationTokenThe cancellation token to monitor for cancellation requests.
Returns
- Task<AuditArchiveResult>
A task that represents the asynchronous operation. The task result contains the archive operation result including the number of events archived and any errors encountered.
Exceptions
- SecurityException
Thrown when audit archiving fails due to security constraints.
- ArgumentNullException
Thrown when the archive request is null.
ArchiveAuditEventsAsync(DateTimeOffset, string, CancellationToken)
Archives audit events before the cutoff date to the specified location.
public Task<AuditArchiveResult> ArchiveAuditEventsAsync(DateTimeOffset cutoffDate, string archiveLocation, CancellationToken cancellationToken)
Parameters
cutoffDateDateTimeOffsetarchiveLocationstringcancellationTokenCancellationToken
Returns
AuditSecurityActivityAsync(SecurityActivityEvent, CancellationToken)
Audits a security activity event for compliance and monitoring purposes.
public Task AuditSecurityActivityAsync(SecurityActivityEvent activityEvent, CancellationToken cancellationToken)
Parameters
activityEventSecurityActivityEventThe security activity event to audit.
cancellationTokenCancellationTokenThe cancellation token to monitor for cancellation requests.
Returns
- Task
A task representing the asynchronous audit operation.
Dispose()
Releases all resources used by the SecurityAuditor.
public void Dispose()
DisposeAsync()
Asynchronously releases resources, ensuring tracked timer callbacks have completed.
public ValueTask DisposeAsync()
Returns
GenerateAuditReportAsync(AuditReportRequest, CancellationToken)
Generates a comprehensive security audit report for the specified time period.
public Task<SecurityAuditReport> GenerateAuditReportAsync(AuditReportRequest reportRequest, CancellationToken cancellationToken)
Parameters
reportRequestAuditReportRequestThe audit report generation request with filters and parameters.
cancellationTokenCancellationTokenThe cancellation token to monitor for cancellation requests.
Returns
- Task<SecurityAuditReport>
A task that represents the asynchronous operation. The task result contains the generated audit report with security events and compliance information.
Exceptions
- SecurityException
Thrown when report generation fails due to security constraints.
- ArgumentNullException
Thrown when the report request is null.
GenerateAuditReportAsync(DateTimeOffset, DateTimeOffset, AuditReportType, CancellationToken)
Generates a comprehensive audit report for the specified time period.
public Task<AuditReport> GenerateAuditReportAsync(DateTimeOffset startTime, DateTimeOffset endTime, AuditReportType reportType, CancellationToken cancellationToken)
Parameters
startTimeDateTimeOffsetendTimeDateTimeOffsetreportTypeAuditReportTypecancellationTokenCancellationToken
Returns
GenerateComplianceReportAsync(ComplianceFramework, DateTimeOffset, DateTimeOffset, CancellationToken)
Generates a compliance report for the specified framework and time period.
public Task<ComplianceReport> GenerateComplianceReportAsync(ComplianceFramework framework, DateTimeOffset startTime, DateTimeOffset endTime, CancellationToken cancellationToken)
Parameters
frameworkComplianceFrameworkstartTimeDateTimeOffsetendTimeDateTimeOffsetcancellationTokenCancellationToken
Returns
GenerateComplianceReportAsync(ComplianceReportRequest, CancellationToken)
Generates a compliance report for specific regulatory frameworks.
public Task<ComplianceReport> GenerateComplianceReportAsync(ComplianceReportRequest complianceRequest, CancellationToken cancellationToken)
Parameters
complianceRequestComplianceReportRequestThe compliance report generation request with framework specifications.
cancellationTokenCancellationTokenThe cancellation token to monitor for cancellation requests.
Returns
- Task<ComplianceReport>
A task that represents the asynchronous operation. The task result contains the generated compliance report formatted according to the specified regulatory requirements.
Exceptions
- SecurityException
Thrown when compliance report generation fails due to security constraints.
- ArgumentNullException
Thrown when the compliance request is null.
RecordAuthenticationEventAsync(AuthenticationEvent, CancellationToken)
Records an authentication event for security monitoring and compliance purposes.
public Task<bool> RecordAuthenticationEventAsync(AuthenticationEvent authenticationEvent, CancellationToken cancellationToken)
Parameters
authenticationEventAuthenticationEventThe authentication event details to record.
cancellationTokenCancellationTokenThe cancellation token to monitor for cancellation requests.
Returns
- Task<bool>
A task that represents the asynchronous operation. The task result contains true if the event was successfully recorded, false otherwise.
Exceptions
- SecurityException
Thrown when audit recording fails due to security constraints.
- ArgumentNullException
Thrown when the authentication event is null.
RecordConfigurationChangeAsync(ConfigurationChangeEvent, CancellationToken)
Records a security configuration change for compliance and change tracking purposes.
public Task<bool> RecordConfigurationChangeAsync(ConfigurationChangeEvent configurationEvent, CancellationToken cancellationToken)
Parameters
configurationEventConfigurationChangeEventThe configuration change event details to record.
cancellationTokenCancellationTokenThe cancellation token to monitor for cancellation requests.
Returns
- Task<bool>
A task that represents the asynchronous operation. The task result contains true if the event was successfully recorded, false otherwise.
Exceptions
- SecurityException
Thrown when audit recording fails due to security constraints.
- ArgumentNullException
Thrown when the configuration event is null.
RecordDataAccessEventAsync(DataAccessEvent, CancellationToken)
Records a data access event for monitoring data usage patterns and detecting anomalies.
public Task<bool> RecordDataAccessEventAsync(DataAccessEvent dataAccessEvent, CancellationToken cancellationToken)
Parameters
dataAccessEventDataAccessEventThe data access event details to record.
cancellationTokenCancellationTokenThe cancellation token to monitor for cancellation requests.
Returns
- Task<bool>
A task that represents the asynchronous operation. The task result contains true if the event was successfully recorded, false otherwise.
Exceptions
- SecurityException
Thrown when audit recording fails due to security constraints.
- ArgumentNullException
Thrown when the data access event is null.
RecordSecurityEventAsync(ElasticsearchSecurityEvent, CancellationToken)
Records a general security event for compliance and monitoring purposes.
public Task<bool> RecordSecurityEventAsync(ElasticsearchSecurityEvent securityEvent, CancellationToken cancellationToken)
Parameters
securityEventElasticsearchSecurityEventcancellationTokenCancellationToken
Returns
RecordSecurityIncidentAsync(SecurityIncident, CancellationToken)
Records a security incident or violation for immediate attention and investigation.
public Task<bool> RecordSecurityIncidentAsync(SecurityIncident securityIncident, CancellationToken cancellationToken)
Parameters
securityIncidentSecurityIncidentThe security incident details to record.
cancellationTokenCancellationTokenThe cancellation token to monitor for cancellation requests.
Returns
- Task<bool>
A task that represents the asynchronous operation. The task result contains true if the incident was successfully recorded, false otherwise.
Exceptions
- SecurityException
Thrown when audit recording fails due to security constraints.
- ArgumentNullException
Thrown when the security incident is null.
SearchAuditEventsAsync(AuditSearchCriteria, CancellationToken)
Searches audit events based on internal search criteria.
public Task<IEnumerable<SecurityAuditEvent>> SearchAuditEventsAsync(AuditSearchCriteria searchCriteria, CancellationToken cancellationToken)
Parameters
searchCriteriaAuditSearchCriteriacancellationTokenCancellationToken
Returns
SearchAuditEventsAsync(AuditSearchRequest, CancellationToken)
Searches audit events based on specified criteria for investigation and analysis.
public Task<AuditSearchResult> SearchAuditEventsAsync(AuditSearchRequest searchRequest, CancellationToken cancellationToken)
Parameters
searchRequestAuditSearchRequestThe audit search request with filters and criteria.
cancellationTokenCancellationTokenThe cancellation token to monitor for cancellation requests.
Returns
- Task<AuditSearchResult>
A task that represents the asynchronous operation. The task result contains the matching audit events and search result metadata.
Exceptions
- SecurityException
Thrown when audit search fails due to security constraints.
- ArgumentNullException
Thrown when the search request is null.
ValidateAuditIntegrityAsync(AuditIntegrityRequest, CancellationToken)
Validates the integrity of audit logs to detect tampering or corruption.
public Task<AuditIntegrityResult> ValidateAuditIntegrityAsync(AuditIntegrityRequest validationRequest, CancellationToken cancellationToken)
Parameters
validationRequestAuditIntegrityRequestThe integrity validation request with parameters.
cancellationTokenCancellationTokenThe cancellation token to monitor for cancellation requests.
Returns
- Task<AuditIntegrityResult>
A task that represents the asynchronous operation. The task result contains the integrity validation result indicating whether audit logs are intact and trustworthy.
Exceptions
- SecurityException
Thrown when integrity validation fails due to security constraints.
- ArgumentNullException
Thrown when the validation request is null.
ValidateAuditIntegrityAsync(DateTimeOffset, DateTimeOffset, CancellationToken)
Validates the integrity of audit logs for the specified time period.
public Task<AuditLogIntegrityResult> ValidateAuditIntegrityAsync(DateTimeOffset startTime, DateTimeOffset endTime, CancellationToken cancellationToken)
Parameters
startTimeDateTimeOffsetendTimeDateTimeOffsetcancellationTokenCancellationToken
Returns
Events
AuditArchiveCompleted
Occurs when audit log archiving is completed.
public event EventHandler<AuditArchiveCompletedEventArgs>? AuditArchiveCompleted
Event Type
ComplianceViolationDetected
Raised when a compliance violation is detected.
public event EventHandler<ComplianceViolationEventArgs>? ComplianceViolationDetected
Event Type
IntegrityViolationDetected
Occurs when audit log integrity validation fails.
public event EventHandler<AuditIntegrityViolationEventArgs>? IntegrityViolationDetected
Event Type
SecurityEventRecorded
Occurs when a security event is successfully recorded.
public event EventHandler<SecurityEventRecordedEventArgs>? SecurityEventRecorded