asp.net.ph

FormsAuthenticationModule Class

System.Web.Security Namespace


Sets the identity of the user for an ASP.NET application when forms authentication is enabled. This class cannot be inherited.

FormsAuthenticationModule Class Members

Collapse   Constructors

Visibility Constructor Parameters
public FormsAuthenticationModule ( )

Collapse   Methods

Visibility Name Parameters Return Type
public Dispose ( ) Void
public Init ( HttpApplication app ) Void

Collapse   Events

Multicast Name Type
multicast Authenticate FormsAuthenticationEventHandler

Remarks

The FormsAuthenticationModule sets the current HttpContext.User property to an IPrincipal object that represents the user identity for the current request when the authentication Mode is set to Forms in the authentication element of the application's configuration file.

The FormsAuthenticationModule exposes an Authenticate event that enables you to provide a custom IPrincipal object for the User property of the current HttpContext. The Authenticate event is handled by specifying a subroutine named FormsAuthentication_OnAuthenticate in the Global.asax file for your ASP.NET application.

Example

The following example uses the FormsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a custom IPrincipal object.

public void FormsAuthentication_OnAuthenticate ( object src, 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." );
   }
}
  C# VB

See Also

ASP.NET Authentication   PassportAuthenticationModule Class   WindowsAuthenticationModule Class Skip Navigation Links




Home
Suggested Reading


Previous page Back to top Next page

© 2000-2010 Rey Nuñez All rights reserved.

If you have any question, comment or suggestion
about this site, please send us a note

You can help support asp.net.ph