IClaimsTransformation を使って ASP.NET Core のユーザーに独自のクレームを追加する

相关文章推荐

难过的沙发 · EF ...· 2 月前 ·

飞翔的枕头 · Python的Tkinter去除边框-CSDN博客· 2 年前 ·

腼腆的香菇 · Oracle常用字符函数小结 - 墨天轮· 2 年前 ·

睿智的香菇 · sp_describe_first_resu ...· 3 年前 ·

刀枪不入的皮带 · sql ...· 3 年前 ·

ASP.NET Core で認証を使っていて、標準のクレーム以外を User.Identity に持たせたくなったので実現する方法を調べました。ASP.NET 時代では Global.asax でイベントハンドラーを追加して Context.User を入れ替えて実現してましたが、ASP.NET Core にはそんなものはありません。

良い感じに認証クッキーからクレームを復元するタイミングで、何らかの処理を挟めないか調べてみると IClaimsTransformation というインターフェースが見つかりました。

このインターフェースは <code>TransformAsync</code> というメソッドのみ持っているシンプルなものです。もはや説明は不要な気がしますが、このメソッドの実装でいい感じに <code>ClaimsPrincipal</code> に対してクレームの追加を行った後に返せば、コントローラやビューなどで追加したクレームを参照できるようになります。デフォルトでは <code>NoopClaimsTransformation</code> が組み込まれていて、実装はそのまま渡された <code>ClaimsPrincipal</code> を返しているだけです。とりあえず独自の変換を実装する前に動きを確認しておきます。 <pre class="code lang-cs" data-lang="cs" data-unlink="">public class MyClaimsTransformation : IClaimsTransformation public Task&lt;ClaimsPrincipal&gt; TransformAsync(ClaimsPrincipal principal) return Task.FromResult(principal); </pre>適当に渡された <code>ClaimsPrincipal</code> をそのまま返す実装を用意しました。実際に ASP.NET Core の認証処理に組むこむためには DI を使って、実装したクラスを登録する必要があるのはこれまで通りです。ASP.NET Core はいろんな処理を DI で差し替えることが出来ますが、柔軟すぎて逆にカスタマイズが難しい部分もあります。 <pre class="code lang-cs" data-lang="cs" data-unlink="">public class Startup public void ConfigureServices(IServiceCollection services) services.AddDbContext&lt;ApplicationDbContext&gt;(options =&gt; options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"))); services.AddDefaultIdentity&lt;IdentityUser&gt;(options =&gt; options.SignIn.RequireConfirmedAccount = true) .AddEntityFrameworkStores&lt;ApplicationDbContext&gt;(); // IClaimsTransformation を継承したクラスを DI に追加 services.AddScoped&lt;IClaimsTransformation, MyClaimsTransformation&gt;(); services.AddControllersWithViews(); services.AddRazorPages(); </pre>DI に追加してしまえば設定は完了なので、動かしてみて変換処理が呼ばれるかを確認しておきました。未ログイン状態の挙動が気になりましたが、ログインしていないときには変換処理は呼ばれませんでした。なので <code>TransformAsync</code> はログインされている前提のコードで良さそうです。<img src="https://cdn-ak.f.st-hatena.com/images/fotolife/s/shiba-yan/20200104/20200104172420.png" alt="f:id:shiba-yan:20200104172420p:plain" title="f:id:shiba-yan:20200104172420p:plain" class="hatena-fotolife" itemprop="image"/>変換メソッドは <code>Task</code> を返すようになっているのと、DI を使って他のインスタンスを取ることができるので、内部で DB へのアクセス処理なども簡単に書けて便利です。サンプルとして登録されているメールアドレスと Gravatar の URL をクレームに追加する変換処理を実装してみました。Gravatar の URL はメールアドレスの MD5 を計算するだけなので簡単です。<iframe src="https://hatenablog-parts.com/embed?url=https%3A%2F%2Fja.gravatar.com%2Fsite%2Fimplement%2Fhash%2F" title="Gravatar - グローバルに認識されるアバター (Globally Recognized Avatars)" class="embed-card embed-webcard" scrolling="no" frameborder="0" style="display: block; width: 100%; height: 155px; max-width: 500px; margin: 10px 0px;"/>今回実装したクレーム変換の処理は以下のようになります。コンストラクタで ASP.NET Core Identity 向けの <code>DbContext</code> 実装を受け取って、<code>TransformAsync</code> で DB にクエリを投げてメールアドレスを取得するようにしています。特に難しいことはしていないです。DI と async / await が使えるので、無理のない自然なコードで書けて最高です。 <pre class="code lang-cs" data-lang="cs" data-unlink="">public class MyClaimsTransformation : IClaimsTransformation public MyClaimsTransformation(ApplicationDbContext applicationDbContext) _applicationDbContext = applicationDbContext; private readonly ApplicationDbContext _applicationDbContext; public async Task&lt;ClaimsPrincipal&gt; TransformAsync(ClaimsPrincipal principal) var identity = (ClaimsIdentity)principal.Identity; var user = await _applicationDbContext.Users.FindAsync(principal.FindFirstValue(ClaimTypes.NameIdentifier)); identity.AddClaim(new Claim(ClaimTypes.Email, user.Email)); identity.AddClaim(new Claim("AvatarImage", GenerateGravatarUrl(user.Email))); return principal; private string GenerateGravatarUrl(string email) using var md5 = MD5.Create(); var hash = md5.ComputeHash(Encoding.UTF8.GetBytes(email.ToLower())); var hashString = new StringBuilder(); for (int i = 0; i &lt; hash.Length; i++) hashString.Append(hash[i].ToString("x2")); return $"https://www.gravatar.com/avatar/{hashString}"; </pre>ASP.NET Core Identity には DB にクレームを永続化する機能もありますが、今回の <code>IClaimsTransformation</code> を使った方法ではデータソースに任意のものを利用出来るので簡単です。微妙に Identity 周りはブラックボックスになってるので、クレームの追加も面倒な感じです。適当なページにログインしているユーザーのクレーム一覧を出すようにして確認してみました。<img src="https://cdn-ak.f.st-hatena.com/images/fotolife/s/shiba-yan/20200104/20200104180043.png" alt="f:id:shiba-yan:20200104180043p:plain" title="f:id:shiba-yan:20200104180043p:plain" class="hatena-fotolife" itemprop="image"/>ちゃんと追加したメールアドレスと Gravatar の URL がクレームに含まれていることが確認できますね。クレームに追加することで、いろんな部分で <code>HttpContext.User</code> 経由して値が利用できるようになります。以下のようにビューに Gravatar のアイコンを表示する定義も簡単に書けます。 <pre class="code lang-html" data-lang="html" data-unlink="">@if (SignInManager.IsSignedIn(User)) &lt;li class="nav-item"&gt; &lt;img src="@(User.FindFirstValue("AvatarImage"))" height="42" /&gt; &lt;li class="nav-item"&gt; &lt;a class="nav-link text-dark" asp-area="Identity" asp-page="/Account/Manage/Index" title="Manage"&gt;Hello @User.Identity.Name!&lt;/a&gt; &lt;li class="nav-item"&gt; &lt;form class="form-inline" asp-area="Identity" asp-page="/Account/Logout" asp-route-returnUrl="@Url.Action("Index", "Home", new { area = "" })"&gt; &lt;button type="submit" class="nav-link btn btn-link text-dark"&gt;Logout&lt;/button&gt; &lt;/form&gt; </pre>実行してみると、ユーザー名の隣に Gravatar で登録したアイコンが表示されました。<img src="https://cdn-ak.f.st-hatena.com/images/fotolife/s/shiba-yan/20200104/20200104180541.png" alt="f:id:shiba-yan:20200104180541p:plain" title="f:id:shiba-yan:20200104180541p:plain" class="hatena-fotolife" itemprop="image"/>実際にアプリケーションを書いていると、標準のクレームでは足りなくて都度 ViewBag に入れたり、JavaScript で取ってきたりと苦労が色々とありましたが、シンプルにクレームに入れてしまえば ASP.NET Core 全体で使えるようになるので非常に便利です。クレームを <code>ClaimsPrincipal</code> から取るのが少し面倒ですが、拡張メソッドを用意してあげれば間違えることもありません。これで実際にかなり見通しの良いコードになりました。