WindowsAuthenticationModule WindowsAuthenticationModule WindowsAuthenticationModule WindowsAuthenticationModule Class

Definition

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

public ref class WindowsAuthenticationModule sealed : System::Web::IHttpModule
public sealed class WindowsAuthenticationModule : System.Web.IHttpModule
type WindowsAuthenticationModule = class
    interface IHttpModule
Public NotInheritable Class WindowsAuthenticationModule
Implements IHttpModule
Inheritance
WindowsAuthenticationModuleWindowsAuthenticationModuleWindowsAuthenticationModuleWindowsAuthenticationModule
Implements

Examples

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

public void WindowsAuthentication_OnAuthenticate(object sender, WindowsAuthenticationEventArgs args)
{
  if (!args.Identity.IsAnonymous)
  {
    args.User = new Samples.AspNet.Security.MyPrincipal(args.Identity);
  }
}
Public Sub WindowsAuthentication_OnAuthenticate(sender As Object, args As WindowsAuthenticationEventArgs)
  If Not args.Identity.IsAnonymous Then
    args.User = New Samples.AspNet.Security.MyPrincipal(args.Identity)
  End If
End Sub

Remarks

When the authentication Mode is set to Windows, the WindowsAuthenticationModule sets the User property of the current HttpContext to an IPrincipal object that represents the Windows identity supplied by IIS for the current request. If IIS uses anonymous authentication, then the WindowsAuthenticationModule uses the identity returned by the GetAnonymous method.

The WindowsAuthenticationModule 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 accessed by specifying a subroutine named WindowsAuthentication_OnAuthenticate in the Global.asax file for your ASP.NET application.

Note

In IIS 7.0, using the WindowsAuthenticationModule class with the FormsAuthenticationModule class is not supported. For more information about compatibility issues in Integrated mode, see Moving an ASP.NET Application from IIS 6.0 to IIS 7.0.

Constructors

WindowsAuthenticationModule() WindowsAuthenticationModule() WindowsAuthenticationModule() WindowsAuthenticationModule()

Creates an instance of the WindowsAuthenticationModule class.

Methods

Dispose() Dispose() Dispose() Dispose()

Releases all resources, other than memory, used by the WindowsAuthenticationModule.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
Init(HttpApplication) Init(HttpApplication) Init(HttpApplication) Init(HttpApplication)

Initializes the WindowsAuthenticationModule object.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Events

Authenticate Authenticate Authenticate Authenticate

Occurs when the application authenticates the current request.

Applies to

See also