Interface IElasticsearchSecurityProvider
- Namespace
- Excalibur.Data.ElasticSearch.Security
- Assembly
- Excalibur.Data.ElasticSearch.dll
Defines the contract for Elasticsearch security operations including authentication, authorization, and security context management.
public interface IElasticsearchSecurityProvider
Remarks
Reference: Microsoft.AspNetCore.Authentication.IAuthenticationService pattern --
minimal interface (3 methods) for core security operations. Advanced capabilities
(encryption, key management, auditing) are accessed via the existing specialized interfaces:
IElasticsearchAuthenticationProvider, IElasticsearchFieldEncryptor,
IElasticsearchKeyProvider.
Methods
AuthenticateAsync(CancellationToken)
Authenticates a request against the configured Elasticsearch security backend.
Task<AuthenticationResult> AuthenticateAsync(CancellationToken cancellationToken)
Parameters
cancellationTokenCancellationTokenThe cancellation token.
Returns
- Task<AuthenticationResult>
The authentication result indicating success or failure.
AuthorizeAsync(DataAccessOperation, CancellationToken)
Authorizes a data access operation against the configured security policies.
Task<bool> AuthorizeAsync(DataAccessOperation operation, CancellationToken cancellationToken)
Parameters
operationDataAccessOperationThe data access operation to authorize.
cancellationTokenCancellationTokenThe cancellation token.
Returns
GetSecurityContextAsync(CancellationToken)
Retrieves the current security context including authentication state and active policies.
Task<ElasticsearchSecurityContext> GetSecurityContextAsync(CancellationToken cancellationToken)
Parameters
cancellationTokenCancellationTokenThe cancellation token.
Returns
- Task<ElasticsearchSecurityContext>
The current ElasticsearchSecurityContext.