com.nimbusds.jose

Interface JWEDecrypter

All Superinterfaces:

AlgorithmProvider, JWEAlgorithmProvider

All Known Implementing Classes:

AESDecrypter, DirectDecrypter, RSADecrypter

public interface JWEDecrypter
extends JWEAlgorithmProvider

Interface for decrypting JSON Web Encryption (JWE) objects.

Callers can query the decrypter to determine its algorithm capabilities as well as the JWE algorithms and header parameters that are accepted for processing.

Version:

$version$ (2014-07-08)

Author:

Vladimir Dzhuvinov

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.
java.util.Set<JWEAlgorithm>	getAcceptedAlgorithms() Gets the names of the accepted JWE algorithms.
java.util.Set<EncryptionMethod>	getAcceptedEncryptionMethods() Gets the names of the accepted encryption methods.
java.util.Set<java.lang.String>	getIgnoredCriticalHeaderParameters() Gets the names of the critical JWE header parameters to ignore.
void	setAcceptedAlgorithms(java.util.Set<JWEAlgorithm> acceptedAlgs) Sets the names of the accepted JWE algorithms.
void	setAcceptedEncryptionMethods(java.util.Set<EncryptionMethod> acceptedEncs) Sets the names of the accepted encryption methods.
void	setIgnoredCriticalHeaderParameters(java.util.Set<java.lang.String> headers) Sets the names of the critical JWE header parameters to ignore.

Methods inherited from interface com.nimbusds.jose.JWEAlgorithmProvider

setContentEncryptionProvider, setKeyEncryptionProvider, setMACProvider, setSecureRandom, supportedAlgorithms, supportedEncryptionMethods

Methods inherited from interface com.nimbusds.jose.AlgorithmProvider

setProvider

Method Detail

getAcceptedAlgorithms

java.util.Set<JWEAlgorithm> getAcceptedAlgorithms()

Gets the names of the accepted JWE algorithms. These correspond to the alg JWE header parameter.

Returns:

The accepted JWE algorithms, as a read-only set, empty set if none.

See Also:

setAcceptedAlgorithms(java.util.Set<com.nimbusds.jose.JWEAlgorithm>)

setAcceptedAlgorithms

void setAcceptedAlgorithms(java.util.Set<JWEAlgorithm> acceptedAlgs)

Sets the names of the accepted JWE algorithms. These correspond to the alg JWE header parameter.

For JWE decrypters that support multiple JWE algorithms this method can be used to indicate that only a subset should be accepted for processing.

Parameters:

acceptedAlgs - The accepted JWE algorithms. Must be a subset of the supported algorithms and not null.

getAcceptedEncryptionMethods

java.util.Set<EncryptionMethod> getAcceptedEncryptionMethods()

Gets the names of the accepted encryption methods. These correspond to the enc JWE header parameter.

Returns:

The accepted encryption methods, as a read-only set, empty set if none.

See Also:

setAcceptedEncryptionMethods(java.util.Set<com.nimbusds.jose.EncryptionMethod>)

setAcceptedEncryptionMethods

void setAcceptedEncryptionMethods(java.util.Set<EncryptionMethod> acceptedEncs)

Sets the names of the accepted encryption methods. These correspond to the enc JWE header parameter.

For JWE decrypters that support multiple encryption methods this method can be used to indicate that only a subset should be accepted for processing.

Parameters:

acceptedEncs - The accepted encryption methods. Must be a subset of the supported encryption methods and not null.

getIgnoredCriticalHeaderParameters

java.util.Set<java.lang.String> getIgnoredCriticalHeaderParameters()

Gets the names of the critical JWE header parameters to ignore. These are indicated by the crit header parameter. The JWE decrypter should not ignore critical headers by default.

Returns:

The names of the critical JWS header parameters to ignore, empty or null if none.

setIgnoredCriticalHeaderParameters

void setIgnoredCriticalHeaderParameters(java.util.Set<java.lang.String> headers)

Sets the names of the critical JWE header parameters to ignore. These are indicated by the crit header parameter. The JWE decrypter should not ignore critical headers by default. Use this setter to delegate processing of selected critical headers to the application.

Parameters:

headers - The names of the critical JWS header parameters to ignore, empty or null if none.

decrypt

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

Decrypts the specified cipher text of a JWE Object.

Parameters:

header - The JSON Web Encryption (JWE) header. Must specify an accepted JWE algorithm, must contain only accepted header parameters, and 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 is not accepted, if a header parameter is not accepted, or if decryption failed for some other reason.