ECDHDecrypter (Nimbus JOSE + JWT v9.7)

java.lang.Object
- com.nimbusds.jose.crypto.impl.ECDHCryptoProvider
- - com.nimbusds.jose.crypto.ECDHDecrypter

All Implemented Interfaces:

CriticalHeaderParamsAware, JCAAware<JWEJCAContext>, JOSEProvider, JWEDecrypter, JWEProvider
```
public class ECDHDecrypter
extends ECDHCryptoProvider
implements JWEDecrypter, CriticalHeaderParamsAware
```
Elliptic Curve Diffie-Hellman decrypter of JWE objects for curves using EC JWK keys. Expects a private 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 X25519Decrypter instead.
This class is thread-safe.
Supports the following key management algorithms:
Supports the following elliptic curves:
Supports the following content encryption algorithms:
Version:

2018-12-12

Author:

Vladimir Dzhuvinov

Field Summary

Fields
Modifier and Type Field and 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

Fields
Modifier and Type	Field and Description
`static Set<Curve>`	`SUPPORTED_ELLIPTIC_CURVES` The supported EC JWK curves 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.
`ECDHDecrypter(PrivateKey privateKey, Set<String> defCritHeaders, Curve curve)` Creates a new Elliptic Curve Diffie-Hellman decrypter.

Method Summary

All Methods Instance Methods Concrete 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`.
`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.
`PrivateKey`	`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<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 com.nimbusds.jose.crypto.impl.ECDHCryptoProvider
decryptWithZ, encryptWithZ, encryptWithZ, getConcatKDF, getCurve

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_ELLIPTIC_CURVES
```
public static final Set<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.
  - ECDHDecrypter
```
public ECDHDecrypter(PrivateKey privateKey,
                     Set<String> defCritHeaders,
                     Curve curve)
              throws JOSEException
```
    Creates a new Elliptic Curve Diffie-Hellman decrypter. This constructor can also accept a private EC key located in a PKCS#11 store that doesn't expose the private key parameters (such as a smart card or HSM).
    
    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.
    
    curve - The key curve. Must not be null.
    
    Throws:
    
    JOSEException - If the elliptic curve is not supported.
- Method Detail
  - getPrivateKey
```
public PrivateKey getPrivateKey()
```
    Returns the private EC key.
    
    Returns:
    
    The private EC key. Casting to ECPrivateKey may not be possible if the key is located in a PKCS#11 store that doesn't expose the private key parameters.
  - 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.
  - 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.
  - 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.

Class ECDHDecrypter

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.nimbusds.jose.JWEProvider

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

Field Detail

SUPPORTED_ELLIPTIC_CURVES

Constructor Detail

ECDHDecrypter

ECDHDecrypter

ECDHDecrypter

ECDHDecrypter

Method Detail

getPrivateKey

supportedEllipticCurves

getProcessedCriticalHeaderParams

getDeferredCriticalHeaderParams

decrypt

supportedJWEAlgorithms

supportedEncryptionMethods

getJCAContext