CookieAuthenticationOptions Classe

Definição

Namespace:

Microsoft.AspNetCore.Builder

Assembly:

Microsoft.AspNetCore.Authentication.Cookies.dll

Pacote:

Microsoft.AspNetCore.Authentication.Cookies v1.1.0

Opções de configuração 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)

Herança

Object

AuthenticationOptions

CookieAuthenticationOptions

Implementações

IOptions<CookieAuthenticationOptions>

Construtores

CookieAuthenticationOptions()

Cria uma instância das opções inicializadas com os valores padrão

Propriedades

AccessDeniedPath	A propriedade AccessDeniedPath informa ao middleware que ele deve alterar um código de status 403 Proibido de saída em um redirecionamento 302 para o caminho fornecido.
AuthenticationScheme	O AuthenticationScheme nas opções corresponde ao nome lógico de um esquema de autenticação específico. Um valor diferente pode ser atribuído a fim de usar o mesmo tipo de middleware de autenticação mais de uma vez em um pipeline. (Herdado de AuthenticationOptions)
AutomaticAuthenticate	Se for true, o middleware de autenticação alterará o usuário de solicitação que está chegando. Se false, o middleware de autenticação só fornecerá identidade quando explicitamente indicado pelo AuthenticationScheme. (Herdado de AuthenticationOptions)
AutomaticChallenge	Se for verdadeiro, o middleware de autenticação deverá lidar com o desafio automático. Se false, o middleware de autenticação só alterará as respostas quando indicado explicitamente pelo AuthenticationScheme. (Herdado de AuthenticationOptions)
ClaimsIssuer	Obtém ou define o emissor que deve ser usado para quaisquer declarações criadas (Herdado de AuthenticationOptions)
CookieDomain	Determina o domínio usado para criar o cookie. Não é fornecido por padrão.
CookieHttpOnly	Determina se o navegador deve permitir que o cookie seja acessado pelo JavaScript do lado do cliente. O padrão é verdadeiro, o que significa que o cookie só será passado para as solicitações HTTP e não será disponibilizado para o script na página.
CookieManager	O componente usado para obter cookies a partir da solicitação ou para defini-los na resposta. ChunkingCookieManager será usado por padrão.
CookieName	Determina o nome do cookie usado para que a identidade persista. O valor padrão é ". AspNetCore.Cookies". Esse valor deverá ser alterado se você alterar o nome do AuthenticationScheme, especialmente se o sistema usar o middleware de autenticação de cookie várias vezes.
CookiePath	Determina o caminho usado para criar o cookie. O valor padrão é "/" para maior compatibilidade do navegador.
CookieSecure	Determina se o cookie deve ser transmitido apenas em uma solicitação HTTPS. O padrão é limitar o cookie a solicitações HTTPS se a página que está fazendo o SignIn também for HTTPS. Se você tiver um página de entrada HTTPS e partes do seu site forem HTTP, poderá ser necessário alterar este valor.
DataProtectionProvider	Se definido, isso será usado pelo CookieAuthenticationMiddleware para proteção de dados.
Description	Informações adicionais sobre o tipo de autenticação que fica disponível para o aplicativo. (Herdado de AuthenticationOptions)
Events	O provedor pode ser atribuído a uma instância de um objeto criado pelo aplicativo na hora da inicialização. O middleware chama métodos no provedor que dão ao aplicativo controle em determinados pontos em que o processamento está ocorrendo. Se não for fornecido, uma instância padrão será fornecida, que não fará nada quando os métodos forem chamados.
ExpireTimeSpan	Controla por quanto tempo o cookie permanecerá válido a partir do ponto em que for criado. As informações de expiração estão no tíquete do cookie protegido. Por causa disso, um cookie expirado será ignorado mesmo se for passado ao servidor depois de o navegador tê-lo depurado
LoginPath	A propriedade LoginPath informa o middleware que deve mudar um status 401 Não Autorizado de saída para um redirecionamento 302 para o caminho de logon em questão. A URL atual que gerou o 401 é adicionada ao LoginPath como um parâmetro de caracteres de consulta nomeado pelo ReturnUrlParameter. Depois que uma solicitação para o LoginPath concede uma nova identidade SignIn, o valor ReturnUrlParameter é usado para redirecionar o navegador de volta para a URL que causou o código de status não autorizado original.
LogoutPath	Se o LogoutPath for fornecido ao middleware, então uma solicitação para esse caminho será redirecionada com base no ReturnUrlParameter.
ReturnUrlParameter	O ReturnUrlParameter determina o nome do parâmetro de cadeia de caracteres de consulta que é acrescentado pelo middleware quando um código de status 401 Não Autorizado é alterado para um redirecionamento 302 para o caminho de logon. Esse também é o parâmetro de cadeia de caracteres de consulta procurado quando uma solicitação chega no caminho de logon ou de logoff, a fim de retornar à URL original depois que a ação é realizada.
SessionStore	Um contêiner opcional no qual armazenar a identidade entre solicitações. Quando usado, somente um identificador de sessão será enviado ao cliente. Isso pode ser usado para atenuar problemas potenciais com identidades muito grandes.
SlidingExpiration	O SlidingExpiration é definido como verdadeiro para instruir o middleware a reemitir um novo cookie com um novo tempo de expiração toda vez que ele processar uma solicitação cujo prazo de expiração já tenha passado da metade.
SystemClock	Somente para fins de teste. (Herdado de AuthenticationOptions)
TicketDataFormat	O TicketDataFormat é usado para proteger e desproteger a identidade e outras propriedades que são armazenadas no valor do cookie. Se não for fornecido, um manipulador de dados padrão será criado usando o serviço de proteção de dados contido em IApplicationBuilder.Properties. O serviço de proteção de dados padrão é baseado na chave do computador quando executado em ASP.NET e em DPAPI quando executado em um processo diferente.

Implantações explícitas de interface

IOptions<CookieAuthenticationOptions>.Value

Opções de configuração para CookieAuthenticationMiddleware.