SessionAuthenticationModule Klasse

Definition

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

Vererbung

Object

HttpModuleBase

SessionAuthenticationModule

Beispiele

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;
}

Der folgende XML-Code zeigt, wie Sie das SAM in der ASP.NET Pipeline konfigurieren. Viele andere Elemente, die in einer typischen Konfiguration vorhanden sind, werden hier aus Platzgründen weggelassen.

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

Hinweise

Wenn sie in der ASP.NET Pipeline vorhanden sind, verarbeitet die SessionAuthenticationModule SAM -Sitzungscookies in WS-Federation Szenarien. Er verwendet den von der CookieHandler Eigenschaft angegebenen Cookiehandler, um das unformatierte Sitzungscookies aus der HTTP-Anforderung zu lesen und in die HTTP-Antwort zu schreiben. Es verwendet das, das SessionSecurityTokenHandler für eine Anwendung konfiguriert ist, um das unformatierte Sitzungscookies in SessionSecurityToken Objekte zu deserialisieren. Das Sitzungssicherheitstoken enthält die Ansprüche (Claim) und den Prinzipal (ClaimsPrincipal), die der Entität zugeordnet sind, für die die Anforderung bereitgestellt wird.

Das SAM fügt OnAuthenticateRequest dem Ereignis in der ASP.NET-Pipeline den HttpApplication.AuthenticateRequest Ereignishandler hinzu. Dieser Handler fängt Anmeldeanforderungen ab. Wenn ein Sitzungscookies vorhanden ist, wird er in ein Sitzungstoken deserialisiert, und die Thread.CurrentPrincipal eigenschaften werden HttpContext.User auf den im Sitzungstoken enthaltenen Anspruchsprinzipal festgelegt. Es ruft während dieses Prozesses mehrere der anderen Methoden auf, die vom SAM verfügbar gemacht werden.

Die SignOut Methode kann aufgerufen werden, um den Benutzer bei einer Sitzung abzumelden (z. B. in einer SignOut.aspx.cs CodeBehind-Datei).

Das SAM macht mehrere Ereignisse verfügbar, die Zugriff auf die Verarbeitungspipeline bieten. Mit SessionSecurityTokenReceived den Ereignissen SessionSecurityTokenCreated können Sie Sitzungstoken ändern, die von Cookies gelesen oder während der Verarbeitung erstellt werden. In der Regel erfolgt dies zum Hinzufügen, Entfernen oder Transformieren von Ansprüchen im Token oder zum Anpassen der Ablaufzeit. Die SigningOutEreignisse SignedOutund SignOutError Ereignisse stellen Hooks zur Verarbeitung von Abmeldeanforderungen bereit. Für viele Szenarien reicht das Hinzufügen von Handlern für diese Ereignisse, häufig zur global.asax.cs Datei, aus.

Für kompliziertere Szenarien können Sie von der Implementierung eines benutzerdefinierten SAM abgeleitet SessionAuthenticationModule werden. Zu diesem Zweck werden viele der Methoden, die während OnAuthenticateRequest und SignOut verfügbar gemacht werden, verfügbar gemacht, damit Sie benutzerdefiniertes Verhalten in bestimmten Phasen des Sitzungsverarbeitungslebenszyklus bereitstellen können.

Sie können das SAM der ASP.NET-Pipeline in einer Konfigurationsdatei hinzufügen, indem Sie es den HTTP-Modulen unter dem <system.webServer> Element für IIS Version 7 und höher oder unter dem <system.web> Element für Versionen vor IIS 7 hinzufügen. Der vom SAM verwendete Cookiehandler kann mit dem <CookieHandler-Element> konfiguriert werden.