CookieAuthenticationOptions Třída

Definice

Obor názvů:

Microsoft.AspNetCore.Builder

Sestavení:

Microsoft.AspNetCore.Authentication.Cookies.dll

Balíček:

Microsoft.AspNetCore.Authentication.Cookies v1.1.0

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

Object

AuthenticationOptions

CookieAuthenticationOptions

Implementuje

IOptions<CookieAuthenticationOptions>

Konstruktory

CookieAuthenticationOptions()

Vytvoření instance možností inicializovaných s výchozími hodnotami

Vlastnosti

AccessDeniedPath	Vlastnost AccessDeniedPath informuje middleware, že by měl změnit odchozí stavový kód 403 Zakázáno na přesměrování 302 na danou cestu.
AuthenticationScheme	Parametr AuthenticationScheme v možnostech odpovídá logickému názvu pro konkrétní schéma ověřování. Pokud chcete v kanálu používat stejný typ middlewaru ověřování více než jednou, můžete přiřadit jinou hodnotu. (Zděděno od AuthenticationOptions)
AutomaticAuthenticate	Pokud je hodnota true, middleware ověřování změní požadavek přicházejícího uživatele. Pokud je hodnota false, middleware ověřování poskytne identitu jenom v případě, že to explicitně indikuje AuthenticationScheme. (Zděděno od AuthenticationOptions)
AutomaticChallenge	Pokud je hodnota true, měl by ověřovací middleware zpracovat automatické výzvy. Pokud je hodnota false, middleware ověřování změní odpovědi pouze v případě, že to explicitně označí AuthenticationScheme. (Zděděno od AuthenticationOptions)
ClaimsIssuer	Získá nebo nastaví vystavitele, který by se měl 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. Ve výchozím nastavení není k dispozici.
CookieHttpOnly	Určuje, jestli má prohlížeč povolit přístup k souboru cookie pomocí javascriptu na straně klienta. Výchozí hodnota je true, což znamená, že soubor cookie se bude předávat pouze požadavkům HTTP a není k dispozici skriptům na stránce.
CookieManager	Komponenta použitá k získání souborů cookie z požadavku nebo k jejich nastavení v odpovědi. Ve výchozím nastavení se použije chunkingCookieManager.
CookieName	Určuje název souboru cookie použitý k zachová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 pokud váš systém používá middleware ověřování souborů cookie vícekrá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ášet pouze při požadavku HTTPS. Ve výchozím nastavení se soubor cookie omezí na požadavky HTTPS, pokud stránka, která provádí přihlášení, je také HTTPS. Pokud máte přihlašovací stránku HTTPS a části webu jsou HTTP, možná budete muset tuto hodnotu změnit.
DataProtectionProvider	Pokud je toto nastavení nastaveno, použije cookieAuthenticationMiddleware pro ochranu dat.
Description	Další informace o typu ověřování, který je k dispozici pro aplikaci. (Zděděno od AuthenticationOptions)
Events	Zprostředkovatel může být přiřazen instanci objektu vytvořeného aplikací při spuštění. Middleware volá metody u zprostředkovatele, které poskytují řízení aplikace v určitých bodech, kde probíhá zpracování. Pokud není k dispozici, je zadána výchozí instance, která při zavolání metod neprovede nic.
ExpireTimeSpan	Určuje, po jakou dobu bude soubor cookie platný od okamžiku, kdy je vytvořen. Informace o vypršení platnosti jsou v lístku chráněného souboru cookie. Z tohoto důvodu bude soubor cookie s vypršenou platností ignorován i v případě, že se předá serveru poté, co ho prohlížeč měl vymazat.
LoginPath	Vlastnost LoginPath informuje middleware, že by měl změnit odchozí stavový kód 401 Neautorizováno 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 SignIn, hodnota ReturnUrlParameter se použije k přesměrování prohlížeče zpět. na adresu URL, která způsobila původní neoprávněný stavový kód.
LogoutPath	Pokud je v middlewaru k dispozici logoutPath, požadavek na tuto cestu se přesměruje na základě parametru ReturnUrlParameter.
ReturnUrlParameter	ReturnUrlParameter určuje název parametru řetězce dotazu, který middleware připojí při změně stavového kódu 401 Neautorizováno na přesměrování 302 na přihlašovací cestu. Jedná se také o parametr řetězce dotazu, který se hledá, když požadavek přijde na přihlašovací cestu nebo cestu odhlášení, aby se po provedení akce vrátil na původní adresu URL.
SessionStore	Volitelný kontejner, ve kterém se má identita ukládat mezi požadavky. Při použití se klientovi odešle pouze identifikátor relace. Můžete ho použít ke zmírnění potenciálních problémů s velmi rozsáhlými identitami.
SlidingExpiration	SlidingExpiration je nastavená na hodnotu true, aby middleware při zpracování požadavku, který je více než v polovině okna vypršení platnosti, znovu vystavil nový soubor cookie s novým časem vypršení platnosti.
SystemClock	Pouze pro účely testování. (Zděděno od AuthenticationOptions)
TicketDataFormat	TicketDataFormat slouží k ochraně a zrušení ochrany identity a dalších vlastností, které jsou uložené v hodnotě souboru cookie. Pokud není k dispozici výchozí obslužná rutina dat je vytvořena pomocí služby ochrany dat obsažené v IApplicationBuilder.Properties. Výchozí služba ochrany dat je založena na klíči počítače při spuštění na ASP.NET a na rozhraní DPAPI, pokud se spouští v jiném procesu.

Explicitní implementace rozhraní

IOptions<CookieAuthenticationOptions>.Value

Možnosti konfigurace pro CookieAuthenticationMiddleware.