1# HdfFaceAuth (V1_0) 2 3 4## 概述 5 6提供人脸认证驱动的标准API接口。 7 8人脸认证驱动为人脸认证服务提供统一的访问接口。获取人脸认证驱动代理后，人脸认证服务可以调用相关接口获取执行器，获取人脸认证执行器后， 人脸认证服务可以调用相关接口获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 9 10**起始版本：** 3.2 11 12 13## 汇总 14 15 16### 文件 17 18| 名称 | 描述 | 19| -------- | -------- | 20| [FaceAuthTypes.idl](_face_auth_types_8idl_v10.md) | 定义人脸认证驱动的枚举类和数据结构。 | 21| [IExecutor.idl](_i_executor_8idl_faceauth_v10.md) | 定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 | 22| [IExecutorCallback.idl](_i_executor_callback_8idl_faceauth_v10.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。 | 23| [IFaceAuthInterface.idl](_i_face_auth_interface_8idl_v10.md) | 定义获取人脸认证驱动的执行器列表接口，用于从人脸认证驱动获取执行器对象列表。 | 24 25 26### 类 27 28| 名称 | 描述 | 29| -------- | -------- | 30| struct [ExecutorInfo](_executor_info_faceauth_v10.md) | 执行器信息。 | 31| struct [TemplateInfo](_template_info_faceauth_v10.md) | 凭据模版信息。 | 32| interface [IExecutor](interface_i_executor_faceauth_v10.md) | 定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 | 33| interface [IExecutorCallback](interface_i_executor_callback_faceauth_v10.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_i_executor_faceauth_v10.md)。 | 34| interface [IFaceAuthInterface](interface_i_face_auth_interface_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 { LOCK_TEMPLATE = 1, UNLOCK_TEMPLATE = 2, VENDOR_COMMAND_BEGIN = 10000 } | 枚举人脸认证功能相关操作命令。 | 45| [FaceTipsCode](#facetipscode) : int { FACE_AUTH_TIP_TOO_BRIGHT = 1, FACE_AUTH_TIP_TOO_DARK = 2, FACE_AUTH_TIP_TOO_CLOSE = 3, FACE_AUTH_TIP_TOO_FAR = 4, FACE_AUTH_TIP_TOO_HIGH = 5, FACE_AUTH_TIP_TOO_LOW = 6, FACE_AUTH_TIP_TOO_RIGHT = 7, FACE_AUTH_TIP_TOO_LEFT = 8, FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, FACE_AUTH_TIP_POOR_GAZE = 10, FACE_AUTH_TIP_NOT_DETECTED = 11, VENDOR_FACE_AUTH_TIP_BEGIN = 10000 } | 枚举提示信息编码。 | 46 47 48## 枚举类型说明 49 50 51### AuthType 52 53``` 54enum AuthType : int 55``` 56 57**描述** 58 59 60枚举用户认证凭据类型。 61 62**起始版本：** 3.2 63 64| 枚举值 | 描述 | 65| -------- | -------- | 66| PIN | 认证凭据类型为口令。 | 67| FACE | 认证凭据类型为人脸。 | 68| FINGERPRINT | 认证凭据类型为指纹。 | 69 70 71### CommandId 72 73``` 74enum CommandId : int 75``` 76 77**描述** 78 79 80枚举人脸认证功能相关操作命令。 81 82**起始版本：** 3.2 83 84| 枚举值 | 描述 | 85| -------- | -------- | 86| LOCK_TEMPLATE | 锁定人脸模版。 | 87| UNLOCK_TEMPLATE | 解锁人脸模版。 | 88| VENDOR_COMMAND_BEGIN | 用于厂商自定义操作指令。 | 89 90 91### ExecutorRole 92 93``` 94enum ExecutorRole : int 95``` 96 97**描述** 98 99 100枚举执行器角色。 101 102**起始版本：** 3.2 103 104| 枚举值 | 描述 | 105| -------- | -------- | 106| COLLECTOR | 执行器角色为采集器，提供用户认证时的数据采集能力，需要和认证器配合完成用户认证。 | 107| VERIFIER | 执行器角色为认证器，提供用户认证时数据处理能力，读取存储凭据模板信息并完成比对。 | 108| ALL_IN_ONE | 执行器角色为全功能执行器，可提供用户认证数据采集、处理、储存及比对能力。 | 109 110 111### ExecutorSecureLevel 112 113``` 114enum ExecutorSecureLevel : int 115``` 116 117**描述** 118 119 120枚举执行器安全等级。 121 122**起始版本：** 3.2 123 124| 枚举值 | 描述 | 125| -------- | -------- | 126| ESL0 | 执行器安全级别为0，关键操作在无访问控制执行环境中完成。 | 127| ESL1 | 执行器安全级别为1，关键操作在有访问控制的执行环境中完成。 | 128| ESL2 | 执行器安全级别为2，关键操作在可信执行环境中完成。 | 129| ESL3 | 执行器安全级别为3，关键操作在高安环境如独立安全芯片中完成。 | 130 131 132### FaceTipsCode 133 134``` 135enum FaceTipsCode : int 136``` 137 138**描述** 139 140 141枚举提示信息编码。 142 143**起始版本：** 3.2 144 145| 枚举值 | 描述 | 146| -------- | -------- | 147| FACE_AUTH_TIP_TOO_BRIGHT | 获取的人脸图像由于光照度高而过亮。 | 148| FACE_AUTH_TIP_TOO_DARK | 获取的人脸图像由于光照度低而过暗。 | 149| FACE_AUTH_TIP_TOO_CLOSE | 人脸离设备过近。 | 150| FACE_AUTH_TIP_TOO_FAR | 人脸离设备过远。 | 151| FACE_AUTH_TIP_TOO_HIGH | 设备过高，只拍到人脸的上半部分。 | 152| FACE_AUTH_TIP_TOO_LOW | 设备过低，只拍到人脸的下半部分。 | 153| FACE_AUTH_TIP_TOO_RIGHT | 设备偏右，只拍到人脸的右侧部分。 | 154| FACE_AUTH_TIP_TOO_LEFT | 设备偏左，只拍到人脸的左侧部分。 | 155| FACE_AUTH_TIP_TOO_MUCH_MOTION | 人脸信息采集过程中，人脸移动过多。 | 156| FACE_AUTH_TIP_POOR_GAZE | 用户未注视设备。 | 157| FACE_AUTH_TIP_NOT_DETECTED | 未检测到人脸。 | 158| VENDOR_FACE_AUTH_TIP_BEGIN | 用于厂商自定义提示信息。 | 159