ZiAuthenticatorTool 1.0.0

ZiAuthenticatorTool

Lightweight ASP.NET Core authentication middleware extension for plugging in a custom authenticator.

Dependencies

• .NET target framework: net10.0
• NuGet packages:
  • Microsoft.AspNetCore.Http.Abstractions (2.3.9)
  • Microsoft.Extensions.DependencyInjection.Abstractions (10.0.3)
• Runtime context: ASP.NET Core app using DI + middleware pipeline

Usage

Register your authenticator in DI:

services.AddZiAuthenticatorTool<YourAuthenticator>(options =>
{
    options.UseScheme(Scheme.Basic); // or Scheme.Bearer
    options.SetItemKey("Z-Auth-Result");
});

Enable middleware in the app pipeline:

app.UseZiAuthenticatorTool();

Required API surface:

• IServiceCollection.AddZiAuthenticatorTool<T>()
• IApplicationBuilder.UseZiAuthenticatorTool()

End-to-end example

1) Create a result model and authenticator

using ZiAuthenticatorTool;
using ZiAuthenticatorTool.Entity;

public sealed class DemoAuthResult : IResult
{
    public required string Username { get; init; }
    public required string Role { get; init; }
}

public sealed class DemoBasicAuthenticator : BasicAuthentication<DemoAuthResult>
{
    protected override Task<DemoAuthResult?> AuthenticateAsync(BasicRequest request)
    {
        // Demo only: replace with your own user store / credential validation.
        if (request.Username == "admin" && request.Password == "secret")
        {
            return Task.FromResult<DemoAuthResult?>(new DemoAuthResult
            {
                Username = request.Username,
                Role = "Administrator"
            });
        }

        return Task.FromResult<DemoAuthResult?>(null);
    }
}

2) Register and use in Program.cs

using ZiAuthenticatorTool;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddZiAuthenticatorTool<DemoBasicAuthenticator>(options =>
{
    options.UseScheme(Scheme.Basic);
    options.SetItemKey("Z-Auth-Result");
});

var app = builder.Build();

app.UseZiAuthenticatorTool();

app.MapGet("/secure", (HttpContext ctx) =>
{
    if (ctx.Items["Z-Auth-Result"] is not DemoAuthResult user)
    {
        return Results.Unauthorized();
    }

    return Results.Ok(new
    {
        message = $"Hello {user.Username}",
        role = user.Role
    });
});

app.Run();

3) Call the endpoint with Basic auth

curl -i -H "Authorization: Basic YWRtaW46c2VjcmV0" http://localhost:5000/secure

YWRtaW46c2VjcmV0 is Base64 for admin:secret.

License

MIT