Saml2SecurityTokenHandler 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.
Reprezentuje procedurę obsługi tokenów zabezpieczających, która tworzy tokeny zabezpieczające na podstawie asercji SAML 2.0.
public ref class Saml2SecurityTokenHandler : System::IdentityModel::Tokens::SecurityTokenHandlerpublic class Saml2SecurityTokenHandler : System.IdentityModel.Tokens.SecurityTokenHandlertype Saml2SecurityTokenHandler = class
inherit SecurityTokenHandlerPublic Class Saml2SecurityTokenHandler
Inherits SecurityTokenHandler- Dziedziczenie
Uwagi
Klasa Saml2SecurityTokenHandler serializuje i deserializuje tokeny zabezpieczające wspierane przez asercji SAML 2.0 do Saml2SecurityToken obiektów. Procedury obsługi tokenów zabezpieczających są odpowiedzialne za tworzenie, odczytywanie, zapisywanie i weryfikowanie tokenów.
Możesz skonfigurować usługę tokenu zabezpieczającego (STS) lub aplikację jednostki uzależnionej (RP), aby przetwarzać tokeny zabezpieczające oparte na asercji SAML 2.0, dodając wystąpienie Saml2SecurityTokenHandler klasy do SecurityTokenHandlerCollection obiektu skonfigurowanego dla usługi (lub aplikacji). Można to zrobić programowo lub w pliku konfiguracji. Sama procedura obsługi jest konfigurowana z konfiguracji określonej dla kolekcji za pośrednictwem właściwości kolekcji po dodaniu jej do kolekcji Configuration . Chociaż program obsługi można skonfigurować indywidualnie, ustawiając jego Configuration właściwość, nie jest to zwykle konieczne. Jeśli jednak program obsługi musi być skonfigurowany indywidualnie, właściwość powinna zostać ustawiona po dodaniu programu obsługi do kolekcji.
W wielu scenariuszach klasę Saml2SecurityTokenHandler można użyć as-is; jednak klasa zapewnia wiele punktów rozszerzeń za pośrednictwem metod, które uwidacznia. Korzystając z Saml2SecurityTokenHandler metod i przesłonięć określone metody, można zmodyfikować funkcjonalność przetwarzania tokenu podanego w implementacji domyślnej lub dodać przetwarzanie rozszerzeń do specyfikacji asercji SAML, które mogą być potrzebne w niektórych scenariuszach niestandardowych.
Konstruktory
| Nazwa | Opis |
|---|---|
| Saml2SecurityTokenHandler() |
Inicjuje nowe wystąpienie Saml2SecurityTokenHandler klasy z domyślnymi wymaganiami dotyczącymi tokenu zabezpieczającego. |
| Saml2SecurityTokenHandler(SamlSecurityTokenRequirement) |
Inicjuje nowe wystąpienie Saml2SecurityTokenHandler klasy z określonymi wymaganiami dotyczącymi tokenu zabezpieczającego. |
Pola
| Nazwa | Opis |
|---|---|
| TokenProfile11ValueType |
Typ wartości identyfikatora klucza dla identyfikatorów asercji SAML 2.0, zgodnie z definicją w profilu tokenu SAML Security SAML Security SAML Token Profile 1.1. Jest to identyfikator URI. |
Właściwości
| Nazwa | Opis |
|---|---|
| CanValidateToken |
Pobiera wartość wskazującą, czy ta procedura obsługi może zweryfikować tokeny typu Saml2SecurityToken. |
| CanWriteToken |
Pobiera wartość wskazującą, czy ta procedura obsługi może serializować tokeny typu Saml2SecurityToken. |
| CertificateValidator |
Pobiera lub ustawia moduł sprawdzania poprawności certyfikatu X.509 używany przez bieżące wystąpienie do sprawdzania poprawności certyfikatów X.509. |
| Configuration |
Pobiera lub ustawia SecurityTokenHandlerConfiguration obiekt, który zapewnia konfigurację dla bieżącego wystąpienia. (Odziedziczone po SecurityTokenHandler) |
| ContainingCollection |
Pobiera kolekcję programu obsługi tokenów zawierającą bieżące wystąpienie. (Odziedziczone po SecurityTokenHandler) |
| KeyInfoSerializer |
Pobiera lub ustawia serializator tokenu zabezpieczającego używany do serializacji i deserializacji identyfikatorów kluczy. |
| SamlSecurityTokenRequirement |
Pobiera lub ustawia wymagania dotyczące tokenu zabezpieczającego dla tego wystąpienia. |
| TokenType |
Pobiera typ tokenu obsługiwany przez tę procedurę obsługi. |
Metody
| Nazwa | Opis |
|---|---|
| AddDelegateToAttributes(ClaimsIdentity, ICollection<Saml2Attribute>, SecurityTokenDescriptor) |
Dodaje wszystkich delegatów skojarzonych z tematem do kolekcji atrybutów. |
| CanReadKeyIdentifierClause(XmlReader) |
Wskazuje, czy bieżący element XML wskazuje klauzulę identyfikatora klucza, która może być serializowana przez to wystąpienie. |
| CanReadToken(String) |
Zwraca wartość wskazującą, czy określony ciąg może zostać zdeserializowany jako token typu przetworzonego przez to wystąpienie. (Odziedziczone po SecurityTokenHandler) |
| CanReadToken(XmlReader) |
Wskazuje, czy bieżący element XML może być odczytywany jako token typu obsługiwanego przez to wystąpienie. |
| CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause) |
Wskazuje, czy określona klauzula identyfikatora klucza może być serializowana przez to wystąpienie. |
| CollectAttributeValues(ICollection<Saml2Attribute>) |
Zbiera atrybuty z typowym typem oświadczenia, typem wartości oświadczenia i oryginalnym wystawcą w jeden atrybut z wieloma wartościami. |
| CreateAdvice(SecurityTokenDescriptor) |
Tworzy Saml2Advice obiekt dla asercji. |
| CreateAttribute(Claim, SecurityTokenDescriptor) |
Tworzy Saml2Attribute obiekt na podstawie oświadczenia. |
| CreateAttributeStatement(ClaimsIdentity, SecurityTokenDescriptor) |
Tworzy Saml2AttributeStatement obiekt na podstawie deskryptora tokenu. |
| CreateAuthenticationStatement(AuthenticationInformation, SecurityTokenDescriptor) |
Tworzy instrukcję uwierzytelniania SAML 2.0 na podstawie określonych informacji uwierzytelniania. |
| CreateClaims(Saml2SecurityToken) |
Tworzy oświadczenia na podstawie tokenu SAML 2.0. |
| CreateConditions(Lifetime, String, SecurityTokenDescriptor) |
Tworzy warunki potwierdzenia. |
| CreateIssuerNameIdentifier(SecurityTokenDescriptor) |
Tworzy identyfikator nazwy identyfikujący wystawcę asercji. |
| CreateSamlSubject(SecurityTokenDescriptor) |
Tworzy podmiot SAML 2.0 dla potwierdzenia. |
| CreateSecurityTokenReference(SecurityToken, Boolean) |
Tworzy odwołanie do tokenu zabezpieczającego, gdy token nie jest dołączony do komunikatu. |
| CreateStatements(SecurityTokenDescriptor) |
Tworzy instrukcje SAML 2.0, które mają zostać uwzględnione w asercji. |
| CreateToken(SecurityTokenDescriptor) |
Tworzy token zabezpieczający na podstawie deskryptora tokenu. |
| CreateWindowsIdentity(String) |
WindowsIdentity Tworzy obiekt przy użyciu określonej głównej nazwy użytkownika (UPN). |
| CreateXmlStringFromAttributes(IEnumerable<Saml2Attribute>) |
Tworzy ciąg sformatowany w formacie XML z kolekcji atrybutów SAML 2.0 reprezentujących aktora. |
| DenormalizeAuthenticationType(String) |
Zwraca wartość Saml2 AuthenticationContext zgodną z znormalizowaną wartością. |
| DetectReplayedToken(SecurityToken) |
Zgłasza wyjątek, jeśli określony token już istnieje w pamięci podręcznej ponownego odtwarzania tokenu; w przeciwnym razie token zostanie dodany do pamięci podręcznej. |
| Equals(Object) |
Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone po Object) |
| FindUpn(ClaimsIdentity) |
Znajduje wartość oświadczenia nazwy UPN w określonym ClaimsIdentity obiekcie w celu mapowania tożsamości na WindowsIdentity obiekt. |
| GetEncryptingCredentials(SecurityTokenDescriptor) |
Pobiera token szyfrujący poświadczenia. Zastąp tę metodę, aby zmienić token szyfrujący poświadczenia. |
| GetHashCode() |
Służy jako domyślna funkcja skrótu. (Odziedziczone po Object) |
| GetSigningCredentials(SecurityTokenDescriptor) |
Pobiera poświadczenia do podpisywania asercji. |
| GetTokenReplayCacheEntryExpirationTime(Saml2SecurityToken) |
Zwraca czas, do którego token powinien być przechowywany w pamięci podręcznej ponownego odtwarzania tokenu. |
| GetTokenTypeIdentifiers() |
Pobiera identyfikatory typu tokenu obsługiwane przez tę procedurę obsługi. |
| GetType() |
Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object) |
| LoadCustomConfiguration(XmlNodeList) |
Ładuje konfigurację niestandardową z pliku XML. |
| MemberwiseClone() |
Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object) |
| NormalizeAuthenticationContextClassReference(String) |
Zwraca znormalizowaną wartość zgodną z odwołaniem do klasy kontekstu uwierzytelniania SAML. |
| ProcessAttributeStatement(Saml2AttributeStatement, ClaimsIdentity, String) |
Tworzy oświadczenia na podstawie instrukcji atrybutu SAML 2.0 i dodaje je do określonego tematu. |
| ProcessAuthenticationStatement(Saml2AuthenticationStatement, ClaimsIdentity, String) |
Tworzy oświadczenia na podstawie instrukcji uwierzytelniania SAML 2.0 i dodaje je do określonego podmiotu. |
| ProcessAuthorizationDecisionStatement(Saml2AuthorizationDecisionStatement, ClaimsIdentity, String) |
Tworzy oświadczenia na podstawie instrukcji decyzji autoryzacji SAML 2.0 i dodaje je do określonego podmiotu. |
| ProcessSamlSubject(Saml2Subject, ClaimsIdentity, String) |
Tworzy oświadczenia z tematu SAML 2.0 i dodaje je do określonego tematu. |
| ProcessStatement(Collection<Saml2Statement>, ClaimsIdentity, String) |
Tworzy oświadczenia z kolekcji instrukcji SAML 2.0 i dodaje je do określonego tematu. |
| ReadAction(XmlReader) |
Odczytuje element <saml:Action> . |
| ReadAdvice(XmlReader) |
Odczytuje <element saml:Advice> . |
| ReadAssertion(XmlReader) |
Odczytuje element <saml:Assertion> . |
| ReadAttribute(XmlReader) |
Odczytuje element <saml:Attribute> . |
| ReadAttributeStatement(XmlReader) |
Odczytuje <element saml:AttributeStatement> lub <saml:Statement> , który określa xsi:type saml:AttributeStatementType. |
| ReadAttributeValue(XmlReader, Saml2Attribute) |
Odczytuje wartość atrybutu. |
| ReadAudienceRestriction(XmlReader) |
Odczytuje <element saml:AudienceRestriction> lub <saml:Condition> , który określa xsi:type saml:AudienceRestrictionType. |
| ReadAuthenticationContext(XmlReader) |
Odczytuje element <saml:AuthnContext> . |
| ReadAuthenticationStatement(XmlReader) |
Odczytuje <element saml:AuthnStatement> lub <element saml:Statement> , który określa xsi:type saml:AuthnStatementType. |
| ReadAuthorizationDecisionStatement(XmlReader) |
Odczytuje <element saml:AuthzDecisionStatement> lub <saml:Statement> , który określa xsi:type saml:AuthzDecisionStatementType. |
| ReadConditions(XmlReader) |
Odczytuje <element saml:Conditions> . |
| ReadEncryptedId(XmlReader) |
Odczytuje element <saml:EncryptedId> . |
| ReadEvidence(XmlReader) |
Odczytuje element <saml:Evidence> . |
| ReadIssuer(XmlReader) |
Odczytuje element <saml:Issuer> . |
| ReadKeyIdentifierClause(XmlReader) |
Odczytuje element SecurityKeyIdentifierClause. |
| ReadNameId(XmlReader) |
Odczytuje element <saml:NameID> . |
| ReadNameIdType(XmlReader) |
Zarówno Wystawca,> jak <i <NameID> mają typ NameIDType. Ta metoda odczytuje zawartość jednego z tych elementów. |
| ReadProxyRestriction(XmlReader) |
Odczytuje <element saml:ProxyRestriction> lub <saml:Condition> , który określa xsi:type saml:ProxyRestrictionType. |
| ReadSigningKeyInfo(XmlReader, Saml2Assertion) |
Deserializuje informacje o kluczu podpisywania SAML. |
| ReadStatement(XmlReader) |
Odczytuje <element saml:Statement> . |
| ReadSubject(XmlReader) |
Odczytuje element <saml:Subject> . |
| ReadSubjectConfirmation(XmlReader) |
Odczytuje <element SubjectConfirmation> . |
| ReadSubjectConfirmationData(XmlReader) |
Odczytuje <element saml:SubjectConfirmationData> . |
| ReadSubjectId(XmlReader, String) |
Ta metoda obsługuje konstrukcję używaną w elementach <Subject> i <SubjectConfirmation> dla identyfikatora. |
| ReadSubjectKeyInfo(XmlReader) |
Deserializuje element SAML Subject <ds:KeyInfo> . |
| ReadSubjectLocality(XmlReader) |
Odczytuje <element saml:SubjectLocality> . |
| ReadToken(String) |
Po zastąpieniu w klasie pochodnej deserializuje określony ciąg do tokenu typu przetworzonego przez klasę pochodną. (Odziedziczone po SecurityTokenHandler) |
| ReadToken(XmlReader, SecurityTokenResolver) |
Po zastąpieniu w klasie pochodnej deserializuje kod XML przywoływane przez określony czytnik XML do tokenu typu przetworzonego przez klasę pochodną przy użyciu określonego rozpoznawania tokenów. (Odziedziczone po SecurityTokenHandler) |
| ReadToken(XmlReader) |
Odczytuje token SAML 2.0 z określonego strumienia. |
| ResolveIssuerToken(Saml2Assertion, SecurityTokenResolver) |
Usuwa identyfikator klucza podpisywania do elementu SecurityToken. |
| ResolveSecurityKeys(Saml2Assertion, SecurityTokenResolver) |
Usuwa kolekcję odwołań SecurityKey w obiekcie Saml2Assertion. |
| SetDelegateFromAttribute(Saml2Attribute, ClaimsIdentity, String) |
Ta metoda jest wywoływana po wykryciu specjalnego typu Saml2Attribute . Przekazany Saml2Attribute element zawija Saml2Attribute element zawierający kolekcję wartości atrybutów (we Values właściwości), z których każda zostanie zamapowana na oświadczenie. Wszystkie oświadczenia zostaną zwrócone w obiekcie ClaimsIdentity z określonym wystawcą. |
| ToString() |
Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object) |
| TraceTokenValidationFailure(SecurityToken, String) |
Śledzi zdarzenie niepowodzenia podczas walidacji tokenów zabezpieczających po włączeniu śledzenia. (Odziedziczone po SecurityTokenHandler) |
| TraceTokenValidationSuccess(SecurityToken) |
Śledzi pomyślne sprawdzanie poprawności zdarzenia tokenów zabezpieczających po włączeniu śledzenia. (Odziedziczone po SecurityTokenHandler) |
| TryResolveIssuerToken(Saml2Assertion, SecurityTokenResolver, SecurityToken) |
Usuwa identyfikator klucza podpisywania do tokenu SecurityToken. |
| ValidateConditions(Saml2Conditions, Boolean) |
Sprawdza poprawność określonego Saml2Conditions obiektu. |
| ValidateConfirmationData(Saml2SubjectConfirmationData) |
Sprawdza poprawność określonego Saml2SubjectConfirmationData obiektu. |
| ValidateToken(SecurityToken) |
Weryfikuje dane tokenu i zwraca swoje oświadczenia. |
| WriteAction(XmlWriter, Saml2Action) |
<Zapisuje element saml:Action>. |
| WriteAdvice(XmlWriter, Saml2Advice) |
<Zapisuje element saml:Advice>. |
| WriteAssertion(XmlWriter, Saml2Assertion) |
Serializuje określoną asercję SAML do określonego modułu zapisywania XML. |
| WriteAttribute(XmlWriter, Saml2Attribute) |
Zapisuje element <saml:Attribute> . |
| WriteAttributeStatement(XmlWriter, Saml2AttributeStatement) |
<Zapisuje element saml:AttributeStatement>. |
| WriteAttributeValue(XmlWriter, String, Saml2Attribute) |
Zapisuje wartość saml:Attribute. |
| WriteAudienceRestriction(XmlWriter, Saml2AudienceRestriction) |
<Zapisuje element saml:AudienceRestriction>. |
| WriteAuthenticationContext(XmlWriter, Saml2AuthenticationContext) |
Zapisuje element <saml:AuthnContext> . |
| WriteAuthenticationStatement(XmlWriter, Saml2AuthenticationStatement) |
<Zapisuje element saml:AuthnStatement>. |
| WriteAuthorizationDecisionStatement(XmlWriter, Saml2AuthorizationDecisionStatement) |
Zapisuje element <saml:AuthzDecisionStatement> . |
| WriteConditions(XmlWriter, Saml2Conditions) |
<Zapisuje element saml:Conditions>. |
| WriteEvidence(XmlWriter, Saml2Evidence) |
<Zapisuje element saml:Evidence>. |
| WriteIssuer(XmlWriter, Saml2NameIdentifier) |
Zapisuje element <saml:Issuer> . |
| WriteKeyIdentifierClause(XmlWriter, SecurityKeyIdentifierClause) |
Serializuje element do Saml2AssertionKeyIdentifierClause określonego składnika zapisywania XML. |
| WriteNameId(XmlWriter, Saml2NameIdentifier) |
Zapisuje element <saml:NameID> . |
| WriteNameIdType(XmlWriter, Saml2NameIdentifier) |
Zarówno Wystawca,> jak <i <NameID> mają typ NameIDType. Ta metoda zapisuje zawartość jednego z tych elementów. |
| WriteProxyRestriction(XmlWriter, Saml2ProxyRestriction) |
<Zapisuje element saml:ProxyRestriction>. |
| WriteSigningKeyInfo(XmlWriter, SecurityKeyIdentifier) |
Zapisuje element Signing <ds:KeyInfo> przy użyciu określonego składnika zapisywania XML. |
| WriteStatement(XmlWriter, Saml2Statement) |
Zapisuje element Saml2Statement. |
| WriteSubject(XmlWriter, Saml2Subject) |
<Zapisuje element saml:Subject>. |
| WriteSubjectConfirmation(XmlWriter, Saml2SubjectConfirmation) |
<Zapisuje element saml:SubjectConfirmation>. |
| WriteSubjectConfirmationData(XmlWriter, Saml2SubjectConfirmationData) |
<Zapisuje element saml:SubjectConfirmationData>. |
| WriteSubjectKeyInfo(XmlWriter, SecurityKeyIdentifier) |
Serializuje element Subject <ds:KeyInfo> przy użyciu określonego składnika zapisywania XML. |
| WriteSubjectLocality(XmlWriter, Saml2SubjectLocality) |
<Zapisuje element saml:SubjectLocality>. |
| WriteToken(SecurityToken) |
Po zastąpieniu w klasie pochodnej serializuje określony token zabezpieczający do ciągu. Token musi być typu przetwarzanego przez klasę pochodną. (Odziedziczone po SecurityTokenHandler) |
| WriteToken(XmlWriter, SecurityToken) |
Zapisuje token Saml2 do określonego modułu zapisywania XML. |
