io.jsonwebtoken

Class Jwts.ENC

java.lang.Object

io.jsonwebtoken.Jwts.ENC

Enclosing class:

Jwts

public static final class Jwts.ENC
extends Object

Constants for all standard JWA Cryptographic Algorithms for Content Encryption defined in the JSON Web Signature and Encryption Algorithms Registry. Each standard algorithm is available as a (public static final) constant for direct type-safe reference in application code. For example:

 Jwts.builder()
    // ... etc ...
    .encryptWith(aKey, Jwts.ENC.A256GCM) // or A128GCM, A192GCM, etc...
    .build();

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 AeadAlgorithm	A128CBC_HS256 AES_128_CBC_HMAC_SHA_256 authenticated encryption algorithm as defined by RFC 7518, Section 5.2.3.
static AeadAlgorithm	A128GCM "AES GCM using 128-bit key" as defined by RFC 7518, Section 5.31.
static AeadAlgorithm	A192CBC_HS384 AES_192_CBC_HMAC_SHA_384 authenticated encryption algorithm, as defined by RFC 7518, Section 5.2.4.
static AeadAlgorithm	A192GCM "AES GCM using 192-bit key" as defined by RFC 7518, Section 5.31.
static AeadAlgorithm	A256CBC_HS512 AES_256_CBC_HMAC_SHA_512 authenticated encryption algorithm, as defined by RFC 7518, Section 5.2.5.
static AeadAlgorithm	A256GCM "AES GCM using 256-bit key" as defined by RFC 7518, Section 5.31.

Method Summary

Methods

Modifier and Type	Method and Description
static Registry<String,AeadAlgorithm>	get() Returns all standard JWA Cryptographic Algorithms for Content Encryption defined in the JSON Web Signature and Encryption Algorithms Registry.

Methods inherited from class java.lang.Object

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

Field Detail

A128CBC_HS256

public static final AeadAlgorithm A128CBC_HS256

AES_128_CBC_HMAC_SHA_256 authenticated encryption algorithm as defined by RFC 7518, Section 5.2.3. This algorithm requires a 256-bit (32 byte) key.

A192CBC_HS384

public static final AeadAlgorithm A192CBC_HS384

AES_192_CBC_HMAC_SHA_384 authenticated encryption algorithm, as defined by RFC 7518, Section 5.2.4. This algorithm requires a 384-bit (48 byte) key.

A256CBC_HS512

public static final AeadAlgorithm A256CBC_HS512

AES_256_CBC_HMAC_SHA_512 authenticated encryption algorithm, as defined by RFC 7518, Section 5.2.5. This algorithm requires a 512-bit (64 byte) key.

A128GCM

public static final AeadAlgorithm A128GCM

"AES GCM using 128-bit key" as defined by RFC 7518, Section 5.3¹. This algorithm requires a 128-bit (16 byte) key.

¹ Requires Java 8 or a compatible JCA Provider (like BouncyCastle) in the runtime classpath. If on Java 7 or earlier, BouncyCastle will be used automatically if found in the runtime classpath.

A192GCM

public static final AeadAlgorithm A192GCM

"AES GCM using 192-bit key" as defined by RFC 7518, Section 5.3¹. This algorithm requires a 192-bit (24 byte) key.

¹ Requires Java 8 or a compatible JCA Provider (like BouncyCastle) in the runtime classpath. If on Java 7 or earlier, BouncyCastle will be used automatically if found in the runtime classpath.

A256GCM

public static final AeadAlgorithm A256GCM

"AES GCM using 256-bit key" as defined by RFC 7518, Section 5.3¹. This algorithm requires a 256-bit (32 byte) key.

¹ Requires Java 8 or a compatible JCA Provider (like BouncyCastle) in the runtime classpath. If on Java 7 or earlier, BouncyCastle will be used automatically if found in the runtime classpath.

Method Detail

get

public static Registry<String,AeadAlgorithm> get()

Returns all standard JWA Cryptographic Algorithms for Content Encryption defined in the JSON Web Signature and Encryption Algorithms Registry.

Returns:

all standard JWA content encryption algorithms.