1# IVerifier
2
3
4## 概述
5
6定义认证器标准API接口。接口可用于获取执行器信息，取消认证，口令认证，发送消息等。
7
8**起始版本：** 5.0
9
10**相关模块：**[HdfPinAuth](_hdf_pin_auth_v20.md)
11
12
13## 汇总
14
15
16### Public 成员函数
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [GetExecutorInfo](#getexecutorinfo) ([out] struct [ExecutorInfo](_executor_info_v20.md) executorInfo) | 获取执行器信息。 |
21| [OnRegisterFinish](#onregisterfinish) ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo) | 完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。 |
22| [Cancel](#cancel) ([in] unsigned long scheduleId) | 取消操作请求。 |
23| [SendMessage](#sendmessage) ([in] unsigned long scheduleId, [in] int srcRole, [in] unsigned char[] msg) | 发送消息。 |
24| [Authenticate](#authenticate) ([in] unsigned long scheduleId, [in] unsigned long[] templateIdList, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback_v20.md) callbackObj) | 认证口令。 |
25| [NotifyCollectorReady](#notifycollectorready) ([in] unsigned long scheduleId) | 通知收集器准备就绪。 |
26
27
28## 成员函数说明
29
30
31### Authenticate()
32
33```
34IVerifier::Authenticate ([in] unsigned long scheduleId, [in] unsigned long[] templateIdList, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj )
35```
36
37**描述**
38
39认证口令。
40
41**起始版本：** 5.0
42
43**参数:**
44
45| 名称 | 描述 |
46| -------- | -------- |
47| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 |
48| templateIdList | 指定要认证的模版ID列表。 |
49| extraInfo | 其他相关信息，用于支持信息扩展。 |
50| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_v20.md)。 |
51
52**返回：**
53
540 表示操作成功。
55
56非0 表示操作失败。
57
58
59### Cancel()
60
61```
62IVerifier::Cancel ([in] unsigned long scheduleId)
63```
64
65**描述**
66
67取消操作请求。
68
69**起始版本：** 5.0
70
71**参数:**
72
73| 名称 | 描述 |
74| -------- | -------- |
75| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 |
76
77**返回：**
78
790 表示操作成功。
80
81非0 表示操作失败。
82
83
84### GetExecutorInfo()
85
86```
87IVerifier::GetExecutorInfo ([out] struct ExecutorInfo executorInfo)
88```
89
90**描述**
91
92获取执行器信息。
93
94**起始版本：** 5.0
95
96**参数:**
97
98| 名称 | 描述 |
99| -------- | -------- |
100| executorInfo | 执行器信息[ExecutorInfo](_executor_info_v20.md)。 |
101
102**返回：**
103
1040 表示操作成功。
105
106非0 表示操作失败。
107
108
109### NotifyCollectorReady()
110
111```
112IVerifier::NotifyCollectorReady ([in] unsigned long scheduleId)
113```
114
115**描述**
116
117通知收集器准备就绪。
118
119**起始版本：** 5.0
120
121**参数:**
122
123| 名称 | 描述 |
124| -------- | -------- |
125| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 |
126
127**返回：**
128
1290 表示操作成功。
130
131非0 表示操作失败。
132
133
134### OnRegisterFinish()
135
136```
137IVerifier::OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo )
138```
139
140**描述**
141
142完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。
143
144**起始版本：** 5.0
145
146**参数:**
147
148| 名称 | 描述 |
149| -------- | -------- |
150| templateIdList | 用户认证框架内由该执行器注册的口令凭据模版ID列表。 |
151| frameworkPublicKey | 用户认证框架的公钥，用于校验用户认证框架私钥签名的信息。 |
152| extraInfo | 其他相关信息，用于支持信息扩展。 |
153
154**返回：**
155
1560 表示操作成功。
157
158非0 表示操作失败。
159
160
161### SendMessage()
162
163```
164IVerifier::SendMessage ([in] unsigned long scheduleId, [in] int srcRole, [in] unsigned char[] msg )
165```
166
167**描述**
168
169发送消息。
170
171**起始版本：** 5.0
172
173**参数:**
174
175| 名称 | 描述 |
176| -------- | -------- |
177| scheduleId | 标识消息的调度ID。 |
178| srcRole | 源执行器角色[ExecutorRole](_hdf_pin_auth_v20.md#executorrole). |
179| msg | 消息。 |
180
181**返回：**
182
1830 表示操作成功。
184
185非0 表示操作失败。
186