Package org.ametys.core.util

Class CryptoHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.util.CryptoHelper

All Implemented Interfaces:

LogEnabled, Component, Configurable

Direct Known Subclasses:

MultifactorAuthenticationCryptoHelper

public class CryptoHelper
extends AbstractLogEnabled
implements Component, Configurable

Helper to encrypt/decrypt some text

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CryptoHelper.WrongKeyException	Exception when the decrypt key has not worked

Constructor Summary

Constructors

Constructor	Description
CryptoHelper()

Method Summary

Modifier and Type	Method	Description
protected String	_configureFilename(Configuration configuration)	Configure the file name containing the key
protected String	_getFilename()	Retrieves the file name
protected String	_writeKeyInFile(File file)	Will create a new random key based on a sha256 hash of the current time, and write it to a file
void	configure(Configuration configuration)
String	decrypt(String encryptedValue)	Decrypt a string (base64) using the generated key
String	decrypt(String encryptedValue, String key)	Decrypt a string (base64) using the selected key
String	encrypt(String data)	Encrypt (base64) a string using the generated key
String	encrypt(String data, String key)	Encrypt (base64) a string using the selected key
String	getCryptoKey()	Get the generated crypto key

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Details

CryptoHelper

public CryptoHelper()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

_configureFilename

protected String _configureFilename(Configuration configuration)
                             throws ConfigurationException

Configure the file name containing the key

Parameters:

configuration - the configuration

Returns:

the file name

Throws:

ConfigurationException - if an error occurs while configuring the file name

_getFilename

protected String _getFilename()

Retrieves the file name

Returns:

the file name

decrypt

public String decrypt(String encryptedValue,
 String key)
               throws CryptoHelper.WrongKeyException

Decrypt a string (base64) using the selected key

Parameters:

encryptedValue - the encrypted value

key - The key used to decrypt value

Returns:

the decrypted String

Throws:

CryptoHelper.WrongKeyException - If the key is not the right one

decrypt

public String decrypt(String encryptedValue)

Decrypt a string (base64) using the generated key

Parameters:

encryptedValue - the encrypted value

Returns:

the decrypted String

encrypt

public String encrypt(String data,
 String key)

Encrypt (base64) a string using the selected key

Parameters:

data - input data

key - the key used to encrypt

Returns:

the base64 value of the encrypted data

encrypt

public String encrypt(String data)

Encrypt (base64) a string using the generated key

Parameters:

data - input data

Returns:

the base64 value of the encrypted data

getCryptoKey

public String getCryptoKey()

Get the generated crypto key

Returns:

the generated crypto key

_writeKeyInFile

protected String _writeKeyInFile(File file)
                          throws IOException

Will create a new random key based on a sha256 hash of the current time, and write it to a file

Parameters:

file - file where to write

Returns:

the generated password

Throws:

IOException - if something went wrong when writting the file