Table of Contents

Interface IElasticsearchSecurityAlerting

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

Defines the contract for security alerting operations including alert processing, risk calculation, and alert generation.

public interface IElasticsearchSecurityAlerting

Properties

AutomatedResponseEnabled

Gets a value indicating whether the AutomatedResponseTriggered event is raised for high-priority alerts. Acting on that event is the consumer's responsibility; this package raises it and takes no action of its own.

bool AutomatedResponseEnabled { get; }

Property Value

bool

True if the event is raised for high-priority alerts, false otherwise.

Methods

CalculateSecurityRiskAsync(RiskCalculationRequest, CancellationToken)

Calculates the current security risk score based on recent events and system state.

Task<SecurityRiskScore> CalculateSecurityRiskAsync(RiskCalculationRequest riskCalculationRequest, CancellationToken cancellationToken)

Parameters

riskCalculationRequest RiskCalculationRequest

The risk calculation request with parameters.

cancellationToken CancellationToken

The cancellation token to monitor for cancellation requests.

Returns

Task<SecurityRiskScore>

A task that represents the asynchronous operation. The task result contains the calculated risk score and contributing factors.

Exceptions

SecurityException

Thrown when risk calculation fails due to security constraints.

ArgumentNullException

Thrown when the risk calculation request is null.

GenerateSecurityAlertsAsync(SecurityAlertRequest, CancellationToken)

Generates security alerts based on detected threats and anomalies.

Task<SecurityAlertResult> GenerateSecurityAlertsAsync(SecurityAlertRequest alertRequest, CancellationToken cancellationToken)

Parameters

alertRequest SecurityAlertRequest

The security alert generation request with criteria.

cancellationToken CancellationToken

The cancellation token to monitor for cancellation requests.

Returns

Task<SecurityAlertResult>

A task that represents the asynchronous operation. The task result contains the generated security alerts. Alerts are generated and, when enabled, stored in Elasticsearch and raised on SecurityAlertGenerated; this package does not deliver them to a notification channel.

Exceptions

SecurityException

Thrown when alert generation fails due to security constraints.

ArgumentNullException

Thrown when the alert request is null.

ProcessSecurityAlertsAsync(CancellationToken)

Processes pending security alerts and triggers appropriate automated responses.

Task<int> ProcessSecurityAlertsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token to monitor for cancellation requests.

Returns

Task<int>

A task that represents the asynchronous operation. The task result contains the number of processed alerts.

Exceptions

SecurityException

Thrown when alert processing fails due to security constraints.