Package org.opencms.crypto

Class CmsAESTextEncryption

java.lang.Object

org.opencms.crypto.CmsAESTextEncryption

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsTextEncryption

public class CmsAESTextEncryption
extends Object
implements I_CmsTextEncryption

Default text encryption class using AES, where the encryption key is generated from a string passed in as a parameter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AES	The name of the algorithm.
static final com.google.common.io.BaseEncoding	BASE64	URL parameter safe base64 encoder.
static final String	PARAM_SECRET	The configuration parameter for configuring the secret.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsAESTextEncryption()	Default constructor (used when instantiated automatically during OpenCms configuration).
CmsAESTextEncryption(String secret)	Constructor used to manually, conveniently create a new encryption object with a given secret.

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String paramName, String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
String	decrypt(String input)	Decrypts encrypted data.
String	encrypt(String input)	Encrypts data.
static SecretKey	generateAESKey(String secret)	Helper method for generating an AES key from a secret string.
CmsParameterConfiguration	getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
String	getName()	Gets the name of the encryption handler.
void	initConfiguration()	Initializes a configuration after all parameters have been added.
void	initialize(CmsObject cms)	Initializes the encryption handler.
void	setName(String name)	Sets the name of the encryption handler.

Methods inherited from class java.lang.Object

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

Field Details

AES

public static final String AES

The name of the algorithm.

See Also:

• Constant Field Values

BASE64

public static final com.google.common.io.BaseEncoding BASE64

URL parameter safe base64 encoder.

PARAM_SECRET

public static final String PARAM_SECRET

The configuration parameter for configuring the secret.

See Also:

• Constant Field Values

Constructor Details

CmsAESTextEncryption

public CmsAESTextEncryption()

Default constructor (used when instantiated automatically during OpenCms configuration).

CmsAESTextEncryption

public CmsAESTextEncryption(String secret)

Constructor used to manually, conveniently create a new encryption object with a given secret.

When using this constructor, it is not necessary to call initialize() to make the object usable.

Parameters:

secret - the secret used to generate the key

Method Details

generateAESKey

public static SecretKey generateAESKey(String secret)

Helper method for generating an AES key from a secret string.

Parameters:

secret - the secret string

Returns:

the AES key

addConfigurationParameter

public void addConfigurationParameter(String paramName,
 String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

• I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

decrypt

public String decrypt(String input)
               throws CmsEncryptionException

Description copied from interface: I_CmsTextEncryption

Decrypts encrypted data.

Specified by:

decrypt in interface I_CmsTextEncryption

Parameters:

input - the encrypted data

Returns:

the decrypted data

Throws:

CmsEncryptionException - if the data couldn't be decrypted

See Also:

• I_CmsTextEncryption.decrypt(java.lang.String)

encrypt

public String encrypt(String input)
               throws CmsEncryptionException

Description copied from interface: I_CmsTextEncryption

Encrypts data.

Specified by:

encrypt in interface I_CmsTextEncryption

Parameters:

input - the data to encrypt

Returns:

the encrypted data

Throws:

CmsEncryptionException - if the data couldn't be encrypted

See Also:

• I_CmsTextEncryption.encrypt(java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

getName

public String getName()

Description copied from interface: I_CmsTextEncryption

Gets the name of the encryption handler.

Specified by:

getName in interface I_CmsTextEncryption

Returns:

the name

See Also:

• I_CmsTextEncryption.getName()

initConfiguration

public void initConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()

initialize

public void initialize(CmsObject cms)

Description copied from interface: I_CmsTextEncryption

Initializes the encryption handler.

Specified by:

initialize in interface I_CmsTextEncryption

Parameters:

cms - an Admin CMS context

See Also:

• I_CmsTextEncryption.initialize(org.opencms.file.CmsObject)

setName

public void setName(String name)

Description copied from interface: I_CmsTextEncryption

Sets the name of the encryption handler.

Specified by:

setName in interface I_CmsTextEncryption

Parameters:

name - the name that should be set

See Also:

• I_CmsTextEncryption.setName(java.lang.String)