Package org.compiere.util

Class Secure

java.lang.Object

org.compiere.util.Secure

All Implemented Interfaces:

SecureInterface

public class Secure
extends Object
implements SecureInterface

Default implementation of SecureInterface for encryption and decryption.

Change log:

• 2007-01-27 - teo_sarca - [ 1598095 ] class Secure is not working with UTF8

Version:

$Id: Secure.java,v 1.2 2006/07/30 00:52:23 jjanke Exp $

Author:

Jorg Janke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LEGACY_PASSWORD_HASH_ALGORITHM

Fields inherited from interface org.compiere.util.SecureInterface

ADEMPIERE_SECURE, ADEMPIERE_SECURE_DEFAULT, CLEARVALUE_END, CLEARVALUE_START, ENCRYPTEDVALUE_END, ENCRYPTEDVALUE_START

Constructor Summary

Constructors

Constructor	Description
Secure()	iDempiere Security

Method Summary

Modifier and Type	Method	Description
static byte[]	convertHexString(String hexString)	Convert Hex String to Byte Array
static String	convertToHexString(byte[] bytes)	Convert Byte Array to Hex String
Integer	decrypt(Integer value, int ad_client_id)	Not implemented, just return value as it is
String	decrypt(String value, int AD_Client_ID)	Decryption.
BigDecimal	decrypt(BigDecimal value, int ad_client_id)	Not implemented, just return value as it is
Timestamp	decrypt(Timestamp value, int ad_client_id)	Not implemented, just return value as it is
Integer	encrypt(Integer value, int ad_client_id)	Not implemented, just return value as it is
String	encrypt(String value, int AD_Client_ID)	Encryption.
BigDecimal	encrypt(BigDecimal value, int ad_client_id)	Not implemented, just return value as it is
Timestamp	encrypt(Timestamp value, int ad_client_id)	Not implemented, just return value as it is
protected Cipher	getCipherInstance()	Get Cipher Instance
protected String	getCipherProvider()	Get Cipher Provider
String	getDigest(String value)	Perform MD5 Digest of value JavaScript version see - http://pajhome.org.uk/crypt/md5/index.html
IKeyStore	getKeyStore()
String	getPasswordHash(String password, byte[] salt, String algorithm)	Hash the password with the given salt and algorithm
String	getSHA256Digest(String value)	Convert String to SHA-256 digest
String	getSHA512Hash(int iterations, String value, byte[] salt)	Convert String and salt to SHA-512 hash with iterations https://www.owasp.org/index.php/Hashing_Java
static int	hash(String key)	Hash checksum number
boolean	isDigest(String value)	Checks, if value is a valid digest
boolean	isSHA256Digest(String value)	Check if value is a valid SHA-256 digest
boolean	isSupportedPaswordHashAlgorithm(String algorithm)	Check if the given password hash algorithm is supported
String	toString()	String Representation

Methods inherited from class java.lang.Object

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

Field Details

LEGACY_PASSWORD_HASH_ALGORITHM

public static final String LEGACY_PASSWORD_HASH_ALGORITHM

See Also:

• Constant Field Values

Constructor Details

Secure

public Secure()

iDempiere Security

Method Details

hash

public static int hash(String key)

Hash checksum number

Parameters:

key - key

Returns:

checksum number

convertToHexString

public static String convertToHexString(byte[] bytes)

Convert Byte Array to Hex String

Parameters:

bytes - bytes

Returns:

HexString

convertHexString

public static byte[] convertHexString(String hexString)

Convert Hex String to Byte Array

Parameters:

hexString - hex string

Returns:

byte array

encrypt

public String encrypt(String value,
 int AD_Client_ID)

Encryption.

Specified by:

encrypt in interface SecureInterface

Parameters:

value - clear value

AD_Client_ID -

Returns:

encrypted String

getCipherInstance

protected Cipher getCipherInstance()
                            throws NoSuchAlgorithmException,
NoSuchPaddingException,
NoSuchProviderException

Get Cipher Instance

Returns:

cipher

Throws:

NoSuchAlgorithmException

NoSuchPaddingException

NoSuchProviderException

getCipherProvider

protected String getCipherProvider()

Get Cipher Provider

Returns:

cipher provider or null if default provider should be used

decrypt

public String decrypt(String value,
 int AD_Client_ID)

Decryption. The methods must recognize clear text values

Specified by:

decrypt in interface SecureInterface

Parameters:

value - encrypted value

AD_Client_ID -

Returns:

decrypted String

encrypt

public Integer encrypt(Integer value,
 int ad_client_id)

Not implemented, just return value as it is

Specified by:

encrypt in interface SecureInterface

Parameters:

value - clear value

ad_client_id -

Returns:

integer value

decrypt

public Integer decrypt(Integer value,
 int ad_client_id)

Not implemented, just return value as it is

Specified by:

decrypt in interface SecureInterface

Parameters:

value - encrypted value

Returns:

integer value

encrypt

public BigDecimal encrypt(BigDecimal value,
 int ad_client_id)

Not implemented, just return value as it is

Specified by:

encrypt in interface SecureInterface

Parameters:

value - clear value

ad_client_id -

Returns:

BigDecimal value

decrypt

public BigDecimal decrypt(BigDecimal value,
 int ad_client_id)

Not implemented, just return value as it is

Specified by:

decrypt in interface SecureInterface

Parameters:

value - encrypted value

Returns:

Big decimal value

encrypt

public Timestamp encrypt(Timestamp value,
 int ad_client_id)

Not implemented, just return value as it is

Specified by:

encrypt in interface SecureInterface

Parameters:

value - clear value

ad_client_id -

Returns:

Timestamp value

decrypt

public Timestamp decrypt(Timestamp value,
 int ad_client_id)

Not implemented, just return value as it is

Specified by:

decrypt in interface SecureInterface

Parameters:

value - encrypted value

Returns:

Timestamp value

getDigest

public String getDigest(String value)

Perform MD5 Digest of value JavaScript version see - http://pajhome.org.uk/crypt/md5/index.html

Specified by:

getDigest in interface SecureInterface

Parameters:

value - text to digest

Returns:

HexString of digested message (length = 32 characters)

isDigest

public boolean isDigest(String value)

Checks, if value is a valid digest

Specified by:

isDigest in interface SecureInterface

Parameters:

value - digest string

Returns:

true if valid digest

getSHA256Digest

public String getSHA256Digest(String value)

Description copied from interface: SecureInterface

Convert String to SHA-256 digest

Specified by:

getSHA256Digest in interface SecureInterface

Returns:

HexString of digested message (length = 64 characters)

isSHA256Digest

public boolean isSHA256Digest(String value)

Description copied from interface: SecureInterface

Check if value is a valid SHA-256 digest

Specified by:

isSHA256Digest in interface SecureInterface

Returns:

true if valid SHA-256 digest

getSHA512Hash

public String getSHA512Hash(int iterations,
 String value,
 byte[] salt)
                     throws NoSuchAlgorithmException,
UnsupportedEncodingException

Convert String and salt to SHA-512 hash with iterations https://www.owasp.org/index.php/Hashing_Java

Specified by:

getSHA512Hash in interface SecureInterface

Parameters:

value - message

Returns:

HexString of message (length = 128 characters)

Throws:

NoSuchAlgorithmException

UnsupportedEncodingException

toString

public String toString()

String Representation

Overrides:

toString in class Object

Returns:

info

getKeyStore

public IKeyStore getKeyStore()

Returns:

keystore

isSupportedPaswordHashAlgorithm

public boolean isSupportedPaswordHashAlgorithm(String algorithm)

Description copied from interface: SecureInterface

Check if the given password hash algorithm is supported

Specified by:

isSupportedPaswordHashAlgorithm in interface SecureInterface

Returns:

true if supported, false otherwise

getPasswordHash

public String getPasswordHash(String password,
 byte[] salt,
 String algorithm)
                       throws NoSuchAlgorithmException,
UnsupportedEncodingException,
NoSuchProviderException,
InvalidKeySpecException

Description copied from interface: SecureInterface

Hash the password with the given salt and algorithm

Specified by:

getPasswordHash in interface SecureInterface

Returns:

HexString of hashed password

Throws:

NoSuchAlgorithmException

UnsupportedEncodingException

NoSuchProviderException

InvalidKeySpecException