FormsAuthenticationEventHandler 委托

定义

命名空间:

System.Web.Security

程序集:

System.Web.dll

表示处理 FormsAuthenticationModule 的 FormsAuthentication_OnAuthenticate 事件的方法。

public delegate void FormsAuthenticationEventHandler(System::Object ^ sender, FormsAuthenticationEventArgs ^ e);

public delegate void FormsAuthenticationEventHandler(object sender, FormsAuthenticationEventArgs e);

type FormsAuthenticationEventHandler = delegate of obj * FormsAuthenticationEventArgs -> unit

Public Delegate Sub FormsAuthenticationEventHandler(sender As Object, e As FormsAuthenticationEventArgs)

参数

sender

Object

事件源。

e

FormsAuthenticationEventArgs

包含事件数据的 FormsAuthenticationEventArgs。

示例

下面的代码示例使用 FormsAuthentication_OnAuthenticate 事件将当前 HttpContextGenericPrincipal 的 属性设置为User具有自定义 Identity的 对象。

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

注解

委托 FormsAuthenticationEventHandler 是为 Authenticate 类的 FormsAuthenticationModule 事件定义的。 可以通过在 global.asax 文件中为 ASP.NET 应用程序指定名为 FormsAuthentication_OnAuthenticate 的子例程来访问 Authenticate 类的 事件。FormsAuthenticationModule 事件 Authenticate 在 事件期间 AuthenticateRequest 引发。

FormsAuthenticationModule使用当前 HttpContext 构造 FormsAuthenticationEventArgs 对象，并将其传递给 FormsAuthentication_OnAuthenticate 事件。

可以使用User提供给 FormsAuthentication_OnAuthenticate 事件的 对象的 属性FormsAuthenticationEventArgs将当前 HttpContext 的 属性设置为User自定义IPrincipal对象。 如果在 FormsAuthentication_OnAuthenticate 事件期间未指定 User 属性的值，则会使用 cookie 或 URL 中的 forms 身份验证票证提供的标识。

仅当身份验证Mode设置为 Forms 并且 是应用程序的活动 HTTP 模块时，FormsAuthenticationModule才会引发 FormsAuthentication_OnAuthenticate 事件。

扩展方法

GetMethodInfo(Delegate)

获取指示指定委托表示的方法的对象。

另请参阅

• Forms 身份验证提供程序