Package com.nimbusds.jose.crypto.impl

Class PasswordBasedCryptoProvider

java.lang.Object

com.nimbusds.jose.crypto.impl.PasswordBasedCryptoProvider

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEProvider

Direct Known Subclasses:

PasswordBasedDecrypter, PasswordBasedEncrypter

public abstract class PasswordBasedCryptoProvider
extends Object

The base abstract class for password-based encrypters and decrypters of JWE objects.

Supports the following key management algorithms:

• JWEAlgorithm.PBES2_HS256_A128KW
• JWEAlgorithm.PBES2_HS384_A192KW
• JWEAlgorithm.PBES2_HS512_A256KW

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
• EncryptionMethod.XC20P

Version:

2016-07-26

Author:

Vladimir Dzhuvinov

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PasswordBasedCryptoProvider(byte[] password)	Creates a new password-based encryption / decryption provider.

Method Summary

Modifier and Type	Method	Description
protected SecretKey	getCEK(EncryptionMethod enc)	Returns the content encryption key (CEK) to use.
JWEJCAContext	getJCAContext()	Returns the Java Cryptography Architecture (JCA) context.
byte[]	getPassword()	Returns the password.
String	getPasswordString()	Returns the password.
protected boolean	isCEKProvided()	Returns true if a content encryption key (CEK) was provided at construction time.
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 by the password-based crypto provider class.

SUPPORTED_ENCRYPTION_METHODS

public static final Set<EncryptionMethod> SUPPORTED_ENCRYPTION_METHODS

The supported encryption methods by the password-base crypto provider class.

Constructor Detail

PasswordBasedCryptoProvider

protected PasswordBasedCryptoProvider(byte[] password)

Creates a new password-based encryption / decryption provider.

Parameters:

password - The password bytes. Must not be empty or null.

Method Detail

getPassword

public byte[] getPassword()

Returns the password.

Returns:

The password bytes.

getPasswordString

public String getPasswordString()

Returns the password.

Returns:

The password as a UTF-8 encoded string.

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.

isCEKProvided

protected boolean isCEKProvided()

Returns true if a content encryption key (CEK) was provided at construction time.

Returns:

true if a CEK was provided at construction time, false if CEKs will be internally generated.

getCEK

protected SecretKey getCEK(EncryptionMethod enc)
                    throws JOSEException

Returns the content encryption key (CEK) to use. Unless a CEK was provided at construction time this will be a new internally generated CEK.

Parameters:

enc - The encryption method. Must not be null.

Returns:

The content encryption key (CEK).

Throws:

JOSEException - If an internal exception is encountered.