Package com.nimbusds.jose.crypto
Class AESEncrypter
- java.lang.Object
-
- com.nimbusds.jose.crypto.impl.AESCryptoProvider
-
- com.nimbusds.jose.crypto.AESEncrypter
-
- All Implemented Interfaces:
JCAAware<JWEJCAContext>
,JOSEProvider
,JWEEncrypter
,JWEProvider
@ThreadSafe public class AESEncrypter extends AESCryptoProvider implements JWEEncrypter
AES and AES GCM key wrap encrypter ofJWE objects
. Expects an AES key.Encrypts the plain text with a generated AES key (the Content Encryption Key) according to the specified JOSE encryption method, then wraps the CEK with the specified AES key and returns it alongside the IV, cipher text and authentication tag. See RFC 7518, sections 4.4 and 4.7 for more information.
This class is thread-safe.
Supports the following key management algorithms:
JWEAlgorithm.A128KW
JWEAlgorithm.A192KW
JWEAlgorithm.A256KW
JWEAlgorithm.A128GCMKW
JWEAlgorithm.A192GCMKW
JWEAlgorithm.A256GCMKW
Supports the following content encryption algorithms:
- Version:
- 2017-06-01
- Author:
- Melisa Halsband, Vladimir Dzhuvinov, Dimitar A. Stoikov
-
-
Field Summary
-
Fields inherited from class com.nimbusds.jose.crypto.impl.AESCryptoProvider
COMPATIBLE_ALGORITHMS, SUPPORTED_ALGORITHMS, SUPPORTED_ENCRYPTION_METHODS
-
-
Constructor Summary
Constructors Constructor Description AESEncrypter(byte[] keyBytes)
Creates a new AES encrypter.AESEncrypter(OctetSequenceKey octJWK)
Creates a new AES encrypter.AESEncrypter(SecretKey kek)
Creates a new AES encrypter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JWECryptoParts
encrypt(JWEHeader header, byte[] clearText)
Encrypts the specified clear text of aJWE object
.JWEJCAContext
getJCAContext()
Returns the Java Cryptography Architecture (JCA) context.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.AESCryptoProvider
getKey
-
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.jca.JCAAware
getJCAContext
-
Methods inherited from interface com.nimbusds.jose.JWEProvider
supportedEncryptionMethods, supportedJWEAlgorithms
-
-
-
-
Constructor Detail
-
AESEncrypter
public AESEncrypter(SecretKey kek) throws KeyLengthException
Creates a new AES encrypter.- Parameters:
kek
- The Key Encryption Key. Must be 128 bits (16 bytes), 192 bits (24 bytes) or 256 bits (32 bytes). Must not benull
.- Throws:
KeyLengthException
- If the KEK length is invalid.
-
AESEncrypter
public AESEncrypter(byte[] keyBytes) throws KeyLengthException
Creates a new AES encrypter.- Parameters:
keyBytes
- The Key Encryption Key, as a byte array. Must be 128 bits (16 bytes), 192 bits (24 bytes) or 256 bits (32 bytes). Must not benull
.- Throws:
KeyLengthException
- If the KEK length is invalid.
-
AESEncrypter
public AESEncrypter(OctetSequenceKey octJWK) throws KeyLengthException
Creates a new AES encrypter.- Parameters:
octJWK
- The Key Encryption 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 benull
.- Throws:
KeyLengthException
- If the KEK length is invalid.
-
-
Method Detail
-
encrypt
public JWECryptoParts encrypt(JWEHeader header, byte[] clearText) throws JOSEException
Description copied from interface:JWEEncrypter
Encrypts the specified clear text of aJWE object
.- Specified by:
encrypt
in interfaceJWEEncrypter
- Parameters:
header
- The JSON Web Encryption (JWE) header. Must specify a supported JWE algorithm and method. Must not benull
.clearText
- The clear text to encrypt. Must not benull
.- 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.
-
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 thealg
JWE header parameter.- Specified by:
supportedJWEAlgorithms
in interfaceJWEProvider
- 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 theenc
JWE header parameter.- Specified by:
supportedEncryptionMethods
in interfaceJWEProvider
- 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 interfaceJCAAware<JWEJCAContext>
- Returns:
- The JCA context. Not
null
.
-
-