SessionAuthenticationModule Clase

Definición

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

Herencia

Object

HttpModuleBase

SessionAuthenticationModule

Ejemplos

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

El siguiente CÓDIGO XML muestra cómo configurar sam en la canalización de ASP.NET. Muchos otros elementos que están presentes en una configuración típica se omiten aquí para mayor brevedad.

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

Comentarios

Cuando se encuentra en la canalización de ASP.NET, el SessionAuthenticationModule (SAM) procesa las cookies de sesión en escenarios WS-Federation. Usa el controlador de cookies especificado por la CookieHandler propiedad para leer la cookie de sesión sin procesar de la solicitud HTTP y escribirla en la respuesta HTTP. Usa el SessionSecurityTokenHandler que está configurado para que una aplicación deserialice la cookie de sesión sin procesar en SessionSecurityToken objetos . El token de seguridad de sesión contiene las notificaciones (Claim) y la entidad de seguridad (ClaimsPrincipal) asociadas a la entidad para la que se atiende la solicitud.

Sam agrega su OnAuthenticateRequest controlador de eventos al HttpApplication.AuthenticateRequest evento en la canalización de ASP.NET. Este controlador intercepta las solicitudes de inicio de sesión y, si hay una cookie de sesión, la deserializa en un token de sesión y establece las Thread.CurrentPrincipal propiedades y HttpContext.User en la entidad de seguridad de notificaciones contenida en el token de sesión. Invoca varios de los otros métodos expuestos por sam durante este proceso.

El SignOut método se puede invocar para cerrar la sesión del usuario (por ejemplo, en un archivo de código subyacente de SignOut.aspx.cs).

Sam expone varios eventos que proporcionan acceso a su canalización de procesamiento. Los SessionSecurityTokenReceived eventos y SessionSecurityTokenCreated le permiten modificar los tokens de sesión que se leen de las cookies o que se crean durante el procesamiento. Normalmente, esto se hace para agregar, quitar o transformar notificaciones en el token o para ajustar su tiempo de expiración. Los SigningOuteventos , SignedOuty SignOutError proporcionan enlaces al procesamiento de solicitudes de cierre de sesión. Para muchos escenarios, basta con agregar controladores para estos eventos, a menudo al archivo global.asax.cs, será suficiente.

Para escenarios más complicados, puede derivar de SessionAuthenticationModule para implementar un SAM personalizado. Para ello, muchos de los métodos que se invocan durante OnAuthenticateRequest y SignOut se exponen para que pueda proporcionar un comportamiento personalizado en fases específicas del ciclo de vida de procesamiento de la sesión.

Puede agregar el SAM a la canalización de ASP.NET en un archivo de configuración agregándolo a los módulos HTTP en el <system.webServer> elemento para IIS versión 7 y posteriores o en el <system.web> elemento para las versiones anteriores a IIS 7. El controlador de cookies utilizado por sam se puede configurar con el <elemento cookieHandler> .

Constructores

Propiedades

Métodos

Eventos

Se aplica a