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.

The following tables list the members exposed by the WSFederationAuthenticationModule type.

Public Constructors

  Name Description
WSFederationAuthenticationModule Initializes a new instance of the WSFederationAuthenticationModule class.
Top

Public Properties

  Name Description
public property AuthenticationType Federation passive "wauth" property.
public property Freshness This is an optional property applicable when FederationAuthenticationModule. PassiveRedirectEnabled is set to true. Use this property to get or set and optional parameter that identifies the desired maximum age of authentication specified in minutes.
public property HomeRealm  
public property Issuer This is a required property if PassiveRedirectEnabled is set to true. It specifies the URL of the STS where the caller is redirected to for authentication.
public property PassiveRedirectEnabled Specifies whether the module is enabled to initiate WS-Federation passive protocol redirects. This mode of operation of the module enables its use in scenarios that do not employ the Federated Passive SignIn ASP.NET control.
public property PersistentCookiesOnPassiveRedirects  
public property Policy Federation passive "wp" property.
public property Realm This is a required property if PassiveRedirectEnabled is set to true. Get or set a required property that is a URI identifying the relying party to the STS. (For identifying the STS to the RP, see Issuer).
public property Reply This is an optional property if PassiveRedirectEnabled is set to true. Get or set this optional parameter to a URL identifying the relying party to the STS.
public property Request This is an optional property applicable when PassiveRedirectEnabled is set to true. Get or set this optional parameter to send the request as a WS-Trust Request Security Token <RST> element.
public property RequestPtr This is an optional property applicable when PassiveRedirectEnabled is set to true. Get or set an optional parameter that contains a pointer to the request as a Request Security Token <RST> element.
public property RequireHttps  
public property Resource This is an optional property applicable when PassiveRedirectEnabled is set to true. Get or set this optional parameter to a URI that identifies the resource being accessed (relying party) to the STS.
public property ServiceConfiguration  (Inherited from HttpModuleBase)
public property SignInContext RP or STS defined context parameter.
public property SignInQueryString Query string of request, which may contain other message parameters.
public property SignOutQueryString  
public property SignOutReply  
public property XmlDictionaryReaderQuotas  
Top

Public Methods (see also Protected Methods)

  Name Description
public method CanReadSignInResponse Overloaded.  
public method CreateSignInRequest Creates a WS-Federation Passive Protocol SignIn Request, using the WS-Federation parameters configured on the module.
public method Dispose  (Inherited from HttpModuleBase)
public method Equals  Overloaded. (Inherited from Object)
public methodstatic FederatedSignOut  
public methodstatic GetFederationPassiveSignOutUrl  
public method GetHashCode  (Inherited from Object)
public method GetSecurityToken Overloaded.  
public method GetSignInResponseMessage Reads a SignInResponseMessage from the given HttpRequest.
public method GetType  (Inherited from Object)
public method GetXmlTokenFromMessage Overloaded.  
public method Init  Initializes a module and prepares it to handle requests. (Inherited from HttpModuleBase)
public method IsSignInResponse  
public method RedirectToIdentityProvider Redirect user to identity provider STS for obtaining a token using WS-Federation Passive Protocol.
public methodstatic ReferenceEquals  (Inherited from Object)
public method SetPrincipalAndWriteSessionToken  
public method SignOut  
public method ToString  (Inherited from Object)
public method VerifyProperties  
Top

Protected Methods

  Name Description
protected method Finalize  (Inherited from Object)
protected method GetReferencedResult  
protected method GetReturnUrlFromResponse Extract the originally requested page (ReturnUrl) from the response.
protected method GetSessionTokenContext  
protected method GetSignOutRedirectUrl  
protected method InitializeModule Overridden.  
protected method InitializePropertiesFromConfiguration  
protected method MemberwiseClone  (Inherited from Object)
protected method OnAuthenticateRequest  
protected method OnAuthorizationFailed  
protected method OnEndRequest Handle the HTTP pipeline EndRequest event.
protected method OnPostAuthenticateRequest  
protected method OnRedirectingToIdentityProvider  
protected method OnSessionSecurityTokenCreated  
protected method OnSignedIn  
protected method OnSignedOut  
protected method OnSignInError  
protected method OnSigningOut  
protected method OnSignOutError  
Top

Public Events

See Also



Copyright © 2008 by Microsoft Corporation. All rights reserved.