com.nimbusds.jose.crypto

Class DirectEncrypter

java.lang.Object

com.nimbusds.jose.crypto.DirectEncrypter

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEEncrypter, JWEProvider

@ThreadSafe
public class DirectEncrypter
extends Object
implements JWEEncrypter

Direct encrypter of JWE objects with a shared symmetric key. This class is thread-safe.

Supports the following key management algorithms:

• JWEAlgorithm.DIR

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:

2014-06-29

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
static Set<JWEAlgorithm>	SUPPORTED_ALGORITHMS The supported JWE algorithms by the direct crypto provider class.
static Set<EncryptionMethod>	SUPPORTED_ENCRYPTION_METHODS The supported encryption methods by the direct crypto provider class.

Constructor Summary

Constructors

Constructor and Description
DirectEncrypter(byte[] keyBytes) Creates a new direct encrypter.
DirectEncrypter(OctetSequenceKey octJWK) Creates a new direct encrypter.
DirectEncrypter(SecretKey key) Creates a new direct encrypter.

Method Summary

Modifier and Type	Method and Description
JWECryptoParts	encrypt(JWEHeader header, byte[] clearText) Encrypts the specified clear text of a JWE object.
JWEJCAContext	getJCAContext() Returns the Java Cryptography Architecture (JCA) context.
SecretKey	getKey() Gets the Content Encryption Key (CEK).
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 direct crypto provider class.

SUPPORTED_ENCRYPTION_METHODS

public static final Set<EncryptionMethod> SUPPORTED_ENCRYPTION_METHODS

The supported encryption methods by the direct crypto provider class.

Constructor Detail

DirectEncrypter

public DirectEncrypter(SecretKey key)
                throws KeyLengthException

Creates a new direct encrypter.

Parameters:

key - The symmetric key. Its algorithm must be "AES". Must be 128 bits (16 bytes), 192 bits (24 bytes), 256 bits (32 bytes), 384 bits (48 bytes) or 512 bits (64 bytes) long. Must not be null.

Throws:

KeyLengthException - If the symmetric key length is not compatible.

DirectEncrypter

public DirectEncrypter(byte[] keyBytes)
                throws KeyLengthException

Creates a new direct encrypter.

Parameters:

keyBytes - The symmetric key, as a byte array. Must be 128 bits (16 bytes), 192 bits (24 bytes), 256 bits (32 bytes), 384 bits (48 bytes) or 512 bits (64 bytes) long. Must not be null.

Throws:

KeyLengthException - If the symmetric key length is not compatible.

DirectEncrypter

public DirectEncrypter(OctetSequenceKey octJWK)
                throws KeyLengthException

Creates a new direct encrypter.

Parameters:

octJWK - The symmetric key, as a JWK. Must be 128 bits (16 bytes), 192 bits (24 bytes), 256 bits (32 bytes), 384 bits (48 bytes) or 512 bits (64 bytes) long. Must not be null.

Throws:

KeyLengthException - If the symmetric key length is not compatible.

Method Detail

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.

getKey

public SecretKey getKey()

Gets the Content Encryption Key (CEK).

Returns:

The key.

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.