【C#】Blazor.Authで認証認可をシンプルに実装する
Blazorで認証を実装していく際、組み込みのASP.NET Core Identityはちょっと大げさな感じですし、何をやっているのかイマイチわかりにくくて敷居が高いと感じることがあります。
そんなときに役立つのがBlazor.Authライブラリです。このライブラリを使うことで、認証機能をシンプルかつサクッと実装できます。
実際に試してみたレポジトリはこちら。
利点・欠点
まず良いところから。
- 実装が楽。組み込みのIdentityを使うよりもずっとシンプル。
- 専用のEndpointを用意してくれるのでInteractive Serverでも使える。
- Blazorで取り扱おうとするとHttpContextを触る関係で静的SSRにする必要がある。
- 個人的にはとても嬉しい。
欠点としては
- 3rd-partyライブラリなので、この先使っていけるかはなんとも言えない。
- とは言ってもやってることは単純そう。
- パスワードリセットやメール認証・2FAなどまで全部盛りにしたいときはIdentityの方が楽かもしれない。
といったところ。単純な認証認可を実装したい場合には良い選択肢になると思います。
使ってみる（サーバー側）
ライブラリを追加する
NuGetからBitzArt.Blazor.Auth.Serverライブラリを入れます。今回は2.1.0を使用。
認証を行うコードを追加する（サインイン）
SampleAuthService というクラスを作成し、このクラスの中で認証ロジックを実装します。
いきなり全てを書くと複雑になるので、少しずつ実装を進めていきます。
using System.IdentityModel.Tokens.Jwt;
using System.Security.Claims;
using System.Text;
using BitzArt.Blazor.Auth;
using BitzArt.Blazor.Auth.Server;
using Microsoft.IdentityModel.Tokens;
namespace TryBlazorAuth.Auth;
// Payloadの型を指定してAuthenticationServiceを継承
public class SampleAuthService : AuthenticationService<SignInPayload>
{
// --- デモ用にInMemoryでユーザー情報を保持 ---
// 実際にはDBなどに保存・参照するイメージ。
private Dictionary<string, UserInfo> Users { get; } =
new()
{
["user1"] = new UserInfo("user1", "user1", "Alice", "User"),
["user2"] = new UserInfo("user2", "user2", "Bob", "User"),
["admin"] = new UserInfo("admin", "admin", "Charlie", "Admin"),
};
// ------------------------------------------
public override async Task<AuthenticationResult> SignInAsync(
SignInPayload signInPayload,
CancellationToken cancellationToken = default
)
{
// ユーザーIDをPayloadから取得して、そこからDB等でユーザー情報を取得する
// その後パスワードを検証して、OKならトークンを発行する。
if (
Users.TryGetValue(signInPayload.Id, out var user)
&& user.Password == signInPayload.Password
)
{
return LoginSuccessful(user);
}
else
{
return Failure("Invalid credentials");
}
}
}
// ログインするのに必要な情報
public class SignInPayload
{
public required string Id { get; set; }
public required string Password { get; set; }
}
// ユーザー情報データ（デモ用）
internal record UserInfo(string Id, string Password, string Name, string Role);
SignInAsyncメソッド内では、ユーザーIDとパスワードを検証し、成功した場合にJWTトークンを発行します。今回はDictionaryでユーザー情報を保持していますが、実際にはデータベースから取得する形になります。
次にLoginSuccessfulメソッドを実装していきます。
private AuthenticationResult LoginSuccessful(UserInfo user)
{
// ユーザー情報をclaimsに追加する
var claims = new List<Claim>
{
new(ClaimTypes.Name, user.Name),
new(ClaimTypes.NameIdentifier, user.Id),
new(ClaimTypes.Role, user.Role),
};
var jwt = BuildJwtPair(claims);
return Success(jwt);
}
ここでは、ユーザー情報をClaimとして追加し、JWTペアを生成する関数を呼び出しています。
JWTを使った認証においては、ユーザーの権限情報をClaimとしてトークンに含めることが一般的です。
今回はName、NameIdentifier、Roleの3つのClaimを追加しています。それぞれユーザーの名前、ID、ロールを表します。
最後にBuildJwtPairメソッドを実装します。また、ここでコンストラクタも合わせて実装します。
private readonly SigningCredentials _signingCredentials;
private readonly JwtSecurityTokenHandler _tokenHandler;
public SampleAuthService()
{
// 32文字以上推奨。実際にはIConfigurationなどから取得してください。
var secretKey = "SuperSecretKeyForJwtTokenGeneration12345";
var securityKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(secretKey));
_signingCredentials = new SigningCredentials(securityKey, SecurityAlgorithms.HmacSha256);
_tokenHandler = new JwtSecurityTokenHandler();
}
private JwtPair BuildJwtPair(IEnumerable<Claim> claims)
{
var AccessTokenDuration = TimeSpan.FromMinutes(15); // アクセストークンの有効期限
var RefreshTokenDuration = TimeSpan.FromDays(7); // リフレッシュトークンの有効期限
// -----
var now = DateTime.UtcNow;
// Access token
// ユーザー権限(claims)をここで追加する。
var accessTokenExpiresAt = now + AccessTokenDuration;
var accessToken = _tokenHandler.WriteToken(
new JwtSecurityToken(
claims: claims,
notBefore: now,
expires: accessTokenExpiresAt,
signingCredentials: _signingCredentials
)
);
// Refresh token
// JWTを更新するのに使用されるトークン
var refreshTokenExpiresAt = now + RefreshTokenDuration;
var refreshToken = _tokenHandler.WriteToken(
new JwtSecurityToken(
notBefore: now,
expires: refreshTokenExpiresAt,
signingCredentials: _signingCredentials
)
);
return new JwtPair(accessToken, accessTokenExpiresAt, refreshToken, refreshTokenExpiresAt);
}
何をやっているかというと、渡されたClaim情報を元に2種類のJWTトークンを生成しています。
片方は実際に権限情報やユーザー情報を含むアクセストークン、もう片方はアクセストークンを更新するためのリフレッシュトークンです。
アクセストークンは頻繁にやり取りされるため短めの有効期限にし、寿命が短いと不便なので自動更新できるようにリフレッシュトークンを用意する、というのが一般的なパターンです。
このあたりは下記リンクが参考になります。
認証を行うコードを追加する（更新）
次に、JWTトークンを更新するためのRefreshJwtPairAsyncメソッドを実装します。これも先程のクラスに追加していきます。
public class SampleAuthService : AuthenticationService<SignInPayload>
{
// さっきの部分 (省略)
// ------------------------------------
// デモ用にInMemoryでユーザー情報と更新用トークンを保持
// 実際にはDBなどに保存・参照するイメージ。
private Dictionary<string, string> UsersRefreshTokens { get; } = [];
public override async Task<AuthenticationResult> RefreshJwtPairAsync(
string refreshToken,
CancellationToken cancellationToken = default
)
{
// 渡されたRefresh tokenを検証する
// 今回はInMemoryで保持している中にあるかどうかを確認するだけ。
// 実際にはDBから拾ってくる+無効化されてないかをチェックする。
if (UsersRefreshTokens.Any(kvp => kvp.Value == refreshToken))
{
// 更新のためにユーザー情報がもう一度必要になる
// そこで紐づくユーザーIDを取得して、再度ユーザー情報を取得する
var userId = UsersRefreshTokens.First(kvp => kvp.Value == refreshToken).Key;
var user = Users[userId];
// 後はサインイン時と同じようにトークンを発行するだけ。
return LoginSuccessful(user);
}
else
{
return Failure("Invalid refresh token");
}
}
}
忘れずに、サインインした時にリフレッシュトークンを保存するコードも追加します。言うまでもなく、実際にはDB等に保存してください。
private AuthenticationResult LoginSuccessful(UserInfo user)
{
// ユーザー情報をclaimsに追加する
var claims = new List<Claim>
{
new(ClaimTypes.Name, user.Name),
new(ClaimTypes.NameIdentifier, user.Id),
new(ClaimTypes.Role, user.Role),
};
var jwt = BuildJwtPair(claims);
+ // リフレッシュトークンを保存する
+ UsersRefreshTokens[user.Id] = jwt.RefreshToken!;
return Success(jwt);
}
完成形のコードはこんな感じ。
サービスを登録する
Program.csに認証サービスを登録します。
var builder = WebApplication.CreateBuilder(args);
builder.AddBlazorAuth<SampleAuthService>();
// 省略
var app = builder.Build();
app.MapAuthEndpoints();
// 省略
使ってみる（Blazor側）
この時点で認証認可機能は完成しています。後はBlazor側であれこれ書くだけです。
_Imports.razorを編集する
作業に移る前に、_Imports.razorに以下を追加しておきます。
@* 全てのページをログイン必須にする。除外したい場合は @attribute[AllowAnonymous]を先頭に付与する *@
@attribute [Authorize]
@* 認証認可関係のnamespace *@
@using TryBlazorAuth.Auth
@using BitzArt.Blazor.Auth
@using Microsoft.AspNetCore.Authorization
@using Microsoft.AspNetCore.Components.Authorization
@* 毎回Generics指定のクラスを書きたくないので、短縮版を用意しておく *@
@using SimpleLoginService = BitzArt.Blazor.Auth.IUserService<TryBlazorAuth.Auth.SignInPayload>
ルーターを編集する
Route.razorを編集して、認証状態に基づいて表示を切り替えられるようにします。
<AuthorizeRouteView>を使うと、@attribute [Authorize]が付与されたコンポーネントにアクセスしたときに自動的に認証状態をチェックしてくれます。
もし認証NGになると<NotAuthorized>セクションが表示されます。そのパターンとして
- ログインしてないとき
- ログインはしているが権限が足りないとき
の2パターンがあるため、それぞれの場合に応じた表示を行うようにしています。
ログインページを作成する
ログインページを用意します。今回はMudBlazorを使っていますが、このあたりは自由です。
注意点として、エラーが発生した際もページが更新されてしまうので、クエリパラメータでメッセージを受け取って表示する(内部の状態で持たせない)ようにしています。
ログアウトページを作成する
ログアウトページも用意します。こちらは非常にシンプルで、SignOutAsyncを呼び出すだけです。
終わったらトップページにリダイレクトします。
Claim情報から必要な情報を引っ張る拡張クラスを作成する
認証状態を取得するとClaimsPrincipalが得られますが、そこから必要な情報を引っ張るのが面倒です(なぜかNameだけは用意されているが……)
というわけで、拡張メソッドを用意してサクッとほしい情報にアクセスできるようにします。
特にID(ClaimTypes.NameIdentifier)はよく使いますので、これだけでもあると便利です。
やっていることは単純で
これだけです。こんなのを毎回書きたくないので拡張メソッドにしました。
Admin専用のページを作成する
Admin権限を持つユーザーだけがアクセスできるページを用意してみます。
といっても、@attribute [Authorize(Roles="Admin")]を付与するだけです。
今回はWeatherページをAdmin専用にしてみます。
@page "/weather"
+@attribute [Authorize(Roles = "Admin")]
<PageTitle>Weather</PageTitle>
<MudText Typo="Typo.h3" GutterBottom="true">Weather forecast</MudText>
<MudText Typo="Typo.body1" Class="mb-8">This component demonstrates fetching data from the server.</MudText>
@* 以下略 *@
認証情報を取得して表示する
最後に、トップページを編集して、現在の認証・認可情報で表示を切り替えるようにします。
Blazorコンポーネント内では
- ユーザー名:
@context.User.Identity?.Name - ユーザーID:
@context.User.GetUserId()
で取得できます。
また、資格情報(Role)でコンポーネントの表示を切り替えたいときは<AuthorizeView>を使います。
完成形
ログインしてない場合はトップページ以外にアクセスできず、ログインするよう促す表示になります。
ログインするとユーザー名とIDが表示され、権限に応じてCounter/Weatherページの表示が切り替わります。
TODO
- 初期設定画面へのリダイレクト
- 設定更新の方法
参考文献
JWT関連
Discussion