aspnetcore token authentication

Wd3w.AspNetCore.TokenAuthentication

Расширение ASP.NET Core для настройки аутентификации по пользовательскому токену.

Начало работы

1. Инсталляционный пакет к вашему проекту.

 dotnet add package Wd3w.AspNetCore.TokenAuthentication

2. Реализуйте свой собственный CustomTokenAuthService

Какой бы ни была ваша инфраструктура аутентификации, просто реализуйте этот интерфейс и зарегистрируйте его как службу.

 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. Добавьте собственную схему токенов в построитель аутентификации с помощью AddTokenAuthenticationScheme<TService>

Realm , TokenLength . Это свойство является обязательным для работы обработчика аутентификации.

 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. Прикрепите AuthorizeAttribute к вашему контроллеру или методам действий.

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

Функции

Пользовательское сообщение об ошибке проверки

Если вам нужно предоставить собственное сообщение проверки токена аутентификации, просто создайте AuthenticationFailException в 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." ) ;
    }
} 

Управление версиями

Эта стратегия управления версиями пакета соответствует версии пакета AspNetCore. Когда выйдет новая версия AspNetCore, этот пакет также будет обновлен.

Только минорная версия не соответствует AspNetCore, которую мы будем использовать для исправления ошибок и некоторых изменений.

Лицензия

Лицензия MIT

Авторские права (c) 2020 WDWWW

Настоящим бесплатно любому лицу, получившему копию этого программного обеспечения и связанных с ним файлов документации («Программное обеспечение»), предоставляется разрешение на работу с Программным обеспечением без ограничений, включая, помимо прочего, права на использование, копирование, изменение, объединение. публиковать, распространять, сублицензировать и/или продавать копии Программного обеспечения, а также разрешать лицам, которым предоставлено Программное обеспечение, делать это при соблюдении следующих условий:

Вышеупомянутое уведомление об авторских правах и данное уведомление о разрешении должны быть включены во все копии или существенные части Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ, ГАРАНТИЯМИ ТОВАРНОЙ ЦЕННОСТИ, ПРИГОДНОСТИ ДЛЯ ОПРЕДЕЛЕННОЙ ЦЕЛИ И НЕНАРУШЕНИЯ ПРАВ. НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ АВТОРЫ ИЛИ ОБЛАДАТЕЛИ АВТОРСКИХ ПРАВ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УБЫТКИ ИЛИ ДРУГУЮ ОТВЕТСТВЕННОСТЬ, БУДЬ В ДЕЙСТВИЯХ ПО КОНТРАКТУ, ПРАВОНАРУШЕНИЮ ИЛИ ДРУГИМ ОБРАЗОМ, ВОЗНИКАЮЩИЕ ОТ, ИЗ ИЛИ В СВЯЗИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ДРУГИМИ СДЕЛКАМИ, ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ.