CookieAuthenticationOptions Klasse

Definition

Namespace:

Microsoft.AspNetCore.Builder

Assembly:

Microsoft.AspNetCore.Authentication.Cookies.dll

Paket:

Microsoft.AspNetCore.Authentication.Cookies v1.1.0

Konfigurationsoptionen für 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)

Vererbung

Object

AuthenticationOptions

CookieAuthenticationOptions

Implementiert

IOptions<CookieAuthenticationOptions>

Konstruktoren

CookieAuthenticationOptions()

Erstellt eine Instanz der Optionen, die mit den Standardwerten initialisiert werden.

Eigenschaften

AccessDeniedPath	Die AccessDeniedPath-Eigenschaft informiert die Middleware darüber, dass sie einen ausgehenden 403 Forbidden status-Code in eine 302-Umleitung auf den angegebenen Pfad ändern soll.
AuthenticationScheme	Die AuthenticationScheme in den Optionen entspricht dem logischen Namen für ein bestimmtes Authentifizierungsschema. Es kann ein anderer Wert zugewiesen werden, um den gleichen Authentifizierungsmiddlewaretyp mehrmals in einer Pipeline zu verwenden. (Geerbt von AuthenticationOptions)
AutomaticAuthenticate	Wenn true, ändert die Authentifizierungs-Middleware den anforderungsbenutzer, der eingeht. Bei "false" gibt die Authentifizierungs-Middleware nur dann Identität an, wenn sie von AuthenticationScheme explizit angegeben wird. (Geerbt von AuthenticationOptions)
AutomaticChallenge	Wenn true, sollte die Middleware für die Authentifizierung automatische Herausforderungen verarbeiten. Bei "false" ändert die Authentifizierungs-Middleware antworten nur, wenn sie von AuthenticationScheme explizit angegeben werden. (Geerbt von AuthenticationOptions)
ClaimsIssuer	Ruft den Aussteller ab, der für alle ansprüche verwendet werden soll, die erstellt werden sollen, oder legt diesen fest. (Geerbt von AuthenticationOptions)
CookieDomain	Bestimmt die Domäne, mit der ein Cookie erstellt wurde. Wird nicht standardmäßig bereitgestellt.
CookieHttpOnly	Bestimmt, ob der Browser den Zugriff auf das Cookie durch clientseitiges JavaScript erlauben soll. Der Standardwert ist true. Dies bedeutet, dass das Cookie nur an HTTP-Anforderungen übergeben und nicht für das Skript auf der Seite bereitgestellt wird.
CookieManager	Die Komponente, die zum Abrufen von Cookies aus der Anforderung oder oder zum Festlegen von Cookies für die Antwort verwendet wird. ChunkingCookieManager wird standardmäßig verwendet.
CookieName	Bestimmt den Cookienamen, der zum dauerhaften Speichern der Identität verwendet wird. Der Standardwert ist ". AspNetCore.Cookies". Dieser Wert sollte geändert werden, wenn Sie den Namen von AuthenticationScheme ändern, insbesondere wenn Ihr System die Middleware für die Cookieauthentifizierung mehrmals verwendet.
CookiePath	Bestimmt den Pfad, mit dem ein Cookie erstellt wurde. Der Standardwert ist "/" für höchste Browserkompatibilität.
CookieSecure	Bestimmt, ob das Cookie nur bei einer HTTPS-Anforderung übertragen werden soll. Die Standardeinstellung besteht im Einschränken des Cookies auf HTTPS-Anforderungen, wenn die Seite, die den SignIn-Vorgang ausführt, ebenfalls HTTPS verwendet. Wenn Sie eine HTTPS-Anmeldeseite verwenden, und Teile Ihrer Website verwenden HTTP, müssen Sie diesen Wert ggf. ändern.
DataProtectionProvider	Wenn festgelegt, wird dies von der CookieAuthenticationMiddleware für den Datenschutz verwendet.
Description	Zusätzliche Informationen zum Authentifizierungstyp, die der Anwendung zur Verfügung gestellt werden. (Geerbt von AuthenticationOptions)
Events	Der Anbieter kann einer Instanz eines Objekts zugewiesen werden, das von der Anwendung zum Startzeitpunkt erstellt wurde. Die Middleware ruft Methoden für den Anbieter auf, die der Anwendung die Steuerung an bestimmten Stellen geben, an denen die Verarbeitung stattfindet. Wenn diese Option nicht angegeben wird, wird eine Standardinstanz bereitgestellt, die keine Aktionen ausführt, wenn die Methoden aufgerufen werden.
ExpireTimeSpan	Steuert, wie lange das Cookie ab dem Zeitpunkt seiner Erstellung gültig bleibt. Die Ablaufinformationen befinden sich im geschützten Cookieticket. Aus diesem Grund wird ein abgelaufenes Cookie selbst dann ignoriert, wenn es an den Server übergeben wird, nachdem der Browser es bereinigt haben sollte.
LoginPath	Die Eigenschaft LoginPath informiert die Middleware, dass sie einen ausgehenden Statuscode 401 Nicht autorisiert in eine 302-Umleitung in den angegebenen Anmeldepfad ändern sollte. Die aktuelle URL, die den Statuscode 401 generiert hat, wird LoginPath als ein Abfragezeichenfolgen-Parameter hinzugefügt, die durch ReturnUrlParameter benannt wird. Sobald eine Anforderung an den LoginPath eine neue SignIn-Identität gewährt, wird der ReturnUrlParameter-Wert verwendet, um den Browser zurückzuleiten. an die URL, die den ursprünglichen nicht autorisierten status Code verursacht hat.
LogoutPath	Wenn LogoutPath für die Middleware bereitgestellt wird, wird eine Anforderung an diesen Pfad basierend auf ReturnUrlParameter umgeleitet.
ReturnUrlParameter	ReturnUrlParameter bestimmt den Namen des Abfragezeichenfolgen-Parameters, der von der Middleware angefügt wird, wenn ein Statuscode 401 Nicht autorisiert in eine 302-Umleitung für den Anmeldepfad geändert wird. Dabei handelt es sich auch um den Abfragezeichenfolgen-Parameter, nach dem gesucht wird, wenn eine Anforderung für den Anmelde- oder Abmeldepfad eingeht, damit die ursprüngliche URL nach dem Ausführen der Aktion zurückgegeben wird.
SessionStore	Ein optionaler Container, in dem die Identität anforderungsübergreifend gespeichert werden soll. Wird dieser verwendet, wird nur ein Sitzungsbezeichner an den Client gesendet. Dies kann zum Verringern potenzieller Probleme mit sehr großen Identitäten verwendet werden.
SlidingExpiration	SlidingExpiration wird auf true festgelegt, um die Middleware anzuweisen, ein neues Cookie mit einer neuen Ablaufzeit bei jeder Verarbeitung einer Anforderung erneut auszustellen, die das Ablauffenster mehr als zur Hälfte durchlaufen hat.
SystemClock	Nur zu Testzwecken. (Geerbt von AuthenticationOptions)
TicketDataFormat	TicketDataFormat wird zum Schützen und Aufheben des Schutzes der Identität und anderer Eigenschaften verwendet, die im Cookiewert gespeichert werden. Wenn er nicht bereitgestellt wird, wird ein Standarddatenhandler mithilfe des in IApplicationBuilder.Properties enthaltenen Datenschutzdiensts erstellt. Der Datenschutz-Standarddienst basiert auf dem Computerschlüssel, wenn die Ausführung unter ASP.NET erfolgt, und auf DPAPI, wenn die Ausführung in einem anderen Prozess erfolgt.

Explizite Schnittstellenimplementierungen

IOptions<CookieAuthenticationOptions>.Value

Konfigurationsoptionen für CookieAuthenticationMiddleware.