Table of Contents

Interface IElasticsearchSecurityAuditorCore

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

Core auditing capabilities for Elasticsearch security: configuration access, security activity auditing, and authentication event recording.

public interface IElasticsearchSecurityAuditorCore

Remarks

This is the core sub-interface of IElasticsearchSecurityAuditor. For recording data access, configuration changes, and security incidents, see IElasticsearchSecurityAuditorRecording. For event notifications, see IElasticsearchSecurityAuditorEvents.

Properties

Configuration

Gets the audit configuration settings currently in use.

AuditOptions Configuration { get; }

Property Value

AuditOptions

The current audit configuration settings.

IntegrityProtectionEnabled

Gets a value indicating whether audit log integrity protection is enabled.

bool IntegrityProtectionEnabled { get; }

Property Value

bool

True if audit logs are cryptographically protected, false otherwise.

SupportedComplianceFrameworks

Gets the supported compliance frameworks for reporting.

IReadOnlyCollection<ComplianceFramework> SupportedComplianceFrameworks { get; }

Property Value

IReadOnlyCollection<ComplianceFramework>

A collection of compliance frameworks supported by this auditor.

Methods

AuditSecurityActivityAsync(SecurityActivityEvent, CancellationToken)

Audits a security activity event for compliance and monitoring purposes.

Task AuditSecurityActivityAsync(SecurityActivityEvent activityEvent, CancellationToken cancellationToken)

Parameters

activityEvent SecurityActivityEvent

The security activity event to audit.

cancellationToken CancellationToken

The cancellation token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous audit operation.

RecordAuthenticationEventAsync(AuthenticationEvent, CancellationToken)

Records an authentication event for security monitoring and compliance purposes.

Task<bool> RecordAuthenticationEventAsync(AuthenticationEvent authenticationEvent, CancellationToken cancellationToken)

Parameters

authenticationEvent AuthenticationEvent

The authentication event details to record.

cancellationToken CancellationToken

The 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.