com.amazonaws.mobileconnectors.cognitoidentityprovider.util

Class CognitoJWTParser

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.util.CognitoJWTParser

public class CognitoJWTParser
extends java.lang.Object

Utility class for all operations on JWT.

Constructor Summary

Constructors

Constructor and Description
CognitoJWTParser()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getClaim(java.lang.String jwt, java.lang.String claim) Returns a claim, from the JWTs' payload, as a String.
static org.json.JSONObject	getHeader(java.lang.String jwt) Returns header for a JWT as a JSON object.
static org.json.JSONObject	getPayload(java.lang.String jwt) Returns payload of a JWT as a JSON object.
static java.lang.String	getSignature(java.lang.String jwt) Returns signature of a JWT as a String.
static boolean	hasClaim(java.lang.String jwt, java.lang.String key) Checks if a JWT token contains a claim.
static void	validateJWT(java.lang.String jwt) Checks if JWT is a valid JSON Web Token.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CognitoJWTParser

public CognitoJWTParser()

Method Detail

getHeader

public static org.json.JSONObject getHeader(java.lang.String jwt)

Returns header for a JWT as a JSON object.

Parameters:

jwt - REQUIRED: valid JSON Web Token as String.

Returns:

header as a JSONObject.

getPayload

public static org.json.JSONObject getPayload(java.lang.String jwt)

Returns payload of a JWT as a JSON object.

Parameters:

jwt - REQUIRED: valid JSON Web Token as String.

Returns:

payload as a JSONObject.

getSignature

public static java.lang.String getSignature(java.lang.String jwt)

Returns signature of a JWT as a String.

Parameters:

jwt - REQUIRED: valid JSON Web Token as String.

Returns:

signature as a String.

getClaim

public static java.lang.String getClaim(java.lang.String jwt,
                                        java.lang.String claim)

Returns a claim, from the JWTs' payload, as a String.

Parameters:

jwt - REQUIRED: valid JSON Web Token as String.

claim - REQUIRED: claim name as String.

Returns:

claim from the JWT as a String.

hasClaim

public static boolean hasClaim(java.lang.String jwt,
                               java.lang.String key)

Checks if a JWT token contains a claim.

Parameters:

jwt - A string, possibly not event a JWT

key - Key for a claim, e.g., "jti" or "aud"

Returns:

True if JWT is a valid JWT and contains the requested claim, false otherwise

validateJWT

public static void validateJWT(java.lang.String jwt)

Checks if JWT is a valid JSON Web Token.

Parameters:

jwt - REQUIRED: The JWT as a String.