CookieAuthenticationOptions Clase

Definición

Opciones de configuración para CookieAuthenticationMiddleware.

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Builder::AuthenticationOptions, Microsoft::Extensions::Options::IOptions<Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^>
public class CookieAuthenticationOptions : Microsoft.AspNetCore.Builder.AuthenticationOptions, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.CookieAuthenticationOptions>
type CookieAuthenticationOptions = class
    inherit AuthenticationOptions
    interface IOptions<CookieAuthenticationOptions>
Public Class CookieAuthenticationOptions
Inherits AuthenticationOptions
Implements IOptions(Of CookieAuthenticationOptions)
Herencia
CookieAuthenticationOptions
Implementaciones

Constructores

CookieAuthenticationOptions()

Crea una instancia de las opciones inicializadas con los valores predeterminados

Propiedades

AccessDeniedPath

La propiedad AccessDeniedPath informa al middleware de que debe cambiar un código de estado 403 prohibido saliente a una redirección 302 en la ruta de acceso especificada.

AuthenticationScheme

AuthenticationScheme en las opciones corresponde al nombre lógico de un esquema de autenticación determinado. Se puede asignar un valor diferente para utilizar el mismo tipo de middleware de autenticación más de una vez en una canalización.

(Heredado de AuthenticationOptions)
AutomaticAuthenticate

Si es true, el middleware de autenticación modifica el usuario de solicitud que entra. Si false, el middleware de autenticación solo proporcionará identidad cuando se indique explícitamente mediante AuthenticationScheme.

(Heredado de AuthenticationOptions)
AutomaticChallenge

Si es true, el middleware de autenticación debe controlar el desafío automático. Si false, el middleware de autenticación solo modificará las respuestas cuando se indique explícitamente mediante AuthenticationScheme.

(Heredado de AuthenticationOptions)
ClaimsIssuer

Obtiene o establece el emisor que se debe usar para las notificaciones que se crean.

(Heredado de AuthenticationOptions)
CookieDomain

Determina el dominio usado para crear la cookie. No se proporciona de forma predeterminada.

CookieHttpOnly

Determina si el explorador debe permitir que el javascript del lado cliente acceda a la cookie. El valor predeterminado es true, lo que significa que la cookie solo se pasará a solicitudes http y no estará disponible para el script de la página.

CookieManager

Componente que se usa para obtener cookies de la solicitud o para establecerlas en la respuesta.

Se usará ChunkingCookieManager de forma predeterminada.

CookieName

Determina el nombre de la cookie usado para persistir la identidad. El valor predeterminado es ". AspNetCore.Cookies". Este valor debe cambiarse si cambia el nombre de AuthenticationScheme, especialmente si el sistema usa el middleware de autenticación de cookies varias veces.

CookiePath

Determina la ruta de acceso usada para crear la cookie. El valor predeterminado es "/" para mayor compatibilidad con el explorador.

CookieSecure

Determina si la cookie solo se debe transmitir por solicitud HTTPS. El valor predeterminado limita la cookie a solicitudes HTTPS si la página que ejecuta SignIn también es HTTPS. Si tiene una página de inicio de sesión HTTPS y partes del sitio son HTTP, puede que tenga que cambiar este valor.

DataProtectionProvider

Si establece esta opción la usará CookieAuthenticationMiddleware para la protección de datos.

Description

Información adicional sobre el tipo de autenticación que se pone a disposición de la aplicación.

(Heredado de AuthenticationOptions)
Events

Puede que se asigne el proveedor a una instancia de un objeto creada por la aplicación al inicio. El middleware llama a métodos en el proveedor que proporcionan el control de la aplicación en determinados puntos en los que se está produciendo el procesamiento. Si no se proporciona, se ofrece una instancia predeterminada que no hace nada cuando se invocan los métodos.

ExpireTimeSpan

Controla el tiempo que será válida la cookie desde que se crea. La información sobre caducidad se incluye en el vale de cookie protegido. Por este motivo, las cookies caducadas se ignorarán incluso si se pasan al servidor cuando el explorador las tendría que haber purgado

LoginPath

La propiedad LoginPath informa al middleware de que debe cambiar un código de estado sin autorización 401 saliente a un redireccionamiento 302 en la ruta de acceso de inicio de sesión proporcionada. La URL actual que generó el 401 se agrega a LoginPath como parámetro de cadena de consulta designado por ReturnUrlParameter. Una vez que una solicitud a LoginPath concede una nueva identidad de SignIn, se usa el valor ReturnUrlParameter para redirigir el explorador de nuevo.
a la dirección URL que provocó el código de estado no autorizado original.

LogoutPath

Si se proporciona el middleware a LogoutPath, se redirigirá una solicitud a dicha ruta de acceso en función de ReturnUrlParameter.

ReturnUrlParameter

ReturnUrlParameter determina el nombre del parámetro de la cadena de consulta que anexa el middleware cuando se cambia un código de estado sin autorización 401 a una redirección 302 en la ruta de acceso de inicio de sesión. Este también es el parámetro de cadena de consulta que se busca cuando llega una solicitud a la ruta de acceso de inicio o cierre de sesión, para volver a la dirección URL original después de llevar a cabo la acción.

SessionStore

Contenedor opcional para almacenar las solicitudes entre identidades. Cuando se usa, solo se envía un identificador de sesión al cliente. Esto puede ayudar a minimizar los posibles problemas con identidades muy grandes.

SlidingExpiration

SlidingExpiration se define como true para instruir al middleware para que vuelva a emitir una cookie nueva con una nueva hora de caducidad cada vez que procese una solicitud a más de medio camino en la ventana de caducidad.

SystemClock

Sólo con fines de prueba.

SystemClock

Sólo con fines de prueba.

(Heredado de AuthenticationOptions)
TicketDataFormat

TicketDataFormat se usa para proteger y desproteger la identidad y otras propiedades almacenadas en el valor de la cookie. Si no se proporciona un controlador de datos predeterminado se crea mediante el servicio de protección de datos incluido en IApplicationBuilder.Properties. El servicio de protección de datos predeterminado se basa en una clave de equipo si se ejecuta en ASP.NET y en DPAPI si se ejecuta en otro proceso.

Implementaciones de interfaz explícitas

IOptions<CookieAuthenticationOptions>.Value

Opciones de configuración para CookieAuthenticationMiddleware.

Se aplica a