1# HdfUserAuth 2 3 4## **概述** 5 6提供用户认证驱动的标准API接口。 7 8用户认证驱动为用户认证服务提供统一的访问接口。获取用户认证驱动代理后，用户认证服务可以调用相关接口注册执行器，管理用户认证凭据， 完成PIN码和生物特征。 9 10**Since：** 11 123.2 13 14 15## **汇总** 16 17 18### 文件 19 20 | 名称 | 描述 | 21| -------- | -------- | 22| [IUserAuthInterface.idl](_i_user_auth_interface_8idl.md) | 声明用户认证驱动的API接口。接口可用于注册执行器，管理用户认证凭据，完成PIN码和生物特征认证。 | 23| [UserAuthTypes.idl](_user_auth_types_8idl.md) | 定义用户认证驱动的枚举类和数据结构。 | 24 25 26### 类 27 28 | 名称 | 描述 | 29| -------- | -------- | 30| [IUserAuthInterface](interface_i_user_auth_interface.md) | 声明用户认证驱动的API接口。 | 31| [ExecutorRegisterInfo](_executor_register_info.md) | 执行器注册信息。 | 32| [ExecutorInfo](_user_executor_info.md) | 执行器信息。 | 33| [ScheduleInfo](_schedule_info.md) | 调度信息。 | 34| [AuthSolution](_auth_solution.md) | 认证方案。 | 35| [ExecutorSendMsg](_executor_send_msg.md) | 执行器发送的消息。 | 36| [AuthResultInfo](_auth_result_info.md) | 用户身份认证结果信息。 | 37| [IdentifyResultInfo](_identify_result_info.md) | 用户身份识别结果信息。 | 38| [EnrollParam](_enroll_param.md) | 注册认证凭据参数。 | 39| [CredentialInfo](_credential_info.md) | 认证凭据信息。 | 40| [EnrolledInfo](_enrolled_info.md) | 注册信息。 | 41| [EnrollResultInfo](_enroll_resultinfo.md) | 录入结果信息。 | 42 43 44### 枚举 45 46 | 名称 | 描述 | 47| -------- | -------- | 48| [AuthType](#authtype): int { PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0 } | 枚举用户认证凭据类型。 | 49| [ExecutorRole](#executorrole): int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 | 50| [ExecutorSecureLevel](#executorsecurelevel): int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 | 51| [PinSubType](#pinsubtype) : int { PIN_SIX = 10000, PIN_NUMBER = 10001, PIN_MIX = 10002 } | 口令认证子类型。 | 52 53 54### 关键字 55 56 | 名称 | 描述 | 57| -------- | -------- | 58| package ohos.hdi.user_auth.v1_0 | 用户认证接口的包路径 | 59 60 61## **枚举类型说明** 62 63 64### AuthType 65 66 67``` 68enum AuthType : int 69``` 70 71**描述：** 72 73枚举用户认证凭据类型。 74 75 | 枚举值 | 描述 | 76| -------- | -------- | 77| PIN | 认证凭据类型为口令。 | 78| FACE | 认证凭据类型为人脸。 | 79| FINGERPRINT | 认证凭据类型为指纹。 | 80| ALL | 表示包含所有认证凭据类型。 | 81 82 83### ExecutorRole 84 85 86``` 87enum ExecutorRole : int 88``` 89 90**描述：** 91 92枚举执行器角色。 93 94 | 枚举值 | 描述 | 95| -------- | -------- | 96| COLLECTOR | 执行器角色为采集器，提供用户认证时的数据采集能力，需要和认证器配合完成用户认证。 | 97| VERIFIER | 执行器角色为认证器，提供用户认证时数据处理能力，读取存储凭据模板信息并完成比对。 | 98| ALL_IN_ONE | 执行器角色为全功能执行器，可提供用户认证数据采集、处理、储存及比对能力。 | 99 100 101### ExecutorSecureLevel 102 103 104``` 105enum ExecutorSecureLevel : int 106``` 107 108**描述：** 109 110枚举执行器安全等级。 111 112 | 枚举值 | 描述 | 113| -------- | -------- | 114| ESL0 | 执行器安全级别为0，关键操作在无访问控制执行环境中完成。 | 115| ESL1 | 执行器安全级别为1，关键操作在有访问控制的执行环境中完成。 | 116| ESL2 | 执行器安全级别为2，关键操作在可信执行环境中完成。 | 117| ESL3 | 执行器安全级别为3，关键操作在高安环境如独立安全芯片中完成。 | 118 119 120### PinSubType 121 122 123``` 124enum PinSubType : int 125``` 126 127**描述：** 128 129口令认证子类型。 130 131 | 枚举值 | 描述 | 132| -------- | -------- | 133| PIN_SIX | 六位口令密码。 | 134| PIN_NUMBER | 数字口令密码。 | 135| PIN_MIX | 混合密码。 | 136