io.jsonwebtoken.security

Class Jwks.HASH

java.lang.Object

io.jsonwebtoken.security.Jwks.HASH

Enclosing class:

Jwks

public static final class Jwks.HASH
extends Object

Various (but not all) IANA Hash Algorithms commonly used to compute JWK Thumbprints and ensure valid JWK Thumbprint URIs. Each algorithm is made available as a (public static final) constant for direct type-safe reference in application code. For example:

 Jwks.Jwks.builder()()
     // ... etc ...
     .idFromThumbprint(Jwts.HASH.SHA256) // <---
     .build()

or

 HashAlgorithm hashAlg = Jwks.HASH.SHA256;
 JwkThumbprint thumbprint = aJwk.thumbprint(hashAlg);
 String rfcMandatoryPrefix = "urn:ietf:params:oauth:jwk-thumbprint:" + hashAlg.getId();
 assert thumbprint.toURI().toString().startsWith(rfcMandatoryPrefix);
 

They are also available together as a Registry instance via the get() method.

Since:

0.12.0

See Also:

get()

Field Summary

Fields

Modifier and Type	Field and Description
static HashAlgorithm	SHA256 IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha-256.
static HashAlgorithm	SHA3_256 IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha3-256.
static HashAlgorithm	SHA3_384 IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha3-384.
static HashAlgorithm	SHA3_512 IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha3-512.
static HashAlgorithm	SHA384 IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha-384.
static HashAlgorithm	SHA512 IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha-512.

Method Summary

Methods

Modifier and Type	Method and Description
static Registry<String,HashAlgorithm>	get() Returns a registry of various (but not all) IANA Hash Algorithms commonly used to compute JWK Thumbprints and ensure valid JWK Thumbprint URIs.

Methods inherited from class java.lang.Object

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

Field Detail

SHA256

public static final HashAlgorithm SHA256

IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha-256. It is a HashAlgorithm alias for the native Java JCA SHA-256 MessageDigest algorithm.

SHA384

public static final HashAlgorithm SHA384

IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha-384. It is a HashAlgorithm alias for the native Java JCA SHA-384 MessageDigest algorithm.

SHA512

public static final HashAlgorithm SHA512

IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha-512. It is a HashAlgorithm alias for the native Java JCA SHA-512 MessageDigest algorithm.

SHA3_256

public static final HashAlgorithm SHA3_256

IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha3-256. It is a HashAlgorithm alias for the native Java JCA SHA3-256 MessageDigest algorithm.

This algorithm requires at least JDK 9 or a compatible JCA Provider (like BouncyCastle) in the runtime classpath.

SHA3_384

public static final HashAlgorithm SHA3_384

IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha3-384. It is a HashAlgorithm alias for the native Java JCA SHA3-384 MessageDigest algorithm.

This algorithm requires at least JDK 9 or a compatible JCA Provider (like BouncyCastle) in the runtime classpath.

SHA3_512

public static final HashAlgorithm SHA3_512

IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha3-512. It is a HashAlgorithm alias for the native Java JCA SHA3-512 MessageDigest algorithm.

This algorithm requires at least JDK 9 or a compatible JCA Provider (like BouncyCastle) in the runtime classpath.

Method Detail

get

public static Registry<String,HashAlgorithm> get()

Returns a registry of various (but not all) IANA Hash Algorithms commonly used to compute JWK Thumbprints and ensure valid JWK Thumbprint URIs.

Returns:

a registry of various (but not all) IANA Hash Algorithms commonly used to compute JWK Thumbprints and ensure valid JWK Thumbprint URIs.