Package com.nimbusds.jose.crypto.impl

Class PasswordBasedCryptoProvider

java.lang.Object

com.nimbusds.jose.crypto.impl.BaseJWEProvider

com.nimbusds.jose.crypto.impl.PasswordBasedCryptoProvider

All Implemented Interfaces:

JCAAware<JWEJCAContext>, JOSEProvider, JWEProvider

Direct Known Subclasses:

PasswordBasedDecrypter, PasswordBasedEncrypter

public abstract class PasswordBasedCryptoProvider
extends BaseJWEProvider

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 final Set<JWEAlgorithm>	SUPPORTED_ALGORITHMS	The supported JWE algorithms by the password-based crypto provider class.
static final 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
byte[]	getPassword()	Returns the password.
String	getPasswordString()	Returns the password.

Methods inherited from class com.nimbusds.jose.crypto.impl.BaseJWEProvider

getCEK, getJCAContext, isCEKProvided, supportedEncryptionMethods, supportedJWEAlgorithms

Methods inherited from class java.lang.Object

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

Field Details

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 Details

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 Details

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.