1# Fingerprint_auth 2 3## 概述 4 5### 功能简介 6 7指纹认证是端侧设备不可或缺的功能，为设备提供用户认证能力，可应用于设备解锁、支付、应用登录等身份认证场景。用户注册指纹后，指纹认证模块就可为设备提供指纹认证的功能。指纹认证功能整体框架如图1。 8 9基于HDF（Hardware Driver Foundation）驱动框架开发的Fingerprint_auth驱动，能够屏蔽硬件器件差异，为上层用户认证框架和Fingerprint_auth服务提供稳定的指纹认证基础能力接口，包括指纹认证执行器列表查询、执行器信息查询、指定指纹模板ID查询模板信息、用户认证框架和执行器间的指纹模板信息对账、指纹的录入、删除、认证和识别等。 10 11**图1** 指纹认证功能整体框架 12 13 14 15### 基本概念 16 17用户认证框架与各基础认证服务组成的身份认证系统支持用户认证凭据设置、删除、认证等基础功能。系统支持用户身份认证，需要提供数据采集、处理、存储及比对能力。 18- 执行器 19 20 执行器是能够提供以上能力的处理模块，各基础认证服务提供执行器能力，被身份认证框架调度完成各项基础能力。 21 22- 执行器安全等级 23 24 执行器提供能力时所在运行环境达到的安全级别。 25 26- 执行器角色 27 28 - 全功能执行器：执行器可独立处理一次凭据注册和身份认证请求，即可提供用户认证数据采集、处理、储存及比对能力。 29 30 - 采集器：执行器提供用户认证时的数据采集能力，需要和认证器配合完成用户认证。 31 32 - 认证器：认证器提供用户认证时数据处理能力，读取存储的凭据模板与当前认证信息完成比对。 33 34- 执行器类型 35 36 同一种身份认证类型的不同认证方式会产生认证算法差异，设备器件差异也会导致算法差异，执行器根据支持的算法类型差异或对接的器件差异，会定义不同的执行器类型。 37 38- 用户认证框架公钥 & 执行器公钥 39 40 用户身份认证处理需要保证用户数据安全以及认证结果的准确性，用户认证框架与基础认证服务间的关键交互信息需要做数据完整性保护，各基础认证服务将提供的执行器能力对接到用户认证框架时，需要交换各自的公钥，其中： 41 42 1）执行器通过用户认证框架公钥校验调度指令的准确性。 43 44 2）执行器公钥可被用户认证框架用于校验认证结果的准确性，同时用于执行器交互认证时的校验交互信息的完整性。 45 46- 认证凭据 47 48 在用户设置认证凭据时认证服务会产生并存储认证凭据，每个模板有一个ID，用于索引模板信息文件，在认证时读取模板信息并用于与当次认证过程中产生的认证数据做对比，完成身份认证。 49 50- 执行器对账 51 52 用户认证框架统一管理用户身份和凭据ID的映射关系，执行器对接到用户认证框架时，会读取用户身份认证框架内保存的该执行器的模板ID列表，执行器需要与自己维护的模板ID列表进行比对，并删除冗余信息。 53 54- HAPs 55 56 HAPs（Harmony Ability Packages），广义上指可以安装在OpenHarmony上的应用包，本章节中仅代表Fingerprint_auth驱动的上层应用。 57 58- IDL接口 59 60 接口定义语言（Interface Definition Language）通过IDL编译器编译后，能够生成与编程语言相关的文件：客户端桩文件，服务器框架文件。本文主要是通过IDL接口生成的客户端和服务端来实现Fingerprint_auth服务和驱动的通信，详细使用方法可参考[IDL简介](https://gitee.com/openharmony/ability_idl_tool/blob/master/README.md)。 61 62- IPC通信 63 64 IPC（Inter Process Communication），进程间通信是指两个进程的数据之间产生交互，详细原理可参考[IPC通信简介](https://gitee.com/openharmony/communication_ipc/blob/master/README_zh.md)。 65 66- HDI 67 68 HDI（Hardware Device Interface），硬件设备接口，位于基础系统服务层和设备驱动层之间，是提供给硬件系统服务开发者使用的、统一的硬件设备功能抽象接口，其目的是为系统服务屏蔽底层硬件设备差异，具体可参考[HDI规范](../../design/hdi-design-specifications.md)。 69 70### 运作机制 71 72Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprint_auth服务提供稳定的指纹认证基础能力，保证设备上指纹认证功能可以正常运行。如图2，Fingerprint_auth服务通过执行器列表接口获取执行器信息后，向用户认证框架注册执行器。Fingerprint_auth服务通过执行器功能接口实现和Fingerprint_auth驱动的认证、识别、查询等功能的信息交互。 73开发者可基于HDF框架对不同芯片进行各自驱动的开发及HDI层接口的调用。 74 75**图2** Fingerprint_auth服务和Fingerprint_auth驱动交互 76 77 78 79### 约束与限制 80 81要求设备上具有可信执行环境TEE（Trusted Execution Environment），指纹特征信息高强度加密保存在可信执行环境中。 82 83## 开发指导 84 85### 场景介绍 86 87Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprint_auth服务提供稳定的指纹认证基础能力，保证设备上指纹认证功能可以正常运行。为实现上述场景的功能，开发者首先需要基于HDF驱动框架，完成Fingerprint_auth驱动开发，其次实现获取执行器列表接口和认证、识别查询等功能接口。 88 89### 接口说明 90 91注：以下接口列举的为IDL接口描述生成的对应C++语言函数接口，接口声明见idl文件（/drivers/interface/fingerprint_auth）。 92在本文中，指纹凭据的录入、认证、识别和删除相关的HDI接口如表1所示，表2中的回调函数分别用于指纹执行器返回操作结果给框架和返回操作过程中的提示信息给上层应用。 93 94**表1** 接口功能介绍 95 96| 接口名称 | 功能介绍 | 97| -------------------------------- | ----------------------------------- | 98| GetExecutorList(std::vector\<sptr\<V1_0::IExecutor>>& executorList) | 获取V1_0版本执行器列表。 | 99| GetExecutorListV1_1(std::vector\<sptr\<V1_1::IExecutor>>& executorList) | 获取V1_1版本执行器列表。 | 100| GetExecutorInfo(ExecutorInfo& info) | 获取执行器信息，包括执行器类型、执行器角色、认证类型、安全等级、执行器公钥等信息，用于向用户认证框架注册执行器。 | 101| GetTemplateInfo(uint64_t templateId, TemplateInfo& info) | 获取指定模板ID的模板信息。 | 102| OnRegisterFinish(const std::vector\<uint64_t>& templateIdList,<br/> const std::vector\<uint8_t>& frameworkPublicKey, const std::vector\<uint8_t>& extraInfo) | 执行器注册成功后，获取用户认证框架的公钥信息；获取用户认证框架的模板列表用于对账。 | 103| Enroll(uint64_t scheduleId, const std::vector\<uint8_t>& extraInfo,<br/> const sptr\<IExecutorCallback>& callbackObj) | 录入指纹模板。 | 104| Authenticate(uint64_t scheduleId, const std::vector\<uint64_t>& templateIdList,<br/> const std::vector\<uint8_t>& extraInfo, const sptr\<IExecutorCallback>& callbackObj) | 认证指纹模板(V1_0版本)。 | 105| AuthenticateV1_1(uint64_t scheduleId, const std::vector\<uint64_t>& templateIdList,<br/> bool endAfterFirstFail, const std::vector\<uint8_t>& extraInfo, const sptr\<IExecutorCallback>& callbackObj) | 认证指纹模板(V1_1版本)。 | 106| Identify(uint64_t scheduleId, const std::vector\<uint8_t>& extraInfo,<br/> const sptr\<IExecutorCallback>& callbackObj) | 识别指纹模板。 | 107| Delete(const std::vector\<uint64_t>& templateIdList) | 删除指纹模板。 | 108| Cancel(uint64_t scheduleId) | 通过scheduleId取消指定录入、认证、识别操作。 | 109| SendCommand(int32_t commandId, const std::vector\<uint8_t>& extraInfo,<br/> const sptr\<IExecutorCallback>& callbackObj) | 指纹认证服务向Fingerprint_auth驱动传递参数的通用接口。 | 110| GetProperty(const std::vector\<uint64_t>& templateIdList,<br/>const std::vector\<GetPropertyType>& propertyTypes, Property& property) | 获取执行器属性信息。 | 111| SetCachedTemplates(const std::vector\<uint64_t> &templateIdList) | 设置需缓存模板列表。 | 112| RegisterSaCommandCallback(const sptr\<ISaCommandCallback> &callbackObj) | 注册SA命令回调。 | 113 114**表2** 回调函数介绍 115 116| 接口名称 | 功能介绍 | 117| ------------------------------------------------------------ | ------------------------ | 118| IExecutorCallback::OnResult(int32_t code, const std::vector\<uint8_t>& extraInfo) | 返回操作的最终结果。 | 119| IExecutorCallback::OnTip(int32_t code, const std::vector\<uint8_t>& extraInfo) | 返回操作的过程交互信息。 | 120| ISaCommandCallback::OnSaCommands(const std::vector\<SaCommand>& commands) | 发送命令列表。 | 121 122### 开发步骤 123 124以Hi3516DV300平台为例，我们提供了Fingerprint_auth驱动DEMO实例，以下是目录结构及各部分功能简介。 125 126```undefined 127// drivers/peripheral/fingerprint_auth 128├── BUILD.gn # 编译脚本 129├── bundle.json # 组件描述文件 130└── hdi_service # Fingerprint_auth驱动实现 131 ├── BUILD.gn # 编译脚本 132 ├── include # 头文件 133 └── src # 源文件 134 ├── executor_impl.cpp # 认证、录入等功能接口实现 135 ├── fingerprint_auth_interface_driver.cpp # Fingerprint_auth驱动入口 136 └── fingerprint_auth_interface_service.cpp # 获取执行器列表接口实现 137``` 138 139下面结合DEMO实例介绍驱动开发的具体步骤。 140 1411. Fingerprint_auth驱动是基于HDF驱动框架设计，所以开发者需要按照驱动Driver Entry程序，完成Fingerprint_auth驱动框架开发，主要由Bind、Init、Release、Dispatch函数接口实现。关键代码如下，详细代码请参见[fingerprint_auth_interface_driver.cpp](https://gitee.com/openharmony/drivers_peripheral/blob/master/fingerprint_auth/hdi_service/src/fingerprint_auth_interface_driver.cpp)文件。 142 143 ```c++ 144 // 通过自定义的HdfFingerprintAuthInterfaceHost对象包含ioService对象和真正的HDI Service实现IRemoteObject对象 145 struct HdfFingerprintAuthInterfaceHost { 146 struct IDeviceIoService ioService; 147 OHOS::sptr<OHOS::IRemoteObject> stub; 148 }; 149 150 // 服务接口调用响应接口 151 static int32_t FingerprintAuthInterfaceDriverDispatch(struct HdfDeviceIoClient *client, int cmdId, struct HdfSBuf *data, 152 struct HdfSBuf *reply) 153 { 154 IAM_LOGI("start"); 155 auto *hdfFingerprintAuthInterfaceHost = CONTAINER_OF(client->device->service, 156 struct HdfFingerprintAuthInterfaceHost, ioService); 157 158 OHOS::MessageParcel *dataParcel = nullptr; 159 OHOS::MessageParcel *replyParcel = nullptr; 160 OHOS::MessageOption option; 161 162 if (SbufToParcel(data, &dataParcel) != HDF_SUCCESS) { 163 IAM_LOGE("%{public}s:invalid data sbuf object to dispatch", __func__); 164 return HDF_ERR_INVALID_PARAM; 165 } 166 if (SbufToParcel(reply, &replyParcel) != HDF_SUCCESS) { 167 IAM_LOGE("%{public}s:invalid reply sbuf object to dispatch", __func__); 168 return HDF_ERR_INVALID_PARAM; 169 } 170 171 return hdfFingerprintAuthInterfaceHost->stub->SendRequest(cmdId, *dataParcel, *replyParcel, option); 172 } 173 174 // 初始化接口 175 int HdfFingerprintAuthInterfaceDriverInit(struct HdfDeviceObject *deviceObject) 176 { 177 IAM_LOGI("start"); 178 if (!HdfDeviceSetClass(deviceObject, DEVICE_CLASS_USERAUTH)) { 179 IAM_LOGE("set fingerprint auth hdf class failed"); 180 return HDF_FAILURE; 181 } 182 return HDF_SUCCESS; 183 } 184 185 // Fingerprint_auth驱动对外提供的服务绑定到HDF框架 186 int HdfFingerprintAuthInterfaceDriverBind(struct HdfDeviceObject *deviceObject) 187 { 188 IAM_LOGI("start"); 189 auto *hdfFingerprintAuthInterfaceHost = new (std::nothrow) HdfFingerprintAuthInterfaceHost; 190 if (hdfFingerprintAuthInterfaceHost == nullptr) { 191 IAM_LOGE("%{public}s: failed to create HdfFaceAuthInterfaceHost object", __func__); 192 return HDF_FAILURE; 193 } 194 195 hdfFingerprintAuthInterfaceHost->ioService.Dispatch = FingerprintAuthInterfaceDriverDispatch; 196 hdfFingerprintAuthInterfaceHost->ioService.Open = NULL; 197 hdfFingerprintAuthInterfaceHost->ioService.Release = NULL; 198 199 auto serviceImpl = IFingerprintAuthInterface::Get(true); 200 if (serviceImpl == nullptr) { 201 IAM_LOGE("%{public}s: failed to implement service", __func__); 202 return HDF_FAILURE; 203 } 204 205 hdfFingerprintAuthInterfaceHost->stub = OHOS::HDI::ObjectCollector::GetInstance().GetOrNewObject(serviceImpl, 206 IFaceAuthInterface::GetDescriptor()); 207 if (hdfFingerprintAuthInterfaceHost->stub == nullptr) { 208 IAM_LOGE("%{public}s: failed to get stub object", __func__); 209 return HDF_FAILURE; 210 } 211 212 deviceObject->service = &hdfFingerprintAuthInterfaceHost->ioService; 213 IAM_LOGI("success"); 214 return HDF_SUCCESS; 215 } 216 217 // 释放Fingerprint_auth驱动中的资源 218 void HdfFingerprintAuthInterfaceDriverRelease(struct HdfDeviceObject *deviceObject) 219 { 220 IAM_LOGI("start"); 221 auto *hdfFingerprintAuthInterfaceHost = CONTAINER_OF(deviceObject->service, 222 struct HdfFaceAuthInterfaceHost, ioService); 223 delete hdfFaceAuthInterfaceHost; 224 IAM_LOGI("success"); 225 } 226 227 // 注册Fingerprint_auth驱动入口数据结构体对象 228 struct HdfDriverEntry g_fingerprintAuthInterfaceDriverEntry = { 229 .moduleVersion = 1, 230 .moduleName = "fingerprint_auth_interface_service", 231 .Bind = HdfFingerprintAuthInterfaceDriverBind, 232 .Init = HdfFingerprintAuthInterfaceDriverInit, 233 .Release = HdfFingerprintAuthInterfaceDriverRelease, 234 }; 235 236 // 调用HDF_INIT将驱动入口注册到HDF框架中。在加载驱动时HDF框架会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出 237 HDF_INIT(g_fingerprintAuthInterfaceDriverEntry); 238 ``` 239 2402. Fingerprint_auth驱动框架开发完成后，Fingerprint_auth驱动需要向Fingerprint_auth服务和统一身份认证注册执行器，所以需要实现获取执行器列表接口。关键代码如下，详细代码请参见[fingerprint_auth_interface_service.cpp](https://gitee.com/openharmony/drivers_peripheral/blob/master/fingerprint_auth/hdi_service/src/fingerprint_auth_interface_service.cpp)文件。 241 242 ```c++ 243 // 执行器实现类 244 class ExecutorImpl : public IExecutor { 245 public: 246 ExecutorImpl(struct ExecutorInfo executorInfo); 247 virtual ~ExecutorImpl() {} 248 249 private: 250 struct ExecutorInfo executorInfo_; // 执行器信息 251 }; 252 253 static constexpr uint16_t SENSOR_ID = 123; // 执行器sensorID 254 static constexpr uint32_t EXECUTOR_TYPE = 123; // 执行器类型 255 static constexpr size_t PUBLIC_KEY_LEN = 32; // 执行器32字节公钥 256 257 // 创建HDI服务对象 258 extern "C" IFaceAuthInterface *FingerprintAuthInterfaceImplGetInstance(void) 259 { 260 auto fingerprintAuthInterfaceService = new (std::nothrow) FingerprintAuthInterfaceService(); 261 if (fingerprintAuthInterfaceService == nullptr) { 262 IAM_LOGE("faceAuthInterfaceService is nullptr"); 263 return nullptr; 264 } 265 return fingerprintAuthInterfaceService; 266 } 267 268 // 获取执行器列表实现，创建执行器 269 int32_t GetExecutorListV1_1(std::vector<sptr<V1_1::IExecutor>>& executorList) 270 { 271 IAM_LOGI("interface mock start"); 272 executorList.clear(); 273 struct ExecutorInfo executorInfoExample = { 274 .sensorId = SENSOR_ID, 275 .executorType = EXECUTOR_TYPE, 276 .executorRole = ExecutorRole::ALL_IN_ONE, 277 .authType = AuthType::FINGERPRINT, 278 .esl = ExecutorSecureLevel::ESL0, // ExecutorSecureLevel标识执行器的安全等级，范围是ESL0~ESL3，其中ESL3标识的安全等级最高 279 .publicKey = std::vector<uint8_t>(PUBLIC_KEY_LEN, 0), // 32字节公钥，算法是Ed25519 280 .extraInfo = {}, 281 }; 282 auto executor = new (std::nothrow) ExecutorImpl(executorInfoExample); 283 if (executor == nullptr) { 284 IAM_LOGE("executor is nullptr"); 285 return HDF_FAILURE; 286 } 287 executorList.push_back(sptr<V1_1::IExecutor>(executor)); 288 IAM_LOGI("interface mock success"); 289 return HDF_SUCCESS; 290 } 291 292 // 获取V1_0执行器列表实现，使用V1_1版本执行器实现V1_0版本执行器的功能 293 int32_t GetExecutorList(std::vector<sptr<V1_0::IExecutor>> &executorList) 294 { 295 std::vector<sptr<V1_1::IExecutor>> executorListV1_1; 296 int32_t result = GetExecutorListV1_1(executorListV1_1); 297 for (auto &executor : executorListV1_1) { 298 executorList.push_back(executor); 299 } 300 return result; 301 } 302 ``` 303 3043. 步骤1、2完成后基本实现了Fingerprint_auth驱动和Fingerprint_auth服务对接。接下来需实现执行器每个功能接口，来完成指纹认证基础能力。关键代码如下，详细代码请参见[executor_impl.cpp](https://gitee.com/openharmony/drivers_peripheral/blob/master/fingerprint_auth/hdi_service/src/executor_impl.cpp)文件。 305 306 ```c++ 307 // 实现获取执行器信息接口 308 int32_t GetExecutorInfo(ExecutorInfo& info) 309 { 310 IAM_LOGI("interface mock start"); 311 info = executorInfo_; 312 IAM_LOGI("get executor information success"); 313 return HDF_SUCCESS; 314 } 315 316 // 实现获取指定模板ID的模板信息接口 317 int32_t GetTemplateInfo(uint64_t templateId, TemplateInfo& info) 318 { 319 IAM_LOGI("interface mock start"); 320 static_cast<void>(templateId); 321 info = {0}; 322 IAM_LOGI("get template information success"); 323 return HDF_SUCCESS; 324 } 325 326 // 实现执行器注册成功后，获取用户认证框架的公钥信息、获取用户认证框架的模板列表接口。将公钥信息保持，模板列表用于和本地的模板做对账 327 int32_t OnRegisterFinish(const std::vector<uint64_t>& templateIdList, 328 const std::vector<uint8_t>& frameworkPublicKey, const std::vector<uint8_t>& extraInfo) 329 { 330 IAM_LOGI("interface mock start"); 331 static_cast<void>(templateIdList); 332 static_cast<void>(extraInfo); 333 static_cast<void>(frameworkPublicKey); 334 IAM_LOGI("register finish"); 335 return HDF_SUCCESS; 336 } 337 338 // 实现指纹录入接口 339 int32_t Enroll(uint64_t scheduleId, const std::vector<uint8_t>& extraInfo, 340 const sptr<IExecutorCallback>& callbackObj) 341 { 342 IAM_LOGI("interface mock start"); 343 static_cast<void>(scheduleId); 344 static_cast<void>(extraInfo); 345 IAM_LOGI("enroll, result is %{public}d", ResultCode::OPERATION_NOT_SUPPORT); 346 int32_t ret = callbackObj->OnResult(ResultCode::OPERATION_NOT_SUPPORT, {}); 347 if (ret != ResultCode::SUCCESS) { 348 IAM_LOGE("callback result is %{public}d", ret); 349 return HDF_FAILURE; 350 } 351 return HDF_SUCCESS; 352 } 353 354 // 调用指纹认证V1_1版本接口实现指纹认证V1_0版本接口 355 int32_t Authenticate(uint64_t scheduleId, const std::vector<uint64_t> &templateIdList, 356 const std::vector<uint8_t> &extraInfo, const sptr<IExecutorCallback> &callbackObj) 357 { 358 IAM_LOGI("interface mock start"); 359 return AuthenticateV1_1(scheduleId, templateIdList, true, extraInfo, callbackObj); 360 } 361 362 // 实现指纹认证V1_1版本接口 363 int32_t AuthenticateV1_1(uint64_t scheduleId, const std::vector<uint64_t>& templateIdList, bool endAfterFirstFail, 364 const std::vector<uint8_t>& extraInfo, const sptr<IExecutorCallback>& callbackObj) 365 { 366 IAM_LOGI("interface mock start"); 367 static_cast<void>(scheduleId); 368 static_cast<void>(templateIdList); 369 static_cast<void>(endAfterFirstFail); 370 static_cast<void>(extraInfo); 371 IAM_LOGI("authenticateV1_1, result is %{public}d", ResultCode::NOT_ENROLLED); 372 int32_t ret = callbackObj->OnResult(ResultCode::NOT_ENROLLED, {}); 373 if (ret != ResultCode::SUCCESS) { 374 IAM_LOGE("callback result is %{public}d", ret); 375 return HDF_FAILURE; 376 } 377 return HDF_SUCCESS; 378 } 379 380 // 实现指纹识别接口 381 int32_t Identify(uint64_t scheduleId, const std::vector<uint8_t>& extraInfo, 382 const sptr<IExecutorCallback>& callbackObj) 383 { 384 IAM_LOGI("interface mock start"); 385 static_cast<void>(scheduleId); 386 static_cast<void>(extraInfo); 387 IAM_LOGI("identify, result is %{public}d", ResultCode::OPERATION_NOT_SUPPORT); 388 int32_t ret = callbackObj->OnResult(ResultCode::OPERATION_NOT_SUPPORT, {}); 389 if (ret != ResultCode::SUCCESS) { 390 IAM_LOGE("callback result is %{public}d", ret); 391 return HDF_FAILURE; 392 } 393 return HDF_SUCCESS; 394 } 395 396 // 实现删除指纹模板接口 397 int32_t Delete(const std::vector<uint64_t>& templateIdList) 398 { 399 IAM_LOGI("interface mock start"); 400 static_cast<void>(templateIdList); 401 IAM_LOGI("delete success"); 402 return HDF_SUCCESS; 403 } 404 405 // 实现通过scheduleId取消指定操作接口 406 int32_t Cancel(uint64_t scheduleId) 407 { 408 IAM_LOGI("interface mock start"); 409 static_cast<void>(scheduleId); 410 IAM_LOGI("cancel success"); 411 return HDF_SUCCESS; 412 } 413 414 // 实现指纹认证服务向Fingerprint_auth驱动传递参数的通用接口，当前需要实现冻结与解锁模板命令 415 int32_t SendCommand(int32_t commandId, const std::vector<uint8_t>& extraInfo, 416 const sptr<IExecutorCallback>& callbackObj) 417 { 418 IAM_LOGI("interface mock start"); 419 static_cast<void>(extraInfo); 420 int32_t ret; 421 switch (commandId) { 422 case LOCK_TEMPLATE: 423 IAM_LOGI("unlock template, result is %{public}d", ResultCode::SUCCESS); 424 ret = callbackObj->OnResult(ResultCode::SUCCESS, {}); 425 if (ret != ResultCode::SUCCESS) { 426 IAM_LOGE("callback result is %{public}d", ret); 427 return HDF_FAILURE; 428 } 429 break; 430 case UNLOCK_TEMPLATE: 431 IAM_LOGI("unlock template, result is %{public}d", ResultCode::SUCCESS); 432 ret = callbackObj->OnResult(ResultCode::SUCCESS, {}); 433 if (ret != ResultCode::SUCCESS) { 434 IAM_LOGE("callback result is %{public}d", ret); 435 return HDF_FAILURE; 436 } 437 break; 438 default: 439 IAM_LOGD("not support CommandId : %{public}d", commandId); 440 ret = callbackObj->OnResult(ResultCode::GENERAL_ERROR, {}); 441 if (ret != ResultCode::SUCCESS) { 442 IAM_LOGE("callback result is %{public}d", ret); 443 return HDF_FAILURE; 444 } 445 } 446 return HDF_SUCCESS; 447 } 448 449 // 实现获取执行器属性接口 450 int32_t ExecutorImpl::GetProperty( 451 const std::vector<uint64_t> &templateIdList, const std::vector<GetPropertyType> &propertyTypes, Property &property) 452 { 453 IAM_LOGI("interface mock start"); 454 property = {}; 455 IAM_LOGI("get property success"); 456 return HDF_SUCCESS; 457 } 458 459 // 实现设置需缓存模板列表接口 460 int32_t ExecutorImpl::SetCachedTemplates(const std::vector<uint64_t> &templateIdList) 461 { 462 IAM_LOGI("interface mock start"); 463 IAM_LOGI("set cached templates success"); 464 return HDF_SUCCESS; 465 } 466 467 // 实现注册SA命令回调接口 468 int32_t ExecutorImpl::RegisterSaCommandCallback(const sptr<ISaCommandCallback> &callbackObj) 469 { 470 IAM_LOGI("interface mock start"); 471 IAM_LOGI("register sa command callback success"); 472 return HDF_SUCCESS; 473 } 474 ``` 475 4764. 用户身份认证框架支持多driver，当增加driver或者修改driver信息，需要修改如下文件中serviceName2Config。 477 478 ```c++ 479 // base/user_iam/fingerprint_auth/services/src/fingerprint_auth_service.cpp 480 void FingerprintAuthService::StartDriverManager() 481 { 482 IAM_LOGI("start"); 483 // 此处增加或修改driver服务名字和ID，driver服务名字和ID需要全局唯一 484 const std::map<std::string, UserAuth::ServiceConfig> serviceName2Config = { 485 {"fingerprint_auth_interface_service", {2, std::make_shared<FingerprintAuthDriverHdi>()}}, 486 }; 487 UserIAM::UserAuth::IDriverManager::GetInstance().Start(serviceName2Config); 488 } 489 ``` 490 491### 调测验证 492 493驱动开发完成后，开发者可以通过[用户认证API接口](../../application-dev/reference/apis/js-apis-useriam-userauth.md)开发JS应用，JS应用通过Fingerprint_auth服务调用Fingerprint_auth驱动，从而验证驱动开发是否符合预期。基于Hi3516DV300平台验证，认证功能验证的JS测试代码如下： 494 495 ```js 496 // API version 9 497 import userIAM_userAuth from '@ohos.userIAM.userAuth'; 498 499 let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); 500 let authType = userIAM_userAuth.UserAuthType.FINGERPRINT; 501 let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; 502 503 // 获取认证对象 504 let auth; 505 try { 506 auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); 507 console.log("get auth instance success"); 508 } catch (error) { 509 console.log("get auth instance failed" + error); 510 } 511 512 // 订阅认证结果 513 try { 514 auth.on("result", { 515 callback: (result: userIAM_userAuth.AuthResultInfo) => { 516 console.log("authV9 result " + result.result); 517 console.log("authV9 token " + result.token); 518 console.log("authV9 remainAttempts " + result.remainAttempts); 519 console.log("authV9 lockoutDuration " + result.lockoutDuration); 520 } 521 }); 522 console.log("subscribe authentication event success"); 523 } catch (error) { 524 console.log("subscribe authentication event failed " + error); 525 } 526 527 // 开始认证 528 try { 529 auth.start(); 530 console.info("authV9 start auth success"); 531 } catch (error) { 532 console.info("authV9 start auth failed, error = " + error); 533 } 534 535 // 取消认证 536 try { 537 auth.cancel(); 538 console.info("cancel auth success"); 539 } catch (error) { 540 console.info("cancel auth failed, error = " + error); 541 } 542 543 // 取消订阅认证结果 544 try { 545 auth.off("result"); 546 console.info("cancel subscribe authentication event success"); 547 } catch (error) { 548 console.info("cancel subscribe authentication event failed, error = " + error); 549 } 550 ``` 551