BiometricAuthentication

java.lang.Object
- ohos.biometrics.authentication.BiometricAuthentication

```
public class BiometricAuthentication
extends Object
```
Provides the biometric authentication capability.
This class provides methods for checking the biometric authentication capability, and performing and canceling authentication.

从以下版本开始:

1

SystemCapability

SystemCapability.UserIAM#BIOMETRIC_AUTH

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`BiometricAuthentication.AuthenticationTips`	Provides the authentication tips.
`static class`	`BiometricAuthentication.AuthType`	Indicates the authentication type.
`static class`	`BiometricAuthentication.SecureLevel`	Indicates the security level of the data to access.
`static class`	`BiometricAuthentication.SystemAuthDialogInfo`	Provides the customized authentication tips in the system-provided authentication dialog box.

字段概要

字段
限定符和类型	字段	说明
`static int`	`BA_CHECK_AUTH_TYPE_NOT_SUPPORT`	Indicates that this type of biometric authentication is not supported.
`static int`	`BA_CHECK_DISTRIBUTED_AUTH_NOT_SUPPORT`	Indicates that distributed authentication is not supported.
`static int`	`BA_CHECK_NOT_ENROLLED`	Indicates that no biometric characteristic has been enrolled in the device.
`static int`	`BA_CHECK_SECURE_LEVEL_NOT_SUPPORT`	Indicates that the security level of the biometric authentication is not supported.
`static int`	`BA_CHECK_SUPPORTED`	Indicates that biometric authentication is supported.
`static int`	`BA_CHECK_UNAVAILABLE`	Indicates that this type of biometric authentication is unavailable.
`static int`	`BA_FAILED`	Indicates that a failed execution.
`static int`	`BA_SUCCESS`	Indicates that a successful execution.
`static int`	`INVALID_BIOMETRIC_ID`	Indicates the id for biometric authentication.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`int`	`cancelAuthenticationAction()`	Cancels biometric authentication.
`int`	`checkAuthenticationAvailability(BiometricAuthentication.AuthType type, BiometricAuthentication.SecureLevel level, boolean isLocalAuth)`	Checks whether a device supports biometric authentication.
`int`	`execAuthenticationAction(BiometricAuthentication.AuthType type, BiometricAuthentication.SecureLevel level, boolean isLocalAuth, boolean isAppAuthDialog, BiometricAuthentication.SystemAuthDialogInfo information)`	Performs biometric authentication.
`BiometricAuthentication.AuthenticationTips`	`getAuthenticationTips()`	Obtains authentication tips.
`static BiometricAuthentication`	`getInstance(Ability ability)`	Obtains a `BiometricAuthentication` singleton object.
`Cipher`	`getSecureObjectCipher()`	Obtains an authorized `Cipher` object.
`Mac`	`getSecureObjectMac()`	Obtains an authorized `Mac` object.
`Signature`	`getSecureObjectSignature()`	Obtains an authorized `Signature` object.
`void`	`setSecureObjectCipher(Cipher cipher)`	Sets the `Cipher` object associated with the authentication result.
`void`	`setSecureObjectMac(Mac mac)`	Sets the `Mac` object associated with the authentication result.
`void`	`setSecureObjectSignature(Signature sign)`	Sets the `Signature` object associated with the authentication result.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - BA_CHECK_AUTH_TYPE_NOT_SUPPORT
```
public static final int BA_CHECK_AUTH_TYPE_NOT_SUPPORT
```
    Indicates that this type of biometric authentication is not supported.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - BA_CHECK_DISTRIBUTED_AUTH_NOT_SUPPORT
```
public static final int BA_CHECK_DISTRIBUTED_AUTH_NOT_SUPPORT
```
    Indicates that distributed authentication is not supported.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - BA_CHECK_NOT_ENROLLED
```
public static final int BA_CHECK_NOT_ENROLLED
```
    Indicates that no biometric characteristic has been enrolled in the device.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - BA_CHECK_SECURE_LEVEL_NOT_SUPPORT
```
public static final int BA_CHECK_SECURE_LEVEL_NOT_SUPPORT
```
    Indicates that the security level of the biometric authentication is not supported.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - BA_CHECK_SUPPORTED
```
public static final int BA_CHECK_SUPPORTED
```
    Indicates that biometric authentication is supported.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - BA_CHECK_UNAVAILABLE
```
public static final int BA_CHECK_UNAVAILABLE
```
    Indicates that this type of biometric authentication is unavailable. You are advised to use other authentication types.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - BA_FAILED
```
public static final int BA_FAILED
```
    Indicates that a failed execution.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - BA_SUCCESS
```
public static final int BA_SUCCESS
```
    Indicates that a successful execution.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - INVALID_BIOMETRIC_ID
```
public static final int INVALID_BIOMETRIC_ID
```
    Indicates the id for biometric authentication.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getInstance
```
public static BiometricAuthentication getInstance(Ability ability)
                                           throws IllegalAccessException
```
    Obtains a BiometricAuthentication singleton object.
    This method requires ohos.permission.ACCESS_BIOMETRIC.
    
    参数:
    
    ability - Indicates the smallest deployment unit on the HarmonyOS, which is defined in Ability.
    
    返回:
    
    Returns the BiometricAuthentication singleton object.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the input parameter is null.
    
    IllegalAccessException - Throws this exception if the current process has not the permission.
    
    从以下版本开始:
    
    1
  - checkAuthenticationAvailability
```
public int checkAuthenticationAvailability(BiometricAuthentication.AuthType type,
                                           BiometricAuthentication.SecureLevel level,
                                           boolean isLocalAuth)
```
    Checks whether a device supports biometric authentication.
    This method is used to check whether the device supports biometric authentication based on AuthType, SecureLevel, and isLocalAuth. If biometric authentication is not supported, consider using other authentication capabilities.
    
    参数:
    
    type - Indicates the authentication type, which is specified by AuthType.
    
    level - Indicates the security level, which is specified by SecureLevel.
    
    isLocalAuth - Indicates whether local authentication is used. Value false indicates distributed authentication. Currently, only local authentication is supported.
    
    返回:
    
    Returns BA_CHECK_SUPPORTED if the device supports biometric authentication. Other return values can be referenced by BA_CHECK_AUTH_TYPE_NOT_SUPPORT, BA_CHECK_SECURE_LEVEL_NOT_SUPPORT, BA_CHECK_DISTRIBUTED_AUTH_NOT_SUPPORT, BA_CHECK_NOT_ENROLLED, BA_CHECK_UNAVAILABLE, BA_FAILED.
    
    从以下版本开始:
    
    1
  - execAuthenticationAction
```
public int execAuthenticationAction(BiometricAuthentication.AuthType type,
                                    BiometricAuthentication.SecureLevel level,
                                    boolean isLocalAuth,
                                    boolean isAppAuthDialog,
                                    BiometricAuthentication.SystemAuthDialogInfo information)
```
    Performs biometric authentication.
    You can use either the system-provided or a customized authentication dialog box. If you use the former, you can customize the authentication tips. The authentication result is returned only after the authentication is complete. To cancel the authentication, use cancelAuthenticationAction().
    
    参数:
    
    type - Indicates the authentication type, which is specified by AuthType.
    
    level - Indicates the security level, which is specified by SecureLevel.
    
    isLocalAuth - Indicates whether local authentication is used. Value false indicates distributed authentication. Currently, only local authentication is supported.
    
    isAppAuthDialog - Indicates whether a customized authentication dialog box is used.
    
    information - Indicates the authentication tips in the system-provided authentication dialog box.
    
    返回:
    
    Returns the result code in IFaceAuthentication.FaceAuthResultCode.
    
    从以下版本开始:
    
    1
  - getAuthenticationTips
```
public BiometricAuthentication.AuthenticationTips getAuthenticationTips()
```
    Obtains authentication tips.
    An example is the tip to adjust the face angle in face recognition.
    
    返回:
    
    Returns authentication tips, which are specified by AuthenticationTips.
    
    从以下版本开始:
    
    1
  - cancelAuthenticationAction
```
public int cancelAuthenticationAction()
```
    Cancels biometric authentication.
    Performing and canceling an authentication must be in different threads and have the same identifier. This method is used to cancel an ongoing biometric authentication.
    
    返回:
    
    Returns BA_SUCCESS if the authentication is canceled; returns BA_FAILED otherwise.
    
    从以下版本开始:
    
    1
  - setSecureObjectSignature
```
public void setSecureObjectSignature(Signature sign)
```
    Sets the Signature object associated with the authentication result.
    If an authentication succeeds, the Signature object associated with the authentication result is authorized and available. The Signature object must be initialized correctly before it is associated with the authentication result.
    
    参数:
    
    sign - Indicates the Signature object to be associated with the authentication result.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the input parameter is not a Signature object.
    
    IllegalStateException - Throws this exception if the private key of the input parameter is not correctly initialized.
    
    从以下版本开始:
    
    1
  - getSecureObjectSignature
```
public Signature getSecureObjectSignature()
```
    Obtains an authorized Signature object.
    
    返回:
    
    Returns the authorized Signature object; returns null if no Signature object is authorized.
    
    从以下版本开始:
    
    1
  - setSecureObjectCipher
```
public void setSecureObjectCipher(Cipher cipher)
```
    Sets the Cipher object associated with the authentication result.
    If an authentication succeeds, the Cipher object associated with the authentication result is authorized and available. The Cipher object must be initialized correctly before it is associated with the authentication result.
    
    参数:
    
    cipher - Indicates the Cipher object to be associated with the authentication result.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the input parameter is not a Cipher object.
    
    IllegalStateException - Throws this exception if the private key of the input parameter is not correctly initialized.
    
    从以下版本开始:
    
    1
  - getSecureObjectCipher
```
public Cipher getSecureObjectCipher()
```
    Obtains an authorized Cipher object.
    
    返回:
    
    Returns the authorized Cipher object; returns null if no Cipher object is authorized.
    
    从以下版本开始:
    
    1
  - setSecureObjectMac
```
public void setSecureObjectMac(Mac mac)
```
    Sets the Mac object associated with the authentication result.
    If an authentication succeeds, the Mac object associated with the authentication result is authorized and available. The Mac object must be initialized correctly before it is associated with the authentication result.
    
    参数:
    
    mac - Indicates the Mac object to be associated with the authentication result.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the input parameter is not a Mac object.
    
    IllegalStateException - Throws this exception if the private key of the input parameter is not correctly initialized.
    
    从以下版本开始:
    
    1
  - getSecureObjectMac
```
public Mac getSecureObjectMac()
```
    Obtains an authorized Mac object.
    
    返回:
    
    Returns the authorized Mac object; returns null if no Mac object is authorized.
    
    从以下版本开始:
    
    1

类 BiometricAuthentication

嵌套类概要

字段概要

方法概要

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

字段详细资料

BA_CHECK_AUTH_TYPE_NOT_SUPPORT

BA_CHECK_DISTRIBUTED_AUTH_NOT_SUPPORT

BA_CHECK_NOT_ENROLLED

BA_CHECK_SECURE_LEVEL_NOT_SUPPORT

BA_CHECK_SUPPORTED

BA_CHECK_UNAVAILABLE

BA_FAILED

BA_SUCCESS

INVALID_BIOMETRIC_ID

方法详细资料

getInstance

checkAuthenticationAvailability

execAuthenticationAction

getAuthenticationTips

cancelAuthenticationAction

setSecureObjectSignature

getSecureObjectSignature

setSecureObjectCipher

getSecureObjectCipher

setSecureObjectMac

getSecureObjectMac