Partilhar via


CookieAuthenticationOptions Classe

Definição

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

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions
public class CookieAuthenticationOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions
type CookieAuthenticationOptions = class
    inherit AuthenticationSchemeOptions
Public Class CookieAuthenticationOptions
Inherits AuthenticationSchemeOptions
Herança
CookieAuthenticationOptions

Construtores

Nome Description
CookieAuthenticationOptions()

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

Propriedades

Nome Description
AccessDeniedPath

A propriedade AccessDeniedPath é usada pelo manipulador para o destino de redirecionamento ao manipular o ForbidAsync.

ClaimsIssuer

Obtém ou define o emissor que deve ser usado para quaisquer declarações criadas

(Herdado de AuthenticationSchemeOptions)
Cookie

Determina as configurações usadas para criar o cookie.

CookieDomain
Obsoleto.

Essa propriedade é obsoleta e será removida em uma versão futura. A alternativa recomendada é <seealso cref="P:Microsoft. AspNetCore.Http.CookieBuilder.Domain"></seealso> em Cookie.

Determina o domínio usado para criar o cookie. Não é fornecido por padrão.

CookieHttpOnly
Obsoleto.
Obsoleto.

Essa propriedade é obsoleta e será removida em uma versão futura. A alternativa recomendada é <seealso cref="P:Microsoft. AspNetCore.Http.CookieBuilder.HttpOnly"></seealso> em Cookie.

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 solicitações http e não será disponibilizado para script na página.

CookieManager

O componente usado para obter cookies da solicitação ou defini-los na resposta.

ChunkingCookieManager será usado por padrão.

CookieName
Obsoleto.
Obsoleto.

Essa propriedade é obsoleta e será removida em uma versão futura. A alternativa recomendada é <seealso cref="P:Microsoft. AspNetCore.Http.CookieBuilder.Name"></seealso> em Cookie.

Determina o nome do cookie usado para persistir a identidade. O valor padrão é ". AspNetCore.Cookies". Esse valor deverá ser alterado se você alterar o nome do AuthenticationScheme, especialmente se o sistema usar o manipulador de autenticação de cookie várias vezes.

CookiePath
Obsoleto.

Essa propriedade é obsoleta e será removida em uma versão futura. A alternativa recomendada é <seealso cref="P:Microsoft. AspNetCore.Http.CookieBuilder.Path"></seealso> em Cookie.

Determina o caminho usado para criar o cookie. O valor padrão é "/" para maior compatibilidade do navegador.

CookieSecure
Obsoleto.

Essa propriedade é obsoleta e será removida em uma versão futura. A alternativa recomendada é <seealso cref="P:Microsoft. AspNetCore.Http.CookieBuilder.SecurePolicy"></seealso> em Cookie.

Determina se o cookie só deve ser transmitido na 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 uma página de entrada HTTPS e partes do seu site forem HTTP, talvez seja necessário alterar esse valor.

DataProtectionProvider

Se definido, isso será usado pelo CookieAuthenticationHandler para proteção de dados.

Events

O Provedor pode ser atribuído a uma instância de um objeto criado pelo aplicativo no momento da inicialização. O manipulador 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 não será fornecida, o que não fará nada quando os métodos forem chamados.

EventsType

Se definido, será usado como o tipo de serviço para obter a instância eventos em vez da propriedade.

(Herdado de AuthenticationSchemeOptions)
ExpireTimeSpan

Controla quanto tempo o tíquete de autenticação armazenado no cookie permanecerá válido a partir do ponto em que ele é criado. As informações de expiração são armazenadas no tíquete de cookie protegido. Devido a isso, um cookie expirado será ignorado mesmo se ele for passado para o servidor depois que o navegador deve tê-lo limpado.

Essa propriedade deve ser usada em vez de Expiration, que é ignorada.

ForwardAuthenticate

Se definido, isso especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas AuthenticateAsync. Por exemplo, Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Defina o destino para o esquema atual para desabilitar o encaminhamento e permitir o processamento normal.

(Herdado de AuthenticationSchemeOptions)
ForwardChallenge

Se definido, isso especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas ChallengeAsync. Por exemplo, Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Defina o destino para o esquema atual para desabilitar o encaminhamento e permitir o processamento normal.

(Herdado de AuthenticationSchemeOptions)
ForwardDefault

Se definido, isso especifica um esquema padrão para o qual os manipuladores de autenticação devem encaminhar todas as operações de autenticação por padrão. A lógica de encaminhamento padrão verificará primeiro a configuração forwardAuthenticate/Challenge/Forbid/SignIn/SignOut mais específica, seguida pela verificação do ForwardDefaultSelector, seguida por ForwardDefault. O primeiro resultado não nulo será usado como o esquema de destino para o qual encaminhar.

(Herdado de AuthenticationSchemeOptions)
ForwardDefaultSelector

Usado para selecionar um esquema padrão para a solicitação atual para a qual os manipuladores de autenticação devem encaminhar todas as operações de autenticação por padrão. A lógica de encaminhamento padrão verificará primeiro a configuração forwardAuthenticate/Challenge/Forbid/SignIn/SignOut mais específica, seguida pela verificação do ForwardDefaultSelector, seguida por ForwardDefault. O primeiro resultado não nulo será usado como o esquema de destino para o qual encaminhar.

(Herdado de AuthenticationSchemeOptions)
ForwardForbid

Se definido, isso especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas de ForbidAsync. Por exemplo, Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Defina o destino para o esquema atual para desabilitar o encaminhamento e permitir o processamento normal.

(Herdado de AuthenticationSchemeOptions)
ForwardSignIn

Se definido, isso especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas SignInAsync. Por exemplo, Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Defina o destino para o esquema atual para desabilitar o encaminhamento e permitir o processamento normal.

(Herdado de AuthenticationSchemeOptions)
ForwardSignOut

Se definido, isso especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas SignOutAsync. Por exemplo, Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Defina o destino para o esquema atual para desabilitar o encaminhamento e permitir o processamento normal.

(Herdado de AuthenticationSchemeOptions)
LoginPath

A propriedade LoginPath é usada pelo manipulador para o destino de redirecionamento ao lidar com ChallengeAsync. A URL atual que é adicionada ao LoginPath como um parâmetro de cadeia de caracteres de consulta nomeado pelo ReturnUrlParameter. Depois que uma solicitação ao LoginPath concede uma nova identidade signin, o valor ReturnUrlParameter é usado para redirecionar o navegador de volta para a URL original.

LogoutPath

Se o LogoutPath for fornecido o manipulador, 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 manipulador durante um Desafio. Esse também é o parâmetro de cadeia de caracteres de consulta procurado quando uma solicitação chega no caminho de logoff ou no caminho de logoff, a fim de retornar à URL original após a ação ser executada.

SessionStore

Um contêiner opcional no qual armazenar a identidade entre solicitações. Quando usado, somente um identificador de sessão é enviado para o cliente. Isso pode ser usado para atenuar possíveis problemas com identidades muito grandes.

SlidingExpiration

O SlidingExpiration é definido como true para instruir o manipulador a emitir novamente um novo cookie com um novo tempo de expiração sempre que processar uma solicitação que esteja mais da metade da janela de expiração.

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 será criado usando DataProtectionProvider.

TimeProvider

Usado para teste.

(Herdado de AuthenticationSchemeOptions)

Métodos

Nome Description
Validate()

Verifique se as opções são válidas. Deve gerar uma exceção se as coisas não estiverem bem.

(Herdado de AuthenticationSchemeOptions)
Validate(String)

Verifica se as opções são válidas para um esquema específico

(Herdado de AuthenticationSchemeOptions)

Aplica-se a