org.forgerock.json.jose.utils

Class Utils

java.lang.Object

org.forgerock.json.jose.utils.Utils

public final class Utils
extends Object

This class provides utility methods to share common behaviour.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	CHARSET UTF-8 Charset.

Method Summary

Modifier and Type	Method and Description
static String	base64urlDecode(String s) Deprecated. Use Utils.decodeJwtComponent(String).
static String	base64urlEncode(String s) Deprecated. Use Utils.encodeJwtComponent(String).
static boolean	constantEquals(byte[] a, byte[] b) Compares two byte arrays for equality, in a constant time.
static String	decodeJwtComponent(String s) Decodes the given String and converts the decoded bytes into a UTF-8 String.
static String	encodeJwtComponent(String s) Encodes the given String, converting the String to UTF-8 bytes.
static Map<String,Object>	parseJson(String json) Parses the given JSON string into a NoDuplicatesMap.
static byte[]	reverse(byte[] xs) Reverses the given array and returns the reversed copy.
static byte[]	sha256(byte[] data) Convenience method to perform SHA-256 hashing of the input data.
static String	writeJsonObject(Map<String,Object> object) Writes the given map as a string in JSON object format.

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET

public static final Charset CHARSET

UTF-8 Charset.

Method Detail

base64urlEncode

public static String base64urlEncode(String s)

Deprecated. Use Utils.encodeJwtComponent(String).

Base64url encodes the given String, converting the String to UTF-8 bytes.

Parameters:

s - The String to encode.

Returns:

A Base64url encoded UTF-8 String.

base64urlDecode

public static String base64urlDecode(String s)

Deprecated. Use Utils.decodeJwtComponent(String).

Base64url decodes the given String and converts the decoded bytes into a UTF-8 String.

Parameters:

s - The Base64url encoded String to decode.

Returns:

The UTF-8 decoded String.

encodeJwtComponent

public static String encodeJwtComponent(String s)

Encodes the given String, converting the String to UTF-8 bytes.

Parameters:

s - The String to encode.

Returns:

An encoded UTF-8 String.

decodeJwtComponent

public static String decodeJwtComponent(String s)

Decodes the given String and converts the decoded bytes into a UTF-8 String.

Parameters:

s - The encoded String to decode.

Returns:

The UTF-8 decoded String.

constantEquals

public static boolean constantEquals(byte[] a,
                                     byte[] b)

Compares two byte arrays for equality, in a constant time.

If the two byte arrays don't match the method will not return until the whole byte array has been checked. This prevents timing attacks. Unless the two arrays are not off equal length, and in this case the method will return immediately.

Parameters:

a - One of the byte arrays to compare.

b - The other byte array to compare.

Returns:

true if the arrays are equal, false otherwise.

parseJson

public static Map<String,Object> parseJson(String json)

Parses the given JSON string into a NoDuplicatesMap.

The JWT specification details that any JWT with duplicate header parameters or claims MUST be rejected so a Map implementation is used to parse the JSON which will throw an exception if an entry with the same key is added to the map more than once.

Parameters:

json - The JSON string to parse.

Returns:

A Map of the JSON properties.

Throws:

InvalidJwtException - if the json value is not well formed or contains duplicate keys.

writeJsonObject

public static String writeJsonObject(Map<String,Object> object)

Writes the given map as a string in JSON object format.

Parameters:

object - the object to write as JSON.

Returns:

the JSON serialisation of the given object.

Throws:

InvalidJwtException - if the object cannot be converted to JSON for any reason.

sha256

public static byte[] sha256(byte[] data)

Convenience method to perform SHA-256 hashing of the input data.

Parameters:

data - the data to hash.

Returns:

the SHA-256 hash of the data.

reverse

public static byte[] reverse(byte[] xs)

Reverses the given array and returns the reversed copy.

Parameters:

xs - the array to reverse.

Returns:

the reversed array.