Package com.nimbusds.jose.crypto.impl

Class MultiCryptoProvider

java.lang.Object

com.nimbusds.jose.crypto.impl.BaseJWEProvider

com.nimbusds.jose.crypto.impl.MultiCryptoProvider

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEProvider

Direct Known Subclasses:

MultiDecrypter, MultiEncrypter

public abstract class MultiCryptoProvider
extends BaseJWEProvider

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

Supports the following key management algorithms:

• JWEAlgorithm.A128KW
• JWEAlgorithm.A192KW
• JWEAlgorithm.A256KW
• JWEAlgorithm.A128GCMKW
• JWEAlgorithm.A192GCMKW
• JWEAlgorithm.A256GCMKW
• JWEAlgorithm.DIR
• JWEAlgorithm.ECDH_ES
• JWEAlgorithm.ECDH_ES_A128KW
• JWEAlgorithm.ECDH_ES_A192KW
• JWEAlgorithm.ECDH_ES_A256KW
• JWEAlgorithm.RSA_OAEP_256
• JWEAlgorithm.RSA_OAEP_384
• JWEAlgorithm.RSA_OAEP_512
• JWEAlgorithm.RSA_OAEP (deprecated)
• JWEAlgorithm.RSA1_5 (deprecated)

Supports the following elliptic curves:

• Curve.P_256
• Curve.P_384
• Curve.P_521
• Curve.X25519 (Curve25519)

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:

2023-03-24

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<Integer,Set<JWEAlgorithm>>	COMPATIBLE_ALGORITHMS	The JWE algorithms compatible with each key size in bits.
static final Set<JWEAlgorithm>	SUPPORTED_ALGORITHMS	The supported JWE algorithms by the direct crypto provider class.
static final Set<Curve>	SUPPORTED_ELLIPTIC_CURVES	The supported EC JWK curves by the ECDH crypto provider class.
static final Set<EncryptionMethod>	SUPPORTED_ENCRYPTION_METHODS	The supported encryption methods by the direct crypto provider class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MultiCryptoProvider(SecretKey cek)	Creates a new multi-recipient encryption / decryption provider.

Method Summary

Modifier and Type	Method	Description
Set<Curve>	supportedEllipticCurves()	Returns the names of the supported elliptic curves.

Methods inherited from class com.nimbusds.jose.crypto.impl.BaseJWEProvider

getCEK, getJCAContext, isCEKProvided, supportedEncryptionMethods, supportedJWEAlgorithms

Methods inherited from class java.lang.Object

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

Field Details

SUPPORTED_ALGORITHMS

public static final Set<JWEAlgorithm> SUPPORTED_ALGORITHMS

The supported JWE algorithms by the direct crypto provider class.

SUPPORTED_ENCRYPTION_METHODS

public static final Set<EncryptionMethod> SUPPORTED_ENCRYPTION_METHODS

The supported encryption methods by the direct crypto provider class.

COMPATIBLE_ALGORITHMS

public static final Map<Integer,Set<JWEAlgorithm>> COMPATIBLE_ALGORITHMS

The JWE algorithms compatible with each key size in bits.

SUPPORTED_ELLIPTIC_CURVES

public static final Set<Curve> SUPPORTED_ELLIPTIC_CURVES

The supported EC JWK curves by the ECDH crypto provider class.

Constructor Details

MultiCryptoProvider

protected MultiCryptoProvider(SecretKey cek)
                       throws KeyLengthException

Creates a new multi-recipient 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 Details

supportedEllipticCurves

public Set<Curve> supportedEllipticCurves()

Returns the names of the supported elliptic curves. These correspond to the crv EC JWK parameter.

Returns:

The supported elliptic curves.