1# HdfPinAuth (V2_0)
2
3
4## 概述
5
6提供口令认证驱动的标准API接口。
7
8口令认证驱动为口令认证服务提供统一的访问接口。获取口令认证驱动代理后，口令认证服务可以调用相关接口获取执行器，获取口令认证执行器后， 口令认证服务可以调用相关接口获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。
9
10**起始版本：** 5.0
11
12
13## 汇总
14
15
16### 文件
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [IAllInOneExecutor.idl](_i_all_in_one_executor_8idl_v20.md) | 定义全功能执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 |
21| [ICollector.idl](_i_collector_8idl_v20.md) | 定义采集器标准API接口。接口可用于获取执行器信息，取消认证，采集数据，发送消息等。 |
22| [IExecutorCallback.idl](_i_executor_callback_8idl_v20.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。 |
23| [IPinAuthInterface.idl](_i_pin_auth_interface_8idl_v20.md) | 定义获取口令认证驱动的执行器列表接口，用于从口令认证驱动获取执行器对象列表。 |
24| [IVerifier.idl](_i_verifier_8idl_v20.md) | 定义认证器标准API接口。接口可用于获取执行器信息，取消认证，口令认证，发送消息等。 |
25| [PinAuthTypes.idl](_pin_auth_types_8idl_v20.md) | 定义口令认证驱动的枚举类和数据结构，包括认证类型，执行器角色，执行器安全等级命令ID，返回码，执行器信息，模板信息。 |
26
27
28### 类
29
30| 名称 | 描述 |
31| -------- | -------- |
32| interface  [IAllInOneExecutor](interface_i_all_in_one_executor_v20.md) | 定义全功能执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 |
33| interface  [ICollector](interface_i_collector_v20.md) | 定义采集器标准API接口。接口可用于获取执行器信息，取消认证，采集数据，发送消息等。 |
34| interface  [IExecutorCallback](interface_i_executor_callback_v20.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。 |
35| interface  [IPinAuthInterface](interface_i_pin_auth_interface_v20.md) | 定义获取口令认证驱动的执行器列表接口，用于从口令认证驱动获取执行器对象列表。 |
36| interface  [IVerifier](interface_i_verifier_v20.md) | 定义认证器标准API接口。接口可用于获取执行器信息，取消认证，口令认证，发送消息等。 |
37| struct  [ExecutorInfo](_executor_info_v20.md) | 执行器信息。 |
38| struct  [Property](_property_v20.md) | 执行器属性。 |
39
40
41### 枚举
42
43| 名称 | 描述 |
44| -------- | -------- |
45| [AuthType](#authtype) : int { PIN = 1 , FACE = 2 , FINGERPRINT = 4 } | 枚举用于认证的凭据类型。 |
46| [ExecutorRole](#executorrole) : int { SCHEDULER = 0 , COLLECTOR = 1 , VERIFIER = 2 , ALL_IN_ONE = 3 } | 枚举执行器角色。 |
47| [ExecutorSecureLevel](#executorsecurelevel) : int { ESL0 = 0 , ESL1 = 1 , ESL2 = 2 , ESL3 = 3 } | 枚举执行器安全等级。 |
48| [GetPropertyType](#getpropertytype) : int { AUTH_SUB_TYPE = 1 , LOCKOUT_DURATION = 2 , REMAIN_ATTEMPTS = 3 , NEXT_FAIL_LOCKOUT_DURATION = 6 } | 获取执行器属性信息。 |
49
50
51## 枚举类型说明
52
53
54### AuthType
55
56```
57enum AuthType : int
58```
59
60**描述**
61
62枚举用于认证的凭据类型。
63
64**起始版本：** 3.2
65
66| 枚举值 | 描述 |
67| -------- | -------- |
68| PIN | 标识认证类型是口令。 |
69| FACE | 标识认证类型是人脸。 |
70| FINGERPRINT | 标识认证类型是指纹。 |
71
72
73### ExecutorRole
74
75```
76enum ExecutorRole : int
77```
78
79**描述**
80
81枚举执行器角色。
82
83**起始版本：** 3.2
84
85| 枚举值 | 描述 |
86| -------- | -------- |
87| SCHEDULER | 执行器角色为调度器。 |
88| COLLECTOR | 执行器角色为采集器，提供用户认证时的数据采集能力，需要和认证器配合完成用户认证。 |
89| VERIFIER | 执行器角色为认证器，提供用户认证时数据处理能力，读取存储凭据模板信息并完成比对。 |
90| ALL_IN_ONE | 执行器角色为全功能执行器，可提供用户认证数据采集、处理、储存及比对能力。 |
91
92
93### ExecutorSecureLevel
94
95```
96enum ExecutorSecureLevel : int
97```
98
99**描述**
100
101枚举执行器安全等级。
102
103**起始版本：** 3.2
104
105| 枚举值 | 描述 |
106| -------- | -------- |
107| ESL0 | 执行器安全等级是ESL0。 |
108| ESL1 | 执行器安全等级是ESL1。 |
109| ESL2 | 执行器安全等级是ESL2。 |
110| ESL3 | 执行器安全等级是ESL3。 |
111
112
113### GetPropertyType
114
115```
116enum GetPropertyType : int
117```
118
119**描述**
120
121获取执行器属性信息。
122
123**起始版本：** 4.0
124
125| 枚举值 | 描述 |
126| -------- | -------- |
127| AUTH_SUB_TYPE | 获取执行器的认证子类型。 |
128| LOCKOUT_DURATION | 获取执行器的剩余锁定时间。 |
129| REMAIN_ATTEMPTS | 获取执行器的剩余可重试次数。 |
130| NEXT_FAIL_LOCKOUT_DURATION | 获取执行器的下一次失败锁定时间。 |
131