Roles クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Roles クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

ASP.NET アプリケーションの承認チェックに使用するロールのユーザーメンバシップを管理します。このクラスは継承できません。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 Roles

Visual Basic (使用法)

静的クラスのメンバは、クラスのインスタンスなしに直接アクセスされます。

public static class Roles

C++

public ref class Roles abstract sealed

public final class Roles

JScript

public final class Roles

解説

ASP.NET のロール管理によって、ロールと呼ばれるユーザーグループに基づいてアプリケーションの承認を管理できます。ユーザーをロールに割り当てることによって、ユーザー名に基づいた承認を指定する代わり、またはそれに加えて、ロールに基づいて Web アプリケーションの各部または機能に対するアクセスを制御できます。たとえば、従業員アプリケーションには Managers、Employees、Directors などのロールを作成し、各ロールに異なる権限を指定できます。

ユーザーは複数のロールに所属できます。たとえば、ディスカッションフォーラムのサイトでは、一部のユーザーが Members と Moderators の両方のロールに所属します。サイトの各ロールには異なる権限を定義でき、両方のロールに属するユーザーには両方の権限が与えられます。

ASP.NET アプリケーションのロール管理を有効にするには、次の例にあるように、アプリケーションの Web.config ファイルの system.web セクションの roleManager 要素を使用します。

<configuration>
  <connectionStrings>
    <add name="SqlServices" connectionString="Data Source=localhost;Initial Catalog=aspnetdb;Integrated
 Security=SSPI;" />
  </connectionStrings>

  <system.web>
    <authentication mode="Forms" >
      <forms loginUrl="login.aspx"
      name=".ASPXFORMSAUTH" />
    </authentication>

  <roleManager defaultProvider="SqlProvider" 
    enabled="true"
    cacheRolesInCookie="true"
    cookieName=".ASPROLES"
    cookieTimeout="30"
    cookiePath="/"
    cookieRequireSSL="false"
    cookieSlidingExpiration="true"
    cookieProtection="All" >
    <providers>
      <add
        name="SqlProvider"
        type="System.Web.Security.SqlRoleProvider"
        connectionStringName="SqlServices"
        applicationName="SampleApplication" />
      </providers>
    </roleManager>
  </system.web>
</configuration>

承認ルールは Web アプリケーションの構成ファイルに指定するか、またはプログラムによってコードに記述します。たとえば、次の Web.config ファイルの authorization セクションでは、匿名ユーザーのアクセスを拒否することによってユーザーにログオンを要求し、Administrators ロールのユーザーのみにアクセスを許可しています。

<authorization>
  <deny users="?" />
  <allow roles="Administrators" />
  <deny users="*" />
</authorization>

アプリケーションの Web.config ファイルの authorization セクションを使用してロールに基づいた承認を指定すると、アプリケーションのユーザーは認証されているユーザー ID を提供する必要があります。ユーザーは、Windows または Forms 認証を使用して認証できます。匿名ユーザーをロールに割り当てることはできません。ロールは ASP.NET の Membership クラスと独立して使用することも、関連して使用することもできます。

ロールメンバシップをプログラムによって検証するには、Roles クラスまたは Page.User プロパティを IsUserInRole メソッドと共に使用します。または Page.User プロパティを IPrincipal.IsInRole メソッドと共に使用することもできます。プログラムによってロールメンバシップをチェックするコード例については、このトピックの「使用例」を参照してください。

Roles クラスを使用して、ロールを作成または削除し、ユーザーを追加または削除することもできます。

メモ
WindowsTokenRoleProvider クラスを使用するようにアプリケーションを構成している場合、ロールおよびそのロールメンバシップを変更することはできません。WindowsTokenRoleProvider クラスが検証するメンバシップは、Windows セキュリティグループのみです。この場合、ASP.NET ロールの代わりに Windows ユーザーアカウント管理を使用して、グループを作成または削除し、グループメンバシップを管理する必要があります。

メモ

WindowsTokenRoleProvider クラスを使用するようにアプリケーションを構成している場合、ロールおよびそのロールメンバシップを変更することはできません。WindowsTokenRoleProvider クラスが検証するメンバシップは、Windows セキュリティグループのみです。この場合、ASP.NET ロールの代わりに Windows ユーザーアカウント管理を使用して、グループを作成または削除し、グループメンバシップを管理する必要があります。

ロール情報は、いくつかのデータソースに保存できます。

WindowsTokenRoleProvider クラスを使用すると、Windows グループのメンバシップに基づくロール情報を取得できます。
SqlRoleProvider クラスを使用すると、SQL Server データベースにロール情報を保存できます。
既存のロール情報がある場合、または Windows、承認ストア、または SQL Server 以外のデータストアにロール情報を保存してそこから取得する場合は、RoleProvider 抽象クラスを継承するクラスを作成してカスタムロールプロバイダを実装します。詳細については、「ロールプロバイダの実装」を参照してください。

ユーザーのブラウザが Cookie を受け入れる場合は、ロール情報をユーザーのコンピュータの Cookie に保存できます。ASP.NET は、各ページの要求に対して Cookie からユーザーのロール情報を読み取ります。これによって、データソースからロール情報を取得するために必要な通信量が減少するので、アプリケーションのパフォーマンスが向上します。ロール情報のサイズが大きいために Cookie に保存できない場合、ASP.NET は最新のロール情報を Cookie に保存し、その他のロール情報をデータソースから必要に応じて取得します。ユーザーのブラウザが Cookie をサポートしていないか、または Cookie が無効になっている場合、ロール情報は Cookie にキャッシュされません。

ASP.NET ロールを構成する際に CookieProtectionValue プロパティを指定すると、Cookie にキャッシュされるロール名の信頼性が向上します。CookieProtectionValue の既定値は All です。これは、Cookie 内のロール名を暗号化し、Cookie の内容が改ざんされていないかどうかを検査します。

Topic	Location
方法 : サンプルロールプロバイダを実装する	ASP .NET Web アプリケーションの作成

使用例

ASP.NET メンバシップと ASP.NET ロールの両方を使用し、SqlRoleProvider を使用してメンバシップとロール情報を SQL Server データベースに保存するように構成されているアプリケーションの Web.config ファイルの例を次に示します。ユーザーはフォーム認証によって認証され、Administrators ロールのユーザーのみがアプリケーションにアクセスできます。

<configuration>
  <connectionStrings>
    <add name="SqlServices" connectionString="Data Source=localhost;Initial Catalog=aspnetdb;Integrated
 Security=SSPI;" />
  </connectionStrings>

  <system.web>
    <authentication mode="Forms" >
      <forms loginUrl="login.aspx"
      name=".ASPXFORMSAUTH" />
    </authentication>

    <authorization>
      <deny users="?" />
      <allow roles="Administrators" />
      <deny users="*" />
    </authorization>

    <membership defaultProvider="AspNetSqlProvider" userIsOnlineTimeWindow="15">
    </membership>

    <roleManager defaultProvider="SqlProvider" 
      enabled="true"
      cacheRolesInCookie="true"
      cookieName=".ASPROLES"
      cookieTimeout="30"
      cookiePath="/"
      cookieRequireSSL="true"
      cookieSlidingExpiration="true"
      cookieProtection="All" >

      <providers>
        <clear />
        <add
          name="SqlProvider"
          type="System.Web.Security.SqlRoleProvider"
          connectionStringName="SqlServices"
          applicationName="SampleApplication" />
        </providers>

    </roleManager>
  </system.web>
</configuration>