com.nimbusds.jose.crypto

Class ECDHEncrypter

java.lang.Object

com.nimbusds.jose.crypto.ECDHEncrypter

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEEncrypter, JWEProvider

@ThreadSafe
public class ECDHEncrypter
extends Object
implements JWEEncrypter

Elliptic Curve Diffie-Hellman encrypter of JWE objects. 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:

• ECKey.Curve.P_256
• ECKey.Curve.P_384
• ECKey.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

Version:

2015-06-08

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
static Set<JWEAlgorithm>	SUPPORTED_ALGORITHMS The supported JWE algorithms by the ECDH crypto provider class.
static Set<ECKey.Curve>	SUPPORTED_ELLIPTIC_CURVES The supported EC JWK curves 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

Constructor and Description
ECDHEncrypter(ECKey ecJWK) Creates a new Elliptic Curve Diffie-Hellman encrypter.
ECDHEncrypter(ECPublicKey publicKey) Creates a new Elliptic Curve Diffie-Hellman encrypter.

Method Summary

Methods

Modifier and Type	Method and Description
JWECryptoParts	encrypt(JWEHeader header, byte[] clearText) Encrypts the specified clear text of a JWE object.
protected com.nimbusds.jose.crypto.ConcatKDF	getConcatKDF() Returns the Concatenation Key Derivation Function (KDF).
ECKey.Curve	getCurve() Returns the elliptic curve of the key (JWK designation).
JWEJCAContext	getJCAContext() Returns the Java Cryptography Architecture (JCA) context.
ECPublicKey	getPublicKey() Returns the public EC key.
Set<ECKey.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

Methods inherited from interface com.nimbusds.jose.JWEProvider

supportedEncryptionMethods, supportedJWEAlgorithms

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

getJCAContext

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.

SUPPORTED_ELLIPTIC_CURVES

public static final Set<ECKey.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.

Method Detail

getPublicKey

public ECPublicKey getPublicKey()

Returns the public EC key.

Returns:

The public EC key.

encrypt

public JWECryptoParts encrypt(JWEHeader header,
                     byte[] clearText)
                       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.

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.

getConcatKDF

protected com.nimbusds.jose.crypto.ConcatKDF getConcatKDF()

Returns the Concatenation Key Derivation Function (KDF).

Returns:

The concat KDF.

supportedEllipticCurves

public Set<ECKey.Curve> supportedEllipticCurves()

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

Returns:

The supported elliptic curves.

getCurve

public ECKey.Curve getCurve()

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

Returns:

The elliptic curve.

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.