io.jsonwebtoken.security

Class Jwks

java.lang.Object

io.jsonwebtoken.security.Jwks

public final class Jwks
extends Object

Utility methods for creating JWKs (JSON Web Keys) with a type-safe builder.

Standard JWK Thumbprint Algorithm References

Standard IANA Hash Algorithms commonly used to compute JWK Thumbprints and ensure valid JWK Thumbprint URIs are available via the Jwks.HASH registry constants to allow for easy code-completion in IDEs. For example, when typing:

 Jwks.HASH.// press hotkeys to suggest individual hash algorithms or utility methods

Since:

0.12.0

See Also:

builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Jwks.CRV Constants for all standard JWK crv (Curve) parameter values defined in the JSON Web Key Elliptic Curve Registry (including its Edwards Elliptic Curve additions).
static class	Jwks.HASH Various (but not all) IANA Hash Algorithms commonly used to compute JWK Thumbprints and ensure valid JWK Thumbprint URIs.
static class	Jwks.OP Constants for all standard JWK key_ops (Key Operations) parameter values defined in the JSON Web Key Operations Registry.

Method Summary

Methods

Modifier and Type	Method and Description
static DynamicJwkBuilder<?,?>	builder() Return a new JWK builder instance, allowing for type-safe JWK builder coercion based on a specified key or key pair.
static String	json(PublicJwk<?> publicJwk) Converts the specified PublicJwk into JSON.
static JwkParserBuilder	parser() Returns a new builder used to create Parsers that parse JSON into Jwk instances.
static JwkSetBuilder	set() Return a new builder used to create JwkSets.
static JwkSetParserBuilder	setParser() Returns a new builder used to create Parsers that parse JSON into JwkSet instances.
static String	UNSAFE_JSON(Jwk<?> jwk) WARNING - UNSAFE OPERATION - RETURN VALUES CONTAIN RAW KEY MATERIAL, DO NOT LOG OR PRINT TO SYSTEM.OUT. Converts the specified JWK into JSON, including raw key material.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static DynamicJwkBuilder<?,?> builder()

Return a new JWK builder instance, allowing for type-safe JWK builder coercion based on a specified key or key pair.

Returns:

a new JWK builder instance, allowing for type-safe JWK builder coercion based on a specified key or key pair.

parser

public static JwkParserBuilder parser()

Returns a new builder used to create Parsers that parse JSON into Jwk instances. For example:

 Jwk<?> jwk = Jwks.parser()
         //.provider(aJcaProvider)     // optional
         //.deserializer(deserializer) // optional
         //.operationPolicy(policy)    // optional
         .build()
         .parse(jwkString);

Returns:

a new builder used to create Parsers that parse JSON into Jwk instances.

set

public static JwkSetBuilder set()

Return a new builder used to create JwkSets. For example:

 JwkSet jwkSet = Jwks.set()
     //.provider(aJcaProvider)     // optional
     //.operationPolicy(policy)    // optional
     .add(aJwk)                    // appends a key
     .add(aCollection)             // appends multiple keys
     //.keys(allJwks)              // sets/replaces all keys
     .build()
 

Returns:

a new builder used to create JwkSets

setParser

public static JwkSetParserBuilder setParser()

Returns a new builder used to create Parsers that parse JSON into JwkSet instances. For example:

 JwkSet jwkSet = Jwks.setParser()
         //.provider(aJcaProvider)     // optional
         //.deserializer(deserializer) // optional
         //.operationPolicy(policy)    // optional
         .build()
         .parse(jwkSetString);

Returns:

a new builder used to create Parsers that parse JSON into JwkSet instances.

json

public static String json(PublicJwk<?> publicJwk)

Converts the specified PublicJwk into JSON. Because PublicJwks do not contain secret or private key material, they are safe to be printed to application logs or System.out.

Parameters:

publicJwk - the PublicJwk to convert to JSON

Returns:

the JWK's canonical JSON value

UNSAFE_JSON

public static String UNSAFE_JSON(Jwk<?> jwk)

WARNING - UNSAFE OPERATION - RETURN VALUES CONTAIN RAW KEY MATERIAL, DO NOT LOG OR PRINT TO SYSTEM.OUT. Converts the specified JWK into JSON, including raw key material. If the specified JWK is a SecretJwk or a PrivateJwk, be very careful with the return value, ensuring it is not printed to application logs or system.out.

Parameters:

jwk - the JWK to convert to JSON

Returns:

the JWK's canonical JSON value