com.nimbusds.jose.crypto

Class ECDHDecrypter

java.lang.Object

com.nimbusds.jose.crypto.ECDHDecrypter

All Implemented Interfaces:

CriticalHeaderParamsAware, JCAAware<JWEJCAContext>, JOSEProvider, JWEDecrypter, JWEProvider

public class ECDHDecrypter
extends Object
implements JWEDecrypter, CriticalHeaderParamsAware

Elliptic Curve Diffie-Hellman decrypter 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
ECDHDecrypter(ECKey ecJWK) Creates a new Elliptic Curve Diffie-Hellman decrypter.
ECDHDecrypter(ECPrivateKey privateKey) Creates a new Elliptic Curve Diffie-Hellman decrypter.
ECDHDecrypter(ECPrivateKey privateKey, Set<String> defCritHeaders) Creates a new Elliptic Curve Diffie-Hellman decrypter.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag) Decrypts the specified cipher 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).
Set<String>	getDeferredCriticalHeaderParams() Returns the names of the critical (crit) header parameters that are deferred to the application for processing and will be ignored by the JWS verifier / JWE decrypter.
JWEJCAContext	getJCAContext() Returns the Java Cryptography Architecture (JCA) context.
ECPrivateKey	getPrivateKey() Returns the private EC key.
Set<String>	getProcessedCriticalHeaderParams() Returns the names of the critical (crit) header parameters that are understood and processed by the JWS verifier / JWE decrypter.
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

ECDHDecrypter

public ECDHDecrypter(ECPrivateKey privateKey)
              throws JOSEException

Creates a new Elliptic Curve Diffie-Hellman decrypter.

Parameters:

privateKey - The private EC key. Must not be null.

Throws:

JOSEException - If the elliptic curve is not supported.

ECDHDecrypter

public ECDHDecrypter(ECKey ecJWK)
              throws JOSEException

Creates a new Elliptic Curve Diffie-Hellman decrypter.

Parameters:

ecJWK - The EC JSON Web Key (JWK). Must contain a private part. Must not be null.

Throws:

JOSEException - If the elliptic curve is not supported.

ECDHDecrypter

public ECDHDecrypter(ECPrivateKey privateKey,
             Set<String> defCritHeaders)
              throws JOSEException

Creates a new Elliptic Curve Diffie-Hellman decrypter.

Parameters:

privateKey - The private EC key. Must not be null.

defCritHeaders - The names of the critical header parameters that are deferred to the application for processing, empty set or null if none.

Throws:

JOSEException - If the elliptic curve is not supported.

Method Detail

getPrivateKey

public ECPrivateKey getPrivateKey()

Returns the private EC key.

Returns:

The private EC key.

getProcessedCriticalHeaderParams

public Set<String> getProcessedCriticalHeaderParams()

Description copied from interface: CriticalHeaderParamsAware

Returns the names of the critical (crit) header parameters that are understood and processed by the JWS verifier / JWE decrypter.

Specified by:

getProcessedCriticalHeaderParams in interface CriticalHeaderParamsAware

Returns:

The names of the critical header parameters that are understood and processed, empty set if none.

getDeferredCriticalHeaderParams

public Set<String> getDeferredCriticalHeaderParams()

Description copied from interface: CriticalHeaderParamsAware

Returns the names of the critical (crit) header parameters that are deferred to the application for processing and will be ignored by the JWS verifier / JWE decrypter.

Specified by:

getDeferredCriticalHeaderParams in interface CriticalHeaderParamsAware

Returns:

The names of the critical header parameters that are deferred to the application for processing, empty set if none.

decrypt

public byte[] decrypt(JWEHeader header,
             Base64URL encryptedKey,
             Base64URL iv,
             Base64URL cipherText,
             Base64URL authTag)
               throws JOSEException

Description copied from interface: JWEDecrypter

Decrypts the specified cipher text of a JWE Object.

Specified by:

decrypt in interface JWEDecrypter

Parameters:

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

encryptedKey - The encrypted key, null if not required by the JWE algorithm.

iv - The initialisation vector, null if not required by the JWE algorithm.

cipherText - The cipher text to decrypt. Must not be null.

authTag - The authentication tag, null if not required.

Returns:

The clear text.

Throws:

JOSEException - If the JWE algorithm or method is not supported, if a critical header parameter is not supported or marked for deferral to the application, or if decryption failed for some other 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.