CookieAuthenticationOptions Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Možnosti konfigurace pro 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
- Dědičnost
Konstruktory
| CookieAuthenticationOptions() |
Vytvoření instance možností inicializovaných s výchozími hodnotami |
Vlastnosti
| AccessDeniedPath |
AccessDeniedPath vlastnost používá obslužná rutina pro cíl přesměrování při zpracování ForbidAsync. |
| ClaimsIssuer |
Získá nebo nastaví vystavitele, který se má použít pro všechny vytvořené deklarace identity. (Zděděno od AuthenticationSchemeOptions) |
| Cookie |
Určuje nastavení použitá k vytvoření souboru cookie.
SameSitevýchozí hodnota je .Lax
HttpOnly výchozí hodnota |
| CookieDomain |
Zastaralé.
Tato vlastnost je zastaralá a bude odebrána v budoucí verzi. Doporučená alternativa je na Cookie. Určuje doménu použitou k vytvoření souboru cookie. Ve výchozím nastavení není k dispozici. |
| CookieHttpOnly |
Zastaralé.
Zastaralé.
Tato vlastnost je zastaralá a bude odebrána v budoucí verzi. Doporučená alternativa je na Cookie. Určuje, jestli má prohlížeč povolit přístup k souboru cookie pomocí javascriptu na straně klienta. Výchozí hodnota je pravdivá, což znamená, že soubor cookie se předá 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 jejich nastavení v odpovědi.
|
| CookieName |
Zastaralé.
Zastaralé.
Tato vlastnost je zastaralá a bude odebrána v budoucí verzi. Doporučená alternativa je na Cookie. 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á obslužnou rutinu ověřování cookie několikrát. |
| CookiePath |
Zastaralé.
Tato vlastnost je zastaralá a bude odebrána v budoucí verzi. Doporučená alternativa je na Cookie. Určuje cestu použitou k vytvoření souboru cookie. Výchozí hodnota je "/" pro zajištění nejvyšší kompatibility prohlížeče. |
| CookieSecure |
Zastaralé.
Tato vlastnost je zastaralá a bude odebrána v budoucí verzi. Doporučená alternativa je na Cookie. Určuje, jestli by se soubor cookie měl přenášet jenom na žádost HTTPS. Výchozí nastavení je omezit soubor cookie na požadavky HTTPS, pokud stránka, která provádí signIn, 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 tuto možnost nastavíte, použije obslužná rutina cookieAuthenticationHandler pro ochranu dat. |
| Events |
Poskytovatel může být přiřazen k instanci objektu vytvořeného aplikací při spuštění. Obslužná rutina volá metody poskytovatele, které poskytují řízení aplikace v určitých bodech, kde probíhá zpracování. Pokud není zadána výchozí instance je zadána, která nic nedělá, když jsou volána metody. |
| EventsType |
Pokud je nastavena, použije se jako typ služby k získání instance Events místo vlastnosti. (Zděděno od AuthenticationSchemeOptions) |
| ExpireTimeSpan |
Určuje, kolik času ověřovací lístek uložený v souboru cookie zůstane platný od okamžiku, kdy se vytvoří, informace o vypršení platnosti se ukládají do chráněného lístku cookie. Vzhledem k tomu, že soubor cookie s vypršenou platností bude ignorován i v případě, že se předá serveru po jeho vymazání prohlížeče. To je oddělené od hodnoty Expires, která určuje, jak dlouho bude prohlížeč uchovávat soubor cookie. |
| ForwardAuthenticate |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání AuthenticateAsync. Například Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| ForwardChallenge |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání ChallengeAsync. Například Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| ForwardDefault |
Pokud je tato možnost nastavená, určuje výchozí schéma, do kterého by obslužné rutiny ověřování měly ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika předávání nejprve zkontroluje nejsměrnější nastavení ForwardAuthenticate,Challenge/Forbid/SignIn/SignOut a pak zkontroluje ForwardDefaultSelector a pak forwardDefault. První výsledek, který není null, se použije jako cílové schéma, na které se má přeposlat. (Zděděno od AuthenticationSchemeOptions) |
| ForwardDefaultSelector |
Používá se k výběru výchozího schématu pro aktuální požadavek, do kterého by obslužné rutiny ověřování měly ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika předávání nejprve zkontroluje nejsměrnější nastavení ForwardAuthenticate,Challenge/Forbid/SignIn/SignOut a pak zkontroluje ForwardDefaultSelector a pak forwardDefault. První výsledek, který není null, se použije jako cílové schéma, na které se má přeposlat. (Zděděno od AuthenticationSchemeOptions) |
| ForwardForbid |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání ForbidAsync. Například Context.ForbidAsync("ThisScheme") => Context.Forbidasync("ForwardForbidValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| ForwardSignIn |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání SignInAsync. Například Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| ForwardSignOut |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání SignOutAsync. Například Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| LoginPath |
Vlastnost LoginPath používá obslužná rutina pro cíl přesměrování při zpracování ChallengeAsync. Aktuální adresa URL přidaná do LoginPathu jako parametr řetězce dotazu s názvem ReturnUrlParameter. Jakmile požadavek na LoginPath udělí novou identitu SignIn, použije se hodnota ReturnUrlParameter k přesměrování prohlížeče zpět na původní adresu URL. |
| LogoutPath |
Pokud je obslužná rutina poskytnutá logoutPath, požadavek na danou cestu se přesměruje na základě ReturnUrlParameter. |
| ReturnUrlParameter |
ReturnUrlParameter určuje název parametru řetězce dotazu, který je připojen obslužnou rutinou během výzvy. Jedná se také o parametr řetězce dotazu, který se hledá, když požadavek přijde na cestu přihlášení nebo cestu k odhlášení, aby se po provedení akce vrátil k původní adrese URL. |
| SessionStore |
Volitelný kontejner, do kterého se má identita ukládat napříč požadavky. Při použití se klientovi odešle pouze identifikátor relace. Dá se použít ke zmírnění potenciálních problémů s velmi velkými identitami. |
| SlidingExpiration |
SlidingExpiration je nastavena na true, aby obslužné rutině dal pokyn k opětovnému vydání nového souboru cookie s novým časem vypršení platnosti pokaždé, když zpracuje požadavek, který je více než půl cesty v okně vypršení platnosti. |
| TicketDataFormat |
TicketDataFormat slouží k ochraně a zrušení ochrany identity a dalších vlastností, které jsou uloženy v hodnotě cookie. Pokud ho nezadáte, vytvoří se pomocí DataProtectionProvider. |
Metody
| Validate() |
Zkontrolujte, jestli jsou možnosti platné. Pokud nejsou věci v pořádku, měla by vyvolat výjimku. (Zděděno od AuthenticationSchemeOptions) |
| Validate(String) |
Zkontroluje, jestli jsou možnosti platné pro konkrétní schéma. (Zděděno od AuthenticationSchemeOptions) |