FormsAuthenticationModule.Authenticate イベント

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

FormsAuthenticationModule.Authenticate イベント

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

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

Visual Basic (宣言)

Public Event Authenticate As
 FormsAuthenticationEventHandler

Visual Basic (使用法)

Dim instance As FormsAuthenticationModule
Dim handler As FormsAuthenticationEventHandler

AddHandler instance.Authenticate, handler

C#

public event FormsAuthenticationEventHandler Authenticate

C++

public:
event FormsAuthenticationEventHandler^ Authenticate {
    void add (FormsAuthenticationEventHandler^ value);
    void remove (FormsAuthenticationEventHandler^ value);
}

J#

/** @event */
public void add_Authenticate (FormsAuthenticationEventHandler
 value)

/** @event */
public void remove_Authenticate (FormsAuthenticationEventHandler
 value)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

Authenticate イベントは、AuthenticateRequest イベント時に生成されます。

FormsAuthenticationModule クラスの Authenticate イベントは、ASP.NET アプリケーションの Global.asax ファイルに、FormsAuthentication_OnAuthenticate というサブルーチンを指定することによって処理できます。

FormsAuthentication_OnAuthenticate イベントに渡した FormsAuthenticationEventArgs の User プロパティを使用して、現在の HttpContext の User プロパティを、カスタムの IPrincipal オブジェクトに設定できます。FormsAuthentication_OnAuthenticate イベント中に User プロパティ値を指定しない場合、Cookie または URL 内のフォーム認証チケットによって提供される ID が使用されます。

FormsAuthentication_OnAuthenticate イベントは、アプリケーションの構成ファイルの authentication 要素 (ASP.NET 設定スキーマ) 要素で認証モードが Forms に設定されていて、FormsAuthenticationModule がアプリケーションのアクティブな HTTP モジュールである場合にのみ発生します。

使用例

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

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.");
  }
}

プラットフォーム

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 名前空間
その他の技術情報
フォーム認証プロバイダ
Global.asax 構文