DefaultAuthenticationModule Class

Reference

Definition

Namespace:: System.Web.Security

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Ensures that an authentication object is present in the context. This class cannot be inherited.

public ref class DefaultAuthenticationModule sealed : System::Web::IHttpModule

public sealed class DefaultAuthenticationModule : System.Web.IHttpModule

type DefaultAuthenticationModule = class
    interface IHttpModule

Public NotInheritable Class DefaultAuthenticationModule
Implements IHttpModule

Inheritance: Object
DefaultAuthenticationModule

Implements: IHttpModule

Examples

The following example uses the DefaultAuthentication_OnAuthenticate event to test whether the User property of the current HttpContext instance is null. If the User property is null, then the sample sets the User property of the current HttpContext instance to a GenericPrincipal object where the Identity of the GenericPrincipal object is a GenericIdentity with a Name value of "default."

Note

The DefaultAuthentication_OnAuthenticate event is raised before the AuthorizeRequest event. As a result, if you set the User property of the current HttpContext instance to a custom identity, it can affect the behavior of your application. For example, if you are using the FormsAuthentication class and you specify <deny users="?" /> in the authorization configuration section to ensure that only authenticated users have access to your site, this sample will cause the deny element to be ignored, as the user will have a name, which is "default." Instead, you would specify <deny users="default" /> to ensure that only authenticated users can access your site.

public void DefaultAuthentication_OnAuthenticate(object sender,
                                                 DefaultAuthenticationEventArgs args)
{
  if (args.Context.User == null)
    args.Context.User = 
      new System.Security.Principal.GenericPrincipal(
        new System.Security.Principal.GenericIdentity("default"),
        new String[0]);
}

Public Sub DefaultAuthentication_OnAuthenticate(sender As Object, _
                                                args As DefaultAuthenticationEventArgs)
  If args.Context.User Is Nothing Then
    args.Context.User = _
      new System.Security.Principal.GenericPrincipal( _
        new System.Security.Principal.GenericIdentity("default"), _
        new String(0) {})
  End If
End Sub

Remarks

The DefaultAuthenticationModule ensures that the User property of the current HttpContext instance is set to an IPrincipal object for each request. The DefaultAuthenticationModule examines the User property after the AuthenticateRequest event and before the AuthorizeRequest event. If the User property is null, the DefaultAuthenticationModule sets the User property to a GenericPrincipal object that contains no user information.

If the authentication module sets the StatusCode property to 401, the DefaultAuthenticationModule will render an access-denied error page. If the value of the StatusCode property is set to a value greater than 200, the DefaultAuthenticationModule object will end the request. In that case, only HTTP modules that subscribe to the EndRequest event are called prior to the completion of the current request.

The DefaultAuthenticationModule exposes an Authenticate event. You can use this event to provide a custom IPrincipal object for the User property of the current HttpContext instance. The Authenticate event is accessed by specifying an event named DefaultAuthentication_OnAuthenticate in the application's Global.asax file.

Constructors

DefaultAuthenticationModule()

Initializes a new instance of the DefaultAuthenticationModule class.

Methods

Dispose()	Releases all resources, other than memory, used by the DefaultAuthenticationModule.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Init(HttpApplication)	Initializes the DefaultAuthenticationModule object.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Events

Authenticate

Occurs after the request has been authenticated.

Applies to

Share via