com.tencent.soter.core

类 SoterCore

java.lang.Object

com.tencent.soter.core.SoterCore

所有已实现的接口:

ConstantsSoter, SoterErrCode

public class SoterCore
extends java.lang.Object
implements ConstantsSoter, SoterErrCode

The SOTER Core APIs for developer to handle keys and other basic stuff. Do not change this file because there're many magic codes in it.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	TAG

从接口继承的字段 com.tencent.soter.core.model.ConstantsSoter

COMMON_SOTER_APP_SECURE_KEY_NAME, ERR_FINGERPRINT_FAIL_MAX, SOTER_COMMON_KEYNAME_PREFIX, SOTER_FINGERPRINT_ERR_FAIL_MAX_MSG, SOTER_PROVIDER_NAME

从接口继承的字段 com.tencent.soter.core.model.SoterErrCode

ERR_ASK_GEN_FAILED, ERR_ASK_NOT_EXIST, ERR_AUTH_KEY_GEN_FAILED, ERR_OK, ERR_PARAMERROR, ERR_REMOVE_ASK, ERR_REMOVE_AUTH_KEY, ERR_SOTER_NOT_SUPPORTED, ERR_UNKNOWN

构造器概要

构造器

构造器和说明
SoterCore()

方法概要

限定符和类型	方法和说明
static SoterSignatureResult	convertFromBytesToSignatureResult(byte[] origin) Convert the byte array got from Signature.sign() to SoterSignatureResult model.
static SoterCoreResult	generateAppGlobalSecureKey() Generate App Secure Key.
static SoterCoreResult	generateAuthKey(java.lang.String authKeyName) Generate Auth Key.
static java.lang.String	generateRemoteCheckRequestParam() The parameter represents this device software build.
static SoterPubKeyModel	getAppGlobalSecureKeyModel() To retrieve the App Secure Key model from device.
static java.security.Signature	getAuthInitAndSign(java.lang.String useKeyAlias) Prepare the Signature object before authenticating.
static SoterPubKeyModel	getAuthKeyModel(java.lang.String authKeyName) To retrieve the App Secure Key model from device.
static boolean	hasAppGlobalSecureKey() Check if there's already a pair of App Secure Key of this application.
static boolean	hasAuthKey(java.lang.String authKeyName) If there's already a pair of auth key by the given key alias
static boolean	isAuthKeyValid(java.lang.String authKeyName, boolean autoDelIfNotValid) Check if the Auth Key is valid or not.
static boolean	isCurrentFingerprintFrozen(android.content.Context context) Judge whether current fingerprint is frozen due to too many failure trials.
static boolean	isNativeSupportSoter() Check whether this device supports SOTER by checking native interfaces.
static boolean	isSupportFingerprint(android.content.Context context) Judge whether there's fingerprint sensor in this device,
static boolean	isSystemHasFingerprint(android.content.Context context) Judge whether there's any fingerprint enrolled in this device
static SoterCoreResult	removeAppGlobalSecureKey() Delete the App Secure Key.
static SoterCoreResult	removeAuthKey(java.lang.String authKeyName, boolean isAutoDeleteASK) Delete the Auth Key.
static void	setUp() The prepare work before using SOTER.

从类继承的方法 java.lang.Object

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

字段详细资料

TAG

public static final java.lang.String TAG

另请参阅:

常量字段值

构造器详细资料

SoterCore

public SoterCore()

方法详细资料

setUp

public static void setUp()

The prepare work before using SOTER. Be sure to call this method before SOTER operation

isNativeSupportSoter

public static boolean isNativeSupportSoter()

Check whether this device supports SOTER by checking native interfaces. Remind that you should check the server side as well, instead of trust the return value of this method only

返回:

Whether this device supports SOTER by it's native check result.

generateAppGlobalSecureKey

public static SoterCoreResult generateAppGlobalSecureKey()

Generate App Secure Key. Remind not to call it in UI thread

返回:

The result of generating process

removeAppGlobalSecureKey

public static SoterCoreResult removeAppGlobalSecureKey()

Delete the App Secure Key. Remind that once removed, this key can never be retrieved any more.

返回:

true if you delete the App Secure Key, false otherwise

hasAppGlobalSecureKey

public static boolean hasAppGlobalSecureKey()

Check if there's already a pair of App Secure Key of this application.

返回:

true if there's already App Secure Key

getAppGlobalSecureKeyModel

public static SoterPubKeyModel getAppGlobalSecureKeyModel()

To retrieve the App Secure Key model from device.

返回:

The App Secure Key model.

generateAuthKey

public static SoterCoreResult generateAuthKey(java.lang.String authKeyName)

Generate Auth Key. Remind not to call it in UI thread

参数:

authKeyName - The alias of the Auth Key to be generated. Keep in mind it should be unique in each business scene, or the key would be overwritten

返回:

The result of key generating process.

removeAuthKey

public static SoterCoreResult removeAuthKey(java.lang.String authKeyName,
                                            boolean isAutoDeleteASK)

Delete the Auth Key. Remind that once removed, this key can never be retrieved any more.

参数:

authKeyName - The alias of the key to be deleted

isAutoDeleteASK - true if you want to remove the App Secure Key at the same time

返回:

true if the key deleting process is successful

hasAuthKey

public static boolean hasAuthKey(java.lang.String authKeyName)

If there's already a pair of auth key by the given key alias

参数:

authKeyName - The key alias to check

返回:

true if there's already a pair of auth key

isAuthKeyValid

public static boolean isAuthKeyValid(java.lang.String authKeyName,
                                     boolean autoDelIfNotValid)

Check if the Auth Key is valid or not. The check is necessary because from Android M, the Auth Key would be permanently invalid once user enrolled a new fingerprint in the device.

参数:

authKeyName - The alias of the auth key to check

autoDelIfNotValid - If the auth key should be deleted when find it invalid

返回:

If the key is valid

getAuthKeyModel

public static SoterPubKeyModel getAuthKeyModel(java.lang.String authKeyName)

To retrieve the App Secure Key model from device.

参数:

authKeyName - he alias of the auth key

返回:

The public key model of the Auth Key

getAuthInitAndSign

public static java.security.Signature getAuthInitAndSign(java.lang.String useKeyAlias)

Prepare the Signature object before authenticating. You should keep the object for later use after user authenticated. More over, this method is used for checking whether the auth key is valid or not.

参数:

useKeyAlias - The Auth Key alias of which key you want to prepare

返回:

The prepared Signature. It would be null if the prepare process fails, or the Auth Key is already invalid.

convertFromBytesToSignatureResult

public static SoterSignatureResult convertFromBytesToSignatureResult(byte[] origin)

Convert the byte array got from Signature.sign() to SoterSignatureResult model.

参数:

origin - The return value of Signature.sign()

返回:

The signature model

isSupportFingerprint

public static boolean isSupportFingerprint(android.content.Context context)

Judge whether there's fingerprint sensor in this device,

参数:

context - The context

返回:

true if there's fingerprint sensor

isSystemHasFingerprint

public static boolean isSystemHasFingerprint(android.content.Context context)

Judge whether there's any fingerprint enrolled in this device

参数:

context - The context

返回:

true if there's fingerprint enrolled

isCurrentFingerprintFrozen

public static boolean isCurrentFingerprintFrozen(android.content.Context context)

Judge whether current fingerprint is frozen due to too many failure trials. If true, you should not use fingerprint for authentication in current session.

返回:

True if the fingerprint sensor is frozen now.

generateRemoteCheckRequestParam

public static java.lang.String generateRemoteCheckRequestParam()

The parameter represents this device software build. It is for remote SOTER support check use.

返回:

The parameter you should put in the request parameter