LSAuthenticationModule Class

Article
10/10/2016

Implements the Logon Server component of AD FS, which runs on the Federation Service and Federation Service Proxy and is responsible for handling protocol requests to the endpoint URL.

Namespace: System.Web.Security.SingleSignOn
Assembly: System.Web.Security.SingleSignOn (in System.Web.Security.SingleSignOn.dll)

Inheritance Hierarchy

System.Object
System.Web.Security.SingleSignOn.LSAuthenticationModule

Syntax

public class LSAuthenticationModule : IHttpModule

public ref class LSAuthenticationModule : IHttpModule

type LSAuthenticationModule = 
    class
        interface IHttpModule
    end

Public Class LSAuthenticationModule
    Implements IHttpModule

Constructors

	Name	Description
	LSAuthenticationModule()	Initializes a new instance of the LSAuthenticationModule class.

Methods

	Name	Description
	Dispose()	Frees, releases, or resets unmanaged resources.
	Equals(Object)	(Inherited from Object.)
	Finalize()	Allows an LSAuthenticationModule object to attempt to free resources and perform other cleanup operations before the object is reclaimed by garbage collection.(Overrides Object.Finalize().)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	Init(HttpApplication)	Initializes an HttpApplication on the Logon Server.
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

The web.config in the application root of Federation Service or Federation Service Proxy should register this HttpModule. Such a registration looks like this:

<configuration>
    <system.web>
        <httpModules>
            <add name="AD FS Endpoint Module" type="System.Web.Security.SingleSignOn.LSAuthenticationModule, System.Web.Security.SingleSignOn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35, Custom=null" />
        </httpModules>
    </system.web>
</configuration>

While handling the BeginRequest and EndRequest events, LSAuthenticationModule constructs an LSAuthenticationObject which processes the WS-Federation Passive Client message, performing all the necessary cookie, query string and HTTP POST message processing. If the LSAuthenticationModule cannot fully process the message and a HTTP 302 or Jscript POST form is returned, then the request flows to the appropriate Web application form (such as to the credentials collection or to the home realm discovery). In this case, the LSAuthenticationModule adds the LSAuthenticationModule reference to the application context. This can be retrieved using the Current property.

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.

Share via