SamlSecurityTokenHandler 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.
Przeznaczony SecurityTokenHandler do tworzenia i weryfikowania tokenów Saml. Zobacz: http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf
public class SamlSecurityTokenHandler : Microsoft.IdentityModel.Tokens.SecurityTokenHandler, Microsoft.IdentityModel.Tokens.Experimental.IResultBasedValidationtype SamlSecurityTokenHandler = class
inherit SecurityTokenHandler
interface IResultBasedValidationPublic Class SamlSecurityTokenHandler
Inherits SecurityTokenHandler
Implements IResultBasedValidation- Dziedziczenie
- Implementuje
Konstruktory
| Nazwa | Opis |
|---|---|
| SamlSecurityTokenHandler() |
Przeznaczony SecurityTokenHandler do tworzenia i weryfikowania tokenów Saml. Zobacz: http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf |
Właściwości
| Nazwa | Opis |
|---|---|
| CanValidateToken |
Pobiera wartość wskazującą, czy ta procedura obsługi obsługuje walidację tokenów obsługiwanych przez to wystąpienie. |
| CanWriteToken |
Pobiera wartość wskazującą, czy klasa zapewnia funkcje serializacji w celu serializacji zabezpieczeńDoken obsługiwanego przez to wystąpienie. |
| MaximumTokenSizeInBytes |
Pobiera i ustawia maksymalny rozmiar tokenu w bajtach, które zostaną przetworzone. (Odziedziczone po TokenHandler) |
| SamlSubjectEqualityComparer |
Pobiera lub ustawia porównanie SamlSubject. |
| Serializer |
Pobiera lub ustawia element SamlSerializer , który będzie używany do odczytywania i zapisywania .SamlSecurityToken |
| SetDefaultTimesOnTokenCreation |
Pobiera lub ustawia wartość logiczną, która kontroluje, czy tworzenie tokenu ustawi domyślne wyrażenie "exp", "nbf" i "iat", jeśli nie zostanie określone. (Odziedziczone po TokenHandler) |
| TokenLifetimeInMinutes |
Pobiera lub ustawia okres istnienia tokenu w minutach. (Odziedziczone po TokenHandler) |
| TokenType |
Pobiera typ securityToken obsługiwany przez tę procedurę obsługi. |
Metody
| Nazwa | Opis |
|---|---|
| AddActorToAttributes(ICollection<SamlAttribute>, ClaimsIdentity) |
Dodaje wszystkich aktorów. |
| CanReadToken(String) |
Określa, czy ciąg jest prawidłowym tokenem Saml, sprawdzając kod XML dla poprawnego elementu początkowego. |
| CanReadToken(XmlReader) |
Wskazuje, czy bieżący czytelnik jest umieszczony w asercji Saml. |
| ConsolidateAttributes(ICollection<SamlAttribute>) |
Zbiera atrybuty z typowym typem oświadczenia, typem wartości oświadczenia i oryginalnym wystawcą w jeden atrybut z wieloma wartościami. |
| CreateAdvice(SecurityTokenDescriptor) |
Zastąp tę metodę, aby podać element SamlAdvice do umieszczenia w tokenie Samltoken. |
| CreateAttribute(Claim) |
Generuje atrybut SamlAttribute z oświadczenia. |
| CreateAttributeStatement(SamlSubject, SecurityTokenDescriptor) |
Tworzy stan SamlAttributeStatements i dodaje je do kolekcji. Zastąpi tę metodę, aby zapewnić implementację niestandardową. Domyślne zachowanie polega na utworzeniu nowego obiektu SamlAttributeStatement dla każdego tematu w kolekcji tokenDescriptor.Subjects. |
| CreateAuthenticationStatement(SamlSubject, AuthenticationInformation) |
Tworzy element SamlAuthenticationStatement dla każdego elementu AuthenticationInformation znalezionego w uwierzytelnianieInformation. Zastąpi tę metodę, aby zapewnić implementację niestandardową. |
| CreateAuthorizationDecisionStatement(SecurityTokenDescriptor) |
Tworzy obiekt SamlAuthorizationDecisionStatement na podstawie elementu SecurityTokenDescriptor. |
| CreateClaimsIdentities(SamlSecurityToken, String, TokenValidationParameters) |
Tworzy oświadczenia na podstawie tokenu Saml securityToken. |
| CreateConditions(SecurityTokenDescriptor) |
Generuje wszystkie warunki dla języka saml |
| CreateSecurityTokenReference(SecurityToken, Boolean) |
Zwraca wartość SecurityKeyIdentifierClause. (Odziedziczone po SecurityTokenHandler) |
| CreateStatements(SecurityTokenDescriptor, AuthenticationInformation) |
Generuje wyliczenie samlStatements z klasy SecurityTokenDescriptor. Generowane są tylko stany SamlAttributeStatements i SamlAuthenticationStatements. Zastąp tę metodę, aby dostosować tworzenie instrukcji. Wywołania w kolejności (wszystkie są wirtualne): 1. CreateSamlSubject 2. CreateAttributeStatements 3. CreateAuthenticationStatements 4. CreateAuthorizationDecisionStatement |
| CreateSubject(SecurityTokenDescriptor) |
Zwraca element SamlSubject do użycia dla wszystkich instrukcji, które zostaną utworzone. Zastąp tę metodę, aby dostosować tworzenie obiektu SamlSubject. |
| CreateToken(SecurityTokenDescriptor, AuthenticationInformation) |
Tworzy obiekt SamlSecurityToken na podstawie informacji zawartych w pliku SecurityTokenDescriptor. |
| CreateToken(SecurityTokenDescriptor) |
Tworzy obiekt SamlSecurityToken na podstawie informacji zawartych w pliku SecurityTokenDescriptor. |
| CreateXmlStringFromAttributes(ICollection<SamlAttribute>) |
Tworzy ciąg w formacie XML z kolekcji atrybutów saml reprezentujących aktora. |
| ProcessAttributeStatement(SamlAttributeStatement, ClaimsIdentity, String) |
Tworzy oświadczenia na podstawie elementu SamlAttributeStatement. |
| ProcessAuthenticationStatement(SamlAuthenticationStatement, ClaimsIdentity, String) |
Tworzy oświadczenia na podstawie elementu SamlAuthenticationStatement. |
| ProcessAuthorizationDecisionStatement(SamlAuthorizationDecisionStatement, ClaimsIdentity, String) |
Tworzy oświadczenia na podstawie elementu SamlAuthorizationDecisionStatement. |
| ProcessCustomSubjectStatement(SamlStatement, ClaimsIdentity, String) |
Tworzy oświadczenia na podstawie instrukcji nieświadomych. |
| ProcessStatements(SamlSecurityToken, String, TokenValidationParameters) |
Przetwarza wszystkie instrukcje w celu wygenerowania oświadczeń. |
| ProcessSubject(SamlSubject, ClaimsIdentity, String) |
Tworzy oświadczenia podmiotu na podstawie elementu SamlSubject. |
| ReadSamlToken(String) |
Konwertuje ciąg na wystąpienie SamlSecurityTokenklasy . |
| ReadSamlToken(XmlReader) |
Odczytuje SamlSecurityToken miejsce, w którym element XmlReader znajduje się na początku asercji Saml. |
| ReadToken(String) |
Konwertuje ciąg na wystąpienie SamlSecurityTokenklasy . |
| ReadToken(XmlReader, TokenValidationParameters) |
Deserializuje z XML token typu obsługiwanego przez to wystąpienie. |
| ReadToken(XmlReader) |
Odczytuje SamlSecurityToken miejsce, w którym element XmlReader znajduje się na początku asercji Saml. |
| ResolveIssuerSigningKey(String, SamlSecurityToken, TokenValidationParameters) |
Zwraca wartość , SecurityKey która ma być używana do sprawdzania poprawności podpisu tokenu. |
| SetDelegateFromAttribute(SamlAttribute, ClaimsIdentity, String) |
Ta metoda jest wywoływana, gdy zostanie wykryty specjalny typ atrybutu SamlAttribute. Atrybut SamlAttribute przekazany w opakowuje atrybut SamlAttribute zawierający kolekcję AttributeValues, z których każda jest mapowana na oświadczenie. Wszystkie oświadczenia zostaną zwrócone w elemencie ClaimsIdentity z określonym wystawcą. |
| ValidateAudience(IEnumerable<String>, SecurityToken, TokenValidationParameters) |
Określa, czy odbiorcy znalezioni w obiekcie SamlSecurityToken są prawidłowe. |
| ValidateConditions(SamlSecurityToken, TokenValidationParameters) |
Weryfikuje warunki istnienia i odbiorców. |
| ValidateIssuer(String, SecurityToken, TokenValidationParameters) |
Określa, czy wystawca znaleziony w obiekcie SamlSecurityToken jest prawidłowy. |
| ValidateIssuerSecurityKey(SecurityKey, SamlSecurityToken, TokenValidationParameters) |
Sprawdza, czy SigningKey wartość jest oczekiwana. |
| ValidateIssuerSecurityKey(SecurityKey, SecurityToken, TokenValidationParameters) |
Sprawdza, czy element SecurityToken został podpisany przez prawidłowy SecurityKeyelement . |
| ValidateLifetime(Nullable<DateTime>, Nullable<DateTime>, SecurityToken, TokenValidationParameters) |
Weryfikuje okres istnienia obiektu SamlSecurityToken. |
| ValidateSignature(String, TokenValidationParameters) |
Sprawdza, czy podpis, jeśli został znaleziony, jest prawidłowy. |
| ValidateToken(String, TokenValidationParameters, SecurityToken) |
Odczytuje i weryfikuje prawidłowo sformułowany SamlSecurityTokenelement . |
| ValidateToken(XmlReader, TokenValidationParameters, SecurityToken) |
Odczytuje i weryfikuje prawidłowo sformułowany SamlSecurityTokenelement . |
| ValidateTokenAsync(SecurityToken, TokenValidationParameters) |
Weryfikuje token. W przypadku niepowodzenia walidacji nie zostanie zgłoszony żaden wyjątek; Zamiast tego wyjątek zostanie ustawiony we zwróconej właściwości TokenValidationResult.Exception. Osoby wywołujące powinny zawsze sprawdzać właściwość TokenValidationResult.IsValid, aby sprawdzić poprawność wyniku. (Odziedziczone po TokenHandler) |
| ValidateTokenAsync(String, TokenValidationParameters) |
Weryfikuje token. W przypadku niepowodzenia walidacji nie zostanie zgłoszony żaden wyjątek; Zamiast tego wyjątek zostanie ustawiony we zwróconej właściwości TokenValidationResult.Exception. Osoby wywołujące powinny zawsze sprawdzać właściwość TokenValidationResult.IsValid, aby sprawdzić poprawność wyniku. |
| ValidateTokenReplay(Nullable<DateTime>, String, TokenValidationParameters) |
Sprawdza poprawność odtwarzania tokenu. |
| WriteToken(SecurityToken) |
Serializuje element SamlSecurityToken do ciągu. |
| WriteToken(XmlWriter, SecurityToken) |
Serializuje dane XML jako securityToken typu obsługiwanego przez to wystąpienie. |