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