CookieAuthenticationOptions Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Opcje konfiguracji dla elementu 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)- Dziedziczenie
- Implementuje
Konstruktory
| CookieAuthenticationOptions() |
Tworzenie wystąpienia opcji zainicjowanych przy użyciu wartości domyślnych |
Właściwości
| AccessDeniedPath |
Właściwość AccessDeniedPath informuje oprogramowanie pośredniczące, że powinno zmienić wychodzący kod stanu 403 Zabronione na przekierowanie 302 na daną ścieżkę. |
| AuthenticationScheme |
Element AuthenticationScheme w opcjach odpowiada nazwie logicznej dla określonego schematu uwierzytelniania. Inną wartość można przypisać, aby używać tego samego typu oprogramowania pośredniczącego uwierzytelniania więcej niż raz w potoku. (Odziedziczone po AuthenticationOptions) |
| AutomaticAuthenticate |
Jeśli ma wartość true, oprogramowanie pośredniczące uwierzytelniania zmienia przychodzącego użytkownika żądania. Jeśli fałsz oprogramowania pośredniczącego uwierzytelniania będzie dostarczać tożsamość tylko wtedy, gdy jest jawnie wskazane przez AuthenticationScheme. (Odziedziczone po AuthenticationOptions) |
| AutomaticChallenge |
Jeśli ma wartość true, oprogramowanie pośredniczące uwierzytelniania powinno obsługiwać automatyczne wyzwanie. Jeśli fałsz oprogramowanie pośredniczące uwierzytelniania zmieni odpowiedzi tylko wtedy, gdy jest jawnie wskazane przez authenticationScheme. (Odziedziczone po AuthenticationOptions) |
| ClaimsIssuer |
Pobiera lub ustawia wystawcę, który powinien być używany dla wszelkich utworzonych oświadczeń (Odziedziczone po AuthenticationOptions) |
| CookieDomain |
Określa domenę używaną do tworzenia pliku cookie. Nie jest domyślnie udostępniany. |
| CookieHttpOnly |
Określa, czy przeglądarka powinna zezwolić na dostęp do pliku cookie za pomocą skryptu javascript po stronie klienta. Wartość domyślna to prawda, 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 domyślnie używany. |
| CookieName |
Określa nazwę pliku cookie używaną do utrwalania tożsamości. Wartość domyślna to ". AspNetCore.Cookies". Ta wartość powinna zostać zmieniona, jeśli zmienisz nazwę elementu AuthenticationScheme, zwłaszcza jeśli system używa oprogramowania pośredniczącego uwierzytelniania plików cookie wiele razy. |
| CookiePath |
Określa ścieżkę używaną do utworzenia pliku cookie. Wartość domyślna to "/" w celu zapewnienia najwyższej zgodności przeglądarki. |
| CookieSecure |
Określa, czy plik cookie powinien być przesyłany tylko na żądanie HTTPS. Ustawieniem domyślnym jest ograniczenie plików cookie do żądań HTTPS, jeśli strona wykonująca polecenie SignIn 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 to ustawienie zostanie ustawione, zostanie użyte przez plik CookieAuthenticationMiddleware na potrzeby ochrony danych. |
| Description |
Dodatkowe informacje o typie uwierzytelniania, który jest udostępniany aplikacji. (Odziedziczone po AuthenticationOptions) |
| Events |
Dostawca może być przypisany do wystąpienia obiektu utworzonego przez aplikację w czasie uruchamiania. Oprogramowanie pośredniczące 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, które nie wykonuje niczego, gdy metody są wywoływane. |
| ExpireTimeSpan |
Określa, ile czasu plik cookie pozostanie prawidłowy od momentu jego utworzenia. Informacje o wygaśnięciu są 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 jego przeczyszczonej przeglądarce |
| LoginPath |
Właściwość LoginPath informuje oprogramowanie pośredniczące, że powinno zmienić wychodzący kod stanu 401 Brak autoryzacji do przekierowania 302 na daną ścieżkę logowania. Bieżący adres URL, który wygenerował parametr 401, jest dodawany do elementu LoginPath jako parametr ciągu zapytania o nazwie ReturnUrlParameter. Gdy żądanie do ścieżki LoginPath udzieli nowej tożsamości SignIn, wartość ReturnUrlParameter jest używana do przekierowania przeglądarki z powrotem |
| LogoutPath |
Jeśli element LogoutPath jest dostarczany oprogramowanie pośredniczące, żą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 oprogramowanie pośredniczące, gdy kod stanu 401 Nieautoryzowany jest zmieniany na przekierowanie 302 do ścieżki logowania. Jest to również parametr ciągu zapytania wyszukiwany po nadejściu żądania na ścieżce logowania lub ścieżce 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żymi tożsamościami. |
| SlidingExpiration |
Ustawienie SlidingExpiration ma wartość true, aby poinstruować oprogramowanie pośredniczące, aby ponownie wydać nowy plik cookie z nowym czasem wygaśnięcia w dowolnym momencie przetwarzania żądania, które jest ponad w połowie okna wygasania. |
| SystemClock |
Tylko do celów testowych. |
| SystemClock |
Tylko do celów testowych. (Odziedziczone po AuthenticationOptions) |
| TicketDataFormat |
Funkcja TicketDataFormat służy do ochrony i wyrejechowania tożsamości oraz innych właściwości przechowywanych w wartości pliku cookie. Jeśli nie podano domyślnej procedury obsługi danych jest tworzona przy użyciu usługi ochrony danych zawartej w pliku IApplicationBuilder.Properties. Domyślna usługa ochrony danych jest oparta na kluczu komputera podczas uruchamiania na ASP.NET i w interfejsie DPAPI podczas uruchamiania w innym procesie. |
Jawne implementacje interfejsu
| IOptions<CookieAuthenticationOptions>.Value |
Opcje konfiguracji dla elementu CookieAuthenticationMiddleware. |