1# HdfPinAuth 2 3 4## **概述** 5 6提供口令认证驱动的标准API接口。 7 8口令认证驱动为口令认证服务提供统一的访问接口。获取口令认证驱动代理后，口令认证服务可以调用相关接口获取执行器，获取口令认证执行器后， 口令认证服务可以调用相关接口获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 9 10**Since：** 11 123.2 13 14 15## **汇总** 16 17 18### 文件 19 20 | 名称 | 描述 | 21| -------- | -------- | 22| [IExecutor.idl](pin__auth_2_i_executor_8idl.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 | 23| [IExecutorCallback.idl](pin__auth_2_i_executor_callback_8idl.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。 | 24| [IPinAuthInterface.idl](_i_pin_auth_interface_8idl.md) | 定义获取口令认证驱动的执行器列表接口，用于从口令认证驱动获取执行器对象列表。 | 25| [PinAuthTypes.idl](_pin_auth_types_8idl.md) | 定义口令认证驱动的枚举类和数据结构。 | 26 27 28### 类 29 30 | 名称 | 描述 | 31| -------- | -------- | 32| [IExecutor](interface_pin_i_executor.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 | 33| [IExecutorCallback](interface_pin_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 | 34| [IPinAuthInterface](interface_i_pin_auth_interface.md) | 定义获取口令认证驱动的执行器列表接口。 | 35| [ExecutorInfo](_executor_info.md) | 执行器信息。 | 36| [TemplateInfo](_template_info.md) | 凭据模版信息。 | 37 38 39### 枚举 40 41 | 名称 | 描述 | 42| -------- | -------- | 43| [AuthType](#authtype): int { PIN = 1, FACE = 2, FINGERPRINT = 4 } | 枚举用户认证凭据类型。 | 44| [ExecutorRole](#executorrole): int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 | 45| [ExecutorSecureLevel](#executorsecurelevel): int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 | 46| [CommandId](#commandid): int { DEFAULT = 0 } | 枚举口令认证相关功能操作命令。 | 47 48 49### 关键字 50 51 | 名称 | 描述 | 52| -------- | -------- | 53| package ohos.hdi.pin_auth.v1_0 | 口令认证接口的包路径 | 54 55 56## **枚举类型说明** 57 58 59### AuthType 60 61 62``` 63enum AuthType : int 64``` 65 66**描述：** 67 68枚举用户认证凭据类型。 69 70 | 枚举值 | 描述 | 71| -------- | -------- | 72| PIN | 认证凭据类型为口令。 | 73| FACE | 认证凭据类型为人脸。 | 74| FINGERPRINT | 认证凭据类型为指纹。 | 75 76 77### CommandId 78 79 80``` 81enum CommandId : int 82``` 83 84**描述：** 85 86枚举口令认证相关功能操作命令。 87 88 | 枚举值 | 描述 | 89| -------- | -------- | 90| DEFAULT | 默认无效操作命令。 | 91 92 93### ExecutorRole 94 95 96``` 97enum ExecutorRole : int 98``` 99 100**描述：** 101 102枚举执行器角色。 103 104 | 枚举值 | 描述 | 105| -------- | -------- | 106| COLLECTOR | 执行器角色为采集器，提供用户认证时的数据采集能力，需要和认证器配合完成用户认证。 | 107| VERIFIER | 执行器角色为认证器，提供用户认证时数据处理能力，读取存储凭据模板信息并完成比对。 | 108| ALL_IN_ONE | 执行器角色为全功能执行器，可提供用户认证数据采集、处理、储存及比对能力。 | 109 110 111### ExecutorSecureLevel 112 113 114``` 115enum ExecutorSecureLevel : int 116``` 117 118**描述：** 119 120枚举执行器安全等级。 121 122 | 枚举值 | 描述 | 123| -------- | -------- | 124| ESL0 | 执行器安全级别为0，关键操作在无访问控制执行环境中完成。 | 125| ESL1 | 执行器安全级别为1，关键操作在有访问控制的执行环境中完成。 | 126| ESL2 | 执行器安全级别为2，关键操作在可信执行环境中完成。 | 127| ESL3 | 执行器安全级别为3，关键操作在高安环境如独立安全芯片中完成。 | 128