ASP.NET Identity 2.0の新機能概説
ASP.NET Identityは第1回で紹介したように、昨今のWeb開発の事情に合わせて開発され、VS2013とともに1.0がリリースされました。しかし、1.0ではまだまだ実際に使用するには不足している機能も多く、仮に採用するなら必要な部分を自分で作りこむ必要がありました。
その後、3月20日にASP.NET Identity 2.0がリリースされ、1.0では不足していた機能が拡充され、そのままでも十分実用に耐えうるものへと進化しました。さらに、5月12日にリリースされたVS2013 Update 2では、標準テンプレートが2.0に対応し、その導入も容易になりました。
そこで今回から数回に分けて、新たなテンプレートを元に2.0で変更、追加された機能を追っていきたいと思います。今回紹介するのは、以下の3つです。
ユーザー情報の変更
新機能の追加に合わせて、ユーザー情報の項目がかなり追加されています。また、ログオンに使用するユーザーがメールアドレスに変更されました。
パスワード検証の強化
設定可能なパスワードの検証は、1.0の標準機能では桁数程度しか確認できませんでした。2.0では桁数、使用可能文字など、基本的なパスワード検証機能を行う専用のクラスが含まれています。
アカウントロックアウト
一定回数パスワードを間違ったユーザーアカウントをロックし、一定時間ログオンできなくする機能です。
それぞれについて、順番に見ていきましょう。
ユーザー情報の変更
まずはユーザー情報の変更点から見ていきましょう。ユーザー情報を表す基底クラスであるMicrosoft.AspNet.Identity.EntityFramework.IdentityUserクラスには、2.0で追加された新機能に対応するため、多くのプロパティが追加されました。その内容を表1にまとめます。
| プロパティ名 | 2.0で追加 | 説明 |
|---|---|---|
| Id | ユーザー情報の識別情報（GUIDを使用） | |
| PasswordHash | パスワードから生成されたハッシュ値 | |
| SecurityTimestamp | ログオン状態を管理するためのタイムスタンプ | |
| UserName | ログインに使用するユーザー名 | |
| ○ | ユーザーのメールアドレス | |
| EmailConfirmed | ○ | メールによるアカウント確認が行われたかどうかを表す値 |
| PhoneNumber | ○ | ユーザーの電話番号 |
| PhoneNumberConfirmed | 電話によるアカウント確認が行われたかどうかを表す値 | |
| TwoFactorEnabled | ○ | 二段階認証が有効かどうかを表す値 |
| LockoutEndDataUtc | ○ | アカウントロックアウトが終了する日時（UTC） |
| LockoutEnabled | ○ | アカウントロックアウトが有効かどうかを表す値 |
| AccessFailedCount | ○ | ログインに失敗した回数 |
Models¥IdentityModels.csファイルには、IdentityUserを継承したApplicationUserクラスが定義されています（リスト1）。前回の記事で行ったように、何かプロファイル情報を追加した場合、このクラスにプロパティを増やします。なお、GenerateUserIdentityAsync並びにGenerateUserIdentityメソッドは、第2回で紹介したCookieに保存する識別情報であるClaimsIdentityを生成するために使用されます。
public class ApplicationUser : IdentityUser
{
public Task<ClaimsIdentity> GenerateUserIdentityAsync(ApplicationUserManager manager)
{
return Task.FromResult(GenerateUserIdentity(manager));
}
public ClaimsIdentity GenerateUserIdentity(ApplicationUserManager manager)
{
// authenticationType は、CookieAuthenticationOptions.AuthenticationType に定義されている種類と一致する必要があります
var userIdentity = manager.CreateIdentity(this, DefaultAuthenticationTypes.ApplicationCookie);
// カスタム ユーザー要求をここに追加します
return userIdentity;
}
}
また、VS2013 Update 2のテンプレートでは、ログインに使用するユーザーがメールアドレスに変更されています（図1）。
ユーザー名がユニーク（一意）なメールアドレスかどうかをチェックするのは、App_Start¥IdentityConfig.csファイルに定義された、ApplicationUserクラスで指定します（リスト2）。
public class ApplicationUserManager : UserManager<ApplicationUser>
{
public ApplicationUserManager(IUserStore<ApplicationUser> store)
: base(store)
{
}
public static ApplicationUserManager Create(IdentityFactoryOptions<ApplicationUserManager> options, IOwinContext context)
{
var manager = new ApplicationUserManager(new UserStore<ApplicationUser>(context.Get<ApplicationDbContext>()));
// ユーザー名の検証ロジックを設定します
manager.UserValidator = new UserValidator<ApplicationUser>(manager)
{
AllowOnlyAlphanumericUserNames = false,
RequireUniqueEmail = true
};
...
}
}
チェック内容の実体はUserManager<TUser>クラスのUserValidatorプロパティにMicrosoft.AspNet.Identity.UserValidator<TUser>クラスで定義されています。このクラスにはチェック内容を表すプロパティが2つあります（表2）。
| プロパティ名 | 説明 |
|---|---|
| AllowOnlyAlphanumericUserNames | アルファベットと数字だけがユーザー名に使えるかどうかを指定します。 |
| RequireUniqueEmail | ユニークなメールアドレスである必要があるかどうかを指定します。 |
UserValidator<TUser>クラスはMicrosoft.AspNet.Identity.IIdentityValidator<TUser>インターフェースを実装しています。標準機能以外の独自のチェックを行いたい場合は、IIdentityValidator<TUser>インターフェースを実装した検証用クラスを作成し、UserManager<TUser>クラスのUserValidatorプロパティに設定します。
