FormsAuthenticationModule

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

FormsAuthenticationModule イベント

パブリック イベント

	名前	説明
	Authenticate	アプリケーションが現在の要求を認証するときに発生します。

参照

関連項目

FormsAuthenticationModule クラス
System.Web.Security 名前空間

その他の技術情報

フォーム認証プロバイダ
Global.asax 構文

FormsAuthenticationModule クラス

フォーム認証が有効な場合、ASP.NET アプリケーションに対してユーザーの ID を設定します。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 FormsAuthenticationModule
    Implements IHttpModule

Visual Basic (使用法)

Dim instance As FormsAuthenticationModule

C#

public sealed class FormsAuthenticationModule
 : IHttpModule

C++

public ref class FormsAuthenticationModule
 sealed : IHttpModule

J#

public final class FormsAuthenticationModule
 implements IHttpModule

JScript

public final class FormsAuthenticationModule
 implements IHttpModule

解説

アプリケーションの構成ファイルの authentication 要素 (ASP.NET 設定スキーマ) 要素で認証 Mode が Forms に設定されている場合、FormsAuthenticationModule は、HttpContext.User プロパティを、現在の要求に対するユーザー ID を表す IPrincipal オブジェクトに設定します。

FormsAuthenticationModule は Authenticate イベントを公開します。このイベントにより、現在の HttpContext の User プロパティにカスタム IPrincipal オブジェクトを設定できます。Authenticate イベントには、ASP.NET アプリケーションの Global.asax ファイルに、FormsAuthentication_OnAuthenticate というサブルーチンを指定することによってアクセスします。

使用例

FormsAuthentication_OnAuthenticate イベントを使用して、現在の HttpContext の User プロパティにカスタム IPrincipal オブジェクトを設定するコード例を次に示します。

Visual Basic

Public Sub FormsAuthentication_OnAuthenticate(sender
 As Object, _
                                              args As FormsAuthenticationEventArgs)
  If FormsAuthentication.CookiesSupported Then
    If Not Request.Cookies(FormsAuthentication.FormsCookieName)
 Is Nothing Then
      Try
        Dim ticket As FormsAuthenticationTicket
 = FormsAuthentication.Decrypt( _
          Request.Cookies(FormsAuthentication.FormsCookieName).Value)
        
        args.User = New System.Security.Principal.GenericPrincipal(
 _
          New Samples.AspNet.Security.MyFormsIdentity(ticket),
 _
          New String(0) {})
      Catch e As HttpException
        ' Decrypt method failed.
      End Try
    End If
  Else
      Throw New Exception("Cookieless
 Forms Authentication is not " & _
                            "supported for this application.")
  End If
End Sub

C#

public void FormsAuthentication_OnAuthenticate(object
 sender, FormsAuthenticationEventArgs args)
{
  if (FormsAuthentication.CookiesSupported)
  {
    if (Request.Cookies[FormsAuthentication.FormsCookieName] !=
 null)
    {
      try
      {
        FormsAuthenticationTicket ticket = FormsAuthentication.Decrypt(
          Request.Cookies[FormsAuthentication.FormsCookieName].Value);
        
        args.User = new System.Security.Principal.GenericPrincipal(
          new Samples.AspNet.Security.MyFormsIdentity(ticket)
,
          new string[0]);
      }
      catch (Exception e)
      {
        // Decrypt method failed.
      }
    }
  }
  else
  {
    throw new HttpException("Cookieless Forms Authentication
 is not " +
                            "supported for this
 application.");
  }
}

.NET Framework のセキュリティ

• AspNetHostingPermission  (ホスト環境で FormsAuthenticationModule クラスを使用するために必要なアクセス許可)要求値 : LinkDemand。アクセス許可値 : Minimal。

継承階層

System.Object
  System.Web.Security.FormsAuthenticationModule

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
FormsAuthenticationModule メンバ
System.Web.Security 名前空間
その他の技術情報
フォーム認証プロバイダ
Global.asax 構文

FormsAuthenticationModule コンストラクタ

FormsAuthenticationModule クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New FormsAuthenticationModule

C#

public FormsAuthenticationModule ()

C++

public:
FormsAuthenticationModule ()

J#

public FormsAuthenticationModule ()

JScript

public function FormsAuthenticationModule ()

解説

このコンストラクタは、アプリケーション コードから呼び出すためのものではありません。

ASP.NET は、このコンストラクタを呼び出して、FormsAuthenticationModule クラスのインスタンスを作成します。コンストラクタを呼び出すと、コンストラクタは Init メソッドを呼び出して新しい FormsAuthenticationModule オブジェクトを初期化します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
FormsAuthenticationModule クラス
FormsAuthenticationModule メンバ
System.Web.Security 名前空間
その他の技術情報
フォーム認証プロバイダ

FormsAuthenticationModule メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Dispose	FormsAuthenticationModule で使用されていたすべてのリソース (メモリを除く) を解放します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	Init	FormsAuthenticationModule オブジェクトを初期化します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

FormsAuthenticationModule クラス
System.Web.Security 名前空間

その他の技術情報

フォーム認証プロバイダ
Global.asax 構文

FormsAuthenticationModule メンバ

フォーム認証が有効な場合、ASP.NET アプリケーションに対してユーザーの ID を設定します。このクラスは継承できません。

FormsAuthenticationModule データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	FormsAuthenticationModule	FormsAuthenticationModule クラスの新しいインスタンスを初期化します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Dispose	FormsAuthenticationModule で使用されていたすべてのリソース (メモリを除く) を解放します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	Init	FormsAuthenticationModule オブジェクトを初期化します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

パブリック イベント

	名前	説明
	Authenticate	アプリケーションが現在の要求を認証するときに発生します。

参照

関連項目

FormsAuthenticationModule クラス
System.Web.Security 名前空間

その他の技術情報

フォーム認証プロバイダ
Global.asax 構文