com.nimbusds.jose.crypto

Class X25519Encrypter

java.lang.Object

com.nimbusds.jose.crypto.X25519Encrypter

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEEncrypter, JWEProvider

@ThreadSafe
public class X25519Encrypter
extends Object
implements JWEEncrypter

Curve25519 Elliptic Curve Diffie-Hellman encrypter of JWE objects. Expects a public OctetKeyPair key with "crv" X25519.

See RFC 8037 for more information.

See also ECDHEncrypter for ECDH on other curves.

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 curve:

• Curve.X25519 (Curve25519)

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:

2018-07-12

Author:

Tim McLean

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<EncryptionMethod>	SUPPORTED_ENCRYPTION_METHODS The supported encryption methods by the ECDH crypto provider class.

Constructor Summary

Constructors

Constructor and Description
X25519Encrypter(OctetKeyPair publicKey) Creates a new Curve25519 Elliptic Curve Diffie-Hellman encrypter.

Method Summary

Modifier and Type	Method and Description
protected byte[]	decryptWithZ(JWEHeader header, SecretKey Z, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag) Decrypts the encrypted JWE parts using the specified shared secret ("Z").
JWECryptoParts	encrypt(JWEHeader header, byte[] clearText) Encrypts the specified clear text of a JWE object.
protected JWECryptoParts	encryptWithZ(JWEHeader header, SecretKey Z, byte[] clearText) Encrypts the specified plaintext using the specified shared secret ("Z").
protected com.nimbusds.jose.crypto.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.
OctetKeyPair	getPublicKey() Returns the public key.
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

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.

Constructor Detail

X25519Encrypter

public X25519Encrypter(OctetKeyPair publicKey)
                throws JOSEException

Creates a new Curve25519 Elliptic Curve Diffie-Hellman encrypter.

Parameters:

publicKey - The public key. Must not be null.

Throws:

JOSEException - If the key subtype is not supported.

Method Detail

supportedEllipticCurves

public Set<Curve> supportedEllipticCurves()

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

Returns:

The supported elliptic curves.

getPublicKey

public OctetKeyPair getPublicKey()

Returns the public key.

Returns:

The public 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.

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)
                               throws JOSEException

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

Throws:

JOSEException

decryptWithZ

protected byte[] decryptWithZ(JWEHeader header,
                              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.