aspnetcore token authentication

Wd3w.AspNetCore.TokenAuthentication

Extension ASP.NET Core pour configurer l'authentification par jeton personnalisé

Commencer

1. Package d'installation pour votre projet.

 dotnet add package Wd3w.AspNetCore.TokenAuthentication

2. Implémentez votre propre CustomTokenAuthService

Quelle que soit votre infrastructure d'authentification, implémentez simplement cette interface et enregistrez-la en tant que service.

 public class CustomTokenAuthService : ITokenAuthService
{
    private CustomDb _db { get ; set ; }

    public CustomTokenAuthService ( CustomDb db )
    {
        _db = db ;
    }

    public async Task < bool > IsValidateAsync ( string token )
    {
        return await _db . AccessTokens . AnyAsync ( accessToken => accessToken . Key == token ) ;
    }

    public async Task < ClaimsPrincipal > GetPrincipalAsync ( string token )
    {
        // Do create your own custom claims pricipal object and return them;
        return new .. .
    }
} 

3. Ajoutez un schéma de jetons personnalisé au générateur d'authentification à l'aide de AddTokenAuthenticationScheme<TService>

Realm , TokenLength , cette propriété est une propriété obligatoire pour le gestionnaire d'authentification fonctionnel.

 services . AddAuthentication ( "Bearer" )
    . AddTokenAuthenticationScheme < CustomTokenAuthService > ( "Bearer" , new TokenAuthenticationConfiguration
    {
        Realm = "www.example.com/sign-in" ,
        TokenLength = 21 ,
        // AuthenticationType = "Bearer" - this value is optional, default is from scheme parameter value.
    } ) ; 

4. Attachez AuthorizeAttribute à votre contrôleur ou à vos méthodes d'action.

 [ ApiController ( "[controller]" ) ]
public class SomeController : ControllerBase
{
    [ HttpGet ]
    [ Authorize ]
    public Task < ActionResult > GetSomethingAsync ( )
    {
        return Task . FromResult ( Ok ( ) ) ;
    }
} 

Caractéristiques

Message d'échec de validation personnalisé

Si vous devez fournir un message de validation de jeton d'authentification personnalisé, lancez simplement AuthenticationFailException sur ITokenAuthService.IsValidateAsync

 public class CustomTokenAuthService : ITokenAuthService
{
    public async Task < bool > IsValidateAsync ( string token )
    {
        throw new AuthenticationFailException ( "invalid_format" , "access token couldn't have any special characters." ) ;
    }
} 

Gestion des versions

Cette stratégie de gestion des versions de package suit la version du package AspNetCore. Lorsqu'il y aura une nouvelle version d'AspNetCore, ce package sera également mis à jour.

Seule la version mineure d'AspNetCore ne correspond pas, elle sera utilisée pour corriger les bogues et certaines modifications.

Licence

Licence MIT

Copyright (c) 2020 WDWWW

L'autorisation est accordée par la présente, gratuitement, à toute personne obtenant une copie de ce logiciel et des fichiers de documentation associés (le « Logiciel »), d'utiliser le Logiciel sans restriction, y compris, sans limitation, les droits d'utilisation, de copie, de modification, de fusion. , publier, distribuer, accorder des sous-licences et/ou vendre des copies du Logiciel, et permettre aux personnes à qui le Logiciel est fourni de le faire, sous réserve des conditions suivantes :

L'avis de droit d'auteur ci-dessus et cet avis d'autorisation doivent être inclus dans toutes les copies ou parties substantielles du logiciel.

LE LOGICIEL EST FOURNI « EN L'ÉTAT », SANS GARANTIE D'AUCUNE SORTE, EXPRESSE OU IMPLICITE, Y COMPRIS MAIS SANS LIMITATION LES GARANTIES DE QUALITÉ MARCHANDE, D'ADAPTATION À UN USAGE PARTICULIER ET DE NON-VIOLATION. EN AUCUN CAS LES AUTEURS OU LES TITULAIRES DES DROITS D'AUTEUR NE SERONT RESPONSABLES DE TOUTE RÉCLAMATION, DOMMAGES OU AUTRE RESPONSABILITÉ, QUE CE SOIT DANS UNE ACTION CONTRACTUELLE, DÉLIT OU AUTRE, DÉCOULANT DE, DE OU EN RELATION AVEC LE LOGICIEL OU L'UTILISATION OU D'AUTRES TRANSACTIONS DANS LE LOGICIEL.