<cookieHandler><cookieHandler>

Configura el CookieHandler SessionAuthenticationModule que usa (SAM) para leer y escribir cookies.Configures the CookieHandler that the SessionAuthenticationModule (SAM) uses to read and write cookies.

<configuration> <configuration>
   <System. identityModel. Services >   <system.identityModel.services>
     <> federationConfiguration    <federationConfiguration>
       <> cookieHandler      <cookieHandler>

SintaxisSyntax

<system.identityModel.services>  
  <federationConfiguration>  
    <cookieHandler name=xs:string  
        path=Path  
        mode="Chunked||Custom||Default"  
        persistentSessionLifetime=xs:string  
        hideFromScript=xs:boolean  
        requireSSL=xs:boolean  
        domain=xs:string  
      <chunkedCookieHandler size=xs:int />  
      <customCookieHandler type="MyNamespace.MyCustomCookieHandler, MyAssembly" />  
    </cookieHandler>  
  </federationConfiguration>  
</system.identityModel.services>  

Atributos y elementosAttributes and Elements

En las siguientes secciones se describen los atributos, los elementos secundarios y los elementos primarios.The following sections describe attributes, child elements, and parent elements.

AtributosAttributes

AtributoAttribute DESCRIPCIÓNDescription
Nombrename Especifica el nombre base para las cookies escritas.Specifies the base name for any cookies written. El valor predeterminado es "FedAuth".The default is "FedAuth".
pathpath Especifica el valor de la ruta de acceso de las cookies escritas.Specifies the path value for any cookies written. El valor predeterminado es "HttpRuntime. AppDomainAppVirtualPath".The default is "HttpRuntime.AppDomainAppVirtualPath".
modomode Uno de los CookieHandlerMode valores de que especifica el tipo de controlador de cookies utilizado por el SAM.One of the CookieHandlerMode values that specifies the kind of cookie handler used by the SAM. Se pueden usar los valores siguientes:The following values may be used:

-"Predeterminado": igual que "fragmentada".- "Default" — The same as "Chunked".
-"Fragmentado": utiliza una instancia de la ChunkedCookieHandler clase.- "Chunked" — Uses an instance of the ChunkedCookieHandler class. Este controlador de cookies garantiza que las cookies individuales no superen un tamaño máximo establecido.This cookie handler ensures that individual cookies do not exceed a set maximum size. Para ello, podría "fragmentar" una cookie lógica en varias cookies en el cable.It accomplishes this by potentially "chunking" one logical cookie into a number of cookies on-the-wire.
-"Custom": utiliza una instancia de una clase personalizada derivada de CookieHandler.- "Custom" — Uses an instance of a custom class derived from CookieHandler. El <customCookieHandler> elemento secundario hace referencia a la clase derivada.The derived class is referenced by the <customCookieHandler> child element.

El valor predeterminado es "default".The default is "Default".
persistentSessionLifetimepersistentSessionLifetime Especifica la duración de las sesiones persistentes.Specifies the lifetime of persistent sessions. Si es cero, siempre se usan sesiones transitorias.If zero, transient sessions are always used. El valor predeterminado es "0:0:0", que especifica una sesión transitoria.The default value is "0:0:0", which specifies a transient session. El valor máximo es "365:0:0", que especifica una sesión de 365 días.The maximum value is "365:0:0", which specifies a session of 365 days. El valor debe especificarse según la restricción siguiente: <xs:pattern value="([0-9.]+:){0,1}([0-9]+:){0,1}[0-9.]+" />, donde el valor más a la izquierda especifica los días, el valor medio (si está presente) especifica las horas y el valor más a la derecha (si está presente) especifica minutos.The value should be specified according to the following restriction: <xs:pattern value="([0-9.]+:){0,1}([0-9]+:){0,1}[0-9.]+" />, where the leftmost value specifies days, the middle value (if present) specifies hours, and the rightmost value (if present) specifies minutes.
requireSslrequireSsl Especifica si se emite la marca "Secure" para las cookies escritas.Specifies whether the "Secure" flag is emitted for any cookies written. Si se establece este valor, las cookies de la sesión de inicio de sesión solo estarán disponibles a través de HTTPS.If this value is set, the sign-in session cookies will only be available over HTTPS. El valor predeterminado es "true".The default is "true".
hideFromScripthideFromScript Controla si se emite la marca "HttpOnly" para las cookies escritas.Controls whether the "HttpOnly" flag is emitted for any cookies written. Algunos exploradores Web respetan esta marca manteniendo el script del lado cliente en el acceso al valor de la cookie.Certain web browsers honor this flag by keeping client-side script from accessing the cookie value. El valor predeterminado es "true".The default is "true".
dominiodomain El valor de dominio para las cookies escritas.The domain value for any cookies written. El valor predeterminado es "".The default is "".

Elementos secundariosChild Elements

ElementoElement DESCRIPCIÓNDescription
<chunkedCookieHandler><chunkedCookieHandler> Configura el ChunkedCookieHandler.Configures the ChunkedCookieHandler. Este elemento solo puede estar presente si el mode atributo <cookieHandler> del elemento es "default" o "fragmentado".This element may only be present if the mode attribute of the <cookieHandler> element is "Default" or "Chunked".
<customCookieHandler><customCookieHandler> Establece el tipo de controlador de cookies personalizado.Sets the custom cookie handler type. Este elemento debe estar presente si el mode atributo <cookieHandler> del elemento es "Custom".This element must be present if the mode attribute of the <cookieHandler> element is "Custom". No puede estar presente para ningún otro valor del mode atributo.It cannot be present for any other values of the mode attribute. El tipo personalizado se debe derivar de CookieHandler la clase.The custom type must be derived from the CookieHandler class.

Elementos primariosParent Elements

ElementoElement DESCRIPCIÓNDescription
<federationConfiguration><federationConfiguration> Contiene la configuración que configura el WSFederationAuthenticationModule (WSFAM) y el SessionAuthenticationModule (SAM).Contains the settings that configure the WSFederationAuthenticationModule (WSFAM) and the SessionAuthenticationModule (SAM).

ComentariosRemarks

El CookieHandler es responsable de leer y escribir las cookies sin formato en el nivel de protocolo http.The CookieHandler is responsible for reading and writing raw cookies at the HTTP protocol level. Puede configurar un ChunkedCookieHandler o un controlador de cookies personalizado derivado de la CookieHandler clase.You can configure either a ChunkedCookieHandler or a custom cookie handler derived from the CookieHandler class.

Para configurar un controlador de cookies fragmentado, establezca el atributo de modo en "fragmentado" o "predeterminado".To configure a chunked cookie handler, set the mode attribute to "Chunked" or "Default". El tamaño de fragmento predeterminado es de 2000 bytes, pero opcionalmente puede especificar un tamaño de fragmento diferente si <chunkedCookieHandler> incluye un elemento secundario.The default chunk size is 2000 bytes, but you may optionally specify a different chunk size by including a <chunkedCookieHandler> child element.

Para configurar un controlador de cookies personalizado, establezca el atributo MODE en "Custom".To configure a custom cookie handler, set the mode attribute to "Custom". También debe especificar un <customCookieHandler> elemento secundario que haga referencia al tipo del controlador personalizado.You must also specify a <customCookieHandler> child element that references the type of your custom handler.

El elemento se representa mediante la CookieHandlerElement clase. <cookieHandler>The <cookieHandler> element is represented by the CookieHandlerElement class. El controlador de cookies que se especificó en la configuración CookieHandler está disponible en FederationConfiguration la propiedad del conjunto FederatedAuthentication.FederationConfiguration de objetos de la propiedad.The cookie handler that was specified in configuration is available from the CookieHandler property of the FederationConfiguration object set on the FederatedAuthentication.FederationConfiguration property.

EjemploExample

El siguiente código XML muestra <cookieHandler> un elemento.The following XML shows a <cookieHandler> element. En este ejemplo, dado que mode no se especifica el atributo, el SAM usará el controlador de cookies predeterminado.In this example, because the mode attribute is not specified, the default cookie handler will be used by the SAM. Se trata de una instancia de ChunkedCookieHandler la clase.This is an instance of the ChunkedCookieHandler class. Dado que <chunkedCookieHandler> no se especifica el elemento secundario, se usará el tamaño de fragmento predeterminado.Because the <chunkedCookieHandler> child element is not specified, the default chunk size will be used. HTTPS no será necesario porque el requireSsl atributo está establecido. falseHTTPS will not be required because the requireSsl attribute is set false.

Advertencia

En este ejemplo, no se requiere HTTPS para escribir cookies de sesión.In this example, HTTPS is not required to write session cookies. Esto se debe a requireSsl que el atributo <cookieHandler> del elemento se establece falseen.This is because the requireSsl attribute on the <cookieHandler> element is set to false. Esta configuración no se recomienda para la mayoría de los entornos de producción, ya que puede suponer un riesgo para la seguridad.This setting is not recommended for most production environments as it may present a security risk.

<cookieHandler requireSsl="false" />  

Vea tambiénSee also