AuthZen.AspNetCore 1.0.0

AuthZen-AspNetCore

Lightweight fine-grained authorization library for ASP.NET Core using the AuthZen protocol.

AuthZen.AspNetCore provides a simple, protocol-driven way to protect your ASP.NET Core microservices by delegating access decisions to a central authorization service.

Table of Contents

1. Installation
2. DI / Program.cs Setup
3. Controller Usage with Attribute
4. Optional UserId Override
5. Configuration via appsettings.json
6. Example Microservice Flow
7. Quick Start Microservice Example
8. License

Installation

Install the NuGet package in your microservice:

dotnet add package AuthZen.AspNetCore
DI / Program.cs Setup
Register AuthZen in any microservice:

using AuthZen.AspNetCore.Extensions;

var builder = WebApplication.CreateBuilder(args);

// Register AuthZen authorization
builder.Services.AddAuthZenAuthorization(options =>
{
    // Full URL to your central AuthZen authorization service
    options.FullUrl = "https://auth-service.local/api/access/check";
});

builder.Services.AddControllers();

var app = builder.Build();

app.MapControllers();
app.Run();
Notes:

FullUrl should point to your central AuthZen authorization service.

The library automatically handles DI for AuthorizationServiceHttp.

Controller Usage with Attribute
Protect your endpoints using the AuthZenAuthorize attribute:

using AuthZen.AspNetCore.Filters;
using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("api/[controller]")]
public class TemplateController : ControllerBase
{
    private readonly TemplateService _templateService;

    public TemplateController(TemplateService templateService)
    {
        _templateService = templateService;
    }

    [HttpGet]
    [AuthZenAuthorize("view")]
    public async Task<IActionResult> GetAll()
    {
        var templates = await _templateService.GetAllAsync();
        return Ok(templates);
    }

    [HttpPost]
    [AuthZenAuthorize("create")]
    public async Task<IActionResult> CreateTemplate([FromBody] TemplateDto dto)
    {
        await _templateService.CreateAsync(dto);
        return Ok();
    }
}
Notes:

"view" and "create" represent the relation to check.

By default, the userId is taken from the logged-in user (HttpContext.User).

Optional UserId Override
You can override the userId if needed:

[AuthZenAuthorize("view", userId: "123")]
If omitted, AuthZen uses the current logged-in user automatically.

Configuration via appsettings.json
Store the AuthZen service URL in your configuration:

{
  "AuthZen": {
    "FullUrl": "https://auth-service.local/api/access/check"
  }
}
And register it in Program.cs:

builder.Services.AddAuthZenAuthorization(options =>
{
    options.FullUrl = builder.Configuration["AuthZen:FullUrl"];
});
Notes:

FullUrl should point to your central AuthZen authorization service.

The library automatically handles DI for AuthorizationServiceHttp.

Example Microservice Flow
Microservice receives HTTP request.

AuthZenAuthorizeAttribute triggers authorization check.

AuthorizationServiceHttp sends request to central AuthZen service.

AuthZen service responds true or false.

Attribute either allows execution or returns 403 Forbidden.

Quick Start Microservice Example
Minimal microservice setup using AuthZen.AspNetCore:

Microservice/
│
├─ Program.cs
├─ appsettings.json
├─ Controllers/
│   └─ TemplateController.cs
├─ Services/
│   └─ TemplateService.cs
└─ Models/
    └─ TemplateDto.cs
Program.cs

using AuthZen.AspNetCore.Extensions;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();
builder.Services.AddAuthZenAuthorization(options =>
{
    options.FullUrl = "https://auth-service.local/api/access/check";
});

builder.Services.AddScoped<TemplateService>();

var app = builder.Build();
app.MapControllers();
app.Run();
TemplateController.cs

using AuthZen.AspNetCore.Filters;
using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("api/[controller]")]
public class TemplateController : ControllerBase
{
    private readonly TemplateService _templateService;

    public TemplateController(TemplateService templateService)
    {
        _templateService = templateService;
    }

    [HttpGet]
    [AuthZenAuthorize("view")]
    public async Task<IActionResult> GetAll()
    {
        var templates = await _templateService.GetAllAsync();
        return Ok(templates);
    }
}
TemplateService.cs

public class TemplateService
{
    public Task<List<TemplateDto>> GetAllAsync()
    {
        // Dummy data for testing
        return Task.FromResult(new List<TemplateDto>
        {
            new TemplateDto { Id = "1", Name = "Sample Template" }
        });
    }
}
TemplateDto.cs

public class TemplateDto
{
    public string Id { get; set; } = string.Empty;
    public string Name { get; set; } = string.Empty;
}