Package com.nimbusds.jose.crypto.impl

Class DirectCryptoProvider

java.lang.Object

com.nimbusds.jose.crypto.impl.DirectCryptoProvider

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEProvider

Direct Known Subclasses:

DirectDecrypter, DirectEncrypter

public abstract class DirectCryptoProvider
extends java.lang.Object

The base abstract class for direct encrypters and decrypters of JWE objects with a shared symmetric key.

Supports the following key management algorithms:

• JWEAlgorithm.DIR

Supports the following content encryption algorithms:

• EncryptionMethod.A128CBC_HS256
• EncryptionMethod.A192CBC_HS384
• EncryptionMethod.A256CBC_HS512
• EncryptionMethod.A128GCM
• EncryptionMethod.A192GCM
• EncryptionMethod.A256GCM
• EncryptionMethod.A128CBC_HS256_DEPRECATED
• EncryptionMethod.A256CBC_HS512_DEPRECATED
• EncryptionMethod.XC20P

Version:

2022-09-20

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Set<JWEAlgorithm>	SUPPORTED_ALGORITHMS	The supported JWE algorithms by the direct crypto provider class.
static java.util.Set<EncryptionMethod>	SUPPORTED_ENCRYPTION_METHODS	The supported encryption methods by the direct crypto provider class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DirectCryptoProvider(javax.crypto.SecretKey cek)	Creates a new direct encryption / decryption provider.

Method Summary

Modifier and Type	Method	Description
JWEJCAContext	getJCAContext()	Returns the Java Cryptography Architecture (JCA) context.
javax.crypto.SecretKey	getKey()	Gets the Content Encryption Key (CEK).
java.util.Set<EncryptionMethod>	supportedEncryptionMethods()	Returns the names of the supported encryption methods by the JWE provier.
java.util.Set<JWEAlgorithm>	supportedJWEAlgorithms()	Returns the names of the supported algorithms by the JWE provider instance.

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_ALGORITHMS

public static final java.util.Set<JWEAlgorithm> SUPPORTED_ALGORITHMS

The supported JWE algorithms by the direct crypto provider class.

SUPPORTED_ENCRYPTION_METHODS

public static final java.util.Set<EncryptionMethod> SUPPORTED_ENCRYPTION_METHODS

The supported encryption methods by the direct crypto provider class.

Constructor Detail

DirectCryptoProvider

protected DirectCryptoProvider(javax.crypto.SecretKey cek)
                        throws KeyLengthException

Creates a new direct encryption / decryption provider.

Parameters:

cek - The Content Encryption Key (CEK). Must be 128 bits (16 bytes), 192 bits (24 bytes), 256 bits (32 bytes), 384 bits (48 bytes) or 512 bits (64 bytes) long. Must not be null.

Throws:

KeyLengthException - If the CEK length is not compatible.

Method Detail

getKey

public javax.crypto.SecretKey getKey()

Gets the Content Encryption Key (CEK).

Returns:

The key.

supportedJWEAlgorithms

public java.util.Set<JWEAlgorithm> supportedJWEAlgorithms()

Description copied from interface: JWEProvider

Returns the names of the supported algorithms by the JWE provider instance. These correspond to the alg JWE header parameter.

Specified by:

supportedJWEAlgorithms in interface JWEProvider

Returns:

The supported JWE algorithms, empty set if none.

supportedEncryptionMethods

public java.util.Set<EncryptionMethod> supportedEncryptionMethods()

Description copied from interface: JWEProvider

Returns the names of the supported encryption methods by the JWE provier. These correspond to the enc JWE header parameter.

Specified by:

supportedEncryptionMethods in interface JWEProvider

Returns:

The supported encryption methods, empty set if none.

getJCAContext

public JWEJCAContext getJCAContext()

Description copied from interface: JCAAware

Returns the Java Cryptography Architecture (JCA) context. May be used to set a specific JCA security provider or secure random generator.

Specified by:

getJCAContext in interface JCAAware<JWEJCAContext>

Returns:

The JCA context. Not null.