Soenneker.Utils.Test.AuthHandler 4.0.334

Soenneker.Utils.Test.AuthHandler

A test authentication handler for integration tests. It creates an authenticated user from simple request headers or an existing bearer token.

Installation

dotnet add package Soenneker.Utils.Test.AuthHandler

Setup

using Microsoft.AspNetCore.Authentication;
using Soenneker.Utils.Test.AuthHandler;

services
    .AddAuthentication("Test")
    .AddScheme<AuthenticationSchemeOptions, TestAuthHandler>("Test", _ => { });

TestAuthHandler depends on IJwtUtil, so register that in the test host as well. Set "Test" as the default authentication scheme when requests should use this handler automatically.

Authenticate a test request

The simplest option is to send a user ID. Email and roles are optional:

client.DefaultRequestHeaders.Add("AuthorizationUserId", "test-user-123");
client.DefaultRequestHeaders.Add("AuthorizationEmail", "test@example.com");
client.DefaultRequestHeaders.Add("AuthorizationRoles", "Admin,Manager");

The resulting principal contains the Microsoft identity-platform object identifier claim, an optional ClaimTypes.Email claim, and one ClaimTypes.Role claim per role. Role values may be sent as repeated headers, comma-separated values, or both; whitespace around comma-separated roles is trimmed. If AuthorizationRoles is omitted, the handler assigns the Admin role.

AuthorizationUserId takes precedence over Authorization. Header-created identities use the configured authentication scheme name.

Authenticate with a token

Alternatively, send an authorization value containing a scheme followed by a token:

using System.Net.Http.Headers;

client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

The handler passes the text after the first space to IJwtUtil.GetPrincipal. For test compatibility it does not require the scheme text itself to be Bearer. If the token does not produce a principal, authentication fails instead of creating a ticket.

Failure behavior

Authentication fails when neither AuthorizationUserId nor Authorization is present. JWT parsing exceptions from IJwtUtil propagate through the authentication pipeline; a null principal becomes a normal failed authentication result.

This package is intended only for controlled integration-test hosts. The identity headers are trusted input and must never be enabled as an authentication mechanism in a deployed application.