de.hybris.platform.util.encryption

Class EncryptionUtil

java.lang.Object

de.hybris.platform.util.encryption.EncryptionUtil

public class EncryptionUtil
extends Object

Helper class for maintenance_reciper.jsp, maintenance_keygenerator.jsp (admin > maintenance > encryption key management) and de.hybris.platform.util.encryption.ValueEncryptor

Rewrites the encrypted attribute with the configured default encyrption key (symmetric.key.file.default)

see project.properties

# attribute encryption

# keyfile location: ${platformhome}/ext/core/resources/

...

symmetric.key.file.1=weak-symmetric.key.one

symmetric.key.file.2=weak-symmetric.key.two

symmetric.key.file.default=2

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENCRYPTION_KEY_FILE_ID
static String	DEFAULT_ENCRYPTION_KEY_FILE_NAME
static String	DEFAULT_KEYFILE_NAME
static String	FILE_SEPARATOR
static char[]	PASSWORD
static String	providerClass
static String	SUBFOLDER

Constructor Summary

Constructors

Constructor and Description
EncryptionUtil()

Method Summary

Modifier and Type	Method and Description
static String	asHex(byte[] buf) Turns array of bytes into string
static boolean	createKey(String filename, int keysize, String cipherName, String cipherAlgorithm, char[] password)
static boolean	generateAESKey(String keyfile, int keysize)
static void	generatedDefaultKeyFile() Deprecated.
static String	getAbsolutePathForDefaultDefaultKeyFile() Deprecated.
Map<ComposedType,List<AttributeDescriptor>>	getAllTypesWhichHasEncyrptedAttributes()
protected static ConfigIntf	getConfig()
Map<String,String>	getConfiguredEncryptionKey()
String	getOldKeyFile()
static PBEParameterSpec	getOldPBEParameterSpec()
static byte[]	getOldSalt()
Map<String,Integer>	getUsedKeys(String type, String qualifier, JspContext jspc)
static boolean	isNewStyleKey(String keyfile)
static SecretKey	laodDefaultKey(String cipherName, String cipherAlgorithm, char[] password)
static SecretKey	loadKey(InputStream fis, String cipherName, String cipherAlgorithm, char[] password)
static SecretKey	loadKey(String keyID)
static SecretKey	loadKey(String keyID, String cipherName, String cipherAlgorithm, char[] password)
void	migrate(String type, String attribute)
void	migrate(String type, String qualifier, JspContext jspc) Performance (MacBook Pro/MySQL 5): Time: 1742901 m/s for '200100' steps-- 8 ms/step

Methods inherited from class java.lang.Object

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

Field Detail

SUBFOLDER

public static final String SUBFOLDER

See Also:

Constant Field Values

providerClass

public static final String providerClass

See Also:

Constant Field Values

FILE_SEPARATOR

public static final String FILE_SEPARATOR

DEFAULT_KEYFILE_NAME

public static final String DEFAULT_KEYFILE_NAME

See Also:

Constant Field Values

PASSWORD

public static char[] PASSWORD

DEFAULT_ENCRYPTION_KEY_FILE_ID

public static final String DEFAULT_ENCRYPTION_KEY_FILE_ID

DEFAULT_ENCRYPTION_KEY_FILE_NAME

public static final String DEFAULT_ENCRYPTION_KEY_FILE_NAME

Constructor Detail

EncryptionUtil

public EncryptionUtil()

Method Detail

getConfig

protected static ConfigIntf getConfig()

Returns:

the ConfigIntf (object) of the MasterTenant

getOldKeyFile

public String getOldKeyFile()

getConfiguredEncryptionKey

public Map<String,String> getConfiguredEncryptionKey()

migrate

public void migrate(String type,
                    String attribute)

migrate

public void migrate(String type,
                    String qualifier,
                    JspContext jspc)

Performance (MacBook Pro/MySQL 5): Time: 1742901 m/s for '200100' steps-- 8 ms/step

Parameters:

type - code of the ComposedTtype

qualifier - name of the encrypted attribute

jspc - jspContext

getUsedKeys

public Map<String,Integer> getUsedKeys(String type,
                                       String qualifier,
                                       JspContext jspc)

getAllTypesWhichHasEncyrptedAttributes

public Map<ComposedType,List<AttributeDescriptor>> getAllTypesWhichHasEncyrptedAttributes()

generateAESKey

public static boolean generateAESKey(String keyfile,
                                     int keysize)
                              throws GeneralSecurityException,
                                     IOException

Throws:

GeneralSecurityException

IOException

createKey

public static boolean createKey(String filename,
                                int keysize,
                                String cipherName,
                                String cipherAlgorithm,
                                char[] password)
                         throws GeneralSecurityException,
                                IOException

Throws:

GeneralSecurityException

IOException

loadKey

public static SecretKey loadKey(String keyID)
                         throws GeneralSecurityException,
                                IOException

Throws:

GeneralSecurityException

IOException

laodDefaultKey

public static SecretKey laodDefaultKey(String cipherName,
                                       String cipherAlgorithm,
                                       char[] password)
                                throws InvalidKeyException,
                                       NoSuchAlgorithmException,
                                       InvalidKeySpecException,
                                       NoSuchPaddingException,
                                       IllegalBlockSizeException,
                                       BadPaddingException,
                                       InvalidAlgorithmParameterException,
                                       IOException

Throws:

InvalidKeyException

NoSuchAlgorithmException

InvalidKeySpecException

NoSuchPaddingException

IllegalBlockSizeException

BadPaddingException

InvalidAlgorithmParameterException

IOException

loadKey

public static SecretKey loadKey(String keyID,
                                String cipherName,
                                String cipherAlgorithm,
                                char[] password)

loadKey

public static SecretKey loadKey(InputStream fis,
                                String cipherName,
                                String cipherAlgorithm,
                                char[] password)
                         throws IOException,
                                NoSuchAlgorithmException,
                                InvalidKeyException,
                                InvalidKeySpecException,
                                NoSuchPaddingException,
                                IllegalBlockSizeException,
                                BadPaddingException,
                                InvalidAlgorithmParameterException

Throws:

IOException

NoSuchAlgorithmException

InvalidKeyException

InvalidKeySpecException

NoSuchPaddingException

IllegalBlockSizeException

BadPaddingException

InvalidAlgorithmParameterException

getOldSalt

public static final byte[] getOldSalt()

getOldPBEParameterSpec

public static final PBEParameterSpec getOldPBEParameterSpec()

isNewStyleKey

public static boolean isNewStyleKey(String keyfile)

generatedDefaultKeyFile

@Deprecated
public static void generatedDefaultKeyFile()

Deprecated.

default key generation will never be done again, because in a cluster environment this could lead to the fact that every node will have its own key for encrypting data.

Throws:

UnsupportedOperationException

Since:

4.0.3

getAbsolutePathForDefaultDefaultKeyFile

@Deprecated
public static String getAbsolutePathForDefaultDefaultKeyFile()

Deprecated.

see also generatedDefaultKeyFile()

Throws:

UnsupportedOperationException

asHex

public static String asHex(byte[] buf)

Turns array of bytes into string

Parameters:

buf - Array of bytes to convert to hex string

Returns:

Generated hex string