5. メンバーシップフレームワークによる認証機能の実装 (後編)

(1) ユーザーとロールの情報をデータベースで管理する

Users, Rolesテーブルの追加

ユーザーとロールを管理するテーブルを作成します。

User と Role は多対多の関係となるので関連付けを管理する UserRole テーブルを作成します。

ER図

CREATE TABLE [dbo].[Users] (
  [UserId] INT IDENTITY (1, 1) NOT NULL,
  [UserName] NVARCHAR (200) NOT NULL,
  [Password] NVARCHAR (200) NOT NULL,
  PRIMARY KEY CLUSTERED ([UserId] ASC)
);

CREATE TABLE [dbo].[Roles] (
  [RoleId] INT IDENTITY (1, 1) NOT NULL,
  [RoleName] NVARCHAR (200) NOT NULL,
  PRIMARY KEY CLUSTERED ([RoleId] ASC)
);

CREATE TABLE [dbo].[UserRole] (
  [Id] INT IDENTITY (1, 1) NOT NULL,
  [UserID] INT NOT NULL,
  [RoleID] INT NOT NULL,
  PRIMARY KEY CLUSTERED ([Id] ASC),
  CONSTRAINT [FK_dbo.UserRole_dbo.User_UserID] FOREIGN KEY ([UserID])
    REFERENCES [dbo].[Users] ([UserID]) ON DELETE CASCADE,
  CONSTRAINT [FK_dbo.UserRole_dbo.Role_RoleID] FOREIGN KEY ([RoleID])
    REFERENCES [dbo].[Roles] ([RoleID]) ON DELETE CASCADE
);

初期データの登録

administrator と user というユーザーを作成します。

insert into dbo.Users ([UserName], [Password]) values ('administrator', 'password');
insert into dbo.Users ([UserName], [Password]) values ('user', 'password');

Administrators と Users というロールを作成します。

insert into dbo.Roles ([RoleName]) values ('Administrators');
insert into dbo.Roles ([RoleName]) values ('Users');

administrator と Administrators を、 user と Users を紐付けます。

insert into dbo.UserRole ([UserId], [RoleId]) values (1, 1);
insert into dbo.UserRole ([UserId], [RoleId]) values (2, 2);

EDMファイルの更新

Models/DrugInfoContext.edmx を開きます。

右クリックし データベースからモデルを更新 を選択します。

追加タブで、 テーブル にチェックを入れ、完了をクリックします。

デザイナーで、Users と Roles, UserRole が表示されることを確認します。

補足説明: EDMファイルの削除と再作成

何らかの理由で EDMファイルをイチから再作成したい場合は、以下の手順で行います。

Models から該当のedmxファイルを削除します。
Web.config を開き、一番下にある <connectionStrings> を削除します。
- <add> が複数ある場合は、name を元に削除対象のデータのみを削除します。
edmxファイルを作成します。
- Models を右クリック -> 追加 -> 新しい項目 を選択
- ADO.NET Entity Data Model を選択
- 名前を入力し、追加をクリック
- ウィザードが起動するので、対象となるテーブルを選択して完了します。

MembershipProvider の更新

Models/CustomMembershipProvider.cs

public override bool ValidateUser(string username, string password)
{
    using (var db = new DrugInfoContext())
    {
        var user = db.Users
            .Where(u => u.UserName.Equals(username) && u.Password.Equals(password))
            .FirstOrDefault();

        if (user != null)
        {
            // 認証OK
            return true;
        }
    }
    return false;
}

username, passwordを元にユーザーを取得します。

RoleProvider の更新

Models/CustomRoleProvider.cs

public override string[] GetRolesForUser(string userId)
{
    using (var db = new DrugInfoContext())
    {
        int id = int.Parse(userId);
        var user = db.Users
            .Where(u => u.UserId == id)
            .FirstOrDefault();

        if (user != null) {
            string[] roles = user.UserRole.Select(item => item.Roles.RoleName).ToArray();
            return roles;
        }
        return new string[] {};
    }
}

GetRolesForUser は、指定されたユーザーの所属するロールを配列で返します。

public override bool IsUserInRole(string userId, string roleName)
{
    using (var db = new DrugInfoContext())
    {
        int id = int.Parse(userId);
        var user = db.Users
            .Where(u => u.UserId == id)
            .FirstOrDefault();

        if (user != null) {
            string[] roles = user.UserRole.Select(item => item.Roles.RoleName).ToArray();

            if (roles.Contains(roleName))
            {
                return true;
            }
        }
    }

    return false;
}

IsUserInRole は、指定されたユーザーが該当のロールに所属しているかを判定するメソッドです。

ユーザーIDを元にユーザーを検索し、ユーザーが所属するロールをチェックしています。

コントローラーの修正

Controllers/LoginController.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using System.Web.Security;
using WebApplication1.Models;

namespace WebApplication1.Controllers
{
    [AllowAnonymous]
    public class LoginController : Controller
    {
        readonly CustomMembershipProvider membershipProvider = new CustomMembershipProvider();
        private DrugInfoContext db = new DrugInfoContext();

        // GET: Login
        public ActionResult Index()
        {
            return View();
        }

        // POST: Login
        [HttpPost]
        [ValidateAntiForgeryToken]
        public ActionResult Index([Bind(Include = "UserName,Password")] LoginViewModel model)
        {
            if (ModelState.IsValid)
            {
                if (this.membershipProvider.ValidateUser(model.UserName, model.Password))
                {
                    var user = db.Users.Where(u => u.UserName.Equals(model.UserName)
                        && u.Password.Equals(model.Password))
                        .FirstOrDefault();

                    if (user != null) {
                        FormsAuthentication.SetAuthCookie(user.UserId.ToString(), false);
                        return RedirectToAction("Index", "Home");
                    }
                }
            }
            ViewBag.Message = "ログインに失敗しました。";
            return View(model);
        }

        // GET: Login/SignOut
        public ActionResult SignOut()
        {
            FormsAuthentication.SignOut();
            return RedirectToAction("Index");
        }
    }
}

FormsAuthentication.SetAuthCookie で登録された値が RoleProvider の GetRolesForUser や IsUserInRole で使用されますのでユーザーを一意に特定できる UserId を保持するように修正します。

動作確認

administrator でログイン
- 薬効分類のリンクにアクセスできることを確認
user でログイン
- 薬効分類のリンクにアクセスするとログイン画面に戻ることを確認

(2) ユーザー, ロールの管理画面の追加

ControllerとViewの追加

Users と Roles を元に Controller と View を自動生成します。

ソリューションエクスプローラー で Controllers を右クリック
追加 -> 新しいスキャフォールディングアイテム を選択
Entity Framework を使用した、ビューがある MVC 5 コントローラー を選択して追加をクリック
モデルクラス、 データコンテキストクラス を選択して追加をクリック

それぞれAdministratorsロールに所属しているユーザーのみ表示できるようにします。

Controllers/UsersController.cs

using System.Data.Entity;
using System.Linq;
using System.Net;
using System.Web.Mvc;
using WebApplication1.Models;

namespace WebApplication1.Controllers
{
    [Authorize(Roles = "Administrators")]
    public class UsersController : Controller
    {
      /* ~~ 省略 ~~ */
    }
}

Controllers/RolesController.cs

using System.Data.Entity;
using System.Linq;
using System.Net;
using System.Web.Mvc;
using WebApplication1.Models;

namespace WebApplication1.Controllers
{
    [Authorize(Roles = "Administrators")]
    public class RolesController : Controller
    {
      /* ~~ 省略 ~~ */
    }
}

Usersモデルの修正

using System.Collections.Generic;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace WebApplication1.Models
{
    [MetadataType(typeof(UsersMetadata))]
    public partial class Users
    {
        [Required]
        [NotMapped]
        [DisplayName("ロール")]
        public List<int> RoleId { get; set; }
    }

    public class UsersMetadata
    {
        public int UserId { get; set; }

        [Required]
        public string UserName { get; set; }

        [Required]
        public string Password { get; set; }
    }
}

リストボックスの表示と更新処理の修正

以下の点について、追加・修正します。

ユーザー登録・更新時に Role を選択できるようにリストボックスを追加します。
Create, Update について POST されてきた際に、選択された Role を反映するよう修正します。

Controllers/UsersController.cs

using System.Collections.Generic;
using System.Data;
using System.Data.Entity;
using System.Linq;
using System.Net;
using System.Web.Mvc;
using WebApplication1.Models;

namespace WebApplication1.Controllers
{
    public class UsersController : Controller
    {

        /* ~~ 省略 ~~ */

        // GET: Users/Create
        public ActionResult Create()
        {
            this.SetRoleItems();
            return View();
        }

        // POST: Users/Create
        // 過多ポスティング攻撃を防止するには、バインド先とする特定のプロパティを有効にしてください。
        // 詳細については、http://go.microsoft.com/fwlink/?LinkId=317598 を参照してください。
        [HttpPost]
        [ValidateAntiForgeryToken]
        public ActionResult Create([Bind(Include = "UserId,UserName,Password,RoleId")] Users users)
        {
            if (ModelState.IsValid)
            {
                foreach(int roleId in users.RoleId)
                {
                    var userRole = new UserRole
                    {
                        UserID = users.UserId,
                        RoleID = roleId
                    };
                    users.UserRole.Add(userRole);
                }

                db.Users.Add(users);
                db.SaveChanges();
                return RedirectToAction("Index");
            }

            this.SetRoleItems();
            return View(users);
        }

        // GET: Users/Edit/5
        public ActionResult Edit(int? id)
        {
            if (id == null)
            {
                return new HttpStatusCodeResult(HttpStatusCode.BadRequest);
            }
            Users users = db.Users.Find(id);
            if (users == null)
            {
                return HttpNotFound();
            }
            var roles = users.UserRole.Select(item => item.Roles).ToList();
            this.SetRoleItems(roles);
            return View(users);
        }

        // POST: Users/Edit/5
        // 過多ポスティング攻撃を防止するには、バインド先とする特定のプロパティを有効にしてください。
        // 詳細については、http://go.microsoft.com/fwlink/?LinkId=317598 を参照してください。
        [HttpPost]
        [ValidateAntiForgeryToken]
        public ActionResult Edit([Bind(Include = "UserId,UserName,Password,RoleId")] Users users)
        {
            if (ModelState.IsValid)
            {
                db.Entry(users).State = EntityState.Modified;

                var roleIds = db.UserRole
                    .Where(item => item.UserID == users.UserId)
                    .Select(item => item.RoleID)
                    .ToList();

                foreach (int roleId in users.RoleId)
                {
                    if (db.UserRole
                        .Where(item => item.UserID == users.UserId && item.RoleID == roleId)
                        .Count() > 0)
                    {
                        // 既に登録済み
                        roleIds.Remove(roleId);
                    }
                    else
                    {
                        // 追加
                        var userRole = new UserRole
                        {
                            UserID = users.UserId,
                            RoleID = roleId
                        };
                        db.UserRole.Add(userRole);
                    }
                }

                // 削除されたロールをDBに反映
                foreach(var roleId in roleIds)
                {
                    var item = db.UserRole.Where(ur => ur.UserID == users.UserId && ur.RoleID == roleId).FirstOrDefault();
                    if (item != null)
                    {
                        db.UserRole.Remove(item);
                    }
                }

                db.SaveChanges();
                return RedirectToAction("Index");
            }
            var roles = users.UserRole.Select(item => item.Roles).ToList();
            this.SetRoleItems(roles);
            return View(users);
        }

        /* ~~ 省略 ~~ */

        /// <summary>
        /// ロールのリストをViewBagにセット
        /// </summary>
        private void SetRoleItems()
        {
            SetRoleItems(new List<Roles>());
        }

        /// <summary>
        /// ロールのリストをViewBagにセット
        /// </summary>
        /// <param name="roleId"></param>
        private void SetRoleItems(List<Roles> roles)
        {
            var roleIds = roles.Select(item => item.RoleId).ToArray();

            var list = db.Roles.Select(item => new SelectListItem
            {
                Text = item.RoleName,
                Value = item.RoleId.ToString(),
                Selected = roleIds.Contains(item.RoleId)
            }).ToList();

            ViewBag.RoleId = list;
        }
    }
}

Views/Users/Create.cshtml

@model WebApplication1.Models.Users

@{
    ViewBag.Title = "Create";
}

<h2>Create</h2>


@using (Html.BeginForm())
{
    @Html.AntiForgeryToken()

    <div class="form-horizontal">
        <h4>Users</h4>
        <hr />
        @Html.ValidationSummary(true, "", new { @class = "text-danger" })
        <div class="form-group">
            @Html.LabelFor(model => model.UserName, htmlAttributes: new { @class = "control-label col-md-2" })
            <div class="col-md-10">
                @Html.EditorFor(model => model.UserName, new { htmlAttributes = new { @class = "form-control" } })
                @Html.ValidationMessageFor(model => model.UserName, "", new { @class = "text-danger" })
            </div>
        </div>

        <div class="form-group">
            @Html.LabelFor(model => model.Password, htmlAttributes: new { @class = "control-label col-md-2" })
            <div class="col-md-10">
                @Html.PasswordFor(model => model.Password, new { @class = "form-control" })
                @Html.ValidationMessageFor(model => model.Password, "", new { @class = "text-danger" })
            </div>
        </div>

        <div class="form-group">
            @Html.LabelFor(model => model.RoleId, htmlAttributes: new { @class = "control-label col-md-2" })
            <div class="col-md-10">
                @Html.ListBox("RoleId", null, new { @class = "form-control" })
                @Html.ValidationMessageFor(model => model.RoleId, "", new { @class = "text-danger" })
            </div>
        </div>

        <div class="form-group">
            <div class="col-md-offset-2 col-md-10">
                <input type="submit" value="Create" class="btn btn-default" />
            </div>
        </div>
    </div>
}

<div>
    @Html.ActionLink("Back to List", "Index")
</div>

<script src="~/Scripts/jquery-1.10.2.min.js"></script>
<script src="~/Scripts/jquery.validate.min.js"></script>
<script src="~/Scripts/jquery.validate.unobtrusive.min.js"></script>

EditorFor -> PasswordFor に変更
ListBox

Views/Users/Edit.cshtml

@model WebApplication1.Models.Users

@{
    ViewBag.Title = "Edit";
}

<h2>Edit</h2>


@using (Html.BeginForm())
{
    @Html.AntiForgeryToken()

    <div class="form-horizontal">
        <h4>Users</h4>
        <hr />
        @Html.ValidationSummary(true, "", new { @class = "text-danger" })
        @Html.HiddenFor(model => model.UserId)

        <div class="form-group">
            @Html.LabelFor(model => model.UserName, htmlAttributes: new { @class = "control-label col-md-2" })
            <div class="col-md-10">
                @Html.EditorFor(model => model.UserName, new { htmlAttributes = new { @class = "form-control" } })
                @Html.ValidationMessageFor(model => model.UserName, "", new { @class = "text-danger" })
            </div>
        </div>

        <div class="form-group">
            @Html.LabelFor(model => model.Password, htmlAttributes: new { @class = "control-label col-md-2" })
            <div class="col-md-10">
                @Html.EditorFor(model => model.Password, new { htmlAttributes = new { @class = "form-control" } })
                @Html.ValidationMessageFor(model => model.Password, "", new { @class = "text-danger" })
            </div>
        </div>

        <div class="form-group">
            @Html.LabelFor(model => model.RoleId, htmlAttributes: new { @class = "control-label col-md-2" })
            <div class="col-md-10">
                @Html.ListBox("RoleId", null, new { @class = "form-control" })
                @Html.ValidationMessageFor(model => model.RoleId, "", new { @class = "text-danger" })
            </div>
        </div>

        <div class="form-group">
            <div class="col-md-offset-2 col-md-10">
                <input type="submit" value="Save" class="btn btn-default" />
            </div>
        </div>
    </div>
}

<div>
    @Html.ActionLink("Back to List", "Index")
</div>

<script src="~/Scripts/jquery-1.10.2.min.js"></script>
<script src="~/Scripts/jquery.validate.min.js"></script>
<script src="~/Scripts/jquery.validate.unobtrusive.min.js"></script>

ナビゲーションバーにリンクを追加

/Users/Index と /Roles/Index に遷移するリンクをナビゲーションバーに追加します。

Views/Shared/_Layout.cshtml

<ul class="nav navbar-nav">
    <li>
        @Html.ActionLink("薬効分類", "Index", new { Controller = "Classifications" })
    </li>
    <li>
        @Html.ActionLink("ユーザー管理", "Index", new { Controller = "Users" })
    </li>
    <li>
        @Html.ActionLink("ロール管理", "Index", new { Controller = "Roles" })
    </li>
</ul>

動作確認

新しいユーザーを追加して、作成したユーザーでログインしてみます。

(3) ロールによって画面表示を切り替える

Viewの修正

_Layout.cshtml

認証されていれば、以下のリンクを表示する
- ログアウト
Administratorsであれば、以下のリンクを表示する
- 薬効分類
- ユーザー管理
- ロール管理

@{
    ViewBag.ApplicationName = "薬品情報検索";
}
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>@ViewBag.Title - @ViewBag.ApplicationName</title>
    <link href="~/Content/Site.css" rel="stylesheet" type="text/css" />
    <link href="~/Content/bootstrap.min.css" rel="stylesheet" type="text/css" />
    <script src="~/Scripts/modernizr-2.6.2.js"></script>
</head>
<body>
    <div class="navbar navbar-inverse navbar-fixed-top">
        <div class="container">
            <div class="navbar-header">
                <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
                    <span class="icon-bar"></span>
                    <span class="icon-bar"></span>
                    <span class="icon-bar"></span>
                </button>
                @Html.ActionLink((string)ViewBag.ApplicationName, "Index", "Home", new { area = "" }, new { @class = "navbar-brand" })
            </div>
            @if (Request.IsAuthenticated)
            {
            <div class="navbar-collapse collapse">
                @if (User.IsInRole("Administrators"))
                {
                <ul class="nav navbar-nav">
                    <li>
                        @Html.ActionLink("薬効分類", "Index", new { Controller = "Classifications" })
                    </li>
                    <li>
                        @Html.ActionLink("ユーザー管理", "Index", new { Controller = "Users" })
                    </li>
                    <li>
                        @Html.ActionLink("ロール管理", "Index", new { Controller = "Roles" })
                    </li>
                </ul>
                }
                <p class="navbar-text navbar-right">
                    @Html.ActionLink("ログアウト", "SignOut", new { Controller = "Login" }, new { @class = "navbar-link" })
                </p>
            </div>
            }
        </div>
    </div>

    <div class="container body-content">
        @RenderBody()
        <hr />
        <footer>
            <p>&copy; @DateTime.Now.Year - @ViewBag.ApplicationName</p>
        </footer>
    </div>

    <script src="~/Scripts/jquery-1.10.2.min.js"></script>
    <script src="~/Scripts/bootstrap.min.js"></script>
</body>
</html>

Razorで認証情報を参照することができます。

認証しているかどうかは Request.IsAuthenticated で判定できます。

認証情報は User に格納されています。 IsInRole メソッドでログインしたユーザーが該当ロールに所属しているかどうかを判定できます。

動作確認

ログインするユーザーのロールによって、ナビゲーションバーのリンクが変わることを確認します。

メンバーシップフレームワークによるユーザー認証とロールによる権限制御について解説しました。

TOP .NET Framework 概要 .NET Framework アプリケーション開発入門 1. 簡単なコンソールアプリケーションの開発 2. Windowsフォームアプリケーションの開発 3. 非同期処理 ASP.NET MVC開発入門 0. Webアプリケーションの定義 1. ASP.NET MVC の概要 2. ASP.NET MVC の基礎 3. EntityFramework によるデータベースファースト開発 4. 薬品情報検索システムの開発 5. メンバーシップフレームワークによる認証機能の実装

5. メンバーシップ フレームワークによる認証機能の実装 (後編)

(1) ユーザーとロールの情報をデータベースで管理する

Users, Rolesテーブルの追加

初期データの登録

EDMファイルの更新

補足説明: EDMファイルの削除と再作成

MembershipProvider の更新

RoleProvider の更新

コントローラーの修正

動作確認

(2) ユーザー, ロールの管理画面の追加

ControllerとViewの追加

Usersモデルの修正

リストボックスの表示と更新処理の修正

ナビゲーションバーにリンクを追加

動作確認

(3) ロールによって画面表示を切り替える

Viewの修正

動作確認

5. メンバーシップフレームワークによる認証機能の実装 (後編)