1# IExecutor
2
3
4## 概述
5
6定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。
7
8**起始版本：** 3.2
9
10**相关模块：**[HdfPinAuth](_hdf_pin_auth_v10.md)
11
12
13## 汇总
14
15
16### Public 成员函数
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [GetExecutorInfo](#getexecutorinfo) ([out] struct [ExecutorInfo](_executor_info_pinauth_v10.md) executorInfo) | 获取执行器信息，口令认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。  |
21| [GetTemplateInfo](#gettemplateinfo) ([in] unsigned long templateId, [out] struct [TemplateInfo](_template_info_pinauth_v10.md) templateInfo) | 获取属性。  |
22| [OnRegisterFinish](#onregisterfinish) ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo) | 完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。  |
23| [OnSetData](#onsetdata) ([in] unsigned long scheduleId, [in] unsigned long authSubType, [in] unsigned char[] data) | 设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。  |
24| [Enroll](#enroll) ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback_pinauth_v10.md) callbackObj) | 注册口令。  |
25| [Authenticate](#authenticate) ([in] unsigned long scheduleId, [in] unsigned long templateId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback_pinauth_v10.md) callbackObj) | 认证口令。  |
26| [Delete](#delete) ([in] unsigned long templateId) | 删除口令。  |
27| [Cancel](#cancel) ([in] unsigned long scheduleId) | 取消操作请求。  |
28| [SendCommand](#sendcommand) ([in] int commandId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback_pinauth_v10.md) callbackObj) | 发送口令认证功能相关操作命令。  |
29
30
31## 成员函数说明
32
33
34### Authenticate()
35
36```
37IExecutor::Authenticate ([in] unsigned long scheduleId, [in] unsigned long templateId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj )
38```
39**描述**
40
41认证口令。
42
43**起始版本：** 3.2
44
45**参数:**
46
47| 名称 | 描述 |
48| -------- | -------- |
49| scheduleId | 调度ID，用于标识一次操作请求的调度过程。  |
50| templateId | 指定要认证的模版ID。  |
51| extraInfo | 其他相关信息，用于支持信息扩展。  |
52| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_pinauth_v10.md)。 |
53
54**返回：**
55
560 表示操作成功。
57
58非0 表示操作失败。
59
60
61### Cancel()
62
63```
64IExecutor::Cancel ([in] unsigned long scheduleId)
65```
66**描述**
67
68取消操作请求。
69
70**起始版本：** 3.2
71
72**参数:**
73
74| 名称 | 描述 |
75| -------- | -------- |
76| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 |
77
78**返回：**
79
800 表示操作成功。
81
82非0 表示操作失败。
83
84
85### Delete()
86
87```
88IExecutor::Delete ([in] unsigned long templateId)
89```
90**描述**
91
92删除口令。
93
94**起始版本：** 3.2
95
96**参数:**
97
98| 名称 | 描述 |
99| -------- | -------- |
100| templateId | 模版ID。 |
101
102**返回：**
103
1040 表示操作成功。
105
106非0 表示操作失败。
107
108
109### Enroll()
110
111```
112IExecutor::Enroll ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj )
113```
114**描述**
115
116注册口令。
117
118**起始版本：** 3.2
119
120**参数:**
121
122| 名称 | 描述 |
123| -------- | -------- |
124| scheduleId | 调度ID，用于标识一次操作请求的调度过程。  |
125| extraInfo | 其他相关信息，用于支持信息扩展。  |
126| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_pinauth_v10.md)。 |
127
128**返回：**
129
1300 表示操作成功。
131
132非0 表示操作失败。
133
134
135### GetExecutorInfo()
136
137```
138IExecutor::GetExecutorInfo ([out] struct ExecutorInfo executorInfo)
139```
140**描述**
141
142获取执行器信息，口令认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。
143
144**起始版本：** 3.2
145
146**参数:**
147
148| 名称 | 描述 |
149| -------- | -------- |
150| executorInfo | 执行器信息[ExecutorInfo](_executor_info_pinauth_v10.md)。 |
151
152**返回：**
153
1540 表示操作成功。
155
156非0 表示操作失败。
157
158
159### GetTemplateInfo()
160
161```
162IExecutor::GetTemplateInfo ([in] unsigned long templateId, [out] struct TemplateInfo templateInfo )
163```
164**描述**
165
166获取属性。
167
168**起始版本：** 3.2
169
170**参数:**
171
172| 名称 | 描述 |
173| -------- | -------- |
174| templateId | 凭据模版ID。  |
175| templateInfo | 凭据模版信息[TemplateInfo](_template_info_pinauth_v10.md)。 |
176
177**返回：**
178
1790 表示操作成功。
180
181非0 表示操作失败。
182
183
184### OnRegisterFinish()
185
186```
187IExecutor::OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo )
188```
189**描述**
190
191完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。
192
193**起始版本：** 3.2
194
195**参数:**
196
197| 名称 | 描述 |
198| -------- | -------- |
199| templateIdList | 用户认证框架内由该执行器注册的口令凭据模版ID列表。  |
200| frameworkPublicKey | 用户认证框架的公钥，用于校验用户认证框架私钥签名的信息。  |
201| extraInfo | 其他相关信息，用于支持信息扩展。 |
202
203**返回：**
204
2050 表示操作成功。
206
207非0 表示操作失败。
208
209
210### OnSetData()
211
212```
213IExecutor::OnSetData ([in] unsigned long scheduleId, [in] unsigned long authSubType, [in] unsigned char[] data )
214```
215**描述**
216
217设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。
218
219**起始版本：** 3.2
220
221**参数:**
222
223| 名称 | 描述 |
224| -------- | -------- |
225| scheduleId | 调度ID，用于标识一次操作请求的调度过程。  |
226| authSubType | 口令子类型，如六位数字PIN码等。  |
227| data | 口令数据。 |
228
229**返回：**
230
2310 表示操作成功。
232
233非0 表示操作失败。
234
235
236### SendCommand()
237
238```
239IExecutor::SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj )
240```
241**描述**
242
243发送口令认证功能相关操作命令。
244
245**起始版本：** 3.2
246
247**参数:**
248
249| 名称 | 描述 |
250| -------- | -------- |
251| commandId | 操作命令ID[CommandId](_hdf_pin_auth_v10.md#commandid)。  |
252| extraInfo | 其他相关信息，用于支持信息扩展。  |
253| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_pinauth_v10.md)。 |
254
255**返回：**
256
2570 表示操作成功。
258
259非0 表示操作失败。
260