Asp.Net MVCのカスタム認証

こんにちはHabrauser! ASP.NET MVCフレームワークに関する私の小さな開発経験をコミュニティと共有したいと思います。 つまり、アプリケーションでのユーザー認証の非常に重要な部分です。 役割ベースのセキュリティシステムの実装と同様に。

この記事は、開発プラットフォームとしてASP.NET MVCを使用する初心者プログラマーに役立つ可能性が最も高いです。 しかし、おそらく「経験のある」(経験のある)ユーザーは、自分でいくつかのアイデアを拾うでしょう。 批判、提案などを歓迎します。 猫に興味がある人は誰でも聞いてください。



したがって、私たちの目標は、小さな役割ベースのセキュリティシステムを使用して、カスタム(カスタム)認証を作成することです。 アプリケーションドメインモデルを変更または追加する必要はありません。 基本的な要件は、ユーザーとロールシステムのヒントです。 メンバーシッププロバイダーに基づく標準のセキュリティシステムは考慮しません。 私にはまったく快適ではないようです。 その主な欠点は、特定のデータスキームが必要なことです。これは、アプリケーションのサブジェクトエリアに関連付けることが難しい場合があります



ちょっとした理論。



小さな理論的な部分から始めましょう。 ASP.NET MVCプラットフォームには、すぐに使用できる認証の種類がいくつかあります。





認証では、クライアント側のフォームに暗号化されたCookieが保存されます。 Cookieがサーバーへのリクエストで送信され、ユーザーが承認されたことを示します。 このような暗号化されたセットを作成するには、フォームを介した標準認証で、System.Web.Security.FormAuthenticationクラスのEncriptメソッドを使用します。 デコードには、Decryptメソッドが使用されます。 優れたFormAuthenticationクラスとは何ですか? 彼のエンコードおよびデコード方法は、サーバーマシンキーを使用してデータを暗号化および署名するという事実によって。 これらのキーがないと、Cookieからの情報を読み取ったり変更したりすることができず、車輪を再発明する必要はありません。



プロジェクトの実施



まず、現在のHttpリクエストHttpContext.User.Identityのセキュリティ情報からアクセスできるユーザー認証クラスを作成します。

実装
[Serializable] //TAccount -     . //TRole -  . public abstract class AbstractIdentity<TAccount, TRole>: MarshalByRefObject, IIdentity { protected AbstractIdentity() { Id = long.MinValue; } private bool _isInitialized = false; public long Id { get; set; } public string Name { get; set; } public string AuthenticationType { get { return String.Format("CustomizeAuthentication_{0}", typeof(TAccount).Name); } } public string[] Role { get; set; } public TRole[] Roles { get; set; } public bool IsAuthenticated { get { return Id != long.MinValue; } } public bool CheckRole(TRole role) { return Role.All(r => r.Equals(role.ToString())); } public void SetAccount(TAccount account) { Id = GetId(account); Name = GetName(account); Roles = GetRole(account); Role = Roles.Select(c=>c.ToString()).ToArray(); InitializeMoreFields(account); _isInitialized = true; } protected virtual void InitializeMoreFields(TAccount account) { } protected abstract long GetId(TAccount account); protected abstract string GetName(TAccount account); protected abstract TRole[] GetRole(TAccount account); public string Serialize() { if (!_isInitialized) throw new AccountNotSetException(); using (var stream = new MemoryStream()) { var formatter = new XmlSerializer(GetType()); formatter.Serialize(stream, this); return Encoding.UTF8.GetString(stream.ToArray()); } } public static TIdenty Deserialize<TIdenty>(string value) where TIdenty : AbstractIdentity<TAccount, TRole> { using (var stream = new MemoryStream(Encoding.UTF8.GetBytes(value))) { var formatter = new XmlSerializer(typeof(TIdenty)); return (TIdenty)formatter.Deserialize(stream); } } }
      
      







次に、抽象HTTP認証モジュールを実装します。 ユーザー認証に合格した後に発生するAuthenticateRequestイベントにサブスクライブします。 署名付きメソッドの実装では、ユーザーを作成して現在のHTTPリクエストに書き込むことにより、Cookieを10倍にします。

実装
 //TIdenty -      //TAccount -     . //TRole -  . public abstract class AbstractAutentificationModule<TIdenty, TAccount, TRole> : IHttpModule where TIdenty : AbstractIdentity<TAccount, TRole> { public void Init(HttpApplication context) { context.AuthenticateRequest += OnAuthenticateRequest; } private static void OnAuthenticateRequest(object sender, EventArgs e) { var application = (HttpApplication)sender; var context = application.Context; if (context.User != null && context.User.Identity.IsAuthenticated) return; var cookieName = FormsAuthentication.FormsCookieName; var cookie = application.Request.Cookies[cookieName.ToUpper()]; if (cookie == null) return; try { var ticket = FormsAuthentication.Decrypt(cookie.Value); var identity = AbstractIdentity<TAccount, TRole>.Deserialize<TIdenty>(ticket.UserData); var principal = new GenericPrincipal(identity, identity.Role); context.User = principal; Thread.CurrentPrincipal = principal; } catch {} } public void Dispose() {} }
      
      







抽象承認サービスの実装。 認証されたユーザーのデータをCookieに記録します。 HTTPリクエストに追加します。

実装
 //TAccount -     . public interface IAuthorizeService<in TAccount> { void SignIn(TAccount account, bool createPersistentCookie); void SignOut(); } //TIdenty -     //TAccount -     . //TRole -  . public abstract class AbstractAuthorizeService<TIdentity, TAccount, TRole> : IAuthorizeService<TAccount> where TIdentity : AbstractIdentity<TAccount, TRole>, new() { private const int TICKET_VERSION = 1; private const int EXPIRATION_MINUTE = 60; public void SignIn(TAccount account, bool createPersistentCookie) { var accountIdentity = CreateIdentity(account); var authTicket = new FormsAuthenticationTicket(TICKET_VERSION, accountIdentity.Name, DateTime.Now, DateTime.Now.AddMinutes(EXPIRATION_MINUTE), createPersistentCookie, accountIdentity.Serialize()); CreateCookie(authTicket); HttpContext.Current.User = new GenericPrincipal(accountIdentity, accountIdentity.Role); } private TIdentity CreateIdentity(TAccount account) { var accountIdentity = new TIdentity(); accountIdentity.SetAccount(account); return accountIdentity; } private void CreateCookie(FormsAuthenticationTicket ticket) { var authCookie = new HttpCookie(FormsAuthentication.FormsCookieName, FormsAuthentication.Encrypt(ticket)) { Expires = DateTime.Now.Add(FormsAuthentication.Timeout), }; HttpContext.Current.Response.Cookies.Add(authCookie); } public void SignOut() { FormsAuthentication.SignOut(); } }
      
      







セキュリティシステムについて忘れないでください。 これを行うには、認証属性を実装します。この属性に、コントローラーメソッドへのアクセスに必要なロールとルールを転送します。 属性はジェネリックをサポートしていないため、別のクラス(RuleFactory)でルールの作成を委任します。

IRuleインターフェースは、認証検査規則を記述します。

実装
 public interface IRule { bool Check(IIdentity user); } //     //TIdenty -     //TAccount -     . //TRole -  . internal class Rule<TIdentity, TAccount, TRole> : IRule where TIdentity : AbstractIdentity<TAccount, TRole> { private readonly Func<TIdentity, bool> _check; public Rule(Func<TIdentity, bool> check) { if (check == null) throw new ArgumentNullException("check"); _check = check; } public bool Check (IIdentity user) { return _check((TIdentity) user); } } //  //TIdenty -     //TAccount -     . //TRole -  . public class RuleFactory<TIdentity, TAccount, TRole> where TIdentity : AbstractIdentity<TAccount, TRole> { public IRule Create(Func<TIdentity, bool> rule) { return new Rule<TIdentity, TAccount, TRole> (rule); } } //  public abstract class AbstractAutintificateAttribute : AuthorizeAttribute { private readonly ICollection<IRule> _rules = new List<IRule> (); private readonly bool _isNotSimpleAuthentication; protected AbstractAutintificateAttribute(bool isNotSimpleAuthentication) { _isNotSimpleAuthentication = isNotSimpleAuthentication; } protected void AddRule(IRule rule) { if (rule == null) throw new ArgumentNullException ("rule"); _rules.Add (rule); } protected override bool AuthorizeCore(HttpContextBase httpContext) { if (httpContext == null) throw new ArgumentNullException("httpContext"); if (httpContext.User == null || !httpContext.User.Identity.IsAuthenticated) return false; var isAuthorize = false; isAuthorize |= _rules.Any(rule => rule.Check(httpContext.User.Identity)); isAuthorize |= httpContext.Request.IsAuthenticated && !_isNotSimpleAuthentication; return isAuthorize; } protected override void HandleUnauthorizedRequest(AuthorizationContext filterContext) { var context = filterContext.HttpContext; var appPath = context.Request.ApplicationPath == "/" ? string.Empty : context.Request.ApplicationPath; var loginUrl = FormsAuthentication.LoginUrl; var path = HttpUtility.UrlEncode(context.Request.Url.PathAndQuery); var url = String.Format("{0}{1}?ReturnUrl={2}", appPath, loginUrl, path); if (!filterContext.IsChildAction) filterContext.Result = new RedirectResult(url); } }
      
      







プロジェクトで使いやすくするために、基本的な抽象コントローラーを実装します。 現在のユーザーに便利なアクセスを提供します。

実装
 //TIdenty -     //TAccount -     . //TRole -  . public abstract class AbstractController<TIdenty, TAccount, TRole> : Controller where TIdenty : AbstractIdentity<TAccount, TRole> { protected AbstractController() { _user = new Lazy<TIdenty>(() => HttpContext.User.Identity as TIdenty); } private readonly Lazy<TIdenty> _user; protected TIdenty CurrentUser { get { return _user.Value; } } }
      
      







使用例



基本的に、特定のプロジェクトの実装全体は、必要なジェネリック型を規定することです。

すべてのプロジェクトで最初に開始することは、識別クラスの実装です。

実装
 public class ExampleIdentity : AbstractIdentity<Account, Role> { public string Email { get; set; } //  .     protected override long GetId(Account account) { return account.Id; } //  .   () protected override string GetName(Account account) { return account.Login; } //  .     protected override Role[] GetRole(Account account) { return new []{ account.Role }; } // .        .     protected override void InitializeMoreFields(Account account) { Email = account.Email; } }
      
      







認証モジュールの実装

実装
 public class ExampleAutintificateModule : AbstractAutentificationModule<ExampleIdentity, Account, Role> { }
      
      





承認モジュールをWeb.configに追加し、そこで認証の種類を変更することは忘れられません。

 <?xml version="1.0" encoding="utf-8"?> <configuration> .... <system.web> .... <httpModules> <remove name="FormsAuthentication" /> <add name="FormsAuthentication" type="Example.Infrostructure.ExampleAutintificateModule" /> </httpModules> <authentication mode="Forms"> <!--loginUrl     --> <forms loginUrl="~/User/Login" timeout="2880" /> </authentication> </system.web> </configuration> <system.webServer> .... <modules runAllManagedModulesForAllRequests="true"> <remove name="FormsAuthentication" /> <add name="FormsAuthentication" type="Example.Infrostructure.ExampleAutintificateModule" /> </modules> </system.webServer>
      
      







認可サービスの例。

実装
 public class ExampleAuthorizeService : AbstractAuthorizeService<ExampleIdentity, Account, Role> { }
      
      







現在のプロジェクトの基本的なコントローラー

実装
 public abstract class ExampleController : AbstractController<ExampleIdentity, Account, Role> { }
      
      







さて、認証ルールで属性を実装します

実装
 //  public class ExampleRuleFactory : RuleFactory<ExampleIdentity, Account, Role> { } //     . public class ExampleAuthintificationAtribute : AbstractAutintificateAttribute { private readonly ExampleRuleFactory _ruleFactory = new ExampleRuleFactory(); public ExampleAuthintificationAtribute(params Role[] allowedRole) : base(allowedRole.Any()) { //    ,        AddRule(_ruleFactory.Create(account => allowedRole.Intersect(account.Roles).Any())); //  ,      AddRule(_ruleFactory.Create(account => account.Roles.Any(c=>c == Role.Admin))); } }
      
      







おわりに



便宜上、次のコマンドでインストールできるナゲットパッケージライブラリを作成しました。

 Install-Package MvcCustomizableFormAuthentication
      
      





プロジェクトのあるリポジトリはgithubにあり、動作するアプリケーションの例があります。

お時間をありがとうございました。 アドバイス、批判、提案を楽しみにしています。

PSユニットテストについて忘れられない。



All Articles