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