Saml2SecurityTokenHandler Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt einen Sicherheitstokenhandler dar, der Sicherheitstoken aus SAML 2.0 Assertionen erstellt.
public ref class Saml2SecurityTokenHandler : System::IdentityModel::Tokens::SecurityTokenHandlerpublic class Saml2SecurityTokenHandler : System.IdentityModel.Tokens.SecurityTokenHandlertype Saml2SecurityTokenHandler = class
inherit SecurityTokenHandlerPublic Class Saml2SecurityTokenHandler
Inherits SecurityTokenHandler- Vererbung
Hinweise
Die Saml2SecurityTokenHandler Klasse serialisiert und deserialisiert Sicherheitstoken, die von SAML 2.0 Assertionen in Saml2SecurityToken Objekte gesichert werden. Sicherheitstokenhandler sind für das Erstellen, Lesen, Schreiben und Validieren von Token verantwortlich.
Sie können einen Sicherheitstokendienst (Security Token Service, STS) oder eine ANWENDUNG mit vertrauender Seite (RP) konfigurieren, um SAML 2.0 Assertion-gesicherte Sicherheitstoken zu verarbeiten, indem Sie dem für den SecurityTokenHandlerCollection Dienst (oder die Anwendung) konfigurierten Objekt eine Instanz der Saml2SecurityTokenHandler Klasse hinzufügen. Dies kann entweder programmgesteuert oder in der Konfigurationsdatei erfolgen. Der Handler selbst wird aus der für die Auflistung angegebenen Konfiguration über die Eigenschaft der Auflistung Configuration konfiguriert, wenn er der Auflistung hinzugefügt wird. Obwohl es möglich ist, den Handler einzeln durch Festlegen der Configuration Eigenschaft zu konfigurieren, ist dies normalerweise nicht erforderlich. Wenn der Handler jedoch einzeln konfiguriert werden muss, sollte die Eigenschaft festgelegt werden, nachdem der Handler der Auflistung hinzugefügt wurde.
In vielen Szenarien kann die Saml2SecurityTokenHandler Klasse as-isverwendet werden. Die Klasse stellt jedoch viele Erweiterungspunkte über die verfügbaren Methoden bereit. Durch die Ableitung von den Saml2SecurityTokenHandler spezifischen Methoden können Sie die Funktionalität der tokenverarbeitung ändern, die in der Standardimplementierung bereitgestellt wird, oder Sie können die Verarbeitung für Erweiterungen zur SAML Assertion-Spezifikation hinzufügen, die in einigen benutzerdefinierten Szenarien erforderlich sein kann.
Konstruktoren
| Name | Beschreibung |
|---|---|
| Saml2SecurityTokenHandler() |
Initialisiert eine neue Instanz der Saml2SecurityTokenHandler Klasse mit Standardsicherheitstokenanforderungen. |
| Saml2SecurityTokenHandler(SamlSecurityTokenRequirement) |
Initialisiert eine neue Instanz der Saml2SecurityTokenHandler Klasse mit den angegebenen Sicherheitstokenanforderungen. |
Felder
| Name | Beschreibung |
|---|---|
| TokenProfile11ValueType |
Der Schlüsselbezeichnerwerttyp für SAML 2.0 Assertions-IDs, wie durch das OASIS Web Services Security SAML Token Profile 1.1 definiert. Dies ist ein URI. |
Eigenschaften
| Name | Beschreibung |
|---|---|
| CanValidateToken |
Ruft einen Wert ab, der angibt, ob dieser Handler Token vom Typ Saml2SecurityTokenüberprüfen kann. |
| CanWriteToken |
Ruft einen Wert ab, der angibt, ob dieser Handler Token vom Typ Saml2SecurityTokenserialisieren kann. |
| CertificateValidator |
Ruft den X.509-Zertifikat validator ab, der von der aktuellen Instanz zum Überprüfen von X.509-Zertifikaten verwendet wird, oder legt diesen fest. |
| Configuration |
Dient zum Abrufen oder Festlegen des SecurityTokenHandlerConfiguration Objekts, das die Konfiguration für die aktuelle Instanz bereitstellt. (Geerbt von SecurityTokenHandler) |
| ContainingCollection |
Ruft die Tokenhandlerauflistung ab, die die aktuelle Instanz enthält. (Geerbt von SecurityTokenHandler) |
| KeyInfoSerializer |
Dient zum Abrufen oder Festlegen des Serialisierungsprogramms für Sicherheitstoken, das zum Serialisieren und Deserialisieren von Schlüsselbezeichnern verwendet wird. |
| SamlSecurityTokenRequirement |
Ruft die Sicherheitstokenanforderungen für diese Instanz ab oder legt diese fest. |
| TokenType |
Ruft den von diesem Handler unterstützten Tokentyp ab. |
Methoden
| Name | Beschreibung |
|---|---|
| AddDelegateToAttributes(ClaimsIdentity, ICollection<Saml2Attribute>, SecurityTokenDescriptor) |
Fügt alle Stellvertretungen, die dem Betreff zugeordnet sind, der Attributauflistung hinzu. |
| CanReadKeyIdentifierClause(XmlReader) |
Gibt an, ob das aktuelle XML-Element auf eine Schlüsselbezeichnerklausel zeigt, die von dieser Instanz serialisiert werden kann. |
| CanReadToken(String) |
Gibt einen Wert zurück, der angibt, ob die angegebene Zeichenfolge als Token des Typs, der von dieser Instanz verarbeitet wird, deserialisiert werden kann. (Geerbt von SecurityTokenHandler) |
| CanReadToken(XmlReader) |
Gibt an, ob das aktuelle XML-Element als Token des Typs gelesen werden kann, der von dieser Instanz behandelt wird. |
| CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause) |
Gibt an, ob die angegebene Schlüsselbezeichnerklausel von dieser Instanz serialisiert werden kann. |
| CollectAttributeValues(ICollection<Saml2Attribute>) |
Sammelt Attribute mit einem allgemeinen Anspruchstyp, Anspruchswerttyp und ursprünglichem Aussteller in einem einzigen Attribut mit mehreren Werten. |
| CreateAdvice(SecurityTokenDescriptor) |
Erstellt ein Saml2Advice Objekt für die Assertion. |
| CreateAttribute(Claim, SecurityTokenDescriptor) |
Erstellt ein Saml2Attribute Objekt aus einem Anspruch. |
| CreateAttributeStatement(ClaimsIdentity, SecurityTokenDescriptor) |
Erstellt ein Saml2AttributeStatement Objekt aus einem Tokendeskriptor. |
| CreateAuthenticationStatement(AuthenticationInformation, SecurityTokenDescriptor) |
Erstellt eine SAML 2.0-Authentifizierungsanweisung aus den angegebenen Authentifizierungsinformationen. |
| CreateClaims(Saml2SecurityToken) |
Erstellt Ansprüche aus einem SAML 2.0-Token. |
| CreateConditions(Lifetime, String, SecurityTokenDescriptor) |
Erstellt die Bedingungen für die Assertion. |
| CreateIssuerNameIdentifier(SecurityTokenDescriptor) |
Erstellt einen Namensbezeichner, der den Assertionsherausgeber identifiziert. |
| CreateSamlSubject(SecurityTokenDescriptor) |
Erstellt einen SAML 2.0-Betreff für die Assertion. |
| CreateSecurityTokenReference(SecurityToken, Boolean) |
Erstellt den Sicherheitstokenverweis, wenn das Token nicht an die Nachricht angefügt ist. |
| CreateStatements(SecurityTokenDescriptor) |
Erstellt SAML 2.0-Anweisungen, die in die Assertion eingeschlossen werden sollen. |
| CreateToken(SecurityTokenDescriptor) |
Erstellt ein Sicherheitstoken basierend auf einem Tokendeskriptor. |
| CreateWindowsIdentity(String) |
Erstellt ein WindowsIdentity Objekt mit dem angegebenen Benutzerprinzipalnamen (USER Principal Name, UPN). |
| CreateXmlStringFromAttributes(IEnumerable<Saml2Attribute>) |
Erstellt eine XML-formatierte Zeichenfolge aus einer Auflistung von SAML 2.0-Attributen, die den Actor darstellen. |
| DenormalizeAuthenticationType(String) |
Gibt den Saml2 AuthenticationContext zurück, der einem normalisierten Wert entspricht. |
| DetectReplayedToken(SecurityToken) |
Löst eine Ausnahme aus, wenn das angegebene Token bereits im Token-Wiedergabecache vorhanden ist; andernfalls wird das Token dem Cache hinzugefügt. |
| Equals(Object) |
Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht. (Geerbt von Object) |
| FindUpn(ClaimsIdentity) |
Sucht den UPN-Anspruchswert im angegebenen ClaimsIdentity Objekt zum Zuordnen der Identität zu einem WindowsIdentity Objekt. |
| GetEncryptingCredentials(SecurityTokenDescriptor) |
Ruft das Token ab, das Anmeldeinformationen verschlüsselt. Überschreiben Sie diese Methode, um die Tokenverschlüsselungsanmeldeinformationen zu ändern. |
| GetHashCode() |
Dient als Standardhashfunktion. (Geerbt von Object) |
| GetSigningCredentials(SecurityTokenDescriptor) |
Ruft die Anmeldeinformationen zum Signieren der Assertion ab. |
| GetTokenReplayCacheEntryExpirationTime(Saml2SecurityToken) |
Gibt die Zeit zurück, bis das Token im Token-Wiedergabecache gespeichert werden soll. |
| GetTokenTypeIdentifiers() |
Ruft die tokentyp-IDs ab, die von diesem Handler unterstützt werden. |
| GetType() |
Ruft die Type der aktuellen Instanz ab. (Geerbt von Object) |
| LoadCustomConfiguration(XmlNodeList) |
Lädt die benutzerdefinierte Konfiguration aus XML. |
| MemberwiseClone() |
Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object) |
| NormalizeAuthenticationContextClassReference(String) |
Gibt den normalisierten Wert zurück, der einem SAML-Authentifizierungskontextklassenverweis entspricht. |
| ProcessAttributeStatement(Saml2AttributeStatement, ClaimsIdentity, String) |
Erstellt Ansprüche aus einer SAML 2.0-Attribut-Anweisung und fügt sie dem angegebenen Betreff hinzu. |
| ProcessAuthenticationStatement(Saml2AuthenticationStatement, ClaimsIdentity, String) |
Erstellt Ansprüche aus einer SAML 2.0-Authentifizierungsanweisung und fügt sie dem angegebenen Betreff hinzu. |
| ProcessAuthorizationDecisionStatement(Saml2AuthorizationDecisionStatement, ClaimsIdentity, String) |
Erstellt Ansprüche aus einer SAML 2.0-Autorisierungsentscheidungserklärung und fügt sie dem angegebenen Betreff hinzu. |
| ProcessSamlSubject(Saml2Subject, ClaimsIdentity, String) |
Erstellt Ansprüche aus dem SAML 2.0-Betreff und fügt sie dem angegebenen Betreff hinzu. |
| ProcessStatement(Collection<Saml2Statement>, ClaimsIdentity, String) |
Erstellt Ansprüche aus einer Sammlung von SAML 2.0-Anweisungen und fügt sie dem angegebenen Betreff hinzu. |
| ReadAction(XmlReader) |
Liest das <saml:Action-Element> . |
| ReadAdvice(XmlReader) |
Liest das <saml:Advice-Element> . |
| ReadAssertion(XmlReader) |
Liest das <saml:Assertion-Element> . |
| ReadAttribute(XmlReader) |
Liest das <saml:Attribute-Element> . |
| ReadAttributeStatement(XmlReader) |
Liest das <saml:AttributeStatement-Element> oder ein <saml:Statement-Element> , das einen xsi:type von saml:AttributeStatementType angibt. |
| ReadAttributeValue(XmlReader, Saml2Attribute) |
Liest einen Attributwert. |
| ReadAudienceRestriction(XmlReader) |
Liest das <saml:AudienceRestriction-Element> oder ein <saml:Condition-Element> , das einen xsi:type von saml:AudienceRestrictionType angibt. |
| ReadAuthenticationContext(XmlReader) |
Liest das <saml:AuthnContext-Element> . |
| ReadAuthenticationStatement(XmlReader) |
Liest das <saml:AuthnStatement-Element> oder ein <saml:Statement-Element> , das einen xsi:type von saml:AuthnStatementType angibt. |
| ReadAuthorizationDecisionStatement(XmlReader) |
Liest das <saml:AuthzDecisionStatement-Element> oder ein <saml:Statement-Element> , das einen xsi:type von saml:AuthzDecisionStatementType angibt. |
| ReadConditions(XmlReader) |
Liest das <saml:Conditions-Element> . |
| ReadEncryptedId(XmlReader) |
Liest das <saml:EncryptedId-Element> . |
| ReadEvidence(XmlReader) |
Liest das <saml:Evidence-Element> . |
| ReadIssuer(XmlReader) |
Liest das <saml:Issuer-Element> . |
| ReadKeyIdentifierClause(XmlReader) |
Liest eine SecurityKeyIdentifierClause. |
| ReadNameId(XmlReader) |
Liest das <saml:NameID-Element> . |
| ReadNameIdType(XmlReader) |
Sowohl Issuer> als <auch <NameID> sind nameIDType. Diese Methode liest den Inhalt einer dieser Elemente. |
| ReadProxyRestriction(XmlReader) |
Liest das <saml:ProxyRestriction-Element> oder ein <saml:Condition-Element> , das einen xsi:type von saml:ProxyRestrictionType angibt. |
| ReadSigningKeyInfo(XmlReader, Saml2Assertion) |
Deserialisiert die SAML-Signaturschlüsselinfo. |
| ReadStatement(XmlReader) |
Liest das <saml:Statement-Element> . |
| ReadSubject(XmlReader) |
Liest das <saml:Subject-Element> . |
| ReadSubjectConfirmation(XmlReader) |
Liest das <SubjectConfirmation-Element> . |
| ReadSubjectConfirmationData(XmlReader) |
Liest das <saml:SubjectConfirmationData-Element> . |
| ReadSubjectId(XmlReader, String) |
Diese Methode behandelt das Konstrukt, das in den <Elementen Subject> und <SubjectConfirmation> für ID verwendet wird. |
| ReadSubjectKeyInfo(XmlReader) |
Deserialisiert das SAML Subject <ds:KeyInfo-Element> . |
| ReadSubjectLocality(XmlReader) |
Liest das <saml:SubjectLocality-Element> . |
| ReadToken(String) |
Wenn sie in einer abgeleiteten Klasse außer Kraft gesetzt wird, wird die angegebene Zeichenfolge auf ein Token des Typs, der von der abgeleiteten Klasse verarbeitet wird, deserialisiert. (Geerbt von SecurityTokenHandler) |
| ReadToken(XmlReader, SecurityTokenResolver) |
Wenn sie in einer abgeleiteten Klasse außer Kraft gesetzt wird, wird der XML-Code, auf den vom angegebenen XML-Reader verwiesen wird, auf ein Token des Typs festgelegt, der von der abgeleiteten Klasse mithilfe des angegebenen Tokenlösers verarbeitet wird. (Geerbt von SecurityTokenHandler) |
| ReadToken(XmlReader) |
Liest ein SAML 2.0-Token aus dem angegebenen Datenstrom. |
| ResolveIssuerToken(Saml2Assertion, SecurityTokenResolver) |
Löst den Signierschlüsselbezeichner in ein SecurityToken. |
| ResolveSecurityKeys(Saml2Assertion, SecurityTokenResolver) |
Löst die Auflistung des SecurityKey Verweises in einer Saml2Assertion. |
| SetDelegateFromAttribute(Saml2Attribute, ClaimsIdentity, String) |
Diese Methode wird aufgerufen, wenn ein spezieller Typ von Saml2Attribute erkannt wird. Das Saml2Attribute übergebene Element umschließt eine Saml2Attribute Auflistung von Attributwerten (in der Values Eigenschaft), die jeweils einem Anspruch zugeordnet werden. Alle Ansprüche werden in einem ClaimsIdentity mit dem angegebenen Aussteller zurückgegeben. |
| ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object) |
| TraceTokenValidationFailure(SecurityToken, String) |
Verfolgt das Fehlerereignis während der Überprüfung von Sicherheitstoken nach, wenn die Ablaufverfolgung aktiviert ist. (Geerbt von SecurityTokenHandler) |
| TraceTokenValidationSuccess(SecurityToken) |
Verfolgt die erfolgreiche Überprüfung des Sicherheitstokenereignisses, wenn die Ablaufverfolgung aktiviert ist. (Geerbt von SecurityTokenHandler) |
| TryResolveIssuerToken(Saml2Assertion, SecurityTokenResolver, SecurityToken) |
Löst den Signierschlüsselbezeichner in ein SecurityToken auf. |
| ValidateConditions(Saml2Conditions, Boolean) |
Überprüft das angegebene Saml2Conditions Objekt. |
| ValidateConfirmationData(Saml2SubjectConfirmationData) |
Überprüft das angegebene Saml2SubjectConfirmationData Objekt. |
| ValidateToken(SecurityToken) |
Überprüft die Tokendaten und gibt ihre Ansprüche zurück. |
| WriteAction(XmlWriter, Saml2Action) |
Schreibt das <saml:Action-Element> . |
| WriteAdvice(XmlWriter, Saml2Advice) |
Schreibt das <saml:Advice-Element> . |
| WriteAssertion(XmlWriter, Saml2Assertion) |
Serialisiert die angegebene SAML-Assertion auf den angegebenen XML-Writer. |
| WriteAttribute(XmlWriter, Saml2Attribute) |
Schreibt das <saml:Attribute-Element> . |
| WriteAttributeStatement(XmlWriter, Saml2AttributeStatement) |
Schreibt das <saml:AttributeStatement-Element> . |
| WriteAttributeValue(XmlWriter, String, Saml2Attribute) |
Schreibt den saml:Attribute-Wert. |
| WriteAudienceRestriction(XmlWriter, Saml2AudienceRestriction) |
Schreibt das <saml:AudienceRestriction-Element> . |
| WriteAuthenticationContext(XmlWriter, Saml2AuthenticationContext) |
Schreibt das <saml:AuthnContext-Element> . |
| WriteAuthenticationStatement(XmlWriter, Saml2AuthenticationStatement) |
Schreibt das <saml:AuthnStatement-Element> . |
| WriteAuthorizationDecisionStatement(XmlWriter, Saml2AuthorizationDecisionStatement) |
Schreibt das <saml:AuthzDecisionStatement-Element> . |
| WriteConditions(XmlWriter, Saml2Conditions) |
Schreibt das <saml:Conditions-Element> . |
| WriteEvidence(XmlWriter, Saml2Evidence) |
Schreibt das <saml:Evidence-Element> . |
| WriteIssuer(XmlWriter, Saml2NameIdentifier) |
Schreibt das <saml:Issuer-Element> . |
| WriteKeyIdentifierClause(XmlWriter, SecurityKeyIdentifierClause) |
Serialisiert einen Saml2AssertionKeyIdentifierClause in den angegebenen XML-Writer. |
| WriteNameId(XmlWriter, Saml2NameIdentifier) |
Schreibt das <saml:NameID-Element> . |
| WriteNameIdType(XmlWriter, Saml2NameIdentifier) |
Sowohl Issuer> als <auch <NameID> sind nameIDType. Diese Methode schreibt den Inhalt einer dieser Elemente. |
| WriteProxyRestriction(XmlWriter, Saml2ProxyRestriction) |
Schreibt das <saml:ProxyRestriction-Element> . |
| WriteSigningKeyInfo(XmlWriter, SecurityKeyIdentifier) |
Schreibt das Signing <ds:KeyInfo-Element> mithilfe des angegebenen XML-Writers. |
| WriteStatement(XmlWriter, Saml2Statement) |
Schreibt ein Saml2Statement. |
| WriteSubject(XmlWriter, Saml2Subject) |
Schreibt das <saml:Subject-Element> . |
| WriteSubjectConfirmation(XmlWriter, Saml2SubjectConfirmation) |
Schreibt das <saml:SubjectConfirmation-Element> . |
| WriteSubjectConfirmationData(XmlWriter, Saml2SubjectConfirmationData) |
Schreibt das <saml:SubjectConfirmationData-Element> . |
| WriteSubjectKeyInfo(XmlWriter, SecurityKeyIdentifier) |
Serialisiert das Subject <ds:KeyInfo-Element> mithilfe des angegebenen XML-Writers. |
| WriteSubjectLocality(XmlWriter, Saml2SubjectLocality) |
Schreibt das <saml:SubjectLocality-Element> . |
| WriteToken(SecurityToken) |
Beim Überschreiben in einer abgeleiteten Klasse serialisiert das angegebene Sicherheitstoken in eine Zeichenfolge. Das Token muss vom Typ sein, der von der abgeleiteten Klasse verarbeitet wird. (Geerbt von SecurityTokenHandler) |
| WriteToken(XmlWriter, SecurityToken) |
Schreibt ein Saml2-Token in den angegebenen XML-Writer. |
