Package com.nimbusds.jose.crypto

Class ECDHEncrypter

java.lang.Object

com.nimbusds.jose.crypto.impl.BaseJWEProvider

com.nimbusds.jose.crypto.impl.ECDHCryptoProvider

com.nimbusds.jose.crypto.ECDHEncrypter

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEEncrypter, JWEProvider

@ThreadSafe
public class ECDHEncrypter
extends ECDHCryptoProvider
implements JWEEncrypter

Elliptic Curve Diffie-Hellman encrypter of JWE objects for curves using EC JWK keys. Expects a public EC key (with a P-256, P-384 or P-521 curve).

See RFC 7518 section 4.6 for more information.

For Curve25519/X25519, see X25519Encrypter instead.

This class is thread-safe.

Supports the following key management algorithms:

• JWEAlgorithm.ECDH_ES
• JWEAlgorithm.ECDH_ES_A128KW
• JWEAlgorithm.ECDH_ES_A192KW
• JWEAlgorithm.ECDH_ES_A256KW

Supports the following elliptic curves:

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

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-05-17

Author:

Tim McLean, Vladimir Dzhuvinov, Fernando González Callejas, Egor Puzanov

Field Summary

Fields

Modifier and Type	Field	Description
static Set<Curve>	SUPPORTED_ELLIPTIC_CURVES	The supported EC JWK curves by the ECDH crypto provider class.

Fields inherited from class com.nimbusds.jose.crypto.impl.ECDHCryptoProvider

SUPPORTED_ALGORITHMS, SUPPORTED_ENCRYPTION_METHODS

Constructor Summary

Constructors

Constructor	Description
ECDHEncrypter(ECKey ecJWK)	Creates a new Elliptic Curve Diffie-Hellman encrypter.
ECDHEncrypter(ECPublicKey publicKey)	Creates a new Elliptic Curve Diffie-Hellman encrypter.
ECDHEncrypter(ECPublicKey publicKey, SecretKey contentEncryptionKey)	Creates a new Elliptic Curve Diffie-Hellman encrypter with an optionally specified content encryption key (CEK).

Method Summary

Modifier and Type	Method	Description
JWECryptoParts	encrypt(JWEHeader header, byte[] clearText)	Deprecated.
JWECryptoParts	encrypt(JWEHeader header, byte[] clearText, byte[] aad)	Encrypts the specified clear text of a JWE object.
ECPublicKey	getPublicKey()	Returns the public EC key.
Set<Curve>	supportedEllipticCurves()	Returns the names of the supported elliptic curves.

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

decryptWithZ, encryptWithZ, getConcatKDF, getCurve

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

Methods inherited from interface com.nimbusds.jose.jca.JCAAware

getJCAContext

Methods inherited from interface com.nimbusds.jose.JWEProvider

supportedEncryptionMethods, supportedJWEAlgorithms

Field Detail

SUPPORTED_ELLIPTIC_CURVES

public static final Set<Curve> SUPPORTED_ELLIPTIC_CURVES

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

Constructor Detail

ECDHEncrypter

public ECDHEncrypter(ECPublicKey publicKey)
              throws JOSEException

Creates a new Elliptic Curve Diffie-Hellman encrypter.

Parameters:

publicKey - The public EC key. Must not be null.

Throws:

JOSEException - If the elliptic curve is not supported.

ECDHEncrypter

public ECDHEncrypter(ECKey ecJWK)
              throws JOSEException

Creates a new Elliptic Curve Diffie-Hellman encrypter.

Parameters:

ecJWK - The EC JSON Web Key (JWK). Must not be null.

Throws:

JOSEException - If the elliptic curve is not supported.

ECDHEncrypter

public ECDHEncrypter(ECPublicKey publicKey,
                     SecretKey contentEncryptionKey)
              throws JOSEException

Creates a new Elliptic Curve Diffie-Hellman encrypter with an optionally specified content encryption key (CEK).

Parameters:

publicKey - The public EC key. Must not be null.

contentEncryptionKey - The content encryption key (CEK) to use. If specified its algorithm must be "AES" 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

getPublicKey

public ECPublicKey getPublicKey()

Returns the public EC key.

Returns:

The public EC key.

supportedEllipticCurves

public Set<Curve> supportedEllipticCurves()

Description copied from class: ECDHCryptoProvider

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

Specified by:

supportedEllipticCurves in class ECDHCryptoProvider

Returns:

The supported elliptic curves.

encrypt

@Deprecated
public JWECryptoParts encrypt(JWEHeader header,
                              byte[] clearText)
                       throws JOSEException

Deprecated.

Encrypts the specified clear text of a JWE object.

Parameters:

header - The JSON Web Encryption (JWE) header. Must specify a supported JWE algorithm and method. Must not be null.

clearText - The clear text to encrypt. Must not be null.

Returns:

The resulting JWE crypto parts.

Throws:

JOSEException - If the JWE algorithm or method is not supported or if encryption failed for some other internal reason.

encrypt

public JWECryptoParts encrypt(JWEHeader header,
                              byte[] clearText,
                              byte[] aad)
                       throws JOSEException

Description copied from interface: JWEEncrypter

Encrypts the specified clear text of a JWE object.

Specified by:

encrypt in interface JWEEncrypter

Parameters:

header - The JSON Web Encryption (JWE) header. Must specify a supported JWE algorithm and method. Must not be null.

clearText - The clear text to encrypt. Must not be null.

aad - The additional authenticated data. Must not be null.

Returns:

The resulting JWE crypto parts.

Throws:

JOSEException - If the JWE algorithm or method is not supported or if encryption failed for some other internal reason.