Freigeben über


CookieAuthenticationOptions Klasse

Definition

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

Konstruktoren

CookieAuthenticationOptions()

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

Eigenschaften

AccessDeniedPath

Die AccessDeniedPath-Eigenschaft wird vom Handler für das Umleitungsziel bei der Behandlung von ForbidAsync verwendet.

ClaimsIssuer

Ruft den Aussteller ab, der für alle erstellten Ansprüche verwendet werden soll, oder legt diesen fest.

(Geerbt von AuthenticationSchemeOptions)
Cookie

Bestimmt die Einstellungen, die zum Erstellen des Cookies verwendet wurden.

CookieDomain
Veraltet.

Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt. Die empfohlene Alternative ist auf Cookie.

Bestimmt die Domäne, mit der ein Cookie erstellt wurde. Wird nicht standardmäßig bereitgestellt.

CookieHttpOnly
Veraltet.
Veraltet.

Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt. Die empfohlene Alternative ist auf Cookie.

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
Veraltet.
Veraltet.

Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt. Die empfohlene Alternative ist auf Cookie.

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 den Cookieauthentifizierungshandler mehrmals verwendet.

CookiePath
Veraltet.

Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt. Die empfohlene Alternative ist auf Cookie.

Bestimmt den Pfad, mit dem ein Cookie erstellt wurde. Der Standardwert ist "/" für die höchste Browserkompatibilität.

CookieSecure
Veraltet.

Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt. Die empfohlene Alternative ist auf Cookie.

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 vom CookieAuthenticationHandler für den Datenschutz verwendet.

Events

Der Anbieter kann einer Instanz eines Objekts zugewiesen werden, das von der Anwendung zum Startzeitpunkt erstellt wurde. Der Handler ruft Methoden für den Anbieter auf, die der Anwendung die Steuerung an bestimmten Stellen geben, an denen die Verarbeitung erfolgt. Wenn diese Option nicht angegeben wird, wird eine Standardinstanz bereitgestellt, die keine Aktionen ausführt, wenn die Methoden aufgerufen werden.

EventsType

Wenn festgelegt, wird als Diensttyp verwendet, um die Ereignisse instance anstelle der -Eigenschaft abzurufen.

(Geerbt von AuthenticationSchemeOptions)
ExpireTimeSpan

Steuert, wie lange das im Cookie gespeicherte Authentifizierungsticket ab dem Zeitpunkt der Erstellung gültig bleibt. Die Ablaufinformationen werden im geschützten Cookie-Ticket gespeichert. Aus diesem Grund wird ein abgelaufenes Cookie ignoriert, auch wenn es an den Server übergeben wird, nachdem der Browser es gelöscht haben sollte.

Dies ist getrennt vom Wert von Expires, der angibt, wie lange der Browser das Cookie behält.

ForwardAuthenticate

Wenn festgelegt, gibt dies das Zielschema an, an das dieses Schema AuthenticateAsync-Aufrufe weiterleiten soll. Beispiel: Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Legen Sie das Ziel auf das aktuelle Schema fest, um die Weiterleitung zu deaktivieren und die normale Verarbeitung zuzulassen.

(Geerbt von AuthenticationSchemeOptions)
ForwardChallenge

Wenn festgelegt, gibt dies das Zielschema an, an das dieses Schema ChallengeAsync-Aufrufe weiterleiten soll. Beispiel: Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Legen Sie das Ziel auf das aktuelle Schema fest, um die Weiterleitung zu deaktivieren und die normale Verarbeitung zuzulassen.

(Geerbt von AuthenticationSchemeOptions)
ForwardDefault

Wenn festgelegt, gibt dies ein Standardschema an, an das Authentifizierungshandler standardmäßig alle Authentifizierungsvorgänge weiterleiten sollen. Die Standardweiterleitungslogik überprüft zuerst die spezifische Einstellung ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, gefolgt von ForwardDefaultSelector, gefolgt von ForwardDefault. Das erste Ergebnis ungleich NULL wird als Zielschema verwendet, an das weitergeleitet werden soll.

(Geerbt von AuthenticationSchemeOptions)
ForwardDefaultSelector

Wird verwendet, um ein Standardschema für die aktuelle Anforderung auszuwählen, an das Authentifizierungshandler standardmäßig alle Authentifizierungsvorgänge weiterleiten sollen. Die Standardweiterleitungslogik überprüft zuerst die spezifische Einstellung ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, gefolgt von ForwardDefaultSelector, gefolgt von ForwardDefault. Das erste Ergebnis ungleich NULL wird als Zielschema verwendet, an das weitergeleitet werden soll.

(Geerbt von AuthenticationSchemeOptions)
ForwardForbid

Wenn festgelegt, gibt dies das Zielschema an, an das dieses Schema ForbidAsync-Aufrufe weiterleiten soll. Beispiel: Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Legen Sie das Ziel auf das aktuelle Schema fest, um die Weiterleitung zu deaktivieren und die normale Verarbeitung zuzulassen.

(Geerbt von AuthenticationSchemeOptions)
ForwardSignIn

Wenn festgelegt, gibt dies das Zielschema an, an das dieses Schema SignInAsync-Aufrufe weiterleiten soll. Beispiel: Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Legen Sie das Ziel auf das aktuelle Schema fest, um die Weiterleitung zu deaktivieren und die normale Verarbeitung zuzulassen.

(Geerbt von AuthenticationSchemeOptions)
ForwardSignOut

Wenn festgelegt, gibt dies das Zielschema an, an das dieses Schema SignOutAsync-Aufrufe weiterleiten soll. Beispiel: Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Legen Sie das Ziel auf das aktuelle Schema fest, um die Weiterleitung zu deaktivieren und die normale Verarbeitung zuzulassen.

(Geerbt von AuthenticationSchemeOptions)
LoginPath

Die LoginPath-Eigenschaft wird vom Handler für das Umleitungsziel bei der Verarbeitung von ChallengeAsync verwendet. Die aktuelle URL, die dem LoginPath als Abfragezeichenfolgenparameter mit dem Namen ReturnUrlParameter hinzugefügt wird. Sobald eine Anforderung an den LoginPath eine neue SignIn-Identität gewährt, wird der ReturnUrlParameter-Wert verwendet, um den Browser zurück zur ursprünglichen URL umzuleiten.

LogoutPath

Wenn logoutPath als Handler bereitgestellt wird, wird eine Anforderung an diesen Pfad basierend auf ReturnUrlParameter umgeleitet.

ReturnUrlParameter

ReturnUrlParameter bestimmt den Namen des Abfragezeichenfolgenparameters, der vom Handler während einer Challenge angefügt 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 den Handler anzuweisen, ein neues Cookie mit einer neuen Ablaufzeit auszugeben, wenn er eine Anforderung verarbeitet, die mehr als die Hälfte des Ablauffensters ist.

TicketDataFormat

TicketDataFormat wird zum Schützen und Aufheben des Schutzes der Identität und anderer Eigenschaften verwendet, die im Cookiewert gespeichert werden. Wenn nicht angegeben, wird mithilfe DataProtectionProvidervon erstellt.

TimeProvider

Wird zum Testen verwendet.

(Geerbt von AuthenticationSchemeOptions)

Methoden

Validate()

Überprüfen Sie, ob die Optionen gültig sind. Sollte eine Ausnahme auslösen, wenn die Dinge nicht in Ordnung sind.

(Geerbt von AuthenticationSchemeOptions)
Validate(String)

Überprüft, ob die Optionen für ein bestimmtes Schema gültig sind.

(Geerbt von AuthenticationSchemeOptions)

Gilt für: