CookieAuthenticationOptions Třída

Definice

Možnosti konfigurace pro 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)
Dědičnost
CookieAuthenticationOptions
Implementuje

Konstruktory

CookieAuthenticationOptions()

Vytvoří instanci možností inicializovaných s výchozími hodnotami.

Vlastnosti

AccessDeniedPath

Vlastnost AccessDeniedPath informuje middleware, že by měl změnit stavový kód odchozího 403 zakázaného na přesměrování 302 na danou cestu.

AuthenticationScheme

AuthenticationScheme v možnostech odpovídá logickému názvu pro konkrétní schéma ověřování. Pro použití stejného typu middlewaru ověřování v kanálu je možné přiřadit jinou hodnotu.

(Zděděno od AuthenticationOptions)
AutomaticAuthenticate

Pokud je hodnota true, middleware ověřování změní požadavek, který uživatel přichází. Pokud je hodnota false, bude middleware ověřování poskytovat pouze identitu, je-li výslovně označena AuthenticationScheme.

(Zděděno od AuthenticationOptions)
AutomaticChallenge

Pokud má hodnotu true, musí middleware ověřování zpracovávat automatické výzvy. Pokud je hodnota false, bude middleware ověřování měnit pouze odpovědi, pokud jsou výslovně označeny AuthenticationScheme.

(Zděděno od AuthenticationOptions)
ClaimsIssuer

Získá nebo nastaví vystavitele, který se má použít pro všechny vytvořené deklarace identity.

(Zděděno od AuthenticationOptions)
CookieDomain

Určuje doménu použitou k vytvoření souboru cookie. Není ve výchozím nastavení k dispozici.

CookieHttpOnly

Určuje, jestli by měl prohlížeč umožňovat, aby se k souboru cookie přistupoval JavaScript na straně klienta. Výchozí hodnota je true (pravda), což znamená, že soubor cookie bude předán pouze do požadavků HTTP a nebude zpřístupněn skriptu na stránce.

CookieManager

Komponenta, která se používá k získání souborů cookie z požadavku nebo jejich nastavení na reakci.

         Ve výchozím nastavení se použije ChunkingCookieManager.
CookieName

Určuje název souboru cookie, který se použije k uchování identity. Výchozí hodnota je ". AspNetCore. cookies ". Tato hodnota by se měla změnit, pokud změníte název AuthenticationScheme, zejména v případě, že váš systém používá middleware pro ověřování souborů cookie víckrát.

CookiePath

Určuje cestu použitou k vytvoření souboru cookie. Výchozí hodnota je "/" pro nejvyšší kompatibilitu prohlížeče.

CookieSecure

Určuje, jestli se má soubor cookie přenést jenom na žádost HTTPS. Ve výchozím nastavení se soubor cookie omezí na požadavky HTTPS, pokud je stránka, která provádí přihlášení, také HTTPS. Pokud máte přihlašovací stránku HTTPS a části vaší lokality jsou HTTP, možná budete muset tuto hodnotu změnit.

DataProtectionProvider

Pokud tuto hodnotu nastavíte, použije CookieAuthenticationMiddleware k ochraně dat.

Description

Další informace o typu ověřování, který je zpřístupněn pro aplikaci.

(Zděděno od AuthenticationOptions)
Events

Poskytovatel může být přiřazen k instanci objektu vytvořeného aplikací v době spuštění. Middleware volá metody pro poskytovatele, které poskytují řízení aplikace v určitých bodech, kde dochází ke zpracování. Není-li zadána výchozí instance, která neprovádí žádnou akci při volání metod.

ExpireTimeSpan

Určuje, jak dlouho zůstane soubor cookie platný od okamžiku jeho vytvoření. Informace o vypršení platnosti jsou v lístku Protected cookie. Vzhledem k tomu, že se soubor cookie s vypršenou platností bude ignorovat i v případě, že se předává na server, i když by ho měl vyprázdnit prohlížeč

LoginPath

Vlastnost LoginPath informuje middleware, že by měl změnit odchozí kód stavu 401 neautorizovaný na přesměrování 302 na danou přihlašovací cestu. Aktuální adresa URL, která vygenerovala 401, se přidá do LoginPath jako parametr řetězce dotazu s názvem ReturnUrlParameter. Jakmile požadavek na LoginPath udělí novou identitu pro přihlášení, použije se pro přesměrování prohlížeče hodnota ReturnUrlParameter.
na adresu URL, která způsobila původní neautorizovaný kód stavu.

LogoutPath

Pokud je LogoutPath k dispozici middleware, požadavek na tuto cestu se přesměruje na základě ReturnUrlParameter.

ReturnUrlParameter

ReturnUrlParameter Určuje název parametru řetězce dotazu, který je připojen middlewarem v případě, že se stavový kód 401 neoprávněně změní na hodnotu 302 přesměrování na přihlašovací cestu. To je také parametr řetězce dotazu, který se vyhledal, když žádost dorazí na přihlašovací cestu nebo cestu odhlášení, aby se po provedení akce vrátila na původní adresu URL.

SessionStore

Volitelný kontejner, ve kterém se má identita ukládat napříč požadavky. Při použití se klientovi pošle jenom identifikátor relace. To se dá využít ke zmírnění potenciálních problémů s velmi velkým objemem identit.

SlidingExpiration

Vlastnost parametr SlidingExpiration je nastavená na hodnotu true, aby middleware požádala o opětovné vydání nového souboru cookie s novým časem vypršení platnosti, kdykoli zpracuje požadavek, který je více než uprostřed okna vypršení platnosti.

SystemClock

Pouze pro účely testování.

SystemClock

Pouze pro účely testování.

(Zděděno od AuthenticationOptions)
TicketDataFormat

TicketDataFormat se používá k ochraně a odochraně identity a dalších vlastností, které jsou uložené v hodnotě souboru cookie. Pokud není k dispozici, je vytvořena výchozí obslužná rutina dat, která je obsažena ve službě ochrany dat obsažené v IApplicationBuilder. Properties. Výchozí služba ochrany dat je založená na klíči počítače při spuštění v ASP.NET a na DPAPI při spuštění v jiném procesu.

Explicitní implementace rozhraní

IOptions<CookieAuthenticationOptions>.Value

Platí pro