com.salesforce.androidsdk.security

Class SalesforceKeyGenerator

java.lang.Object

com.salesforce.androidsdk.security.SalesforceKeyGenerator

public class SalesforceKeyGenerator
extends java.lang.Object

This class provides methods to generate a unique ID that can be used as an encryption key. The key is derived from an AES-256 base using SecureRandom or AES-128 base using UUID.

Author:

bhariharan

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	LEGACY_KEYPAIR_ALIAS
protected static java.lang.String	MSDK_KEYPAIR_ALIAS

Constructor Summary

Constructors

Constructor and Description
SalesforceKeyGenerator()

Method Summary

Modifier and Type	Method and Description
static void	clearAll() Clears all stored identifiers from shared preferences.
static java.lang.String	getEncryptionKey(java.lang.String name) Returns the encryption key being used.
static java.lang.String	getRandom128ByteKey() Returns a randomly generated 128-byte key that's URL safe.
static java.lang.String	getSHA256Hash(java.lang.String privateKey) Returns the SHA-256 hashed value of the supplied private key.
static java.lang.String	getUniqueId(java.lang.String name) Returns the unique ID being used.
static java.lang.String	getUniqueId(java.lang.String name, int length) Returns the unique ID being used based on the key length.
protected static java.lang.String	readFromSharedPrefs(java.lang.String key)
protected static void	storeInSharedPrefs(java.lang.String key, java.lang.String value)

Methods inherited from class java.lang.Object

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

Field Detail

LEGACY_KEYPAIR_ALIAS

protected static final java.lang.String LEGACY_KEYPAIR_ALIAS

See Also:

Constant Field Values

MSDK_KEYPAIR_ALIAS

protected static final java.lang.String MSDK_KEYPAIR_ALIAS

See Also:

Constant Field Values

Constructor Detail

SalesforceKeyGenerator

public SalesforceKeyGenerator()

Method Detail

getUniqueId

public static java.lang.String getUniqueId(java.lang.String name)

Returns the unique ID being used. The default key length is 256 bits.

Parameters:

name - Unique name associated with this unique ID.

Returns:

Unique ID.

getUniqueId

public static java.lang.String getUniqueId(java.lang.String name,
                                           int length)

Returns the unique ID being used based on the key length.

Parameters:

name - Unique name associated with this unique ID.

length - Key length.

Returns:

Unique ID.

getEncryptionKey

public static java.lang.String getEncryptionKey(java.lang.String name)

Returns the encryption key being used.

Parameters:

name - Unique name associated with this encryption key.

Returns:

Encryption key.

getRandom128ByteKey

public static java.lang.String getRandom128ByteKey()

Returns a randomly generated 128-byte key that's URL safe.

Returns:

Random 128-byte key.

getSHA256Hash

public static java.lang.String getSHA256Hash(java.lang.String privateKey)

Returns the SHA-256 hashed value of the supplied private key.

Parameters:

privateKey - Private key.

Returns:

SHA-256 hash.

readFromSharedPrefs

protected static java.lang.String readFromSharedPrefs(java.lang.String key)

storeInSharedPrefs

protected static void storeInSharedPrefs(java.lang.String key,
                                         java.lang.String value)

clearAll

public static void clearAll()

Clears all stored identifiers from shared preferences. This should be called when the last user logs out to ensure no encrypted identifiers remain on the device.