Table of Contents

Interface IAuthenticationService

Namespace
Excalibur.Dispatch.Middleware.Auth
Assembly
Excalibur.Dispatch.dll

Service interface for authenticating message principals.

public interface IAuthenticationService
Extension Methods

Methods

AuthenticateApiKeyAsync(string, CancellationToken)

Authenticates an API key.

Task<ClaimsPrincipal?> AuthenticateApiKeyAsync(string apiKey, CancellationToken cancellationToken)

Parameters

apiKey string

The API key to authenticate.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ClaimsPrincipal>

The authenticated principal or null if authentication fails.

AuthenticateAsync(IDispatchMessage, IMessageContext, CancellationToken)

Authenticates the message and returns the principal.

Task<ClaimsPrincipal?> AuthenticateAsync(IDispatchMessage message, IMessageContext context, CancellationToken cancellationToken)

Parameters

message IDispatchMessage

The message to authenticate.

context IMessageContext

The message context.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ClaimsPrincipal>

The authenticated principal or null if authentication fails.

AuthenticateBearerTokenAsync(string, CancellationToken)

Authenticates a bearer token (JWT).

Task<ClaimsPrincipal?> AuthenticateBearerTokenAsync(string token, CancellationToken cancellationToken)

Parameters

token string

The bearer token to authenticate.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ClaimsPrincipal>

The authenticated principal or null if authentication fails.

AuthenticateCertificateAsync(object, CancellationToken)

Authenticates a client certificate.

Task<ClaimsPrincipal?> AuthenticateCertificateAsync(object certificate, CancellationToken cancellationToken)

Parameters

certificate object

The client certificate to authenticate.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ClaimsPrincipal>

The authenticated principal or null if authentication fails.

ValidateTokenAsync(string, CancellationToken)

Validates an authentication token.

Task<ClaimsPrincipal?> ValidateTokenAsync(string token, CancellationToken cancellationToken)

Parameters

token string

The token to validate.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ClaimsPrincipal>

The claims principal if valid, null otherwise.