Package com.nimbusds.jose.crypto.impl

Class BaseJWEProvider

java.lang.Object

com.nimbusds.jose.crypto.impl.BaseJWEProvider

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEProvider

Direct Known Subclasses:

AESCryptoProvider, DirectCryptoProvider, ECDH1PUCryptoProvider, ECDHCryptoProvider, MultiCryptoProvider, PasswordBasedCryptoProvider, RSACryptoProvider

public abstract class BaseJWEProvider
extends Object
implements JWEProvider

The base abstract class for JSON Web Encryption (JWE) encrypters and decrypters.

Version:

2023-09-18

Author:

Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor	Description
BaseJWEProvider(Set<JWEAlgorithm> algs, Set<EncryptionMethod> encs)	Creates a new base JWE provider.
BaseJWEProvider(Set<JWEAlgorithm> algs, Set<EncryptionMethod> encs, SecretKey cek)	Creates a new base JWE provider.

Method Summary

Modifier and Type	Method	Description
protected SecretKey	getCEK(EncryptionMethod enc)	Returns the content encryption key (CEK) to use.
JWEJCAContext	getJCAContext()	Returns the Java Cryptography Architecture (JCA) context.
protected boolean	isCEKProvided()	Returns true if a content encryption key (CEK) was provided at construction time.
Set<EncryptionMethod>	supportedEncryptionMethods()	Returns the names of the supported encryption methods by the JWE provier.
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

Constructor Detail

BaseJWEProvider

public BaseJWEProvider(Set<JWEAlgorithm> algs,
                       Set<EncryptionMethod> encs)

Creates a new base JWE provider.

Parameters:

algs - The supported algorithms by the JWE provider instance. Must not be null.

encs - The supported encryption methods by the JWE provider instance. Must not be null.

BaseJWEProvider

public BaseJWEProvider(Set<JWEAlgorithm> algs,
                       Set<EncryptionMethod> encs,
                       SecretKey cek)

Creates a new base JWE provider.

Parameters:

algs - The supported algorithms by the JWE provider instance. Must not be null.

encs - The supported encryption methods by the JWE provider instance. Must not be null.

cek - The content encryption key (CEK) to use. If specified its algorithm must be "AES" or "ChaCha20" and its length must match the expected for the JWE encryption method ("enc"). If null a CEK will be generated for each JWE.

Method Detail

supportedJWEAlgorithms

public 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 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.

isCEKProvided

protected boolean isCEKProvided()

Returns true if a content encryption key (CEK) was provided at construction time.

Returns:

true if a CEK was provided at construction time, false if CEKs will be internally generated.

getCEK

protected SecretKey getCEK(EncryptionMethod enc)
                    throws JOSEException

Returns the content encryption key (CEK) to use. Unless a CEK was provided at construction time this will be a new internally generated CEK.

Parameters:

enc - The encryption method. Must not be null.

Returns:

The content encryption key (CEK).

Throws:

JOSEException - If an internal exception is encountered.