FormsAuthenticationModule クラス

  • リファレンス

定義

名前空間:
System.Web.Security
アセンブリ:
System.Web.dll

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

public ref class FormsAuthenticationModule sealed : System::Web::IHttpModule
public sealed class FormsAuthenticationModule : System.Web.IHttpModule
type FormsAuthenticationModule = class
    interface IHttpModule
Public NotInheritable Class FormsAuthenticationModule
Implements IHttpModule
継承
Object
FormsAuthenticationModule
実装
IHttpModule

例

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

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

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

注釈

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

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

注意

IIS 7.0 では、 と を使用WindowsAuthenticationModuleFormsAuthenticationModuleすることはサポートされていません。 統合モードでの互換性の問題の詳細については、「 ASP.NET アプリケーションを IIS 6.0 から IIS 7.0 に移動する」を参照してください。

コンストラクター

FormsAuthenticationModule()

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

メソッド

Dispose()

FormsAuthenticationModule で使用されていたすべてのリソース (メモリを除く) を解放します。
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
Init(HttpApplication)

FormsAuthenticationModule オブジェクトを初期化します。
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

イベント

Authenticate

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

適用対象

こちらもご覧ください