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
67**起始版本：** 3.2
68
69| 枚举值 | 描述 |
70| -------- | -------- |
71| ALL | 表示包含所有认证凭据类型。 |
72| PIN | 认证凭据类型为口令。 |
73| FACE | 认证凭据类型为人脸。 |
74| FINGERPRINT | 认证凭据类型为指纹。 |
75
76
77### ExecutorRole
78
79```
80enum ExecutorRole : int
81```
82
83**描述**
84
85
86枚举执行器角色。
87
88**起始版本：** 3.2
89
90| 枚举值 | 描述 |
91| -------- | -------- |
92| COLLECTOR | 执行器角色为采集器，提供用户认证时的数据采集能力，需要和认证器配合完成用户认证。 |
93| VERIFIER | 执行器角色为认证器，提供用户认证时数据处理能力，读取存储凭据模板信息并完成比对。 |
94| ALL_IN_ONE | 执行器角色为全功能执行器，可提供用户认证数据采集、处理、储存及比对能力。 |
95
96
97### ExecutorSecureLevel
98
99```
100enum ExecutorSecureLevel : int
101```
102
103**描述**
104
105
106枚举执行器安全等级。
107
108**起始版本：** 3.2
109
110| 枚举值 | 描述 |
111| -------- | -------- |
112| ESL0 | 执行器安全级别为0，关键操作在无访问控制执行环境中完成。 |
113| ESL1 | 执行器安全级别为1，关键操作在有访问控制的执行环境中完成。 |
114| ESL2 | 执行器安全级别为2，关键操作在可信执行环境中完成。 |
115| ESL3 | 执行器安全级别为3，关键操作在高安环境如独立安全芯片中完成。 |
116
117
118### PinSubType
119
120```
121enum PinSubType : int
122```
123
124**描述**
125
126
127口令认证子类型。
128
129**起始版本：** 3.2
130
131| 枚举值 | 描述 |
132| -------- | -------- |
133| PIN_SIX |  |
134| PIN_NUMBER | 六位口令密码。 |
135| PIN_MIX | 数字口令密码。 |
136
137
138### ScheduleMode
139
140```
141enum ScheduleMode : int
142```
143
144**描述**
145
146
147调度模式。
148
149**起始版本：** 3.2
150
151| 枚举值 | 描述 |
152| -------- | -------- |
153| ENROLL | 录入模式。 |
154| AUTH | 认证模式。 |
155| IDENTIFY | 识别模式。 |
156