aspnetcore token authentication

Wd3w.AspNetCore.TokenAuthentication

Extensión ASP.NET Core para configurar la autenticación de token personalizada

Empezando

1. Paquete de instalación para su proyecto.

 dotnet add package Wd3w.AspNetCore.TokenAuthentication

2. Implemente su propio CustomTokenAuthService

Cualquiera que sea su infraestructura de autenticación, simplemente implemente esta interfaz y regístrela como un servicio.

 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. Agregue un esquema de token personalizado al generador de autenticación usando AddTokenAuthenticationScheme<TService>

Realm , TokenLength , esta propiedad es una propiedad obligatoria para que el controlador de autenticación funcione.

 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. Adjunte AuthorizeAttribute a su controlador o métodos de acción.

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

Características

Mensaje de error de validación personalizado

Si necesita proporcionar un mensaje de validación de token de autenticación personalizado, simplemente lance AuthenticationFailException en 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." ) ;
    }
} 

Versionado

Esta estrategia de control de versiones del paquete sigue la versión del paquete AspNetCore. Cuando haya una nueva versión de AspNetCore, este paquete también se actualizará.

Solo la versión menor no coincide con AspNetCore, que se utilizará para corregir errores y algunos cambios.

Licencia

Licencia MIT

Copyright (c) 2020 WDWWW

Por el presente se otorga permiso, sin cargo, a cualquier persona que obtenga una copia de este software y los archivos de documentación asociados (el "Software"), para operar con el Software sin restricciones, incluidos, entre otros, los derechos de uso, copia, modificación, fusión. , publicar, distribuir, sublicenciar y/o vender copias del Software, y permitir que las personas a quienes se les proporciona el Software lo hagan, sujeto a las siguientes condiciones:

El aviso de derechos de autor anterior y este aviso de permiso se incluirán en todas las copias o partes sustanciales del Software.

EL SOFTWARE SE PROPORCIONA "TAL CUAL", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O IMPLÍCITA, INCLUYENDO, PERO NO LIMITADO A, LAS GARANTÍAS DE COMERCIABILIDAD, IDONEIDAD PARA UN PROPÓSITO PARTICULAR Y NO INFRACCIÓN. EN NINGÚN CASO LOS AUTORES O TITULARES DE DERECHOS DE AUTOR SERÁN RESPONSABLES DE NINGÚN RECLAMO, DAÑO U OTRA RESPONSABILIDAD, YA SEA EN UNA ACCIÓN CONTRACTUAL, AGRAVIO O DE OTRA MANERA, QUE SURJA DE, FUERA DE O EN RELACIÓN CON EL SOFTWARE O EL USO U OTRAS NEGOCIOS EN EL SOFTWARE.