Package 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	Description
static final String	DEFAULT_KEYFILE_NAME
static final String	PROVIDER_CLASS
static final String	SUBFOLDER

Constructor Summary

Constructors

Constructor	Description
EncryptionUtil()

Method Summary

Modifier and Type	Method	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 Map<ComposedType,List<AttributeDescriptor>>	getAllTypesWhichHasEncyrptedAttributes()
static Map<ComposedType,List<AttributeDescriptor>>	getAllTypesWhichHasEncyrptedAttributes(Predicate<ComposedType> typeFilter)
protected static ConfigIntf	getConfig()
Map<String,String>	getConfiguredEncryptionKey()	Deprecated, for removal: This API element is subject to removal in a future version. since 1905 in favor of getConfiguredEncryptionKeys()
static Map<String,String>	getConfiguredEncryptionKeys()
static String	getDefaultKeyFileId()
static String	getDefaultKeyFileName()
static String	getOldKeyFile()
static final PBEParameterSpec	getOldPBEParameterSpec()
static final byte[]	getOldSalt()
static Map<String,SecretKey>	getSecretKeysFromConfig()
static Map<String,Integer>	getUsedKeys(String type, String qualifier)	Returns used keys
Map<String,Integer>	getUsedKeys(String type, String qualifier, JspContext jspc)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811
static boolean	isConfiguredMigrationKey()
static boolean	isNewStyleKey(String keyfile)
static SecretKey	loadDefaultKey(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)
static void	migrate(String type, String qualifier, JspContext jspc)	Performance (MacBook Pro/MySQL 5): Time: 1742901 m/s for '200100' steps-- 8 ms/step
static void	setKeyfiles(Map<String,String> keyfiles)

Methods inherited from class java.lang.Object

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

Field Details

SUBFOLDER

public static final String SUBFOLDER

See Also:

• Constant Field Values

PROVIDER_CLASS

public static final String PROVIDER_CLASS

See Also:

• Constant Field Values

DEFAULT_KEYFILE_NAME

public static final String DEFAULT_KEYFILE_NAME

See Also:

• Constant Field Values

Constructor Details

EncryptionUtil

public EncryptionUtil()

Method Details

setKeyfiles

public static void setKeyfiles(Map<String,String> keyfiles)

getDefaultKeyFileName

public static String getDefaultKeyFileName()

getDefaultKeyFileId

public static String getDefaultKeyFileId()

getConfig

protected static ConfigIntf getConfig()

getOldKeyFile

public static String getOldKeyFile()

getSecretKeysFromConfig

public static Map<String,SecretKey> getSecretKeysFromConfig()

getConfiguredEncryptionKeys

public static Map<String,String> getConfiguredEncryptionKeys()

isConfiguredMigrationKey

public static boolean isConfiguredMigrationKey()

getConfiguredEncryptionKey

@Deprecated(since="1905",
            forRemoval=true)
public Map<String,String> getConfiguredEncryptionKey()

Deprecated, for removal: This API element is subject to removal in a future version.

since 1905 in favor of getConfiguredEncryptionKeys()

migrate

public void migrate(String type,
 String attribute)

migrate

public static 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 static Map<String,Integer> getUsedKeys(String type,
 String qualifier)

Returns used keys

Parameters:

type - type to get keys for

qualifier - attribute name in given type

Returns:

keys

getUsedKeys

@Deprecated(since="1811",
            forRemoval=true)
public Map<String,Integer> getUsedKeys(String type,
 String qualifier,
 JspContext jspc)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811

Returns used keys

Parameters:

type - type to get keys for

qualifier - attribute name in given type

jspc - jspContext

Returns:

getAllTypesWhichHasEncyrptedAttributes

public static Map<ComposedType,List<AttributeDescriptor>> getAllTypesWhichHasEncyrptedAttributes(Predicate<ComposedType> typeFilter)

getAllTypesWhichHasEncyrptedAttributes

public static 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

loadDefaultKey

public static SecretKey loadDefaultKey(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)

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