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