Table of Contents

Class AuthenticationMiddleware

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

Middleware responsible for authenticating message processing based on tokens, certificates, or other authentication mechanisms.

[AppliesTo(MessageKinds.Action|MessageKinds.Event)]
public sealed class AuthenticationMiddleware : IDispatchMiddleware
Inheritance
AuthenticationMiddleware
Implements
Inherited Members
Extension Methods

Remarks

This middleware operates early in the pipeline to establish identity before authorization and business logic. It:

  • Extracts authentication credentials from context (headers, certificates, etc.)
  • Validates tokens, certificates, or API keys
  • Establishes ClaimsPrincipal for downstream middleware
  • Supports multiple authentication schemes (Bearer, Certificate, ApiKey)
  • Provides optional caching for performance

Constructors

AuthenticationMiddleware(IOptions<AuthenticationOptions>, IAuthenticationService, ITelemetrySanitizer, ILogger<AuthenticationMiddleware>)

Initializes a new instance of the AuthenticationMiddleware class. Creates a new authentication middleware instance.

public AuthenticationMiddleware(IOptions<AuthenticationOptions> options, IAuthenticationService authenticationService, ITelemetrySanitizer sanitizer, ILogger<AuthenticationMiddleware> logger)

Parameters

options IOptions<AuthenticationOptions>

Configuration options for authentication.

authenticationService IAuthenticationService

Service for performing authentication.

sanitizer ITelemetrySanitizer

The telemetry sanitizer for PII protection.

logger ILogger<AuthenticationMiddleware>

Logger for diagnostic information.

Properties

ApplicableMessageKinds

Gets the message kinds that this middleware applies.

public MessageKinds ApplicableMessageKinds { get; }

Property Value

MessageKinds

The set of message kinds this middleware applies to.

Remarks

Specifies which types of messages this middleware should process. The pipeline filters middleware based on these flags, ensuring only relevant middleware processes each message. This improves performance and allows middleware to specialize in handling specific message types. If not implemented, defaults to All for backward compatibility.

Stage

Gets the pipeline stage where this middleware should execute.

public DispatchMiddlewareStage? Stage { get; }

Property Value

DispatchMiddlewareStage?

The pipeline stage for this middleware.

Remarks

The stage determines the execution order of middleware in the pipeline. If null, the middleware will be registered at the end of the pipeline. Stages are processed in numeric order, allowing fine-grained control over middleware execution sequence.

Methods

InvokeAsync(IDispatchMessage, IMessageContext, DispatchRequestDelegate, CancellationToken)

Processes the message within the middleware pipeline.

public ValueTask<IMessageResult> InvokeAsync(IDispatchMessage message, IMessageContext context, DispatchRequestDelegate nextDelegate, CancellationToken cancellationToken)

Parameters

message IDispatchMessage

The message being processed.

context IMessageContext

The message context containing metadata and processing state.

nextDelegate DispatchRequestDelegate

The delegate to invoke the next middleware in the pipeline.

cancellationToken CancellationToken

The cancellation token to observe.

Returns

ValueTask<IMessageResult>

A ValueTask<TResult> representing the result of message processing, potentially modified by this middleware. ValueTask can avoid allocating a Task for a synchronously completed result; other dispatch work can still allocate.

Remarks

Implementations can execute logic before calling nextDelegate, after calling it, or both. To short-circuit the pipeline, don't call nextDelegate and return an appropriate result. The context can be used to share data between middleware components. Respect the cancellation token to support timeouts and graceful shutdown.

Exceptions

ArgumentNullException

Thrown when message, context, or nextDelegate is null.

OperationCanceledException

Thrown when the operation is cancelled.