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