aspnetcore token authentication

Wd3w.AspNetCore.TokenAuthentication

Ekstensi ASP.NET Core untuk mengonfigurasi otentikasi token khusus

Memulai

1. Paket instalasi ke proyek Anda.

 dotnet add package Wd3w.AspNetCore.TokenAuthentication

2. Terapkan CustomTokenAuthService Anda sendiri

Apa pun infrastruktur autentikasi Anda, cukup implementasikan antarmuka ini dan daftarkan sebagai layanan.

 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. Tambahkan skema token khusus ke pembuat autentikasi menggunakan AddTokenAuthenticationScheme<TService>

Realm , TokenLength , Properti ini diperlukan untuk menangani otentikasi yang berfungsi.

 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. Lampirkan AuthorizeAttribute ke pengontrol atau metode tindakan Anda.

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

Fitur

Pesan Gagal Validasi Kustom

Jika Anda perlu memberikan pesan validasi token autentikasi khusus, cukup lemparkan AuthenticationFailException di 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." ) ;
    }
} 

Pembuatan versi

Strategi pembuatan versi paket ini mengikuti versi paket AspNetCore. Ketika ada rilis baru tentang AspNetCore, Paket ini juga akan diperbarui.

Hanya versi minor yang tidak cocok dengan AspNetCore, yang akan digunakan untuk memperbaiki bug dan beberapa perubahan.

Lisensi

Lisensi MIT

Hak Cipta (c) 2020 WDWWW

Izin dengan ini diberikan, secara gratis, kepada siapa pun yang memperoleh salinan perangkat lunak ini dan file dokumentasi terkait ("Perangkat Lunak"), untuk menggunakan Perangkat Lunak tanpa batasan, termasuk namun tidak terbatas pada hak untuk menggunakan, menyalin, memodifikasi, menggabungkan , mempublikasikan, mendistribusikan, mensublisensikan, dan/atau menjual salinan Perangkat Lunak, dan mengizinkan orang yang menerima Perangkat Lunak untuk melakukan hal tersebut, dengan tunduk pada ketentuan berikut:

Pemberitahuan hak cipta di atas dan pemberitahuan izin ini akan disertakan dalam semua salinan atau sebagian besar Perangkat Lunak.

PERANGKAT LUNAK INI DISEDIAKAN "APA ADANYA", TANPA JAMINAN APA PUN, TERSURAT MAUPUN TERSIRAT, TERMASUK NAMUN TIDAK TERBATAS PADA JAMINAN KELAYAKAN UNTUK DIPERDAGANGKAN, KESESUAIAN UNTUK TUJUAN TERTENTU, DAN TIDAK ADA PELANGGARAN. DALAM KEADAAN APA PUN PENULIS ATAU PEMEGANG HAK CIPTA TIDAK BERTANGGUNG JAWAB ATAS KLAIM, KERUSAKAN, ATAU TANGGUNG JAWAB LAINNYA, BAIK DALAM TINDAKAN KONTRAK, HUKUM ATAU LAINNYA, YANG TIMBUL DARI, ATAU SEHUBUNGAN DENGAN PERANGKAT LUNAK ATAU PENGGUNAAN ATAU HAL-HAL LAIN DALAM PERANGKAT LUNAK.