Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.74 KB

README.md

File metadata and controls

55 lines (39 loc) · 2.74 KB
Raw

TerevintoSoftware.AspNetCore.Authentication.ApiKeys Coverage Status

This solution contains a set of classes and interfaces to add API Keys authentication to an ASP.NET Core application.
This solution is split into two packages:

Package Purpose
TerevintoSoftware.AspNetCore.Authentication.ApiKeys Contains main logic, depends on ASP.NET Core.
TerevintoSoftware.AspNetCore.Authentication.ApiKeys.Abstractions Contains interfaces used by the main package.

1. TerevintoSoftware.AspNetCore.Authentication.ApiKeys

This is the main package that contains the main classes and support for ASP.NET Core.
Since there are dependencies on classes from the Microsoft.AspNetCore.Authetication namespace, this contains only logic that should not change a lot under real usage.
Default implementations of some of the interfaces provided in the Abstractions package are in this package.

2. TerevintoSoftware.AspNetCore.Authentication.ApiKeys.Abstractions

This package contains interfaces that are needed by the main package:

  • IApiKeyFactory -> used to generate new API Keys. Default implementation provided in main package.
  • IApiKeysCacheService -> used to add and remove from cache the API Keys. This needs to be implemented by the consumer of the package.
  • IClaimsPrincipalFactory -> used to create ClaimsPrincipals once a key is succesfully validated. Default implementation provided in main package.

Sample usage

A Web Application consuming this package is available in the Samples directory..

The default implementations can be injected as follows:

builder.Services
    .AddDefaultApiKeyGenerator(new ApiKeyGenerationOptions
    {
        KeyPrefix = "CT-",
        GenerateUrlSafeKeys = true,
        LengthOfKey = 36
    })
    .AddDefaultClaimsPrincipalFactory()
    .AddSingleton<IApiKeysCacheService, CacheService>() // CacheService is not provided
    .AddApiKeys();

An example key generated by that configuration is: CT-mTbC4r1Eh7wvXrXE1UDl18NGH1fRzcrRz.

How to build

  • Install Visual Studio 2022 (.NET 6 required), if needed.
  • Install git, if needed.
  • Clone this repository.
  • Build from Visual Studio or through dotnet build.

Bug reports and feature requests

Please use the issue tracker and ensure your question/feedback was not previously reported.