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 |
Vlastnost AccessDeniedPath používá obslužná rutina pro cíl přesměrování při zpracování ForbidAsync. |
ClaimsIssuer |
Získá nebo nastaví vystavitele, který by se měl 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. |
CookieDomain |
Zastaralé.
Tato vlastnost je zastaralá a v budoucí verzi se odebere. 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 v budoucí verzi se odebere. 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 true, což znamená, že soubor cookie se bude předávat pouze požadavkům HTTP a nebude k dispozici pro skripty 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 |
Zastaralé.
Zastaralé.
Tato vlastnost je zastaralá a v budoucí verzi se odebere. Doporučená alternativa je na Cookie. Určuje název souboru cookie použitý 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 pokud váš systém používá obslužnou rutinu ověřování souborů cookie vícekrát. |
CookiePath |
Zastaralé.
Tato vlastnost je zastaralá a v budoucí verzi se odebere. Doporučená alternativa je na Cookie. Určuje cestu použitou k vytvoření souboru cookie. Výchozí hodnota je "/" pro nejvyšší kompatibilitu prohlížeče. |
CookieSecure |
Zastaralé.
Tato vlastnost je zastaralá a v budoucí verzi se odebere. Doporučená alternativa je na Cookie. Určuje, jestli se má soubor cookie přenášet jenom na žádost HTTPS. Výchozí nastavení je omezit soubor cookie 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 vašeho webu jsou HTTP, možná budete muset tuto hodnotu změnit. |
DataProtectionProvider |
Pokud je tato možnost nastavená, použije cookieAuthenticationHandler k ochraně dat. |
Events |
Zprostředkovatel může být přiřazen k instanci objektu vytvořeného aplikací při spuštění. Obslužná rutina volá metody na zprostředkovateli, 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á nedělá nic při zavolání metod. |
EventsType |
Pokud je nastaveno, použije se jako typ služby k získání instance Events místo vlastnosti. (Zděděno od AuthenticationSchemeOptions) |
ExpireTimeSpan |
Určuje, po jakou dobu zůstane ověřovací lístek uložený v souboru cookie platný od okamžiku vytvoření. Informace o vypršení platnosti se ukládají do lístku chráněného souboru cookie. Z tohoto důvodu bude soubor cookie s vypršenou platností ignorován, i když se předá serveru poté, co ho měl prohlížeč vymazat. 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, do kterého by mělo toto schéma směrovat volání AuthenticateAsync. Například Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions) |
ForwardChallenge |
Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovávat volání ChallengeAsync. Například Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions) |
ForwardDefault |
Pokud je tato možnost nastavená, určuje výchozí schéma, do kterého by měly obslužné rutiny ověřování ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika přesměrování nejprve zkontroluje nastavení ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut a potom zkontroluje ForwardDefaultSelector a pak ForwardDefault. První výsledek, který není null, se použije jako cílové schéma, do které se má předat. (Zděděno od AuthenticationSchemeOptions) |
ForwardDefaultSelector |
Slouží k výběru výchozího schématu pro aktuální požadavek, do kterého by měly obslužné rutiny ověřování ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika přesměrování nejprve zkontroluje nastavení ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut a potom zkontroluje ForwardDefaultSelector a pak ForwardDefault. První výsledek, který není null, se použije jako cílové schéma, do které se má předat. (Zděděno od AuthenticationSchemeOptions) |
ForwardForbid |
Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovávat volání ForbidAsync. Například Context.ForbidAsync("ThisScheme") => Context.Forbidasync("ForwardForbidValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions) |
ForwardSignIn |
Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by mělo toto schéma směrovat volání SignInAsync. Například Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions) |
ForwardSignOut |
Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovávat volání SignOutAsync. Například Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (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, která je přidána 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 původní adresu URL. |
LogoutPath |
Pokud logoutPath je k dispozici obslužná rutina pak požadavek na danou cestu bude přesměrován 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 dorazí na cestu přihlášení nebo cestu k 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 velkými identitami. |
SlidingExpiration |
Vlastnost SlidingExpiration je nastavená na hodnotu true, aby obslužná rutina pokyn, aby 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. |
TicketDataFormat |
TicketDataFormat slouží k ochraně a zrušení ochrany identity a dalších vlastností, které jsou uloženy v hodnotě souboru cookie. Pokud ho nezadáte, vytvoří se pomocí DataProtectionProvider. |
TimeProvider |
Používá se k testování. (Zděděno od AuthenticationSchemeOptions) |
Metody
Validate() |
Zkontrolujte, jestli jsou možnosti platné. Pokud to není v pořádku, měl 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) |