SessionAuthenticationModule Classe

Definizione

public ref class SessionAuthenticationModule : System::IdentityModel::Services::HttpModuleBase

public class SessionAuthenticationModule : System.IdentityModel.Services.HttpModuleBase

type SessionAuthenticationModule = class
    inherit HttpModuleBase

Public Class SessionAuthenticationModule
Inherits HttpModuleBase

Ereditarietà

Object

HttpModuleBase

SessionAuthenticationModule

Esempio

void Application_Start(object sender, EventArgs e)
{
    // Code that runs on application startup

    //SUBSCRIBE TO SAM EVENTS
    FederatedAuthentication.SessionAuthenticationModule.SessionSecurityTokenCreated += new EventHandler<SessionSecurityTokenCreatedEventArgs>(SessionAuthenticationModule_SessionSecurityTokenCreated);
    FederatedAuthentication.SessionAuthenticationModule.SessionSecurityTokenReceived += new EventHandler<SessionSecurityTokenReceivedEventArgs>(SessionAuthenticationModule_SessionSecurityTokenReceived);
    FederatedAuthentication.SessionAuthenticationModule.SigningOut += new EventHandler<SigningOutEventArgs>(SessionAuthenticationModule_SigningOut);
    FederatedAuthentication.SessionAuthenticationModule.SignedOut += new EventHandler(SessionAuthenticationModule_SignedOut);
    FederatedAuthentication.SessionAuthenticationModule.SignOutError += new EventHandler<ErrorEventArgs>(SessionAuthenticationModule_SignOutError);
}
void SessionAuthenticationModule_SignOutError(object sender, ErrorEventArgs e)
{
    System.Diagnostics.Trace.WriteLine("Handling SignOutError event");
}

void SessionAuthenticationModule_SignedOut(object sender, EventArgs e)
{
    System.Diagnostics.Trace.WriteLine("Handling SignedOut event");
}

void SessionAuthenticationModule_SigningOut(object sender, SigningOutEventArgs e)
{
    System.Diagnostics.Trace.WriteLine("Handling SigningOut event");
}

void SessionAuthenticationModule_SessionSecurityTokenReceived(object sender, SessionSecurityTokenReceivedEventArgs e)
{
    System.Diagnostics.Trace.WriteLine("Handling SessionSecurityTokenReceived event");
}

void SessionAuthenticationModule_SessionSecurityTokenCreated(object sender, SessionSecurityTokenCreatedEventArgs e)
{
    System.Diagnostics.Trace.WriteLine("Handling SessionSecurityTokenCreated event");
    //Store session on the server-side token cache instead writing the whole token to the cookie.
    //It may improve throughput but introduces server affinity that may affect scalability
    FederatedAuthentication.SessionAuthenticationModule.IsReferenceMode = true;
}

Il codice XML seguente illustra come configurare SAM nella pipeline di ASP.NET. Molti altri elementi presenti in una configurazione tipica vengono omessi qui per brevità.

<configuration>
  <system.webServer>
    <modules>
      <!--WIF 4.5 modules -->
      <add name="SessionAuthenticationModule" type="System.IdentityModel.Services.SessionAuthenticationModule, System.IdentityModel.Services, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
      <add name="WsFederationAuthenticationModule" type="System.IdentityModel.Services.WSFederationAuthenticationModule, System.IdentityModel.Services, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
    </modules>
  </system.webServer>
</configuration>

Commenti

Quando presente nella pipeline di ASP.NET, i SessionAuthenticationModule cookie di sessione (SAM) vengono elaborati in scenari di WS-Federation. Usa il gestore di cookie specificato dalla CookieHandler proprietà per leggere il cookie di sessione non elaborato dalla richiesta HTTP e scriverlo nella risposta HTTP. Usa l'oggetto SessionSecurityTokenHandler configurato per un'applicazione per deserializzare il cookie di sessione non elaborato in SessionSecurityToken oggetti . Il token di sicurezza della sessione contiene le attestazioni () e l'entità (ClaimClaimsPrincipal) associate all'entità per cui viene servita la richiesta.

SAM aggiunge il OnAuthenticateRequest gestore eventi all'evento HttpApplication.AuthenticateRequest nella pipeline di ASP.NET. Questo gestore intercetta le richieste di accesso e, se è presente un cookie di sessione, lo deserializza in un token di sessione e imposta le Thread.CurrentPrincipal proprietà e HttpContext.User sull'entità attestazioni contenuta nel token di sessione. Richiama diversi altri metodi esposti dal sam durante questo processo.

Il SignOut metodo può essere richiamato per disconnettere l'utente da una sessione, ad esempio in un file code-behind SignOut.aspx.cs.

SAM espone diversi eventi che forniscono l'accesso alla pipeline di elaborazione. Gli SessionSecurityTokenReceived eventi e SessionSecurityTokenCreated consentono di modificare i token di sessione letti dai cookie o creati durante l'elaborazione. In genere, questa operazione viene eseguita per aggiungere, rimuovere o trasformare le attestazioni nel token o per modificarne la scadenza. Gli SigningOuteventi , SignedOute SignOutError forniscono hook nell'elaborazione delle richieste di disconnessione. Per molti scenari, l'aggiunta di gestori per questi eventi, spesso al file di global.asax.cs, sarà sufficiente.

Per scenari più complessi, è possibile derivare da SessionAuthenticationModule per implementare un SAM personalizzato. A questo scopo, molti dei metodi richiamati durante OnAuthenticateRequest e SignOut vengono esposti in modo da poter fornire un comportamento personalizzato in fasi specifiche del ciclo di vita dell'elaborazione della sessione.

È possibile aggiungere SAM alla pipeline di ASP.NET in un file di configurazione aggiungendolo ai moduli HTTP nell'elemento <system.webServer> per IIS versione 7 e successiva o nell'elemento <system.web> per le versioni precedenti a IIS 7. Il gestore di cookie usato da SAM può essere configurato con l'elemento <cookieHandler> .