JwtSecurityTokenHandler Класс

Определение

Пространство имен:: System.IdentityModel.Tokens.Jwt

Сборка:: System.IdentityModel.Tokens.Jwt.dll

Пакет:: System.IdentityModel.Tokens.Jwt v8.19.1

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Предназначен SecurityTokenHandler для создания и проверки веб-токенов Json. См. https://datatracker.ietf.org/doc/html/rfc7519 и http://www.rfc-editor.org/info/rfc7515

public class JwtSecurityTokenHandler : Microsoft.IdentityModel.Tokens.SecurityTokenHandler

type JwtSecurityTokenHandler = class
    inherit SecurityTokenHandler

Public Class JwtSecurityTokenHandler
Inherits SecurityTokenHandler

Наследование: Object

TokenHandler

SecurityTokenHandler
JwtSecurityTokenHandler

Конструкторы

Имя	Описание
JwtSecurityTokenHandler()	Инициализирует новый экземпляр класса JwtSecurityTokenHandler.

Поля

Имя	Описание
DefaultInboundClaimFilter	Список фильтров типов утверждений по умолчанию.
DefaultInboundClaimTypeMap	Сопоставление типов утверждений по умолчанию для входящих утверждений.
DefaultMapInboundClaims	Значение по умолчанию для флага, определяющее, используется ли inboundClaimTypeMap.
DefaultOutboundAlgorithmMap	Сопоставление алгоритмов JwtHeader по умолчанию
DefaultOutboundClaimTypeMap	Сопоставление типов утверждений по умолчанию для исходящих утверждений.

Свойства

Имя	Описание
CanValidateToken	Возвращает значение, указывающее, может ли этот обработчик проверить SecurityToken.
CanWriteToken	Возвращает значение, указывающее, может ли этот экземпляр написать SecurityTokenобъект.
InboundClaimFilter	Возвращает или задает ISet<T> используемые для фильтрации утверждений при заполнении формы JwtSecurityTokenутвержденийClaimsIdentity. JwtSecurityToken При проверке утверждения с типами, найденными в этом случаеISet<T>, не будут добавлены в .ClaimsIdentity Значение по умолчанию — ClaimTypeMapping.InboundClaimFilter.
InboundClaimTypeMap	Возвращает или задает InboundClaimTypeMap значение, которое используется при настройке Type утверждений в ClaimsPrincipal извлеченном JwtSecurityTokenпри проверке. Для Type утверждения JSON задано значение name после перевода с помощью этого сопоставления. Значением по умолчанию является ClaimTypeMapping.InboundClaimTypeMap.
JsonClaimTypeProperty	Возвращает или задает имя Properties свойства для типа .NET, распознаваемого при Claims сериализации значения в JSON. Дополнительные сведения см <. в разделе cref="P:System.IdentityModel.Token.JwtSecurityTokenHandler.InboundClaimTypeMap"></seealso> .
MapInboundClaims	Возвращает или задает MapInboundClaims свойство, используемое при определении того, следует ли сопоставлять типы утверждений, извлеченные при проверке JwtSecurityToken. Если задано значение true, Type то для утверждения JSON задано "имя" после перевода с помощью этого сопоставления. В противном случае сопоставление не выполняется. Значение по умолчанию — true.
MaximumTokenSizeInBytes	Возвращает и задает максимальный размер маркера в байтах, которые будут обработаны. (Унаследовано от TokenHandler)
OutboundAlgorithmMap	Возвращает карту исходящего алгоритма, передаваемую конструктору JwtHeader .
OutboundClaimTypeMap	Возвращает или задает значение OutboundClaimTypeMap , используемое при создании JwtSecurityToken из Claim(s). Значение утверждения JSON "name" устанавливается Type после перевода с помощью этого сопоставления. Значение по умолчанию — ClaimTypeMapping.OutboundClaimTypeMap
SetDefaultTimesOnTokenCreation	Возвращает или задает логическое значение, которое определяет, будет ли создание маркера задавать значения по умолчанию exp, nbf и iat, если не указано. (Унаследовано от TokenHandler)
ShortClaimTypeProperty	Возвращает или задает имя свойства, Properties которое будет содержать исходное утверждение JSON "name", если сопоставление произошло при Claimсоздании (s). Дополнительные сведения см <. в разделе cref="P:System.IdentityModel.Token.JwtSecurityTokenHandler.InboundClaimTypeMap"></seealso> .
TokenLifetimeInMinutes	Возвращает или задает время существования маркера в минутах. (Унаследовано от TokenHandler)
TokenType	Возвращает тип JwtSecurityToken.

Методы

Имя	Описание
CanReadToken(String)	Определяет, является ли строка хорошо сформированной веб-токеном Json (JWT). См.: https://datatracker.ietf.org/doc/html/rfc7519
CanReadToken(XmlReader)	Указывает, находится ли объект XmlReader в элементе, который можно прочитать. (Унаследовано от SecurityTokenHandler)
CreateActorValue(ClaimsIdentity)	Создает значение для утверждения субъекта: { actort, "value" }
CreateClaimsIdentity(JwtSecurityToken, String, TokenValidationParameters)	Создает объект ClaimsIdentity из JwtSecurityToken.
CreateEncodedJwt(SecurityTokenDescriptor)	Возвращает веб-токен JSON (JWT).
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	Создает JWT в формате компактной сериализации.
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)	Создает JWT в формате компактной сериализации.
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)	Создает JWT в формате компактной сериализации.
CreateJwtSecurityToken(SecurityTokenDescriptor)	Создает веб-токен Json (JWT).
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	Создает JwtSecurityToken
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)	Создает JwtSecurityToken
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)	Создает JwtSecurityToken
CreateSecurityTokenReference(SecurityToken, Boolean)	Возвращает SecurityKeyIdentifierClause. (Унаследовано от SecurityTokenHandler)
CreateToken(SecurityTokenDescriptor)	Создает веб-токен Json (JWT).
DecryptToken(JwtSecurityToken, TokenValidationParameters)	Расшифровывает JWE и возвращает четкий текст
ReadJwtToken(String)	Преобразует строку в экземпляр JwtSecurityToken.
ReadToken(String)	Преобразует строку в экземпляр JwtSecurityToken.
ReadToken(XmlReader, TokenValidationParameters)	Десериализует маркер с предоставленным TokenValidationParameters.
ReadToken(XmlReader)	Возвращает маркер безопасности. (Унаследовано от SecurityTokenHandler)
ResolveIssuerSigningKey(String, JwtSecurityToken, TokenValidationParameters)	Возвращает значение, используемое SecurityKey при проверке подписи маркера.
ResolveTokenDecryptionKey(String, JwtSecurityToken, TokenValidationParameters)	Возвращает значение, используемое SecurityKey при расшифровке JWE.
ValidateAudience(IEnumerable<String>, JwtSecurityToken, TokenValidationParameters)	Определяет, являются ли аудитории JwtSecurityToken допустимыми.
ValidateIssuer(String, JwtSecurityToken, TokenValidationParameters)	Определяет, является ли издатель допустимым JwtSecurityToken .
ValidateIssuerSecurityKey(SecurityKey, JwtSecurityToken, TokenValidationParameters)	SigningKey Проверяет, является ли ожидаемое значение.
ValidateLifetime(Nullable<DateTime>, Nullable<DateTime>, JwtSecurityToken, TokenValidationParameters)	Проверяет время существования JwtSecurityTokenобъекта.
ValidateSignature(String, TokenValidationParameters)	Проверяет, является ли подпись допустимой при обнаружении или необходимости.
ValidateToken(String, TokenValidationParameters, SecurityToken)	Считывает и проверяет код JSON Web Token (JWT), закодированный как JWS или JWE в компактном сериализованном формате.
ValidateToken(XmlReader, TokenValidationParameters, SecurityToken)	Считывает и проверяет маркер с помощью xmlReader и TokenValidationParameters (Унаследовано от SecurityTokenHandler)
ValidateTokenAsync(SecurityToken, TokenValidationParameters)	Проверяет маркер. При сбое проверки исключение не будет создано; Вместо этого исключение будет задано в возвращаемом свойстве TokenValidationResult.Exception. Вызывающие операторы всегда должны проверять свойство TokenValidationResult.IsValid, чтобы проверить допустимость результата. (Унаследовано от TokenHandler)
ValidateTokenAsync(String, TokenValidationParameters)	Проверяет маркер. При сбое проверки исключение не будет создано; Вместо этого исключение будет задано в возвращаемом свойстве TokenValidationResult.Exception. Вызывающие операторы всегда должны проверять свойство TokenValidationResult.IsValid, чтобы проверить допустимость результата.
ValidateTokenPayload(JwtSecurityToken, TokenValidationParameters)	Проверяет полезные данные JSON для объекта JwtSecurityToken.
ValidateTokenReplay(Nullable<DateTime>, String, TokenValidationParameters)	JwtSecurityToken Определяет, уже ли проверено значение.
WriteToken(SecurityToken)	Сериализует объект JwtSecurityToken в JWT в формате компактной сериализации.
WriteToken(XmlWriter, SecurityToken)	Сериализуется в XML-маркер типа, обрабатываемого этим экземпляром.

Применяется к

Обратная связь

Были ли сведения на этой странице полезными?