Udostępnij za pośrednictwem


CookieAuthenticationOptions Klasa

Definicja

Opcje konfiguracji dla programu 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
Dziedziczenie
CookieAuthenticationOptions

Konstruktory

CookieAuthenticationOptions()

Tworzenie wystąpienia opcji zainicjowanych przy użyciu wartości domyślnych

Właściwości

AccessDeniedPath

Właściwość AccessDeniedPath jest używana przez program obsługi obiektu docelowego przekierowania podczas obsługi forbidAsync.

ClaimsIssuer

Pobiera lub ustawia wystawcę, który ma być używany dla wszelkich utworzonych oświadczeń

(Odziedziczone po AuthenticationSchemeOptions)
Cookie

Określa ustawienia użyte do utworzenia pliku cookie.

CookieDomain
Przestarzałe.

Ta właściwość jest przestarzała i zostanie usunięta w przyszłej wersji. Zalecaną alternatywą jest wartość .Cookie

Określa domenę używaną do utworzenia pliku cookie. Nie jest udostępniany domyślnie.

CookieHttpOnly
Przestarzałe.
Przestarzałe.

Ta właściwość jest przestarzała i zostanie usunięta w przyszłej wersji. Zalecaną alternatywą jest wartość .Cookie

Określa, czy przeglądarka powinna zezwalać na dostęp do pliku cookie za pomocą języka JavaScript po stronie klienta. Wartość domyślna to true, co oznacza, że plik cookie będzie przekazywany tylko do żądań HTTP i nie jest dostępny dla skryptu na stronie.

CookieManager

Składnik używany do pobierania plików cookie z żądania lub ustawiania ich w odpowiedzi.

Element ChunkingCookieManager będzie używany domyślnie.

CookieName
Przestarzałe.
Przestarzałe.

Ta właściwość jest przestarzała i zostanie usunięta w przyszłej wersji. Zalecaną alternatywą jest wartość .Cookie

Określa nazwę pliku cookie używaną do utrwalania tożsamości. Wartość domyślna to ". AspNetCore.Cookies". Ta wartość powinna zostać zmieniona w przypadku zmiany nazwy schematu uwierzytelniania, zwłaszcza jeśli system używa programu obsługi uwierzytelniania plików cookie wiele razy.

CookiePath
Przestarzałe.

Ta właściwość jest przestarzała i zostanie usunięta w przyszłej wersji. Zalecaną alternatywą jest wartość .Cookie

Określa ścieżkę używaną do utworzenia pliku cookie. Wartość domyślna to "/" w celu zapewnienia najwyższej zgodności przeglądarki.

CookieSecure
Przestarzałe.

Ta właściwość jest przestarzała i zostanie usunięta w przyszłej wersji. Zalecaną alternatywą jest wartość .Cookie

Określa, czy plik cookie powinien być przesyłany tylko na żądanie HTTPS. Ustawieniem domyślnym jest ograniczenie pliku cookie do żądań HTTPS, jeśli strona wykonująca logowanie jest również https. Jeśli masz stronę logowania HTTPS i części witryny to HTTP, może być konieczne zmianę tej wartości.

DataProtectionProvider

Jeśli ustawisz tę opcję, będzie używana przez program CookieAuthenticationHandler na potrzeby ochrony danych.

Events

Dostawca może zostać przypisany do wystąpienia obiektu utworzonego przez aplikację w czasie uruchamiania. Procedura obsługi wywołuje metody u dostawcy, które zapewniają kontrolę aplikacji w określonych punktach, w których odbywa się przetwarzanie. Jeśli nie podano wystąpienia domyślnego, nic nie robi, gdy metody są wywoływane.

EventsType

Jeśli jest ustawiona, zostanie użyta jako typ usługi, aby pobrać wystąpienie Zdarzenia zamiast właściwości .

(Odziedziczone po AuthenticationSchemeOptions)
ExpireTimeSpan

Określa, ile czasu bilet uwierzytelniania przechowywany w pliku cookie pozostanie prawidłowy od momentu jego utworzenia. Informacje o wygaśnięciu są przechowywane w chronionym bilecie plików cookie. Ze względu na to wygasły plik cookie zostanie zignorowany, nawet jeśli zostanie przekazany do serwera po przeczyszczonej przeglądarce.

Jest to oddzielone od wartości Expires, która określa, jak długo przeglądarka będzie przechowywać plik cookie.

ForwardAuthenticate

W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania AuthenticateAsync. Na przykład Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie.

(Odziedziczone po AuthenticationSchemeOptions)
ForwardChallenge

W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania ChallengeAsync. Na przykład Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie.

(Odziedziczone po AuthenticationSchemeOptions)
ForwardDefault

W przypadku ustawienia określa domyślny schemat, do którego programy obsługi uwierzytelniania powinny domyślnie przekazywać wszystkie operacje uwierzytelniania. Domyślna logika przekazywania najpierw sprawdzi najbardziej konkretne ustawienie ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, a następnie sprawdź wartość ForwardDefaultSelector, a następnie pozycję ForwardDefaultSelector. Pierwszy wynik o wartości innej niż null będzie używany jako schemat docelowy do przekazywania dalej.

(Odziedziczone po AuthenticationSchemeOptions)
ForwardDefaultSelector

Służy do wybierania domyślnego schematu dla bieżącego żądania, do którego programy obsługi uwierzytelniania powinny domyślnie przekazywać wszystkie operacje uwierzytelniania. Domyślna logika przekazywania najpierw sprawdzi najbardziej konkretne ustawienie ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, a następnie sprawdź wartość ForwardDefaultSelector, a następnie pozycję ForwardDefaultSelector. Pierwszy wynik o wartości innej niż null będzie używany jako schemat docelowy do przekazywania dalej.

(Odziedziczone po AuthenticationSchemeOptions)
ForwardForbid

W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania ForbidAsync. Na przykład Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie.

(Odziedziczone po AuthenticationSchemeOptions)
ForwardSignIn

W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania SignInAsync. Na przykład Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie.

(Odziedziczone po AuthenticationSchemeOptions)
ForwardSignOut

W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania SignOutAsync. Na przykład Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie.

(Odziedziczone po AuthenticationSchemeOptions)
LoginPath

Właściwość LoginPath jest używana przez program obsługi obiektu docelowego przekierowania podczas obsługi narzędzia ChallengeAsync. Bieżący adres URL dodany do ścieżki LoginPath jako parametr ciągu zapytania o nazwie ReturnUrlParameter. Gdy żądanie do loginPath udzieli nowej tożsamości SignIn, wartość ReturnUrlParameter jest używana do przekierowywania przeglądarki z powrotem do oryginalnego adresu URL.

LogoutPath

Jeśli program obsługi jest dostarczany przez program obsługi, żądanie do tej ścieżki zostanie przekierowane na podstawie parametru ReturnUrlParameter.

ReturnUrlParameter

ReturnUrlParameter określa nazwę parametru ciągu zapytania, który jest dołączany przez program obsługi podczas wyzwania. Jest to również parametr ciągu zapytania wyszukiwany, gdy żądanie dociera do ścieżki logowania lub ścieżki wylogowywania, aby powrócić do oryginalnego adresu URL po wykonaniu akcji.

SessionStore

Opcjonalny kontener, w którym ma być przechowywana tożsamość między żądaniami. W przypadku użycia do klienta jest wysyłany tylko identyfikator sesji. Może to służyć do eliminowania potencjalnych problemów z bardzo dużą tożsamością.

SlidingExpiration

Funkcja SlidingExpiration jest ustawiona na wartość true, aby poinstruować program obsługi ponownego wystawienia nowego pliku cookie z nowym czasem wygaśnięcia w dowolnym momencie przetwarzania żądania, które jest ponad w połowie okna wygaśnięcia.

TicketDataFormat

Element TicketDataFormat służy do ochrony i wyrejechowania ochrony tożsamości oraz innych właściwości przechowywanych w wartości pliku cookie. Jeśli go nie podano, zostanie utworzony przy użyciu polecenia DataProtectionProvider.

TimeProvider

Służy do testowania.

(Odziedziczone po AuthenticationSchemeOptions)

Metody

Validate()

Sprawdź, czy opcje są prawidłowe. Jeśli elementy nie są prawidłowe, należy zgłosić wyjątek.

(Odziedziczone po AuthenticationSchemeOptions)
Validate(String)

Sprawdza, czy opcje są prawidłowe dla określonego schematu

(Odziedziczone po AuthenticationSchemeOptions)

Dotyczy