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
| Name | Description |
|---|---|
| CookieAuthenticationOptions() |
Vytvoření instance možností inicializovaných s výchozími hodnotami |
Vlastnosti
| Name | Description |
|---|---|
| AccessDeniedPath |
AccessDeniedPath vlastnost je používán obslužnou rutinou 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 bude odebrána v budoucí verzi. Doporučená alternativa je <seealso cref="P:Microsoft. AspNetCore.Http.CookieBuilder.Domain"></seealso> 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 <seealso cref="P:Microsoft. AspNetCore.Http.CookieBuilder.HttpOnly"></seealso> 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 předá pouze požadavkům HTTP a není zpřístupněn skriptům na stránce. |
| CookieManager |
Komponenta použitá k získání souborů cookie z požadavku nebo jejich nastavení v odpovědi. Ve výchozím nastavení se bude používat chunkingCookieManager. |
| CookieName |
Zastaralé.
Zastaralé.
Tato vlastnost je zastaralá a bude odebrána v budoucí verzi. Doporučená alternativa je <seealso cref="P:Microsoft. AspNetCore.Http.CookieBuilder.Name"></seealso> 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 vícekrát. |
| CookiePath |
Zastaralé.
Tato vlastnost je zastaralá a bude odebrána v budoucí verzi. Doporučená alternativa je <seealso cref="P:Microsoft. AspNetCore.Http.CookieBuilder.Path"></seealso> 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 bude odebrána v budoucí verzi. Doporučená alternativa je <seealso cref="P:Microsoft. AspNetCore.Http.CookieBuilder.SecurePolicy"></seealso> na Cookie. Určuje, jestli se má soubor cookie přenášet pouze na žádost HTTPS. Výchozí hodnota 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 webu jsou HTTP, možná budete muset tuto hodnotu změnit. |
| DataProtectionProvider |
Pokud tuto možnost nastavíte, bude ji používat rutina CookieAuthenticationHandler pro ochranu 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 zprostředkovatele, které poskytují řízení aplikace v určitých bodech, kde probíhá zpracování. Pokud není zadána výchozí instance je zadána, což 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 jsou uloženy v chráněném lístku cookie. Z důvodu toho, že soubor cookie s vypršenou platností bude ignorován, i když se předá na server poté, co by ho prohlížeč měl vyprázdnit. Tato vlastnost by měla být použita místo Expiration, která je ignorována. |
| ForwardAuthenticate |
Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovat volání AuthenticateAsync. Například Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Nastavte cíl na aktuální schéma a zakažte přesměrová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, do kterého by toto schéma mělo přesměrovat volání ChallengeAsync. Příklad Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Nastavte cíl na aktuální schéma a zakažte přesměrová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 forwardDefaultSelector. První výsledek, který není null, se použije jako cílové schéma pro předávání. (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 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 forwardDefaultSelector. První výsledek, který není null, se použije jako cílové schéma pro předávání. (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ěrovat volání ForbidAsync. Například Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Nastavte cíl na aktuální schéma a zakažte přesměrová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, do kterého by toto schéma mělo přesměrovat volání SignInAsync. Například Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Nastavte cíl na aktuální schéma a zakažte přesměrování a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| ForwardSignOut |
Pokud je toto nastavení nastavené, určuje cílové schéma, do kterého by toto schéma mělo přesměrovat volání SignOutAsync. Například Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Nastavte cíl na aktuální schéma a zakažte přesměrová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, 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 je obslužná rutina zadána logoutPath, 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 obslužnou rutinou během výzvy. Jedná se také o parametr řetězce dotazu, který se hledá, když požadavek dorazí na přihlašovací cestu nebo cestu 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 rozsáhlými identitami. |
| SlidingExpiration |
SlidingExpiration je nastavena na hodnotu true, která obslužné rutině dává pokyn, aby znovu vydal nový soubor cookie s novou dobou vypršení platnosti pokaždé, když zpracuje požadavek, který je více než polovina okna 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 není k dispozici, vytvoří se pomocí DataProtectionProvider. |
| TimeProvider |
Používá se k testování. (Zděděno od AuthenticationSchemeOptions) |
Metody
| Name | Description |
|---|---|
| Validate() |
Zkontrolujte, jestli jsou možnosti platné. Pokud věci nejsou v pořádku, měla by vyvolat výjimku. (Zděděno od AuthenticationSchemeOptions) |
| Validate(String) |
Kontroluje, jestli jsou možnosti platné pro určité schéma. (Zděděno od AuthenticationSchemeOptions) |