Package com.nimbusds.jose.crypto.impl

Class ECDH1PUCryptoProvider

java.lang.Object

com.nimbusds.jose.crypto.impl.ECDH1PUCryptoProvider

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEProvider

Direct Known Subclasses:

ECDH1PUDecrypter, ECDH1PUEncrypter, ECDH1PUX25519Decrypter, ECDH1PUX25519Encrypter

public abstract class ECDH1PUCryptoProvider
extends Object

The base abstract class for Elliptic Curve Diffie-Hellman One-Pass Unified Model encrypters and decrypters of JWE objects.

Supports the following key management algorithms:

• JWEAlgorithm.ECDH_1PU
• JWEAlgorithm.ECDH_1PU_A128KW
• JWEAlgorithm.ECDH_1PU_A192KW
• JWEAlgorithm.ECDH_1PU_A256KW

Supports the following elliptic curves:

• Curve.P_256
• Curve.P_384
• Curve.P_521
• Curve.X25519

Supports the following content encryption algorithms for Direct key agreement mode:

• 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

Supports the following content encryption algorithms for Key wrapping mode:

• EncryptionMethod.A128CBC_HS256
• EncryptionMethod.A192CBC_HS384
• EncryptionMethod.A256CBC_HS512

Version:

2023-09-10

Author:

Alexander Martynov, Egor Puzanov

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ECDH1PUCryptoProvider(Curve curve, SecretKey cek)	Creates a new Elliptic Curve Diffie-Hellman One-Pass Unified Model encryption / decryption provider.

Method Summary

Modifier and Type	Method	Description
protected byte[]	decryptWithZ(JWEHeader header, byte[] aad, SecretKey Z, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Decrypts the encrypted JWE parts using the specified shared secret ("Z").
protected JWECryptoParts	encryptWithZ(JWEHeader header, SecretKey Z, byte[] clearText, byte[] aad)	Encrypts the specified plaintext using the specified shared secret ("Z").
protected SecretKey	getCEK(EncryptionMethod enc)	Returns the content encryption key (CEK) to use.
protected ConcatKDF	getConcatKDF()	Returns the Concatenation Key Derivation Function (KDF).
Curve	getCurve()	Returns the elliptic curve of the key (JWK designation).
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.
abstract Set<Curve>	supportedEllipticCurves()	Returns the names of the supported elliptic curves.
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

Field Detail

SUPPORTED_ALGORITHMS

public static final Set<JWEAlgorithm> SUPPORTED_ALGORITHMS

The supported JWE algorithms by the ECDH crypto provider class.

SUPPORTED_ENCRYPTION_METHODS

public static final Set<EncryptionMethod> SUPPORTED_ENCRYPTION_METHODS

The supported encryption methods by the ECDH crypto provider class.

Constructor Detail

ECDH1PUCryptoProvider

protected ECDH1PUCryptoProvider(Curve curve,
                                SecretKey cek)
                         throws JOSEException

Creates a new Elliptic Curve Diffie-Hellman One-Pass Unified Model encryption / decryption provider.

Parameters:

curve - The elliptic curve. Must be supported and not 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.

Throws:

JOSEException - If the elliptic curve is not supported.

Method Detail

getConcatKDF

protected ConcatKDF getConcatKDF()

Returns the Concatenation Key Derivation Function (KDF).

Returns:

The concat KDF.

supportedEllipticCurves

public abstract Set<Curve> supportedEllipticCurves()

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

Returns:

The supported elliptic curves.

getCurve

public Curve getCurve()

Returns the elliptic curve of the key (JWK designation).

Returns:

The elliptic curve.

encryptWithZ

protected JWECryptoParts encryptWithZ(JWEHeader header,
                                      SecretKey Z,
                                      byte[] clearText,
                                      byte[] aad)
                               throws JOSEException

Encrypts the specified plaintext using the specified shared secret ("Z").

Throws:

JOSEException

decryptWithZ

protected byte[] decryptWithZ(JWEHeader header,
                              byte[] aad,
                              SecretKey Z,
                              Base64URL encryptedKey,
                              Base64URL iv,
                              Base64URL cipherText,
                              Base64URL authTag)
                       throws JOSEException

Decrypts the encrypted JWE parts using the specified shared secret ("Z").

Throws:

JOSEException

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.