Language

JsonWebTokenHandler クラス

定義

json Web トークンを作成および検証するために設計された SecurityTokenHandler 。 「 https://datatracker.ietf.org/doc/html/rfc7519 と http://www.rfc-editor.org/info/rfc7515」を参照してください。

public class JsonWebTokenHandler : Microsoft.IdentityModel.Tokens.TokenHandler, Microsoft.IdentityModel.Tokens.Experimental.IResultBasedValidation
type JsonWebTokenHandler = class
    inherit TokenHandler
    interface IResultBasedValidation
Public Class JsonWebTokenHandler
Inherits TokenHandler
Implements IResultBasedValidation
継承
JsonWebTokenHandler
実装

注釈

この部分クラスには、トークンの検証に関連するメソッドとロジックが含まれています。

コンストラクター

Name 説明
JsonWebTokenHandler()

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

フィールド

Name 説明
Base64UrlEncodedUnsignedJWSHeader

次の JWT ヘッダーの Base64Url でエンコードされた文字列形式を取得します: { Alg, None }。

DefaultInboundClaimTypeMap

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

DefaultMapInboundClaims

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

プロパティ

Name 説明
CanValidateToken

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

InboundClaimTypeMap

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

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

既定値は ClaimTypeMapping.InboundClaimTypeMap です。

MapInboundClaims

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

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

既定値は false です。

MaximumTokenSizeInBytes

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

(継承元 TokenHandler)
SetDefaultTimesOnTokenCreation

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

(継承元 TokenHandler)
ShortClaimTypeProperty

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

TokenLifetimeInMinutes

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

(継承元 TokenHandler)
TokenType

JsonWebTokenの型を取得します。

メソッド

Name 説明
CanReadToken(String)

文字列が整形式の JSON Web トークン (JWT) であるかどうかを判断します。 https://datatracker.ietf.org/doc/html/rfc7519を参照してください。

CreateClaimsIdentity(JsonWebToken, TokenValidationParameters, String)

指定した発行者を持つClaimsIdentityからJsonWebTokenを作成します。

CreateClaimsIdentity(JsonWebToken, TokenValidationParameters)

ClaimsIdentityからJsonWebTokenを作成します。

CreateToken(SecurityTokenDescriptor)

JWS または JWE の JWT を作成します。

CreateToken(String, EncryptingCredentials, IDictionary<String,Object>)

JSON Web Encryption (JWE) を作成します。

CreateToken(String, EncryptingCredentials, String)

JSON Web Encryption (JWE) を作成します。

CreateToken(String, EncryptingCredentials)

JSON Web Encryption (JWE) を作成します。

CreateToken(String, IDictionary<String,Object>)

署名されていない JSON Web Signature (JWS) を作成します。

CreateToken(String, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)

JSON Web Encryption (JWE) を作成します。

CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>, IDictionary<String,Object>)

JSON Web Encryption (JWE) を作成します。

CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>)

JSON Web Encryption (JWE) を作成します。

CreateToken(String, SigningCredentials, EncryptingCredentials, String)

JSON Web Encryption (JWE) を作成します。

CreateToken(String, SigningCredentials, EncryptingCredentials)

JSON Web Encryption (JWE) を作成します。

CreateToken(String, SigningCredentials, IDictionary<String,Object>)

JSON Web Signature (JWS) を作成します。

CreateToken(String, SigningCredentials)

JSON Web Signature (JWS) を作成します。

CreateToken(String)

署名されていない JSON Web Signature (JWS) を作成します。

DecryptToken(JsonWebToken, TokenValidationParameters)

JWE を復号化し、クリア テキストを返します。

DecryptTokenWithConfigurationAsync(JsonWebToken, TokenValidationParameters, CancellationToken)

JWE を復号化し、クリア テキストを返します。

EncryptToken(String, EncryptingCredentials, IDictionary<String,Object>)

JWS を暗号化します。

EncryptToken(String, EncryptingCredentials, String, IDictionary<String,Object>)

JWS を暗号化します。

EncryptToken(String, EncryptingCredentials, String)

JWS を暗号化します。

EncryptToken(String, EncryptingCredentials)

JWS を暗号化します。

ReadJsonWebToken(ReadOnlyMemory<Char>)

文字の ReadOnlyMemory スパンを JsonWebTokenのインスタンスに変換します。

ReadJsonWebToken(String)

文字列を JsonWebToken のインスタンスに変換します。

ReadToken(String)

文字列を JsonWebToken のインスタンスに変換します。

ReplaceTokenHeader(JsonWebToken, String)

既存のJsonWebTokenのヘッダーを置き換え、既に解析済みのペイロードと署名を再利用して、新しいJsonWebTokenを作成します。

ResolveTokenDecryptionKey(String, JsonWebToken, TokenValidationParameters)

JWE の暗号化を解除するときに使用する SecurityKey を返します。

ValidateToken(String, TokenValidationParameters)
古い.

JWS または JWE を検証します。

ValidateTokenAsync(SecurityToken, TokenValidationParameters)

トークンを検証します。 検証エラーの場合、例外はスローされません。代わりに、返された TokenValidationResult.Exception プロパティで例外が設定されます。 呼び出し元は常に TokenValidationResult.IsValid プロパティをチェックして、結果の有効性を確認する必要があります。

ValidateTokenAsync(String, TokenValidationParameters)

トークンを検証します。 検証エラーの場合、例外はスローされません。代わりに、返された TokenValidationResult.Exception プロパティで例外が設定されます。 呼び出し元は常に TokenValidationResult.IsValid プロパティをチェックして、結果の有効性を確認する必要があります。

明示的なインターフェイスの実装

Name 説明
IResultBasedValidation.ValidateTokenAsync(SecurityToken, ValidationParameters, CallContext, CancellationToken)

json Web トークンを作成および検証するために設計された SecurityTokenHandler 。 「 https://datatracker.ietf.org/doc/html/rfc7519 と http://www.rfc-editor.org/info/rfc7515」を参照してください。

IResultBasedValidation.ValidateTokenAsync(SecurityToken, ValidationParameters, CallContext)

json Web トークンを作成および検証するために設計された SecurityTokenHandler 。 「 https://datatracker.ietf.org/doc/html/rfc7519 と http://www.rfc-editor.org/info/rfc7515」を参照してください。

IResultBasedValidation.ValidateTokenAsync(String, ValidationParameters, CallContext, CancellationToken)

json Web トークンを作成および検証するために設計された SecurityTokenHandler 。 「 https://datatracker.ietf.org/doc/html/rfc7519 と http://www.rfc-editor.org/info/rfc7515」を参照してください。

IResultBasedValidation.ValidateTokenAsync(String, ValidationParameters, CallContext)

json Web トークンを作成および検証するために設計された SecurityTokenHandler 。 「 https://datatracker.ietf.org/doc/html/rfc7519 と http://www.rfc-editor.org/info/rfc7515」を参照してください。

適用対象