JsonWebTokenHandler.CanReadToken(String) Method

Definition

Namespace:

Microsoft.IdentityModel.JsonWebTokens

Assembly:

Microsoft.IdentityModel.JsonWebTokens.dll

Package:

Microsoft.IdentityModel.JsonWebTokens v8.0.1

Determines if the string is a well formed JSON Web Token (JWT). See: https://datatracker.ietf.org/doc/html/rfc7519.

public virtual bool CanReadToken (string token);

abstract member CanReadToken : string -> bool
override this.CanReadToken : string -> bool

Public Overridable Function CanReadToken (token As String) As Boolean

Parameters

token

String

String that should represent a valid JWT.

Returns

Boolean

false if the token is null or whitespace.

false if token.Length is greater than MaximumTokenSizeInBytes.

true if the token is in JSON Compact Serialization format.

Remarks

Uses IsMatch(String, String) matching:

JWS: @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$"

JWE: (dir): @"^[A-Za-z0-9-_]+\.\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$"

JWE: (wrappedkey): @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]$"