WindowsAuthenticationModule Class (System.Web.Security)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
WindowsAuthenticationModule Class

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

Inheritance Hierarchy
System.Object
  System.Web.Security.WindowsAuthenticationModule

Namespace:  System.Web.Security
Assembly:  System.Web (in System.Web.dll)
Syntax
Visual Basic
Public NotInheritable Class WindowsAuthenticationModule _
	Implements IHttpModule
C#
public sealed class WindowsAuthenticationModule : IHttpModule
Visual C++
public ref class WindowsAuthenticationModule sealed : IHttpModule
F#
[<Sealed>]
type WindowsAuthenticationModule =  
    class
        interface IHttpModule
    end

The WindowsAuthenticationModule type exposes the following members.

Constructors
  Name Description
Public method WindowsAuthenticationModule Creates an instance of the WindowsAuthenticationModule class.
Top
Methods
  Name Description
Public method Dispose Releases all resources, other than memory, used by the WindowsAuthenticationModule.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Init Initializes the WindowsAuthenticationModule object.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Events
  Name Description
Public event Authenticate Occurs when the application authenticates the current request.
Top
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 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.
Examples

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

Visual Basic

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
C#

public void WindowsAuthentication_OnAuthenticate(object sender, WindowsAuthenticationEventArgs args)
{
  if (!args.Identity.IsAnonymous)
  {
    args.User = new Samples.AspNet.Security.MyPrincipal(args.Identity);
  }
}
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.Web.Security Namespace

Other Resources

Windows Authentication Provider
Global.asax Syntax