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

CookieAuthenticationOptions()

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

Propriedades

AccessDeniedPath

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

ClaimsIssuer

Obtém ou define o emissor que deve ser usado para qualquer declaração criada

(Herdado de AuthenticationSchemeOptions)
Cookie

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

SameSite o padrão é Lax . HttpOnlyo padrão é true. SecurePolicy o padrão é SameAsRequest .

CookieDomain
Obsoleto.

Essa propriedade está obsoleta e será removida em uma versão futura. A alternativa recomendada é em Cookie .

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

CookieHttpOnly
Obsoleto.
Obsoleto.

Essa propriedade está obsoleta e será removida em uma versão futura. A alternativa recomendada é 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 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
Obsoleto.
Obsoleto.

Essa propriedade está obsoleta e será removida em uma versão futura. A alternativa recomendada é em Cookie .

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 manipulador de autenticação de cookie várias vezes.

CookiePath
Obsoleto.

Essa propriedade está obsoleta e será removida em uma versão futura. A alternativa recomendada é em Cookie .

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

CookieSecure
Obsoleto.

Essa propriedade está obsoleta e será removida em uma versão futura. A alternativa recomendada é em Cookie .

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 CookieAuthenticationHandler para proteção de dados.

Events

O provedor pode ser atribuído a uma instância de um objeto criado pelo aplicativo na hora 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 será fornecida, 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 de 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. Por isso, um cookie expirado será ignorado mesmo se ele for passado para o servidor depois que o navegador o tiver limpo.

Isso é separado do valor de , que especifica por quanto tempo Expires o navegador manterá o cookie.

ForwardAuthenticate

Se definido, 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, 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 para o por padrão. A lógica de encaminhamento padrão verificará a configuração mais específica de ForwardAuthenticate/desafio/proibir/entrada/saída primeiro, seguida de verificar o ForwardDefaultSelector, seguido 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 à 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á a configuração mais específica de ForwardAuthenticate/desafio/proibir/entrada/saída primeiro, seguida de verificar o ForwardDefaultSelector, seguido 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, especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas 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, 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, 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 manipular ChallengeAsync. A URL atual que é adicionada ao LoginPath como um parâmetro de cadeia de caracteres de consulta chamado 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 original.

LogoutPath

Se o LogoutPath for fornecido ao 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 é anexado 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 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

A SlidingExpiration é definida como true para instruir o manipulador a emitir um novo cookie com um novo tempo de expiração sempre que ele processa uma solicitação que está mais do que na 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 .

Métodos

Validate()

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

(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