FormsAuthenticationModule.Authenticate Event
Assembly: System.Web (in system.web.dll)
'Declaration Public Event Authenticate As FormsAuthenticationEventHandler 'Usage Dim instance As FormsAuthenticationModule Dim handler As FormsAuthenticationEventHandler AddHandler instance.Authenticate, handler
/** @event */ public void add_Authenticate (FormsAuthenticationEventHandler value) /** @event */ public void remove_Authenticate (FormsAuthenticationEventHandler value)
In JScript, you can handle the events defined by a class, but you cannot define your own.
Not applicable.
The Authenticate event is raised during the AuthenticateRequest event.
You can handle the Authenticate event of the FormsAuthenticationModule class by specifying a subroutine named FormsAuthentication_OnAuthenticate in the Global.asax file for your ASP.NET application.
You can use the FormsAuthenticationEventArgsUser property supplied to the FormsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a custom IPrincipal object. If you do not specify a value for the User property during the FormsAuthentication_OnAuthenticate event, the identity supplied by the forms authentication ticket in the cookie or URL is used.
The FormsAuthentication_OnAuthenticate event is only raised when the authentication mode is set to Forms in the authentication Element (ASP.NET Settings Schema) element of the application's configuration file and the FormsAuthenticationModule is an active HTTP module for the application.
The following code example uses the FormsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a GenericPrincipal object with a custom Identity.
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