言語

JwtSecurityTokenHandler クラス

定義

json Web トークンを作成および検証するために設計された SecurityTokenHandler 。 参照: https://datatracker.ietf.org/doc/html/rfc7519http://www.rfc-editor.org/info/rfc7515

public class JwtSecurityTokenHandler : Microsoft.IdentityModel.Tokens.SecurityTokenHandler
type JwtSecurityTokenHandler = class
    inherit SecurityTokenHandler
Public Class JwtSecurityTokenHandler
Inherits SecurityTokenHandler
継承
JwtSecurityTokenHandler

コンストラクター

名前 説明
JwtSecurityTokenHandler()

JwtSecurityTokenHandler クラスの新しいインスタンスを初期化します。

フィールド

名前 説明
DefaultInboundClaimFilter

既定の要求の種類のフィルター一覧。

DefaultInboundClaimTypeMap

受信要求の既定の要求の種類マッピング。

DefaultMapInboundClaims

InboundClaimTypeMap を使用するかどうかを決定するフラグの既定値。

DefaultOutboundAlgorithmMap

JwtHeader アルゴリズムの既定のマッピング

DefaultOutboundClaimTypeMap

送信要求の既定の要求の種類マッピング。

プロパティ

名前 説明
CanValidateToken

このハンドラーが SecurityTokenを検証できるかどうかを示す値を返します。

CanWriteToken

このインスタンスが SecurityTokenを書き込むことができるかどうかを示す値を取得します。

InboundClaimFilter

ClaimsIdentity要求がJwtSecurityTokenを形成するときに要求をフィルター処理するために使用するISet<T>を取得または設定します。 JwtSecurityTokenが検証されると、このISet<T>で見つかった型を持つ要求はClaimsIdentityに追加されません。

既定値は ClaimTypeMapping.InboundClaimFilter です。

InboundClaimTypeMap

InboundClaimTypeMapの検証時に抽出されたTypeの要求のClaimsPrincipalを設定するときに使用されるJwtSecurityTokenを取得または設定します。

このマッピングを使用して変換した後、 Type は JSON 要求 'name' に設定されます。

既定値は ClaimTypeMapping.InboundClaimTypeMap です。

JsonClaimTypeProperty

値を JSON にシリアル化したときに認識された .Net 型 Properties のプロパティ名 Claims 取得または設定します。

詳細については、「 <seealso cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"></seealso> を参照してください。

MapInboundClaims

MapInboundClaimsの検証時に抽出される要求の種類をマップするかどうかを決定するときに使用されるJwtSecurityToken プロパティを取得または設定します。

これが true に設定されている場合、このマッピングを使用して変換した後、 Type は JSON 要求 'name' に設定されます。 それ以外の場合、マッピングは行われません。

既定値は、true です。

MaximumTokenSizeInBytes

処理される最大トークン サイズ (バイト単位) を取得および設定します。

(継承元 TokenHandler)
OutboundAlgorithmMap

JwtHeader コンストラクターに渡される送信アルゴリズム マップを取得します。

OutboundClaimTypeMap

ClaimからJwtSecurityTokenを作成するときに使用するOutboundClaimTypeMapを取得または設定します。

JSON 要求の 'name' 値は、このマッピングを使用して変換した後に Type に設定されます。

既定値は ClaimTypeMapping.OutboundClaimTypeMap です

SetDefaultTimesOnTokenCreation

トークンの作成で既定の 'exp'、'nbf' および 'iat' が指定されていない場合に設定するかどうかを制御するブール値を取得または設定します。

(継承元 TokenHandler)
ShortClaimTypeProperty

Propertiesの作成時にマッピングが発生した場合に、元の JSON 要求 'name' が含まれるClaimのプロパティ名を取得または設定します。

詳細については、「 <seealso cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"></seealso> を参照してください。

TokenLifetimeInMinutes

トークンの有効期間を分単位で取得または設定します。

(継承元 TokenHandler)
TokenType

JwtSecurityTokenの型を取得します。

メソッド

名前 説明
CanReadToken(String)

文字列が整形式の Json Web トークン (JWT) であるかどうかを判断します。

https://datatracker.ietf.org/doc/html/rfc7519 を参照

CanReadToken(XmlReader)

XmlReaderが読み取り可能な要素に配置されているかどうかを示します。

(継承元 SecurityTokenHandler)
CreateActorValue(ClaimsIdentity)

アクター要求の 'value' を作成します: { actort, 'value' }

CreateClaimsIdentity(JwtSecurityToken, String, TokenValidationParameters)

ClaimsIdentityからJwtSecurityTokenを作成します。

CreateEncodedJwt(SecurityTokenDescriptor)

Json Web トークン (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 Web トークン (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 Web トークン (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)

JWE を復号化するときに使用する SecurityKey を返します。

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)

コンパクト シリアル化形式で JWS または JWE としてエンコードされた "JSON Web トークン" (JWT) を読み取って検証します。

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)

JwtSecurityTokenの JSON ペイロードを検証します。

ValidateTokenReplay(Nullable<DateTime>, String, TokenValidationParameters)

JwtSecurityTokenが既に検証されているかどうかを判断します。

WriteToken(SecurityToken)

コンパクト シリアル化形式で JwtSecurityToken を JWT にシリアル化します。

WriteToken(XmlWriter, SecurityToken)

このインスタンスによって処理される型のトークンを XML にシリアル化します。

適用対象