com.gemalto.idp.mobile.core.devicefingerprint

Enum DeviceFingerprintSource.Type

java.lang.Object

java.lang.Enum<DeviceFingerprintSource.Type>

com.gemalto.idp.mobile.core.devicefingerprint.DeviceFingerprintSource.Type

All Implemented Interfaces:

Serializable, Comparable<DeviceFingerprintSource.Type>

Enclosing class:

DeviceFingerprintSource

public static enum DeviceFingerprintSource.Type
extends Enum<DeviceFingerprintSource.Type>

The defined anti-cloning types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HARDWARE_KEY Seals the user's credentials with the hardware security module provided.
SERVICE Deprecated. Since Mobile Protector SDK v4.9.2 this type is deprecated. For new token created, if this type is used then it will be ignored. For old token, this type will still be used only for the migration.
SOFT Seals the user's credentials with the Settings.Secure.ANDROID_ID of the device.

Method Summary

Modifier and Type	Method and Description
static DeviceFingerprintSource.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static DeviceFingerprintSource.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SERVICE

public static final DeviceFingerprintSource.Type SERVICE

Deprecated. Since Mobile Protector SDK v4.9.2 this type is deprecated. For new token created, if this type is used then it will be ignored. For old token, this type will still be used only for the migration.

Seals the user's credentials with the IMSI of the SIM card.

Any change of the SIM card will make the credentials unusable.

Requirements:

• READ_PHONE_STATE permission.
• The device must have a SIM card and the card must be inserted in the device in order to seal the credentials with the IMSI.

If these requirements are not met, then the credentials are sealed with undefined data.

Warning: This device fingerprint source may be unavailable when devices are on flight/airplane mode. The cellular network status may also affect the availability of this source when some SIM cards inserted on some devices. User is recommended to check the service status (flight/airplane mode ON/OFF, recognizable SIM card inserted, etc) before provisioning once decided to apply this anti-cloning.

Warning: A token's credentials sealed with this type will no longer work as expected if the user alters the state of the SIM card that was used when the token was provisioned. Depending on the token's configuration during provisioning, it will either generate a DeviceFingerprintException or an OTP that cannot be authenticated. The following conditions are known to alter the state of the SIM card:

• Airplane mode - Android devices are expected to return a null reference when accessing the SIM card information when the device is in airplane mode. On some devices the SIM card information is cached until a reboot occurs.
• Different SIM card - Changing the SIM card means the data used to unseal token credentials is different and the token will not work as expected.
• Dual (Multiple) SIM cards - If the device is capable of having more than one SIM card and the primary SIM card is swapped with another or if the primary SIM becomes empty or vice versa, then the data used to unseal the token credentials is different and the token will not work as expected.
• No SIM card - If the SIM card is removed then the data used to unseal the token credentials is not available and the token will not work as expected.
• No signal - On some devices and some SIM cards it has been observed that when the device's cellular state displayed on the lock screen is "No signal" then the SIM card information is not available.

During provisioning the app should recommend to the user to check the above conditions before provisioning if this anti-cloning type is used.

SOFT

public static final DeviceFingerprintSource.Type SOFT

Seals the user's credentials with the Settings.Secure.ANDROID_ID of the device.

A factory reset / initialization of the device will make the credentials unusable.

Requirements:

• None

Warning: If Type.SOFT is used, user cannot use the restored data after doing a factory reset and re-initializing to the same device. Likewise the user cannot backup the app and restore it on a different device.

HARDWARE_KEY

public static final DeviceFingerprintSource.Type HARDWARE_KEY

Seals the user's credentials with the hardware security module provided.

This feature is only available on device that has API level >= 23.

If selected on device which is API level < 23, it does nothing.

Warning: Not all the devices that have API level >= 23 are supporting this feature. Application should check the status of DeviceFingerprintSource.isHardwareKeySupported() before using this mode.

Since:

5.4

See Also:

DeviceFingerprintSource.isHardwareKeySupported()

Method Detail

values

public static DeviceFingerprintSource.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DeviceFingerprintSource.Type c : DeviceFingerprintSource.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DeviceFingerprintSource.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null