WSFederationAuthenticationModule Class

The WSFederationAuthenticationModule is an HTTP module that lets ASP.NET developers build claims aware applications. The WSFederationAuthenticationModule raises several events, which allows ASP.NET developers to customize its functionality in their applications. The WSFederationAuthenticationModule functionality is divided into granular methods to make it easier for ASP.NET developers to reuse and extend its functionality in their applications.

Namespace: Microsoft.IdentityModel.Web
Assembly: Microsoft.IdentityModel (in microsoft.identitymodel.dll)

Verwendung

    Dim instance As WSFederationAuthenticationModule

Syntax

'Declaration
Public Class WSFederationAuthenticationModule
    Inherits HttpModuleBase

public class WSFederationAuthenticationModule : HttpModuleBase

public ref class WSFederationAuthenticationModule : public HttpModuleBase

public class WSFederationAuthenticationModule extends HttpModuleBase

public class WSFederationAuthenticationModule extends HttpModuleBase

Hinweise

WSFederationAuthenticationModule is added to the ASP.NET pipeline by making an entry in the web.config file. It implements IHttpModule, and registers with the ASP.NET runtime to listen for the AuthenticateRequest event. This lets it monitor requests for authentication cookies, and when these cookies are present and valid, to create an instance of IClaimsPrincipal for the authenticated user.

SessionAuthenticationModule monitors requests for authentication cookies. When these cookies are present and valid, the module creates a FederatedIdentity and IPrincipal for the authenticated user and sets the User and CurrentPrincipal properties.

The cookies are written as a result of calling SignIn with a token retrieved via an out-of-band method. SignIn is called automatically by the InformationCard and FederatedPassiveSignIn controls, which retrieve tokens using CardSpace and WS-Federation passive protocols, respectively.

A minimum configuration which enables the module resembles this:

<configuration>
  <system.web>
    <httpModules>
      <add name="WSFederationAuthenticationModule" type="Microsoft.IdentityModel.Web.WSFederationAuthenticationModule, Microsoft.IdentityModel, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" />
    </httpModules>
  </system.web>
  <system.webServer>
    <modules>
      <add name="WSFederationAuthenticationModule" type="Microsoft.IdentityModel.Web.WSFederationAuthenticationModule, Microsoft.IdentityModel, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" preCondition="managedHandler" />
    </modules>
  </system.webServer>
</configuration>

Once configured, the WSFederationAuthenticationModule raises events at various stages of processing an HTTP request. ASP.NET developers can handle these events in the global.asax file. For sample code, see How to: Protect Only Certain Parts of a Web Site using the Federated Authentication Module.

Vererbungshierarchie

System.Object
   Microsoft.IdentityModel.Web.HttpModuleBase
    Microsoft.IdentityModel.Web.WSFederationAuthenticationModule

Threadsicherheit

Beliebige öffentliche, statische (Freigegebene in Visual Basic) Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.

Plattformen

Entwicklungsplattformen

Windows Server 2003, Windows Vista

Target Platforms

Windows Server 2008, Windows Vista, Not tested on Windows XP

Change History

Siehe auch

Referenz

WSFederationAuthenticationModule Members
Microsoft.IdentityModel.Web Namespace