ASP.NET のサイトマップセキュリティトリミング

[アーティクル]
10/22/2014

更新 : 2007 年 11 月

Web サイトには、特定のページへのアクセスを一部のメンバまたはその他の認証されたユーザーだけに限定するというセキュリティ要件が指定されることがよくあります。ASP.NET ロール管理を使用すると、セキュリティロールに基づいて Web ファイルへのアクセスを制限できます。また、サイトマップセキュリティトリミングを使用すると、同じくセキュリティロールに基づいてサイトマップ内のナビゲートリンクを非表示にできます。ロールベースセキュリティについては、「ロール管理について」を参照してください。

サイトマップセキュリティトリミングの動作

ASP.NET ページに次のナビゲーション構造が表示される場合を考えます。

Home
   Products
      Hardware
      Software
      Discounts
   Services
      Training
      Consulting
      Support

Customers というロールのメンバでないクライアントは、Support.aspx ページに設定されている ASP.NET アクセス規則により、Support Web ページを表示することを許可されないものとします。

ナビゲート表示の Support リンクを非表示にするには、Web.config ファイルで、セキュリティトリミングを有効にするようにサイトマッププロバイダを設定します。アプリケーションは、ASP.NET の URL 承認とファイル承認に従って Support ページへのリンクを非表示にするので、これ以外の変更は必要ありません。ASP.NET Version 2.0 に含まれる XmlSiteMapProvider コントロールは、URL 承認機能とファイル承認機能を使用して、各サイトマップノードに対する承認チェックを自動的に実行します。

Customers ロールのメンバでないクライアントに対して Support リンクを表示する場合は、Support.aspx ファイルのサイトマップノードの roles 属性を使用できます。roles 属性は、URL 承認とファイル承認によって与えられるアクセスレベルの範囲を超えてサイトマップノードへのアクセスを拡大します。

Support ページの roles 属性に Customers を設定するコード例を次に示します。セキュリティトリミングを有効にしてから、この設定を行うと、URL 承認やファイル承認によってファイル自体の表示が許可されていない場合でも、Customers ロールに所属するユーザーに対して Support ページへのナビゲートリンクが表示されます。

<?xml version="1.0" encoding="utf-8" ?>
  <siteMap>
    <!-- other <siteMapNode> elements -->
      <siteMapNode title="Support" description="Support"
        url="~/Customers/Support.aspx" roles="Customers" />
  </siteMap>

Customers ロールのメンバでないユーザーには、URL 承認規則やファイル承認規則によって、Support ページを表示することを許可されないため、次のようなナビゲーション構造が表示されます。

Home
   Products
      Hardware
      Software
      Discounts
   Services
      Training
      Consulting

セキュリティトリミングの有効化

セキュリティトリミングは、ASP.NET ロールと連携して動作します。そのため、セキュリティトリミングを有効にするには、アクセスルール (allow 要素と deny 要素) を使用してページを制限する必要があります。アクセスルールの詳細については、「ロールを使用した承認の管理」を参照してください。

セキュリティトリミングは、既定では無効になっており、プログラムから有効にすることはできません。セキュリティトリミングは Web.config ファイルでしか設定できません。これは、SiteMapProvider クラスから継承されたカスタムクラスの場合も同じです。

セキュリティトリミングを有効にするには、Web.config ファイルで siteMap 要素 (ASP.NET 設定スキーマ) 要素を設定する必要があります。サイトマップで既定の ASP.NET サイトマッププロバイダを使用する場合、Web.config ファイルには、siteMap 要素 (ASP.NET 設定スキーマ) 要素が含まれていないことがあります。そのような場合には、この要素を追加する必要があります。既定のサイトマッププロバイダを追加し、セキュリティトリミングを有効にするコード例を次に示します。

<system.web>
<!-- …other configuration settings -->
  <siteMap defaultProvider="XmlSiteMapProvider" enabled="true">
    <providers>
      <add name="XmlSiteMapProvider"
        description="Default SiteMap provider."
        type="System.Web.XmlSiteMapProvider "
        siteMapFile="Web.sitemap"
        securityTrimmingEnabled="true" />
    </providers>
  </siteMap>
</system.web>

パフォーマンスに関する考慮事項

セキュリティトリミング機能では、個々の要求のたびに URL 承認を使用して、siteMapNode 要素に対応する URL にユーザーがアクセスできるかどうかを判断します。承認を受けるノードの数によっては、この追加の処理によってパフォーマンスが低下することがあります。セキュリティトリミングを有効にする場合は、次の方法によってパフォーマンスを改善できます。

サイトマップファイルのノード数を制限する 150 以上のノードがサイトマップファイルに含まれている場合は、セキュリティトリミング操作の実行にかなりの時間がかかる可能性があります。
明示的に roles 属性を siteMapNode要素に設定する roles 属性にワイルドカード文字またはアスタリスク (*) を設定するのは、どのクライアントにも安全に表示できるノードだけに限定する必要があります 。roles 属性が存在すると、ユーザーがこの属性にリストされているロールのいずれかに所属する場合、ASP.NET は、siteMapNode に関連付けられている URL の URL 承認を省略できます。

意図しないトリミングを防止するためのロールの選択

子サイトマップノードの意図しないトリミングを防ぐために、承認規則とロール属性は慎重に設定する必要があります。ASP.NET ページに次のナビゲーション構造が表示される場合を考えます。

Home
   Products
      Hardware

Products.aspx ファイルに設定する URL 承認規則またはファイル承認規則は、Hardware.aspx ファイルに設定する承認規則ほど厳しくしません。前者を後者と同じくらい厳しくすると、Products への親リンクが非表示にされるため、Hardware リンクの表示が許可されるユーザーに対して Hardware リンクが表示されなくなります。非表示のリンクを公開するには、両方のサイトマップノードに roles 属性を追加します。この属性は、無視される ASP.NET ロールの一覧を示します。

サイトマップのルートノードにはユーザー全員がアクセスできるようにすることをお勧めします。ルートノードに全員がアクセスできるようにするには、次のコード例に示すように、roles 属性にワイルドカード文字としてアスタリスク (*) を設定します。

<?xml version="1.0" encoding="utf-8" ?>
<siteMap>
  <siteMapNode title="Home" description="Home" 
    url="default.aspx" roles="*">
    <!-- other <siteMapNode> elements -->
  </siteMapNode>
</siteMap>

サイトマップ内では、Web アプリケーション外部の URL を参照できます。アプリケーション外部の URL へのアクセスは、ASP.NET ではテストできません。そのため、セキュリティトリミングを有効にした場合、ロール属性にアスタリスク (*) を設定しない限り、サイトマップノードが表示されなくなります。アスタリスクを使用すると、事前に URL へのアクセスをテストしなくても、すべてのクライアントがサイトマップノードを表示できるようになります。

複数のサイトマップまたはプロバイダでのセキュリティトリミングの使用

複数のサイトマップを一緒に使用して、単一の Web サイトのナビゲーション構造を定義できます。たとえば、Web.sitemap ファイルは、分割して別個の複数のフォルダに配置できるという点で Web.config ファイルに似ています。

サイトマップは、親サイトマップの SiteMapNode オブジェクトの siteMapFile 属性または provider 属性に設定されている子サイトマップファイルやプロバイダを参照することで、相互にリンクできます。

別のサイトマップを参照するサイトマップノードを次のコード例に示します。

<?xml version="1.0" encoding="utf-8" ?>

<siteMap>
  <!-- other <siteMapNode> elements -->
    <siteMapNode siteMapFile="~/Customers/Customers.sitemap" 
      securityTrimmingEnabled="true" />
</siteMap>

セキュリティトリミングの影響を受ける API メンバ

ナビゲーションコントロールを使用すると、コードをほとんど使わずにページにサイトナビゲーションを追加できますが、コードによってサイトナビゲーションを操作することもできます。Web アプリケーションを実行すると、ASP.NET は、サイトマップ構造を表す SiteMap オブジェクトを公開します。SiteMap オブジェクトのメンバはすべて静的です。SiteMap オブジェクトは、マップ内の各ノードのプロパティを含む SiteMapNode オブジェクトのコレクションを公開します。その理由は、SiteMapPath コントロールを使用した場合、このコントロールは、SiteMap オブジェクトと SiteMapNode オブジェクトを使用して適切なリンクを自動的に表示するからです。

SiteMap、SiteMapNode、SiteMapProvider の各オブジェクトを独自のコードで使用すると、サイトマップ構造を走査したり、カスタムコントロールを作成してサイトマップデータを表示したりできます。サイトマップに書き込むことはできませんが、オブジェクトのインスタンスでサイトマップノードを変更することはできます。詳細については、「方法 : メモリ内のサイトマップノードをプログラムで変更する」または「方法 : サイトマップノードをコードによって列挙する」を参照してください。

ASP.NET は、既定のサイトマッププロバイダである XmlSiteMapProvider を使用して Web.sitemap ファイルを読み取ります。サイトマップファイル以外の場所にサイトマップ情報を格納する場合は、独自のサイトマッププロバイダを作成し、カスタムプロバイダを呼び出すようにアプリケーションを構成します。サイトマッププロバイダは Web.config ファイルで設定されます。アプリケーションを実行すると、ASP.NET はプロバイダを呼び出し、必要に応じてサイトマップ情報を取得できます。この後、ASP.NET は、プロバイダが返した情報に基づいて SiteMapNode オブジェクトを作成し、設定します。このオブジェクトには、SiteMap クラスを使用してプログラムによってアクセスできます。詳細については、「ASP.NET サイトマッププロバイダの実装」を参照してください。

セキュリティに関するメモ :
拡張子が .sitemap 以外のファイル名を持つファイルにサイトマップデータを格納するカスタムサイトマッププロバイダを実装すると、セキュリティ上の問題が発生する可能性があります。既定では、ASP.NET は、.sitemap などの既知のファイル名拡張子を持つファイルがクライアントによってダウンロードされないように設定されています。データを保護するために、ファイル名の拡張子が .sitemap 以外のカスタムサイトマップデータファイルは App_Data フォルダに配置してください。詳細については、「ASP.NET のサイトナビゲーションの保護」を参照してください。

拡張子が .sitemap 以外のファイル名を持つファイルにサイトマップデータを格納するカスタムサイトマッププロバイダを実装すると、セキュリティ上の問題が発生する可能性があります。既定では、ASP.NET は、.sitemap などの既知のファイル名拡張子を持つファイルがクライアントによってダウンロードされないように設定されています。データを保護するために、ファイル名の拡張子が .sitemap 以外のカスタムサイトマップデータファイルは App_Data フォルダに配置してください。詳細については、「ASP.NET のサイトナビゲーションの保護」を参照してください。

セキュリティトリミングを有効にすると、SiteMap、SiteMapNode、SiteMapNodeCollection の各クラスの一部のメンバの動作に影響が及びます。これらのクラスを使用すると、次のような動作が生じます。

サイトナビゲーション API メンバは、表示するセキュリティ権限がユーザーに与えられていないサイトマップノードを参照しようとした場合、null を返します。たとえば、CurrentNode、NextSibling、ParentNode、および PreviousSibling の各プロパティは、制限されているサイトマップノードを返そうとした場合、null を返します。
サイトナビゲーション API メンバがサイトマップノードのツリーを走査する必要がある場合、ユーザーが表示できないサイトマップノードはすべて走査から除外されます。たとえば、ChildNodes メソッドを実行すると、ノードのコレクションがフィルタ処理され、ユーザーが表示できるノードだけが含まれます。Clone メソッドや IsDescendantOf メソッドなど、ノードパスを追跡する必要がある API メンバの場合、パスは制限されたノードで終了します。これにより、複製操作では結果のノード数が減少する場合があります。また、ノードが構造的には要求されたノードの実際の子孫であっても、IsDescendantOf メソッドで false の値が返される場合があります。
表示するセキュリティ権限をユーザーが持たないルートノードをサイトナビゲーション API メンバが参照すると、InvalidOperationException 例外が返されます。ルートプロバイダのルートノードだけには、ユーザー全員がアクセスできるようにする必要があります。これにより、最初に SiteMap オブジェクトを取得したときに例外がスローされなくなります。
SiteMapNode オブジェクトが誤って別のサイトマップファイルやプロバイダを参照すると、ConfigurationException 例外がスローされます。

メモ :
サイトマップ内では、Web アプリケーション外部の URL を参照できます。アプリケーション外部の URL へのアクセスは、ASP.NET ではテストできません。そのため、セキュリティトリミングを有効にした場合、ロール属性にアスタリスク (*) を設定しない限り、サイトマップノードが表示されなくなります。アスタリスクを使用すると、事前に URL へのアクセスをテストしなくても、すべてのクライアントがサイトマップノードを表示できるようになります。

参照

次の方法で共有

ASP.NET のサイトマップセキュリティトリミング

サイトマップセキュリティトリミングの動作

セキュリティトリミングの有効化

パフォーマンスに関する考慮事項

意図しないトリミングを防止するためのロールの選択

複数のサイトマップまたはプロバイダでのセキュリティトリミングの使用

セキュリティトリミングの影響を受ける API メンバ

参照

処理手順

概念

その他の技術情報

その他のリソース

次の方法で共有

ASP.NET のサイト マップ セキュリティ トリミング

サイト マップ セキュリティ トリミングの動作

セキュリティ トリミングの有効化

パフォーマンスに関する考慮事項

意図しないトリミングを防止するためのロールの選択

複数のサイト マップまたはプロバイダでのセキュリティ トリミングの使用

セキュリティ トリミングの影響を受ける API メンバ

参照

処理手順

概念

その他の技術情報

その他のリソース

ASP.NET のサイトマップセキュリティトリミング

サイトマップセキュリティトリミングの動作

セキュリティトリミングの有効化

複数のサイトマップまたはプロバイダでのセキュリティトリミングの使用

セキュリティトリミングの影響を受ける API メンバ