Freigeben über


WsFederationOptions Klasse

Definition

Konfigurationsoptionen für .WsFederationHandler

public ref class WsFederationOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions
public class WsFederationOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions
type WsFederationOptions = class
    inherit RemoteAuthenticationOptions
Public Class WsFederationOptions
Inherits RemoteAuthenticationOptions
Vererbung

Konstruktoren

WsFederationOptions()

Initialisiert eine neue WsFederationOptions-Schnittstelle.

Eigenschaften

AccessDeniedPath

Ruft den optionalen Pfad ab, an den der Benutzer-Agent umgeleitet wird, oder legt diesen fest, wenn der Benutzer die vom Remoteserver angeforderte Autorisierungsanforderung nicht genehmigt. Diese Eigenschaft ist nicht standardmäßig festgelegt. In diesem Fall wird eine Ausnahme ausgelöst, wenn vom Remoteautorisierungsserver eine access_denied Antwort zurückgegeben wird.

(Geerbt von RemoteAuthenticationOptions)
AllowUnsolicitedLogins

Das Ws-Federation-Protokoll ermöglicht es dem Benutzer, Anmeldungen zu initiieren, ohne sich zuerst für eine Challenge an die Anwendung zu wenden. Dieser Flow ist jedoch anfällig für XSRF- und andere Angriffe, sodass er hier standardmäßig deaktiviert ist.

Backchannel

Wird für die Kommunikation mit dem Remoteidentitätsanbieter verwendet.

(Geerbt von RemoteAuthenticationOptions)
BackchannelHttpHandler

Der HttpMessageHandler, der für die Kommunikation mit dem Remoteidentitätsanbieter verwendet wird. Diese Option kann nur dann zur gleichen Zeit wie BackchannelCertificateValidator festgelegt werden, wenn der Wert in eine abgeleitete Klasse WebRequestHandler umgewandelt werden kann.

(Geerbt von RemoteAuthenticationOptions)
BackchannelTimeout

Ruft den Timeoutwert in Millisekunden für die Rückkanalkommunikation mit dem Remoteidentitätsanbieter ab oder legt diese fest.

(Geerbt von RemoteAuthenticationOptions)
CallbackPath

Der Anforderungspfad im Basispfad der Anwendung, an den user-agent zurückgegeben wird. Die Middleware verarbeitet diese Anforderung, wenn sie eingeht.

(Geerbt von RemoteAuthenticationOptions)
ClaimsIssuer

Ruft den Aussteller ab, der für alle ansprüche verwendet werden soll, die erstellt werden sollen, oder legt diesen fest.

(Geerbt von AuthenticationSchemeOptions)
Configuration

Konfiguration, die direkt vom Entwickler bereitgestellt wird. Wenn diese Konfiguration bereitgestellt wird, werden MetadataAddress und die Backchannel-Eigenschaften nicht verwendet. Diese Informationen sollten während der Anforderungsverarbeitung nicht aktualisiert werden.

ConfigurationManager

Verantwortlich für den Abruf, das Caching und die Aktualisierung der Konfiguration aus den Metadaten. Wenn diese Konfiguration nicht bereitgestellt wird, wird mit MetadataAddress und den Backchannel-Eigenschaften eine Konfiguration erstellt.

CorrelationCookie

Bestimmt die Einstellungen, die zum Erstellen des Korrelationscookies verwendet werden, bevor das Cookie der Antwort hinzugefügt wird.

(Geerbt von RemoteAuthenticationOptions)
DataProtectionProvider

Ruft den Typ ab, der zum Schützen von Daten verwendet wird, oder legt diesen fest.

(Geerbt von RemoteAuthenticationOptions)
Events

Ruft die ab, die WsFederationEvents beim Verarbeiten von WsFederation-Nachrichten aufgerufen werden soll, oder legt diesen fest.

EventsType

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

(Geerbt von AuthenticationSchemeOptions)
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 Nicht-NULL-Ergebnis 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 die 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 Nicht-NULL-Ergebnis 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)
MetadataAddress

Ruft die Adresse zum Abrufen der wsFederation-Metadaten ab oder legt diese fest.

RefreshOnIssuerKeyNotFound

Ruft ab oder legt fest, ob nach einer SecurityTokenSignatureKeyNotFoundException eine Metadatenaktualisierung versucht werden soll. Dies ermöglicht automatische Wiederherstellung, im Fall eines Signaturschlüsselrollovers. Diese Einstellung ist standardmäßig aktiviert.

RemoteAuthenticationTimeout

Ruft das Zeitlimit für den Abschluss des Authentifizierungsflows ab oder legt dieses fest (standardmäßig 15 Minuten).

(Geerbt von RemoteAuthenticationOptions)
RemoteSignOutPath

Anforderungen, die für diesen Pfad empfangen werden, führen dazu, dass der Handler die SignOut-Anmeldung mithilfe von SignOutScheme aufruft.

RequireHttpsMetadata

Ruft ab oder legt fest, ob HTTPS für die Metadatenadresse oder -autorität erforderlich ist. Der Standardwert ist „true“. Dies sollte nur in Entwicklungsumgebungen deaktiviert werden.

ReturnUrlParameter

Ruft den Namen des Parameters ab, der verwendet wird, um den ursprünglichen Speicherort des Benutzers zu übermitteln, bevor die Remoteausforderung bis zur Seite "Zugriff verweigert" ausgelöst wurde, oder legt diesen fest. Diese Eigenschaft wird nur verwendet, wenn explizit AccessDeniedPath angegeben wird.

(Geerbt von RemoteAuthenticationOptions)
SaveTokens

SaveTokens wird in WsFederation nicht unterstützt.

SaveTokens

Definiert, ob Zugriffs- und Aktualisierungstoken nach erfolgreicher Autorisierung in AuthenticationProperties gespeichert werden sollen. Diese Eigenschaft ist standardmäßig auf false festgelegt, um die Größe des endgültigen Authentifizierungscookies zu reduzieren.

(Geerbt von RemoteAuthenticationOptions)
SecurityTokenHandlers
Veraltet.

Ruft die Auflistung von ISecurityTokenValidator ab, die zum Lesen und Überprüfen der s verwendet wird, oder legt diese SecurityTokenfest.

SignInScheme

Ruft das Authentifizierungsschema ab, das der Middleware entspricht, die für die Beibehaltung der Benutzeridentität nach einer erfolgreichen Authentifizierung verantwortlich ist, oder legt es fest. Dieser Wert entspricht in der Regel einer Cookie-Middleware, die in der Startup-Klasse registriert ist. Wird bei Auslassung DefaultSignInScheme als Fallbackwert verwendet.

(Geerbt von RemoteAuthenticationOptions)
SignOutScheme

Das Authentifizierungsschema, das mit SignOutAsync von RemoteSignOutPath verwendet werden soll. SignInScheme wird verwendet, wenn dies nicht festgelegt ist.

SignOutWreply

Ruft den wreply-Wert ab, der während der Abmeldung verwendet wird, oder legt diese fest. Wenn keine angegeben ist, wird der Wert aus dem Feld Wreply verwendet.

SkipUnrecognizedRequests

Gibt an, ob Anforderungen an den CallbackPath möglicherweise auch für andere Komponenten gelten. Wenn aktiviert, übergibt der Handler Anforderungen, die keine WsFederation-Authentifizierungsantworten enthalten. Wenn Sie diesen Deaktivieren und den CallbackPath auf einen dedizierten Endpunkt festlegen, kann dies zu einer besseren Fehlerbehandlung führen. Diese Einstellung ist standardmäßig deaktiviert.

StateDataFormat

Ruft den Typ ab, der zum Sichern von Daten verwendet wird, die von der Middleware verarbeitet werden, oder legt diesen fest.

TimeProvider

Wird für Tests verwendet.

(Geerbt von AuthenticationSchemeOptions)
TokenHandlers

Ruft die Auflistung von ab, die ISecurityTokenValidator zum Lesen und Überprüfen der SecurityTokens verwendet wird.

TokenValidationParameters

Ruft ab oder legt den TokenValidationParameters

UseSecurityTokenHandlers

Ruft ab oder legt fest, ob TokenHandlers oder SecurityTokenHandlers zum Überprüfen des eingehenden Tokens verwendet wird.

UseTokenLifetime

Gibt an, dass die Lebensdauer der Authentifizierungssitzung (z. B. Cookies) mit der des Authentifizierungstokens übereinstimmen soll. Wenn das Token keine Informationen zur Lebensdauer bereitstellt, wird die normale Lebensdauer der Sitzung verwendet. Diese Einstellung ist standardmäßig aktiviert.

Wreply

Ruft wreply ab oder legt diesen Wert fest. CallbackPath muss auf übereinstimmungen oder gelöscht werden, damit er dynamisch generiert werden kann. Dieses Feld ist optional. Wenn sie nicht festgelegt ist, wird sie aus der aktuellen Anforderung und dem CallbackPath generiert.

Wtrealm

Ruft wtrealm ab oder legt diesen Wert fest.

Methoden

Validate()

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

Validate(String)

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

(Geerbt von RemoteAuthenticationOptions)

Gilt für: