Package com.nimbusds.jose.crypto.factories

Class DefaultJWEDecrypterFactory

java.lang.Object

com.nimbusds.jose.crypto.factories.DefaultJWEDecrypterFactory

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEProvider, JWEDecrypterFactory

@ThreadSafe
public class DefaultJWEDecrypterFactory
extends Object
implements JWEDecrypterFactory

Default JSON Web Encryption (JWE) decrypter factory.

Supports all standard JWE algorithms implemented in the com.nimbusds.jose.crypto package.

Version:

2020-03-03

Author:

Vladimir Dzhuvinov, stisve

Field Summary

Fields

Modifier and Type	Field	Description
static Set<JWEAlgorithm>	SUPPORTED_ALGORITHMS	The supported JWE algorithms.
static Set<EncryptionMethod>	SUPPORTED_ENCRYPTION_METHODS	The supported encryption methods.

Constructor Summary

Constructors

Constructor	Description
DefaultJWEDecrypterFactory()

Method Summary

Modifier and Type	Method	Description
JWEDecrypter	createJWEDecrypter(JWEHeader header, Key key)	Creates a new JWE decrypter for the specified header and key.
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUPPORTED_ALGORITHMS

public static final Set<JWEAlgorithm> SUPPORTED_ALGORITHMS

The supported JWE algorithms.

SUPPORTED_ENCRYPTION_METHODS

public static final Set<EncryptionMethod> SUPPORTED_ENCRYPTION_METHODS

The supported encryption methods.

Constructor Detail

DefaultJWEDecrypterFactory

public DefaultJWEDecrypterFactory()

Method Detail

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.

createJWEDecrypter

public JWEDecrypter createJWEDecrypter(JWEHeader header,
                                       Key key)
                                throws JOSEException

Description copied from interface: JWEDecrypterFactory

Creates a new JWE decrypter for the specified header and key.

Specified by:

createJWEDecrypter in interface JWEDecrypterFactory

Parameters:

header - The JWE header. Not null.

key - The key intended to verify the JWS message. Not null.

Returns:

The JWE decrypter.

Throws:

JOSEException - If the JWE algorithm / encryption method is not supported or the key type or length doesn't match expected for the JWE algorithm.