Notatka
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
Uwaga
Nie jest to najnowsza wersja tego artykułu. Aby zapoznać się z bieżącą wersją, zobacz wersję tego artykułu dotyczącą platformy .NET 11.
Ostrzeżenie
Ta wersja ASP.NET Core nie jest już obsługiwana. Aby uzyskać więcej informacji, zobacz zasady pomocy technicznej platformy .NET i platformy .NET Core. Aby zapoznać się z aktualną wersją, zobacz artykuł w wersji .NET 10.
W tym artykule wyjaśniono, jak utworzyć niestandardowego dostawcę stanu uwierzytelniania i otrzymywać powiadomienia o zmianie stanu uwierzytelniania użytkownika w kodzie.
Ogólne podejścia stosowane w przypadku aplikacji po stronie serwera i po stronie klienta Blazor są podobne, ale różnią się szczegółami implementacji, dlatego w tym artykule naprzemiennie omawiane są aplikacje po stronie serwera Blazor i aplikacje po stronie klienta Blazor. Użyj selektora widoku u góry artykułu, aby zmienić widok artykułu tak, aby odpowiadał typowi projektu Blazor, nad którym pracujesz:
- Aplikacje po stronie Blazor serwera (Server pivot): Blazor Server dla platformy .NET 7 lub starszej oraz projektu serwera dla Blazor Web App platformy .NET 8 lub nowszej.
- Aplikacje po stronie klienta (Blazor WebAssembly pivot): Blazor WebAssembly dla wszystkich wersji platformy .NET lub projekt
.Clientaplikacji Blazor Web App dla platformy .NET 8 lub nowszej.
Klasa abstrakcyjna AuthenticationStateProvider
Struktura Blazor zawiera abstrakcyjną AuthenticationStateProvider klasę, która udostępnia informacje o stanie uwierzytelniania bieżącego użytkownika z następującymi elementami członkowskimi:
- GetAuthenticationStateAsync: Asynchronicznie pobiera stan uwierzytelniania bieżącego użytkownika.
- AuthenticationStateChanged: zdarzenie informujące o zmianie stanu uwierzytelniania. Na przykład to zdarzenie może zostać zgłoszone, jeśli użytkownik loguje się lub wychodzi z aplikacji.
- NotifyAuthenticationStateChanged: zgłasza zdarzenie zmiany stanu uwierzytelniania.
Zaimplementuj niestandardowy AuthenticationStateProvider
Aplikacja musi odwoływać się do Microsoft.AspNetCore.Components.Authorization pakietu NuGet, który zapewnia obsługę uwierzytelniania i autoryzacji dla Blazor aplikacji.
Uwaga
Aby uzyskać instrukcje dodawania pakietów do aplikacji .NET, zobacz artykuły w sekcji Instalowanie pakietów i zarządzanie nimi w temacie Przepływ pracy użycia pakietów (dokumentacja programu NuGet). Sprawdź prawidłowe wersje pakietów pod adresem NuGet.org.
Skonfiguruj następujące usługi uwierzytelniania, autoryzacji i kaskadowego stanu uwierzytelnienia w pliku Program.
Gdy tworzysz aplikację Blazor na podstawie jednego z szablonów projektów Blazor z włączonym uwierzytelnianiem, aplikacja jest wstępnie skonfigurowana z następującymi rejestracjami usług, które obejmują udostępnienie stanu uwierzytelniania jako parametru kaskadowego. Aby uzyskać więcej informacji, zobacz artykuł Uwierzytelnianie i autoryzacja w BlazorASP.NET Core, a dodatkowe informacje znajdziesz w sekcji Dostosowywanie nieautoryzowanej zawartości za pomocą składnika Router.
using Microsoft.AspNetCore.Components.Authorization;
...
builder.Services.AddAuthorization();
builder.Services.AddCascadingAuthenticationState();
Skonfiguruj usługi uwierzytelniania i autoryzacji w Program pliku.
Podczas tworzenia aplikacji Blazor przy użyciu jednego z szablonów projektów Blazor z włączonym uwierzytelnianiem aplikacja zawiera następującą rejestrację usług.
using Microsoft.AspNetCore.Components.Authorization;
...
builder.Services.AddAuthorization();
Skonfiguruj usługi uwierzytelniania i autoryzacji w Startup.ConfigureServices aplikacji Startup.cs.
Podczas tworzenia aplikacji Blazor przy użyciu jednego z szablonów projektów Blazor z włączonym uwierzytelnianiem aplikacja zawiera następującą rejestrację usług.
using Microsoft.AspNetCore.Components.Authorization;
...
services.AddAuthorization();
W aplikacjach Blazor WebAssembly (we wszystkich wersjach platformy .NET) lub w projekcie .Client aplikacji Blazor Web App (.NET 8 lub nowszym) skonfiguruj uwierzytelnianie, autoryzację oraz usługi kaskadowego stanu uwierzytelniania w pliku Program.
Gdy tworzysz aplikację Blazor na podstawie jednego z szablonów projektów Blazor z włączonym uwierzytelnianiem, aplikacja jest wstępnie skonfigurowana z następującymi rejestracjami usług, które obejmują udostępnienie stanu uwierzytelniania jako parametru kaskadowego. Aby uzyskać więcej informacji, zobacz artykuł Uwierzytelnianie i autoryzacja w BlazorASP.NET Core, a dodatkowe informacje znajdziesz w sekcji Dostosowywanie nieautoryzowanej zawartości za pomocą składnika Router.
using Microsoft.AspNetCore.Components.Authorization;
...
builder.Services.AddAuthorizationCore();
builder.Services.AddCascadingAuthenticationState();
Skonfiguruj usługi uwierzytelniania i autoryzacji w Program pliku.
Podczas tworzenia aplikacji Blazor przy użyciu jednego z szablonów projektów Blazor z włączonym uwierzytelnianiem aplikacja zawiera następującą rejestrację usług.
using Microsoft.AspNetCore.Components.Authorization;
...
builder.Services.AddAuthorizationCore();
Utwórz klasę pochodną AuthenticationStateProvider i przesłoń GetAuthenticationStateAsync, aby utworzyć stan uwierzytelnienia użytkownika. W poniższym przykładzie wszyscy użytkownicy są uwierzytelniani przy użyciu nazwy użytkownika mrfibuli.
CustomAuthStateProvider.cs:
using System.Security.Claims;
using Microsoft.AspNetCore.Components.Authorization;
public class CustomAuthStateProvider : AuthenticationStateProvider
{
public override Task<AuthenticationState> GetAuthenticationStateAsync()
{
var identity = new ClaimsIdentity(
[
new Claim(ClaimTypes.Name, "mrfibuli"),
], "Custom Authentication");
var user = new ClaimsPrincipal(identity);
return Task.FromResult(new AuthenticationState(user));
}
}
Uwaga
Powyższy kod, który tworzy nowe ClaimsIdentity , używa uproszczonej inicjalizacji kolekcji wprowadzonej w języku C# 12 (.NET 8). Aby uzyskać więcej informacji, zobacz Collection expressions — C# language reference (Wyrażenia kolekcji — dokumentacja języka C#).
Usługa CustomAuthStateProvider jest zarejestrowana w pliku Program. Zarejestruj usługę scoped przy użyciu AddScoped:
builder.Services.AddScoped<AuthenticationStateProvider, CustomAuthStateProvider>();
W aplikacji zarejestruj usługę Blazor Servero AddScoped określonym zakresie po wywołaniu metody :AddServerSideBlazor
builder.Services.AddServerSideBlazor();
builder.Services.AddScoped<AuthenticationStateProvider, CustomAuthStateProvider>();
W aplikacji zarejestruj usługę Blazor Servero AddScoped określonym zakresie po wywołaniu metody :AddServerSideBlazor
services.AddServerSideBlazor();
services.AddScoped<AuthenticationStateProvider, CustomAuthStateProvider>();
Usługa CustomAuthStateProvider jest zarejestrowana w pliku Program. Zarejestruj usługę singleton za pomocą :
builder.Services.AddSingleton<AuthenticationStateProvider, CustomAuthStateProvider>();
Jeśli go tam nie ma, dodaj instrukcję @using do pliku importów (_Imports.razor), aby udostępnić przestrzeń nazw Microsoft.AspNetCore.Components.Authorization we wszystkich składnikach:
@using Microsoft.AspNetCore.Components.Authorization;
Potwierdź lub zmień składnik widoku trasy na element AuthorizeRouteView w Router definicji składnika. Lokalizacja Router składnika różni się w zależności od typu aplikacji. Użyj wyszukiwania, aby zlokalizować składnik, jeśli nie znasz jego lokalizacji w projekcie.
<Router ...>
<Found ...>
<AuthorizeRouteView RouteData="routeData"
DefaultLayout="typeof(Layout.MainLayout)" />
...
</Found>
</Router>
Uwaga
Podczas tworzenia aplikacji Blazor przy użyciu jednego z szablonów projektów Blazor z włączonym uwierzytelnianiem aplikacja zawiera składnik AuthorizeRouteView. Aby uzyskać więcej informacji, zobacz artykuł Uwierzytelnianie i autoryzacja w BlazorASP.NET Core, a dodatkowe informacje znajdziesz w sekcji Dostosowywanie nieautoryzowanej zawartości za pomocą składnika Router.
Gdzie znajduje się komponent Router:
- Potwierdź lub zmień składnik widoku trasy na AuthorizeRouteView.
- Potwierdź lub dodaj CascadingAuthenticationState składnik wokół Router składnika.
Lokalizacja Router składnika różni się w zależności od typu aplikacji. Użyj wyszukiwania, aby zlokalizować składnik, jeśli nie znasz jego lokalizacji w projekcie.
<CascadingAuthenticationState>
<Router ...>
<Found ...>
<AuthorizeRouteView RouteData="routeData"
DefaultLayout="typeof(MainLayout)" />
...
</Found>
</Router>
</CascadingAuthenticationState>
Uwaga
Podczas tworzenia aplikacji Blazor na podstawie jednego z szablonów projektów Blazor z włączonym uwierzytelnianiem aplikacja zawiera składniki AuthorizeRouteView i CascadingAuthenticationState. Aby uzyskać więcej informacji, zobacz artykuł Uwierzytelnianie i autoryzacja w BlazorASP.NET Core, a dodatkowe informacje znajdziesz w sekcji Dostosowywanie nieautoryzowanej zawartości za pomocą składnika Router.
Poniższy przykładowy AuthorizeView składnik demonstruje nazwę uwierzytelnioowanego użytkownika:
<AuthorizeView>
<Authorized>
<p>Hello, @context.User.Identity?.Name!</p>
</Authorized>
<NotAuthorized>
<p>You're not authorized.</p>
</NotAuthorized>
</AuthorizeView>
Aby uzyskać wskazówki dotyczące użycia AuthorizeView, zobacz uwierzytelnianie i autoryzację w programie ASP.NET Core Blazor.
Powiadomienia o zmianie stanu uwierzytelniania
Niestandardowa AuthenticationStateProvider może wywołać w klasie bazowej , aby powiadomić odbiorców o zmianie stanu uwierzytelniania i wywołać ponowne renderowanie.
Poniższy przykład opiera się na implementacji niestandardowej AuthenticationStateProvider, zgodnie ze wskazówkami zawartymi we wcześniejszej części tego artykułu, w sekcji Implementowanie niestandardowej AuthenticationStateProvider. Jeśli już wykonano wskazówki opisane w tej sekcji, poniższa część zastępuje element CustomAuthStateProvider pokazany w sekcji .
Poniższa CustomAuthStateProvider implementacja uwidacznia niestandardową metodę , AuthenticateUserw celu zalogowania użytkownika i powiadamiania użytkowników o zmianie stanu uwierzytelniania.
CustomAuthStateProvider.cs:
using System.Security.Claims;
using Microsoft.AspNetCore.Components.Authorization;
public class CustomAuthStateProvider : AuthenticationStateProvider
{
public override Task<AuthenticationState> GetAuthenticationStateAsync()
{
var identity = new ClaimsIdentity();
var user = new ClaimsPrincipal(identity);
return Task.FromResult(new AuthenticationState(user));
}
public void AuthenticateUser(string userIdentifier)
{
var identity = new ClaimsIdentity(
[
new Claim(ClaimTypes.Name, userIdentifier),
], "Custom Authentication");
var user = new ClaimsPrincipal(identity);
NotifyAuthenticationStateChanged(
Task.FromResult(new AuthenticationState(user)));
}
}
Uwaga
Powyższy kod, który tworzy nowe ClaimsIdentity , używa uproszczonej inicjalizacji kolekcji wprowadzonej w języku C# 12 (.NET 8). Aby uzyskać więcej informacji, zobacz Collection expressions — C# language reference (Wyrażenia kolekcji — dokumentacja języka C#).
W komponencie:
- Wstrzyknij AuthenticationStateProvider.
- Dodaj pole do przechowywania identyfikatora użytkownika.
- Dodaj przycisk i metodę, aby rzutować element AuthenticationStateProvider na
CustomAuthStateProvideri wywołaćAuthenticateUserz identyfikatorem użytkownika.
@inject AuthenticationStateProvider AuthenticationStateProvider
<input @bind="userIdentifier" />
<button @onclick="SignIn">Sign in</button>
<AuthorizeView>
<Authorized>
<p>Hello, @context.User.Identity?.Name!</p>
</Authorized>
<NotAuthorized>
<p>You're not authorized.</p>
</NotAuthorized>
</AuthorizeView>
@code {
public string userIdentifier = string.Empty;
private void SignIn()
{
((CustomAuthStateProvider)AuthenticationStateProvider)
.AuthenticateUser(userIdentifier);
}
}
Powyższe podejście można ulepszyć tak, aby wywoływało powiadomienia o zmianach stanu uwierzytelnienia za pomocą niestandardowej usługi. Poniższa klasa CustomAuthenticationService przechowuje obiekt ClaimsPrincipal bieżącego użytkownika w polu pomocniczym (currentUser) oraz udostępnia zdarzenie (UserChanged), które może subskrybować dostawca stanu uwierzytelniania, przy czym zdarzenie wywołuje NotifyAuthenticationStateChanged. Dzięki dodatkowej konfiguracji opisanej w dalszej części tej sekcji element CustomAuthenticationService można wstrzyknąć do komponentu z logiką, która ustawia CurrentUser, aby wywołać zdarzenie UserChanged.
CustomAuthenticationService.cs:
using System.Security.Claims;
public class CustomAuthenticationService
{
public event Action<ClaimsPrincipal>? UserChanged;
private ClaimsPrincipal? currentUser;
public ClaimsPrincipal CurrentUser
{
get { return currentUser ?? new(); }
set
{
currentUser = value;
if (UserChanged is not null)
{
UserChanged(currentUser);
}
}
}
}
W pliku Program zarejestruj CustomAuthenticationService w kontenerze wstrzykiwania zależności:
builder.Services.AddScoped<CustomAuthenticationService>();
W Startup.ConfigureServices pliku Startup.cszarejestruj element CustomAuthenticationService w kontenerze wstrzykiwania zależności:
services.AddScoped<CustomAuthenticationService>();
W pliku Program zarejestruj CustomAuthenticationService w kontenerze wstrzykiwania zależności:
builder.Services.AddSingleton<CustomAuthenticationService>();
Poniżej CustomAuthStateProvider subskrybuje zdarzenie CustomAuthenticationService.UserChanged. Metoda GetAuthenticationStateAsync zwraca stan uwierzytelniania użytkownika. Początkowo stan uwierzytelniania jest oparty na wartości CustomAuthenticationService.CurrentUser. Gdy użytkownik zmieni się, zostanie utworzony nowy stan uwierzytelniania dla nowego użytkownika (new AuthenticationState(newUser)) dla wywołań metody GetAuthenticationStateAsync:
using Microsoft.AspNetCore.Components.Authorization;
public class CustomAuthStateProvider : AuthenticationStateProvider
{
private AuthenticationState authenticationState;
public CustomAuthStateProvider(CustomAuthenticationService service)
{
authenticationState = new AuthenticationState(service.CurrentUser);
service.UserChanged += (newUser) =>
{
authenticationState = new AuthenticationState(newUser);
NotifyAuthenticationStateChanged(Task.FromResult(authenticationState));
};
}
public override Task<AuthenticationState> GetAuthenticationStateAsync() =>
Task.FromResult(authenticationState);
}
Metoda poniższego składnika SignIn tworzy obiekt ClaimsPrincipal na podstawie identyfikatora użytkownika do ustawienia w CustomAuthenticationService.CurrentUser:
@using System.Security.Claims
@inject CustomAuthenticationService AuthService
<input @bind="userIdentifier" />
<button @onclick="SignIn">Sign in</button>
<AuthorizeView>
<Authorized>
<p>Hello, @context.User.Identity?.Name!</p>
</Authorized>
<NotAuthorized>
<p>You're not authorized.</p>
</NotAuthorized>
</AuthorizeView>
@code {
public string userIdentifier = string.Empty;
private void SignIn()
{
var currentUser = AuthService.CurrentUser;
var identity = new ClaimsIdentity(
[
new Claim(ClaimTypes.Name, userIdentifier),
],
"Custom Authentication");
var newUser = new ClaimsPrincipal(identity);
AuthService.CurrentUser = newUser;
}
}
Uwaga
Powyższy kod, który tworzy nowe ClaimsIdentity , używa uproszczonej inicjalizacji kolekcji wprowadzonej w języku C# 12 (.NET 8). Aby uzyskać więcej informacji, zobacz Collection expressions — C# language reference (Wyrażenia kolekcji — dokumentacja języka C#).
Treści powiązane
-
Wyświetlanie nieautoryzowanej zawartości po stronie serwera podczas renderowania wstępnego z użyciem niestandardowego
AuthenticationStateProvider -
Jak uzyskać dostęp do elementu
AuthenticationStateProviderzDelegatingHandlerskonfigurowanego przy użyciuIHttpClientFactory - Zabezpieczanie ASP.NET Core Blazor Web App za pomocą protokołu OpenID Connect (OIDC)
- Zabezpieczanie ASP.NET Core Blazor WebAssembly przy użyciu ASP.NET Core Identity
-
Wyświetlanie nieautoryzowanej zawartości po stronie serwera podczas renderowania wstępnego przy użyciu niestandardowego
AuthenticationStateProvider -
Jak uzyskać dostęp do elementu
AuthenticationStateProviderzDelegatingHandlerskonfigurowanego przy użyciuIHttpClientFactory - Zabezpieczanie ASP.NET Core Blazor Web App za pomocą protokołu OpenID Connect (OIDC)
- Zabezpieczanie ASP.NET Core Blazor WebAssembly za pomocą ASP.NET Core IdentityRenderowanie wstępne z uwierzytelnianiem w aplikacjach hostowanych Blazor WebAssembly