Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 62e0338f 编写于 作者: Y youliang_1314
浏览文件
操作

update useriam file 

Signed-off-by: Nyouliang_1314 <youliang4@huawei.com>
上级 4024e5c6
显示空白变更内容
内联 并排
Showing with 528 addition and 489 deletion
zh-cn/application-dev/reference/apis/js-apis-useriam-faceauth.md
浏览文件 @ 62e0338f
...@@ -30,7 +30,7 @@ constructor() ...@@ -30,7 +30,7 @@ constructor()
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | -------------------- | | ---------------------- | -------------------- |
| [FaceAuthManager](#faceauthmanager) | 人脸认证管理器对象 | | [FaceAuthManager](#faceauthmanager) | 人脸认证管理器对象。 |
**示例：** **示例：**
...@@ -44,7 +44,7 @@ let faceAuthManager = new userIAM_faceAuth.FaceAuthManager(); ...@@ -44,7 +44,7 @@ let faceAuthManager = new userIAM_faceAuth.FaceAuthManager();
setSurfaceId(surfaceId: string): void; setSurfaceId(surfaceId: string): void;
设置录入流程中人脸预览界面 [XComponent](../arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid) 持有 Surface 的 ID。 该接口仅用于在录入人脸时，设置人脸预览界面 [XComponent](../arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid) 持有 Surface 的 ID，需要配合[人脸录入接口](./js-apis-osAccount.md#addcredential8)来使用。
**系统能力：** SystemCapability.UserIAM.UserAuth.FaceAuth **系统能力：** SystemCapability.UserIAM.UserAuth.FaceAuth
...@@ -71,6 +71,7 @@ setSurfaceId(surfaceId: string): void; ...@@ -71,6 +71,7 @@ setSurfaceId(surfaceId: string): void;
```js ```js
import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; import userIAM_faceAuth from '@ohos.userIAM.faceAuth';
// 该surfaceId应该从XComponent控件获取，此处仅用作示例。
let surfaceId = "123456"; let surfaceId = "123456";
let manager = new userIAM_faceAuth.FaceAuthManager(); let manager = new userIAM_faceAuth.FaceAuthManager();
try { try {
......
zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md
浏览文件 @ 62e0338f
...@@ -18,7 +18,7 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth'; ...@@ -18,7 +18,7 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth';
**系统能力**：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core。 **系统能力**：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core。
| 参数名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------ | ---------- | ---- | -------------------- | | ------------ | ---------- | ---- | -------------------- |
| result | number | 是 | 认证结果。 | | result | number | 是 | 认证结果。 |
| token | Uint8Array | 否 | 用户身份认证通过的凭证。 | | token | Uint8Array | 否 | 用户身份认证通过的凭证。 |
...@@ -31,7 +31,7 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth'; ...@@ -31,7 +31,7 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth';
**系统能力**：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core。 **系统能力**：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core。
| 参数名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------ | ---------- | ---- | -------------------- | | ------------ | ---------- | ---- | -------------------- |
| module | number | 是 | 发送提示信息的模块标识。 | | module | number | 是 | 发送提示信息的模块标识。 |
| tip | number | 是 | 认证过程提示信息。 | | tip | number | 是 | 认证过程提示信息。 |
...@@ -62,7 +62,7 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth'; ...@@ -62,7 +62,7 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth';
### callback<sup>9+</sup> ### callback<sup>9+</sup>
callback: (result : EventInfo) => void callback(result : EventInfo) : void
通过该回调获取认证结果信息或认证过程中的提示信息。 通过该回调获取认证结果信息或认证过程中的提示信息。
...@@ -70,7 +70,7 @@ callback: (result : EventInfo) => void ...@@ -70,7 +70,7 @@ callback: (result : EventInfo) => void
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------- | ---- | ------------------------------ | | --------- | -------------------------- | ---- | ------------------------------ |
| result | [EventInfo](#eventinfo9) | 是 | 返回的认证结果信息或提示信息。 | | result | [EventInfo](#eventinfo9) | 是 | 返回的认证结果信息或提示信息。 |
...@@ -128,7 +128,7 @@ try { ...@@ -128,7 +128,7 @@ try {
### on<sup>9+</sup> ### on<sup>9+</sup>
on(name : AuthEventKey, callback : AuthEvent) : void on : (name : AuthEventKey, callback : AuthEvent) => void
订阅指定类型的用户认证事件。 订阅指定类型的用户认证事件。
...@@ -139,7 +139,7 @@ on(name : AuthEventKey, callback : AuthEvent) : void ...@@ -139,7 +139,7 @@ on(name : AuthEventKey, callback : AuthEvent) : void
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------- | ---- | ------------------------- | | --------- | -------------------------- | ---- | ------------------------- |
| name | [AuthEventKey](#autheventkey9) | 是 | 表示认证事件类型，取值为"result"时，回调函数返回认证结果；取值为"tip"时，回调函数返回认证过程中的提示信息。 | | name | [AuthEventKey](#autheventkey9) | 是 | 表示认证事件类型，取值为"result"时，回调函数返回认证结果；取值为"tip"时，回调函数返回认证过程中的提示信息。 |
| callback | [AuthEvent](#authevent9) | 是 | 认证接口的回调函数，用于返回认证结果或认证过程中的提示信息。 | | callback | [AuthEvent](#authevent9) | 是 | 认证接口的回调函数，用于返回认证结果或认证过程中的提示信息。 |
...@@ -195,7 +195,7 @@ try { ...@@ -195,7 +195,7 @@ try {
### off<sup>9+</sup> ### off<sup>9+</sup>
off(name : AuthEventKey) : void off : (name : AuthEventKey) => void
取消订阅特定类型的认证事件。 取消订阅特定类型的认证事件。
...@@ -204,7 +204,7 @@ off(name : AuthEventKey) : void ...@@ -204,7 +204,7 @@ off(name : AuthEventKey) : void
**系统能力**：SystemCapability.UserIAM.UserAuth.Core **系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 参数名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------- | -------------------------- | ---- | ------------------------- | | --------- | -------------------------- | ---- | ------------------------- |
| name | [AuthEventKey](#autheventkey9) | 是 | 表示认证事件类型，取值为"result"时，取消订阅认证结果；取值为"tip"时，取消订阅认证过程中的提示信息。 | | name | [AuthEventKey](#autheventkey9) | 是 | 表示认证事件类型，取值为"result"时，取消订阅认证结果；取值为"tip"时，取消订阅认证过程中的提示信息。 |
...@@ -258,7 +258,7 @@ try { ...@@ -258,7 +258,7 @@ try {
### start<sup>9+</sup> ### start<sup>9+</sup>
start() : void start : () => void
开始认证。 开始认证。
...@@ -302,7 +302,7 @@ try { ...@@ -302,7 +302,7 @@ try {
### cancel<sup>9+</sup> ### cancel<sup>9+</sup>
cancel(): void cancel : () => void
取消认证。 取消认证。
...@@ -354,7 +354,7 @@ getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel ...@@ -354,7 +354,7 @@ getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | ------------------------ | | -------------- | ---------------------------------------- | ---- | ------------------------ |
| challenge | Uint8Array | 是 | 挑战值，最大长度为32字节，可以填null。 | | challenge | Uint8Array | 是 | 挑战值，最大长度为32字节，可以填null。 |
| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 | | authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 |
...@@ -444,7 +444,7 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): vo ...@@ -444,7 +444,7 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): vo
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------- | ---- | -------------------------- | | -------------- | ---------------------------------- | ---- | -------------------------- |
| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前只支持FACE。 | | authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前只支持FACE。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 |
...@@ -475,13 +475,13 @@ try { ...@@ -475,13 +475,13 @@ try {
} }
``` ```
## ResultCodeV9<sup>9+</sup> ## ResultCodeV9<sup>9+</sup>
表示返回码的枚举。 表示返回码的枚举。
**系统能力**：SystemCapability.UserIAM.UserAuth.Core **系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 名称 | 默认值 | 描述 | | 名称 | 值 | 说明 |
| ----------------------- | ------ | -------------------- | | ----------------------- | ------ | -------------------- |
| SUCCESS | 12500000 | 执行成功。 | | SUCCESS | 12500000 | 执行成功。 |
| FAIL | 12500001 | 执行失败。 | | FAIL | 12500001 | 执行失败。 |
...@@ -570,7 +570,7 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : n ...@@ -570,7 +570,7 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : n
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------- | ---- | -------------------------- | | -------------- | ---------------------------------- | ---- | -------------------------- |
| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前只支持FACE。 | | authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前只支持FACE。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 |
...@@ -611,7 +611,7 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev ...@@ -611,7 +611,7 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | ------------------------ | | -------------- | ---------------------------------------- | ---- | ------------------------ |
| challenge | Uint8Array | 是 | 挑战值，可以填null。 | | challenge | Uint8Array | 是 | 挑战值，可以填null。 |
| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 | | authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 |
...@@ -663,7 +663,7 @@ cancelAuth(contextID : Uint8Array) : number ...@@ -663,7 +663,7 @@ cancelAuth(contextID : Uint8Array) : number
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------- | ---- | ------------------------------------------ | | --------- | ---------- | ---- | ------------------------------------------ |
| contextID | Uint8Array | 是 | 上下文的标识，通过[auth](#authdeprecated)接口获取。 | | contextID | Uint8Array | 是 | 上下文的标识，通过[auth](#authdeprecated)接口获取。 |
...@@ -711,12 +711,11 @@ onResult: (result : number, extraInfo : AuthResult) => void ...@@ -711,12 +711,11 @@ onResult: (result : number, extraInfo : AuthResult) => void
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------- | ---- | ------------------------------------------------ | | --------- | -------------------------- | ---- | ------------------------------------------------ |
| result | number | 是 | 认证结果，参见[ResultCode](#resultcodedeprecated)。 | | result | number | 是 | 认证结果，参见[ResultCode](#resultcodedeprecated)。 |
| extraInfo | [AuthResult](#authresultdeprecated) | 是 | 扩展信息，不同情况下的具体信息，<br/>如果身份验证通过，则在extraInfo中返回用户认证令牌，<br/>如果身份验证失败，则在extraInfo中返回剩余的用户认证次数，<br/>如果身份验证执行器被锁定，则在extraInfo中返回冻结时间。 | | extraInfo | [AuthResult](#authresultdeprecated) | 是 | 扩展信息，不同情况下的具体信息，<br/>如果身份验证通过，则在extraInfo中返回用户认证令牌，<br/>如果身份验证失败，则在extraInfo中返回剩余的用户认证次数，<br/>如果身份验证执行器被锁定，则在extraInfo中返回冻结时间。 |
**示例：** **示例：**
```js ```js
...@@ -754,7 +753,7 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void ...@@ -754,7 +753,7 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------------------------ | | --------- | ------ | ---- | ------------------------------ |
| module | number | 是 | 发送提示信息的模块标识。 | | module | number | 是 | 发送提示信息的模块标识。 |
| acquire | number | 是 | 认证执过程中的提示信息。 | | acquire | number | 是 | 认证执过程中的提示信息。 |
...@@ -789,8 +788,8 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe ...@@ -789,8 +788,8 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe
**系统能力**：SystemCapability.UserIAM.UserAuth.Core **系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------ | ---------- | ---- | -------------------- | | ------------ | ---------- | ---- | -------------------|
| token | Uint8Array | 否 | 认证通过的令牌信息。 | | token | Uint8Array | 否 | 认证通过的令牌信息。 |
| remainTimes | number | 否 | 剩余的认证操作次数。 | | remainTimes | number | 否 | 剩余的认证操作次数。 |
| freezingTime | number | 否 | 认证操作的冻结时间。 | | freezingTime | number | 否 | 认证操作的冻结时间。 |
...@@ -804,7 +803,7 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe ...@@ -804,7 +803,7 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe
**系统能力**：SystemCapability.UserIAM.UserAuth.Core **系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 名称 | 默认值 | 描述 | | 名称 | 值 | 说明 |
| ----------------------- | ------ | -------------------- | | ----------------------- | ------ | -------------------- |
| SUCCESS | 0 | 执行成功。 | | SUCCESS | 0 | 执行成功。 |
| FAIL | 1 | 执行失败。 | | FAIL | 1 | 执行失败。 |
...@@ -823,7 +822,7 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe ...@@ -823,7 +822,7 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe
**系统能力**：SystemCapability.UserIAM.UserAuth.Core **系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 名称 | 默认值 | 描述 | | 名称 | 值 | 说明 |
| ----------------------------- | ------ | ------------------------------------ | | ----------------------------- | ------ | ------------------------------------ |
| FACE_AUTH_TIP_TOO_BRIGHT | 1 | 光线太强，获取的图像太亮。 | | FACE_AUTH_TIP_TOO_BRIGHT | 1 | 光线太强，获取的图像太亮。 |
| FACE_AUTH_TIP_TOO_DARK | 2 | 光线太暗，获取的图像太暗。 | | FACE_AUTH_TIP_TOO_DARK | 2 | 光线太暗，获取的图像太暗。 |
...@@ -844,7 +843,7 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe ...@@ -844,7 +843,7 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe
**系统能力**：SystemCapability.UserIAM.UserAuth.Core **系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 名称 | 默认值 | 描述 | | 名称 | 值 | 说明 |
| --------------------------------- | ------ | -------------------------------------------------- | | --------------------------------- | ------ | -------------------------------------------------- |
| FINGERPRINT_AUTH_TIP_GOOD | 0 | 获取的指纹图像良好。 | | FINGERPRINT_AUTH_TIP_GOOD | 0 | 获取的指纹图像良好。 |
| FINGERPRINT_AUTH_TIP_DIRTY | 1 | 由于传感器上可疑或检测到的污垢，指纹图像噪音过大。 | | FINGERPRINT_AUTH_TIP_DIRTY | 1 | 由于传感器上可疑或检测到的污垢，指纹图像噪音过大。 |
...@@ -860,7 +859,7 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe ...@@ -860,7 +859,7 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe
**系统能力**：SystemCapability.UserIAM.UserAuth.Core **系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 名称 | 默认值 | 描述 | | 名称 | 值 | 说明 |
| ----------- | ------ | ---------- | | ----------- | ------ | ---------- |
| FACE | 2 | 人脸认证。 | | FACE | 2 | 人脸认证。 |
| FINGERPRINT | 4 | 指纹认证。 | | FINGERPRINT | 4 | 指纹认证。 |
...@@ -871,7 +870,7 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe ...@@ -871,7 +870,7 @@ auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLe
**系统能力**：SystemCapability.UserIAM.UserAuth.Core **系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 名称 | 默认值 | 描述 | | 名称 | 值 | 说明 |
| ---- | ------ | ------------------------- | | ---- | ------ | ------------------------- |
| ATL1 | 10000 | 认证结果的信任等级级别1。 | | ATL1 | 10000 | 认证结果的信任等级级别1。 |
| ATL2 | 20000 | 认证结果的信任等级级别2。 | | ATL2 | 20000 | 认证结果的信任等级级别2。 |
...@@ -922,11 +921,11 @@ execute(type: AuthType, level: SecureLevel, callback: AsyncCallback&lt;number&gt ...@@ -922,11 +921,11 @@ execute(type: AuthType, level: SecureLevel, callback: AsyncCallback&lt;number&gt
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------------------- | | -------- | --------------------------- | ---- | -------------------------- |
| type | AuthType | 是 | 认证类型，当前只支持"FACE_ONLY"。<br/>ALL为预留参数，当前版本暂不支持ALL类型的认证。 | | type | AuthType | 是 | 认证类型，当前只支持"FACE_ONLY"。<br/>ALL为预留参数，当前版本暂不支持ALL类型的认证。 |
| level | SecureLevel | 是 | 安全级别，对应认证的安全级别，有效值为"S1"（最低）、"S2"、"S3"、"S4"（最高）。<br/>具备3D人脸识别能力的设备支持"S3"及以下安全级别的认证。<br/>具备2D人脸识别能力的设备支持"S2"及以下安全级别的认证。 | | level | SecureLevel | 是 | 安全级别，对应认证的安全级别，有效值为"S1"（最低）、"S2"、"S3"、"S4"（最高）。<br/>具备3D人脸识别能力的设备支持"S3"及以下安全级别的认证。<br/>具备2D人脸识别能力的设备支持"S2"及以下安全级别的认证。 |
| callback | AsyncCallback&lt;number&gt; | 否 | 回调函数。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。 |
callback返回值： callback返回值：
...@@ -963,7 +962,7 @@ execute(type : AuthType, level : SecureLevel): Promise&lt;number&gt; ...@@ -963,7 +962,7 @@ execute(type : AuthType, level : SecureLevel): Promise&lt;number&gt;
**参数：** **参数：**
| 参数名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| type | AuthType | 是 | 认证类型，当前只支持"FACE_ONLY"。<br/>ALL为预留参数，当前版本暂不支持ALL类型的认证。 | | type | AuthType | 是 | 认证类型，当前只支持"FACE_ONLY"。<br/>ALL为预留参数，当前版本暂不支持ALL类型的认证。 |
| level | SecureLevel | 是 | 安全级别，对应认证的安全级别，有效值为"S1"（最低）、"S2"、"S3"、"S4"（最高）。<br/>具备3D人脸识别能力的设备支持"S3"及以下安全级别的认证。<br/>具备2D人脸识别能力的设备支持"S2"及以下安全级别的认证。 | | level | SecureLevel | 是 | 安全级别，对应认证的安全级别，有效值为"S1"（最低）、"S2"、"S3"、"S4"（最高）。<br/>具备3D人脸识别能力的设备支持"S3"及以下安全级别的认证。<br/>具备2D人脸识别能力的设备支持"S2"及以下安全级别的认证。 |
...@@ -994,7 +993,7 @@ authenticator.execute("FACE_ONLY", "S2").then((code)=>{ ...@@ -994,7 +993,7 @@ authenticator.execute("FACE_ONLY", "S2").then((code)=>{
**系统能力**：SystemCapability.UserIAM.UserAuth.Core **系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 名称 | 默认值 | 描述 | | 名称 | 值 | 说明 |
| ------------------ | ------ | -------------------------- | | ------------------ | ------ | -------------------------- |
| NO_SUPPORT | -1 | 设备不支持当前的认证方式。 | | NO_SUPPORT | -1 | 设备不支持当前的认证方式。 |
| SUCCESS | 0 | 认证成功。 | | SUCCESS | 0 | 认证成功。 |
......
zh-cn/application-dev/reference/errorcodes/errcode-useriam.md
浏览文件 @ 62e0338f
...@@ -2,47 +2,15 @@ ...@@ -2,47 +2,15 @@
## 201 权限验证失败 ## 201 权限验证失败
**错误信息** 具体参见[通用错误码](./errorcode-universal.md)
Permission verification failed.
**可能原因**
该应用没有调用相关接口的权限:
调用userAuth模块的getVersion、getAvailableStatus、start和cancel接口都需要ohos.permission.ACCESS_BIOMETRIC权限。
**处理步骤**
申请权限。在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/stage-structure.md)。
## 202 调用方不是一个系统应用 ## 202 调用方不是一个系统应用
**错误信息** 具体参见[通用错误码](./errorcode-universal.md)
The caller is not a system application.
**可能原因**
faceAuth模块的setSurfaceId当前只允许系统应用进行调用，非系统应用调用则会返回202错误码。
**处理步骤**
应用需要更改签名配置文件中的app-feature字段值为hos_system_app，使其成为系统应用才可以调用setSurfaceId接口。
## 401 参数不正确 ## 401 参数不正确
**错误信息** 具体参见[通用错误码](./errorcode-universal.md)
Incorrect parameters.
**可能原因**
该错误码表示调用接口时传入的参数不正确（包括参数个数和参数的取值）
例如调用userAuth模块的getAvailableStatus接口时，如果只传入1个参数，或者authTrustLevel的取值不在[ATL1, ATL2, ATL3, ATL4]范围，则会返回401错误码。
**处理步骤**
请检查传入的参数个数和参数取值等信息。
## 12500002 一般的操作错误 ## 12500002 一般的操作错误
...@@ -52,11 +20,11 @@ General operation error. ...@@ -52,11 +20,11 @@ General operation error.
**可能原因** **可能原因**
NAPI层解析参数出错。 1. NAPI层解析参数出错。
用户认证服务的进程没有启动。 2. 用户认证服务的进程没有启动。
IPC通信的proxy客户端写数据出错。 3. IPC通信的proxy客户端写数据出错。
IPC通信的stub服务端解析数据出错。 4. IPC通信的stub服务端解析数据出错。
获取driver服务出错。 5. 获取driver服务出错。
**处理步骤** **处理步骤**
...@@ -70,7 +38,8 @@ The authentication type is not supported. ...@@ -70,7 +38,8 @@ The authentication type is not supported.
**可能原因** **可能原因**
传入的认证类型参数不支持，例如调用userAuth模块的getAvailableStatus接口时传入的参数不是FACE或FINGERPRINT类型，则会返回12500005错误码。 1. 传入的认证类型参数不支持，例如调用userAuth模块的getAvailableStatus接口时传入的参数不是FACE或FINGERPRINT类型，则会返回12500005错误码。
2. 传入的认证类型参数在本设备上不支持，例如在没有部署指纹传感器的设备上发起指纹认证，则会返回12500005错误码。
**处理步骤** **处理步骤**
...@@ -84,8 +53,8 @@ The authentication trust level is not supported. ...@@ -84,8 +53,8 @@ The authentication trust level is not supported.
**可能原因** **可能原因**
调用userAuth模块的getAvailableStatus或getAuthInstance接口时，传入的authTrustLevel参数不在[ATL1, ATL2, ATL3, ATL4]范围内。 1. 调用userAuth模块的getAvailableStatus或getAuthInstance接口时，传入的authTrustLevel参数不在[ATL1, ATL2, ATL3, ATL4]范围内。
当前的设备的确不支持该认证信任等级。 2. 当前的设备不支持该认证信任等级，例如在只部署了2D摄像头的设备上发起支付级别的人脸认证，则会返回12500006错误码。
**处理步骤** **处理步骤**
...@@ -114,11 +83,11 @@ The operation is failed. ...@@ -114,11 +83,11 @@ The operation is failed.
**可能原因** **可能原因**
例如调用faceAuth模块的setSurfaceId接口时，人脸认证服务未启动，则会返回12700001错误码。 1. 例如调用faceAuth模块的setSurfaceId接口时，人脸认证服务未启动，则会返回12700001错误码。
IPC通信的proxy客户端写数据出错。 2. IPC通信的proxy客户端写数据出错。
IPC通信的stub服务端解析数据出错。 3. IPC通信的stub服务端解析数据出错。
人脸driver层调用出错。 4. 人脸driver层调用出错。
**处理步骤** **处理步骤**
一般主要检查人脸认证服务的进程是否启动。 主要检查人脸认证服务的进程是否启动。
zh-cn/application-dev/security/userauth-guidelines.md
浏览文件 @ 62e0338f
# 用户认证开发指导 # 用户认证开发指导
> **说明：** > **说明：**
> 该开发指导需配合API Version 8或以上版本的SDK使用。 > 该开发指导需配合API version 9版本的SDK使用。
## 场景介绍 ## 场景介绍
...@@ -19,6 +19,9 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ...@@ -19,6 +19,9 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
| ---------- | ----------------------- | | ---------- | ----------------------- |
| getVersion() : number | 获取认证对象的版本信息。 | | getVersion() : number | 获取认证对象的版本信息。 |
| getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void | 根据指定的认证类型、认证等级，检测当前设备是否支持相应的认证能力。 | | getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void | 根据指定的认证类型、认证等级，检测当前设备是否支持相应的认证能力。 |
| getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel : AuthTrustLevel): AuthInstance | 获取AuthInstance对象，用于执行用户身份认证。 |
| on(name : AuthEventKey, callback : AuthEvent) : void | 订阅指定类型的用户认证事件。 |
| off(name : AuthEventKey) : void | 取消订阅特定类型的认证事件。 |
| start: void | 执行用户认证。 | | start: void | 执行用户认证。 |
| cancel: void | 取消本次认证操作。 | | cancel: void | 取消本次认证操作。 |
...@@ -26,70 +29,74 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ...@@ -26,70 +29,74 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
### 开发步骤 ### 开发步骤
1. 申请权限。调用getVersion接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/stage-structure.md)。 1. 申请权限。调用[getVersion](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetversion9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](../quick-start/stage-structure.md)。
2. 调用getVersion接口获取版本信息。 2. 调用[getVersion](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetversion9)接口获取版本信息。
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
try { // 获取版本信息
try {
let version = userIAM_userAuth.getVersion(); let version = userIAM_userAuth.getVersion();
console.info("auth version = " + version); console.info("auth version = " + version);
} catch (error) { } catch (error) {
console.info("get version failed, error = " + error); console.info("get version failed, error = " + error);
} }
``` ```
## 查询当前设备是否支持相应的认证能力 ## 查询当前设备是否支持相应的认证能力
### 开发步骤 ### 开发步骤
1. 申请权限。调用getAvailableStatus接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/stage-structure.md)。 1. 申请权限。调用[getAvailableStatus](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetavailablestatus9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](../quick-start/stage-structure.md)。
2. 指定[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，调用getAvailableStatus接口查询当前的设备是否支持相应的认证能力。 2. 指定[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，调用[getAvailableStatus](../reference/apis/js-apis-useriam-userauth.md#useriam_userauthgetavailablestatus9)接口查询当前的设备是否支持相应的认证能力。
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
try { // 查询认证能力是否支持
try {
userIAM_userAuth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1); userIAM_userAuth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
console.info("current auth trust level is supported"); console.info("current auth trust level is supported");
} catch (error) { } catch (error) {
console.info("current auth trust level is not supported, error = " + error); console.info("current auth trust level is not supported, error = " + error);
} }
``` ```
## 执行认证操作并请阅认证结果 ## 执行认证操作并请阅认证结果
### 开发步骤 ### 开发步骤
1. 申请权限。调用auth接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/stage-structure.md)。 1. 申请权限。调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](../quick-start/stage-structure.md)。
2. 指定challenge、[认证类型](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。 2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。
3. 调用on接口订阅认证结果。 3. 调用[on](../reference/apis/js-apis-useriam-userauth.md#on9)接口订阅认证结果。
4. 调用start接口发起认证，通过callback回调返回认证结果。 4. 调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口发起认证，通过[callback](../reference/apis/js-apis-useriam-userauth.md#callback9)回调返回认证结果。
5. 调用off接口取消订阅认证结果。 5. 调用[off](../reference/apis/js-apis-useriam-userauth.md#off9)接口取消订阅认证结果。
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE; let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
let auth;
try { // 获取认证对象
let auth;
try {
auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.log("get auth instance success"); console.log("get auth instance success");
} catch (error) { } catch (error) {
console.log("get auth instance failed" + error); console.log("get auth instance failed" + error);
} }
try {
// 订阅认证结果 // 订阅认证结果
try {
auth.on("result", { auth.on("result", {
callback: (result: userIAM_userAuth.AuthResultInfo) => { callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.log("authV9 result " + result.result); console.log("authV9 result " + result.result);
...@@ -99,56 +106,59 @@ try { ...@@ -99,56 +106,59 @@ try {
} }
}); });
console.log("subscribe authentication event success"); console.log("subscribe authentication event success");
} catch (error) { } catch (error) {
console.log("subscribe authentication event failed " + error); console.log("subscribe authentication event failed " + error);
} }
try { // 开始认证
try {
auth.start(); auth.start();
console.info("authV9 start auth success"); console.info("authV9 start auth success");
} catch (error) { } catch (error) {
console.info("authV9 start auth failed, error = " + error); console.info("authV9 start auth failed, error = " + error);
} }
// 取消订阅认证结果 // 取消订阅认证结果
try { try {
auth.off("result"); auth.off("result");
console.info("cancel subscribe authentication event success"); console.info("cancel subscribe authentication event success");
} catch (error) { } catch (error) {
console.info("cancel subscribe authentication event failed, error = " + error); console.info("cancel subscribe authentication event failed, error = " + error);
} }
``` ```
## 执行认证操作并订阅认证过程中的提示信息 ## 执行认证操作并订阅认证过程中的提示信息
### 开发步骤 ### 开发步骤
1. 申请权限。调用auth接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/stage-structure.md)。 1. 申请权限。调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](../quick-start/stage-structure.md)。
2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。
2. 指定challenge、[认证类型](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。 3. 调用[on](../reference/apis/js-apis-useriam-userauth.md#on9)接口订阅认证过程中的提示信息。
3. 调用on接口订阅认证过程中的提示信息。 4. 调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口发起认证，通过[callback](../reference/apis/js-apis-useriam-userauth.md#callback9)回调返回认证过程中的提示信息。
4. 调用start接口发起认证，通过callback回调返回认证过程中的提示信息。 5. 调用[off](../reference/apis/js-apis-useriam-userauth.md#off9)接口取消订阅认证过程中的提示信息。
5. 调用off接口取消订阅认证过程中的提示信息。 ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
```js let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
import userIAM_userAuth from '@ohos.userIAM.userAuth'; let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); // 获取认证对象
let authType = userIAM_userAuth.UserAuthType.FACE; let auth;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; try {
let auth;
try {
auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.log("get auth instance success"); console.log("get auth instance success");
} catch (error) { } catch (error) {
console.log("get auth instance failed" + error); console.log("get auth instance failed" + error);
} }
try {
// 订阅认证过程中的提示信息 // 订阅认证过程中的提示信息
try {
auth.on("tip", { auth.on("tip", {
callback : (result : userIAM_userAuth.TipInfo) => { callback : (result : userIAM_userAuth.TipInfo) => {
switch (result.tip) { switch (result.tip) {
...@@ -162,63 +172,68 @@ try { ...@@ -162,63 +172,68 @@ try {
} }
}); });
console.log("subscribe authentication event success"); console.log("subscribe authentication event success");
} catch (error) { } catch (error) {
console.log("subscribe authentication event failed " + error); console.log("subscribe authentication event failed " + error);
} }
try { // 开始认证
try {
auth.start(); auth.start();
console.info("authV9 start auth success"); console.info("authV9 start auth success");
} catch (error) { } catch (error) {
console.info("authV9 start auth failed, error = " + error); console.info("authV9 start auth failed, error = " + error);
} }
// 取消订阅认证结果 // 取消订阅认证过程中的提示信息
try { try {
auth.off("tip"); auth.off("tip");
console.info("cancel subscribe tip information success"); console.info("cancel subscribe tip information success");
} catch (error) { } catch (error) {
console.info("cancel subscribe tip information failed, error = " + error); console.info("cancel subscribe tip information failed, error = " + error);
} }
``` ```
## 认证过程中取消认证 ## 认证过程中取消认证
### 开发步骤 ### 开发步骤
1. 申请权限。调用cancelAuth接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/stage-structure.md)。 1. 申请权限。调用[cancel](../reference/apis/js-apis-useriam-userauth.md#cancel9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息[应用包结构配置文件的说明](../quick-start/stage-structure.md)。
2. 指定challenge、[认证类型](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。 2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。
3. 调用start接口发起认证。 3. 调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口发起认证。
4. 通过调用cancel接口取消本次认证。 4. 通过调用[cancel](../reference/apis/js-apis-useriam-userauth.md#cancel9)接口取消本次认证。
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE; let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
let auth;
try { // 获取认证对象
let auth;
try {
auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.log("get auth instance success"); console.log("get auth instance success");
} catch (error) { } catch (error) {
console.log("get auth instance failed" + error); console.log("get auth instance failed" + error);
} }
try { // 开始认证
try {
auth.start(); auth.start();
console.info("authV9 start auth success"); console.info("authV9 start auth success");
} catch (error) { } catch (error) {
console.info("authV9 start auth failed, error = " + error); console.info("authV9 start auth failed, error = " + error);
} }
try { // 取消认证
try {
auth.cancel(); auth.cancel();
console.info("cancel auth success"); console.info("cancel auth success");
} catch (error) { } catch (error) {
console.info("cancel auth failed, error = " + error); console.info("cancel auth failed, error = " + error);
} }
``` ```
zh-cn/application-dev/security/userauth-overview.md
浏览文件 @ 62e0338f
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
- 人脸识别：基于人的脸部特征信息进行身份识别的一种生物特征识别技术，用摄像机或摄像头采集含有人脸的图像或视频流，并自动在图像中检测和跟踪人脸，进而对检测到的人脸进行脸部识别，通常也叫做人像识别、面部识别、人脸认证。 - 人脸识别：基于人的脸部特征信息进行身份识别的一种生物特征识别技术，用摄像机或摄像头采集含有人脸的图像或视频流，并自动在图像中检测和跟踪人脸，进而对检测到的人脸进行脸部识别，通常也叫做人像识别、面部识别、人脸认证。
- 指纹识别：基于人的指尖皮肤纹路进行身份识别的一种生物识别技术。当用户触摸指纹采集器件时，器件感知并获取到用户的指纹图像，然后传输到指纹识别模块进行一定的处理后与用户预先注册的指纹信息进行比对，从而识别出用户身份。 - 指纹识别：基于人的指尖皮肤纹路进行身份识别的一种生物特征识别技术。当用户触摸指纹采集器件时，器件感知并获取到用户的指纹图像，然后传输到指纹识别模块进行一定的处理后与用户预先注册的指纹信息进行比对，从而识别出用户身份。
## 运作机制 ## 运作机制
......
zh-cn/device-dev/driver/driver-peripherals-face_auth-des.md
浏览文件 @ 62e0338f
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
人脸识别功能是端侧设备不可或缺的一部分，为设备提供一种用户认证能力，可应用于设备解锁、支付、应用登录等身份认证场景。它是基于人的脸部特征信息进行身份识别的一种生物特征识别技术，用摄像机或摄像头采集含有人脸的图像或视频流，并自动在图像中检测和跟踪人脸，进而对检测到的人脸进行脸部识别，通常也叫做人像识别、面部识别、人脸认证。人脸识别功能整体框架如图1。 人脸识别功能是端侧设备不可或缺的一部分，为设备提供一种用户认证能力，可应用于设备解锁、支付、应用登录等身份认证场景。它是基于人的脸部特征信息进行身份识别的一种生物特征识别技术，用摄像机或摄像头采集含有人脸的图像或视频流，并自动在图像中检测和跟踪人脸，进而对检测到的人脸进行脸部识别，通常也叫做人像识别、面部识别、人脸认证。人脸识别功能整体框架如图1。
基于HDF（Hardware Driver Foundation）驱动框架开发的Face_auth驱动，能够屏蔽硬件器件差异，为上层用户认证框架和Face_auth服务提供稳定的人脸识别基础能力接口，包括人脸识别执行器列表查询、执行器信息查询、指定人脸模板ID查询模板信息、用户认证框架和执行器间的人脸模板信息对账、人脸的录入，删除，认证和识别等。 基于HDF（Hardware Driver Foundation）驱动框架开发的Face_auth驱动，能够屏蔽硬件器件差异，为上层用户认证框架和Face_auth服务提供稳定的人脸识别基础能力接口，包括人脸识别执行器列表查询、执行器信息查询、指定人脸模板ID查询模板信息、用户认证框架和执行器间的人脸模板信息对账、人脸录入、删除、认证和识别等。
**图1** 人脸识别功能整体框架 **图1** 人脸识别功能整体框架
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
- 执行器安全等级 - 执行器安全等级
执行器提供能力时运行环境所达到的安全级别。 执行器提供能力时所在运行环境达到的安全级别。
- 执行器角色 - 执行器角色
...@@ -51,6 +51,22 @@ ...@@ -51,6 +51,22 @@
用户认证框架统一管理用户身份和凭据ID的映射关系，执行器对接到用户认证框架时，会读取用户身份认证框架内保存的该执行器的模板ID列表，执行器需要与自己维护的模板ID列表进行比对，并删除冗余信息。 用户认证框架统一管理用户身份和凭据ID的映射关系，执行器对接到用户认证框架时，会读取用户身份认证框架内保存的该执行器的模板ID列表，执行器需要与自己维护的模板ID列表进行比对，并删除冗余信息。
- HAPs
HAPs（OpenHarmony Ability Packages），广义上指可以安装在OpenHarmony上的应用包，本章节中仅代表Face_auth驱动的上层应用。
- IDL接口
接口定义语言（Interface Definition Language）通过IDL编译器编译后，能够生成与编程语言相关的文件：客户端桩文件，服务器框架文件。本文主要是通过IDL接口生成的客户端和服务端来实现Face_auth服务和驱动的通信，详细使用方法可参考[IDL简介](https://gitee.com/openharmony/ability_idl_tool/blob/master/README.md)。
- IPC通信
IPC（Inter Process Communication），进程间通信是指两个进程的数据之间产生交互，详细原理可参考[IPC通信简介](https://gitee.com/openharmony/communication_ipc/blob/master/README_zh.md)。
- HDI
HDI（Hardware Device Interface），硬件设备接口，位于基础系统服务层和设备驱动层之间，是提供给硬件系统服务开发者使用的、统一的硬件设备功能抽象接口，其目的是为系统服务屏蔽底层硬件设备差异，具体可参考[HDI规范](../../design/hdi-design-specifications.md)。
### 运作机制 ### 运作机制
Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务提供稳定的人脸识别基础能力，保证设备上人脸识别功能可以正常运行。 Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务提供稳定的人脸识别基础能力，保证设备上人脸识别功能可以正常运行。
...@@ -74,10 +90,14 @@ Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务 ...@@ -74,10 +90,14 @@ Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务
### 接口说明 ### 接口说明
注：以下接口列举的为IDL接口描述生成的对应C++语言函数接口，接口声明见idl文件（/drivers/interface/face_auth/v1_0/）。
在本文中，人脸凭据的录入、认证、识别和删除相关的HDI接口如表1所示，表2中的回调函数分别用于人脸执行器返回操作结果给框架和返回操作过程中的提示信息给上层应用。
**表1** 接口功能介绍 **表1** 接口功能介绍
| 接口名 | 功能介绍 | | 接口名称 | 功能介绍 |
| ------------------------------------------------------------ | ------------------------------------------------------------ | | ----------------------------------- | ---------------------------------- |
| GetExecutorList(std::vector<sptr<IExecutor>>& executorList) | 获取执行器列表。 | | GetExecutorList(std::vector<sptr<IExecutor>>& executorList) | 获取执行器列表。 |
| GetExecutorInfo(ExecutorInfo& info) | 获取执行器信息，包括执行器类型、执行器角色、认证类型、安全等级、执行器公钥等信息，用于向用户认证框架注册执行器。 | | GetExecutorInfo(ExecutorInfo& info) | 获取执行器信息，包括执行器类型、执行器角色、认证类型、安全等级、执行器公钥等信息，用于向用户认证框架注册执行器。 |
| GetTemplateInfo(uint64_t templateId, TemplateInfo& info) | 获取指定人脸模板ID的模板信息。 | | GetTemplateInfo(uint64_t templateId, TemplateInfo& info) | 获取指定人脸模板ID的模板信息。 |
...@@ -91,7 +111,7 @@ Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务 ...@@ -91,7 +111,7 @@ Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务
**表2** 回调函数介绍 **表2** 回调函数介绍
| 接口名 | 功能介绍 | | 接口名称 | 功能介绍 |
| ------------------------------------------------------------ | ------------------------ | | ------------------------------------------------------------ | ------------------------ |
| IExecutorCallback::OnResult(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的最终结果。 | | IExecutorCallback::OnResult(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的最终结果。 |
| IExecutorCallback::OnTip(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的过程交互信息。 | | IExecutorCallback::OnTip(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的过程交互信息。 |
...@@ -107,7 +127,7 @@ Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务 ...@@ -107,7 +127,7 @@ Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务
└── hdi_service # Face_auth驱动实现 └── hdi_service # Face_auth驱动实现
├── BUILD.gn # 编译脚本 ├── BUILD.gn # 编译脚本
├── include # 头文件 ├── include # 头文件
└── src └── src # 源文件
├── executor_impl.cpp # 认证、录入等功能接口实现 ├── executor_impl.cpp # 认证、录入等功能接口实现
├── face_auth_interface_driver.cpp # Face_auth驱动入口 ├── face_auth_interface_driver.cpp # Face_auth驱动入口
└── face_auth_interface_service.cpp # 获取执行器列表接口实现 └── face_auth_interface_service.cpp # 获取执行器列表接口实现
...@@ -423,66 +443,59 @@ Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务 ...@@ -423,66 +443,59 @@ Face_auth驱动的主要工作是为上层用户认证框架和Face_auth服务
驱动开发完成后，通过[用户认证API接口](../../application-dev/reference/apis/js-apis-useriam-userauth.md)开发JS应用，基于Hi3516DV300平台验证。认证和取消功能验证的JS测试代码如下： 驱动开发完成后，通过[用户认证API接口](../../application-dev/reference/apis/js-apis-useriam-userauth.md)开发JS应用，基于Hi3516DV300平台验证。认证和取消功能验证的JS测试代码如下：
```js ```js
// API version 8 // API version 9
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();
let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
export default { let authType = userIAM_userAuth.UserAuthType.FACE;
getVersion() { let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
console.info("start get version");
let version = this.auth.getVersion(); // 获取认证对象
console.info("auth version = " + version); let auth;
},
startAuth() {
console.info("start auth");
this.auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
try { try {
console.info("auth onResult result = " + result); auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo)); console.log("get auth instance success");
if (result == userIAM_userAuth.ResultCode.SUCCESS) { } catch (error) {
// 此处添加认证成功逻辑 console.log("get auth instance failed" + error);
} else {
// 此处添加认证失败逻辑
}
} catch (e) {
console.info("auth onResult error = " + e);
} }
},
onAcquireInfo: (module, acquire, extraInfo) => { // 订阅认证结果
try { try {
console.info("auth onAcquireInfo module = " + module); auth.on("result", {
console.info("auth onAcquireInfo acquire = " + acquire); callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.info("auth onAcquireInfo extraInfo = " + JSON.stringify(extraInfo)); console.log("authV9 result " + result.result);
} catch (e) { console.log("authV9 token " + result.token);
console.info("auth onAcquireInfo error = " + e); console.log("authV9 remainAttempts " + result.remainAttempts);
} console.log("authV9 lockoutDuration " + result.lockoutDuration);
} }
}); });
}, console.log("subscribe authentication event success");
} catch (error) {
cancelAuth() { console.log("subscribe authentication event failed " + error);
console.info("start cancel auth"); }
// contextId通过auth接口获取
let contextId = auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
console.info("auth onResult result = " + result);
},
onAcquireInfo: (module, acquire, extraInfo) => { // 开始认证
console.info("auth onAcquireInfo module = " + module); try {
auth.start();
console.info("authV9 start auth success");
} catch (error) {
console.info("authV9 start auth failed, error = " + error);
} }
});
let cancelCode = this.auth.cancel(contextId); // 取消认证
if (cancelCode == userIAM_userAuth.ResultCode.SUCCESS) { try {
auth.cancel();
console.info("cancel auth success"); console.info("cancel auth success");
} else { } catch (error) {
console.error("cancel auth fail"); console.info("cancel auth failed, error = " + error);
}
} }
}
```
// 取消订阅认证结果
try {
auth.off("result");
console.info("cancel subscribe authentication event success");
} catch (error) {
console.info("cancel subscribe authentication event failed, error = " + error);
}
```
zh-cn/device-dev/driver/driver-peripherals-fingerprint_auth-des.md
浏览文件 @ 62e0338f
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
- 执行器安全等级 - 执行器安全等级
执行器提供能力时运行环境所达到的安全级别。 执行器提供能力时所在运行环境达到的安全级别。
- 执行器角色 - 执行器角色
...@@ -53,15 +53,19 @@ ...@@ -53,15 +53,19 @@
- HAPs - HAPs
HAPs（OpenHarmony Ability Packages），本章节中仅代表Fingerprint_auth驱动的上层应用。 HAPs（OpenHarmony Ability Packages），广义上指可以安装在OpenHarmony上的应用包，本章节中仅代表Fingerprint_auth驱动的上层应用。
- IDL接口 - IDL接口
接口定义语言（Interface Definition Language）通过IDL编译器编译后，能够生成与编程语言相关的文件：客户端桩文件，服务器框架文件。本文主要是通过IDL接口实现Fingerprint_auth服务和驱动的通信。 接口定义语言（Interface Definition Language）通过IDL编译器编译后，能够生成与编程语言相关的文件：客户端桩文件，服务器框架文件。本文主要是通过IDL接口生成的客户端和服务端来实现Fingerprint_auth服务和驱动的通信，详细使用方法可参考[IDL简介](https://gitee.com/openharmony/ability_idl_tool/blob/master/README.md)。
- IPC通信 - IPC通信
IPC（Inter Process Communication），进程间通信是指两个进程的数据之间产生交互。 IPC（Inter Process Communication），进程间通信是指两个进程的数据之间产生交互，详细原理可参考[IPC通信简介](https://gitee.com/openharmony/communication_ipc/blob/master/README_zh.md)。
- HDI
HDI（Hardware Device Interface），硬件设备接口，位于基础系统服务层和设备驱动层之间，是提供给硬件系统服务开发者使用的、统一的硬件设备功能抽象接口，其目的是为系统服务屏蔽底层硬件设备差异，具体可参考[HDI规范](../../design/hdi-design-specifications.md)。
### 运作机制 ### 运作机制
...@@ -84,10 +88,13 @@ Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprin ...@@ -84,10 +88,13 @@ Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprin
### 接口说明 ### 接口说明
注：以下接口列举的为IDL接口描述生成的对应C++语言函数接口，接口声明见idl文件（/drivers/interface/fingerprint_auth/v1_0/）。
在本文中，指纹凭据的录入、认证、识别和删除相关的HDI接口如表1所示，表2中的回调函数分别用于指纹执行器返回操作结果给框架和返回操作过程中的提示信息给上层应用。
**表1** 接口功能介绍 **表1** 接口功能介绍
| 接口名 | 功能介绍 | | 接口名称 | 功能介绍 |
| ------------------------------------------------------------ | ------------------------------------------------------------ | | -------------------------------- | ----------------------------------- |
| GetExecutorList(std::vector<sptr<IExecutor>>& executorList) | 获取执行器列表。 | | GetExecutorList(std::vector<sptr<IExecutor>>& executorList) | 获取执行器列表。 |
| GetExecutorInfo(ExecutorInfo& info) | 获取执行器信息，包括执行器类型、执行器角色、认证类型、安全等级、执行器公钥等信息，用于向用户认证框架注册执行器。 | | GetExecutorInfo(ExecutorInfo& info) | 获取执行器信息，包括执行器类型、执行器角色、认证类型、安全等级、执行器公钥等信息，用于向用户认证框架注册执行器。 |
| GetTemplateInfo(uint64_t templateId, TemplateInfo& info) | 获取指定模板ID的模板信息。 | | GetTemplateInfo(uint64_t templateId, TemplateInfo& info) | 获取指定模板ID的模板信息。 |
...@@ -101,7 +108,7 @@ Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprin ...@@ -101,7 +108,7 @@ Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprin
**表2** 回调函数介绍 **表2** 回调函数介绍
| 接口名 | 功能介绍 | | 接口名称 | 功能介绍 |
| ------------------------------------------------------------ | ------------------------ | | ------------------------------------------------------------ | ------------------------ |
| IExecutorCallback::OnResult(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的最终结果。 | | IExecutorCallback::OnResult(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的最终结果。 |
| IExecutorCallback::OnTip(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的过程交互信息。 | | IExecutorCallback::OnTip(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的过程交互信息。 |
...@@ -117,7 +124,7 @@ Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprin ...@@ -117,7 +124,7 @@ Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprin
└── hdi_service # Fingerprint_auth驱动实现 └── hdi_service # Fingerprint_auth驱动实现
├── BUILD.gn # 编译脚本 ├── BUILD.gn # 编译脚本
├── include # 头文件 ├── include # 头文件
└── src └── src # 源文件
├── executor_impl.cpp # 认证、录入等功能接口实现 ├── executor_impl.cpp # 认证、录入等功能接口实现
├── fingerprint_auth_interface_driver.cpp # Fingerprint_auth驱动入口 ├── fingerprint_auth_interface_driver.cpp # Fingerprint_auth驱动入口
└── fingerprint_auth_interface_service.cpp # 获取执行器列表接口实现 └── fingerprint_auth_interface_service.cpp # 获取执行器列表接口实现
...@@ -433,47 +440,59 @@ Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprin ...@@ -433,47 +440,59 @@ Fingerprint_auth驱动的主要工作是为上层用户认证框架和Fingerprin
驱动开发完成后，开发者可以通过[用户认证API接口](../../application-dev/reference/apis/js-apis-useriam-userauth.md)开发JS应用，JS应用通过Fingerprint_auth服务调用Fingerprint_auth驱动，从而验证驱动开发是否符合预期。基于Hi3516DV300平台验证，认证功能验证的JS测试代码如下： 驱动开发完成后，开发者可以通过[用户认证API接口](../../application-dev/reference/apis/js-apis-useriam-userauth.md)开发JS应用，JS应用通过Fingerprint_auth服务调用Fingerprint_auth驱动，从而验证驱动开发是否符合预期。基于Hi3516DV300平台验证，认证功能验证的JS测试代码如下：
```js ```js
// API version 8 // API version 9
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();
let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
export default { let authType = userIAM_userAuth.UserAuthType.FINGERPRINT;
getVersion() { let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
console.info("start get version");
let version = this.auth.getVersion(); // 获取认证对象
console.info("auth version = " + version); let auth;
},
startAuth() {
console.info("start auth");
// auth是开发者可以调用的API接口，开发者可以指定认证类型为FINGERPRINT，从而验证驱动是否向框架注册成功以及认证接口实现是否符合预期，result即为认证结果。
this.auth.auth(null, userIAM_userAuth.UserAuthType.FINGERPRINT, userIAM_userAuth.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
try { try {
console.info("auth onResult result = " + result); auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo)); console.log("get auth instance success");
if (result == userIAM_userAuth.ResultCode.SUCCESS) { } catch (error) {
// 此处添加认证成功逻辑 console.log("get auth instance failed" + error);
} else {
// 此处添加认证失败逻辑
} }
} catch (e) {
console.info("auth onResult error = " + e);
}
},
onAcquireInfo: (module, acquire, extraInfo) => { // 订阅认证结果
try { try {
console.info("auth onAcquireInfo module = " + module); auth.on("result", {
console.info("auth onAcquireInfo acquire = " + acquire); callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.info("auth onAcquireInfo extraInfo = " + JSON.stringify(extraInfo)); console.log("authV9 result " + result.result);
} catch (e) { console.log("authV9 token " + result.token);
console.info("auth onAcquireInfo error = " + e); console.log("authV9 remainAttempts " + result.remainAttempts);
} console.log("authV9 lockoutDuration " + result.lockoutDuration);
} }
}); });
console.log("subscribe authentication event success");
} catch (error) {
console.log("subscribe authentication event failed " + error);
} }
}
```
// 开始认证
try {
auth.start();
console.info("authV9 start auth success");
} catch (error) {
console.info("authV9 start auth failed, error = " + error);
}
// 取消认证
try {
auth.cancel();
console.info("cancel auth success");
} catch (error) {
console.info("cancel auth failed, error = " + error);
}
// 取消订阅认证结果
try {
auth.off("result");
console.info("cancel subscribe authentication event success");
} catch (error) {
console.info("cancel subscribe authentication event failed, error = " + error);
}
```
zh-cn/device-dev/driver/driver-peripherals-pinauth-des.md
浏览文件 @ 62e0338f
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
- 执行器安全等级 - 执行器安全等级
执行器提供能力时运行环境所达到的安全级别。 执行器提供能力时所在运行环境达到的安全级别。
- 执行器角色 - 执行器角色
...@@ -52,6 +52,18 @@ ...@@ -52,6 +52,18 @@
用户认证框架统一管理用户身份和凭据ID的映射关系，执行器对接到用户认证框架时，会读取用户身份认证框架内保存的该执行器的模板ID列表，执行器需要与自己维护的模板ID列表进行比对，并删除冗余信息。 用户认证框架统一管理用户身份和凭据ID的映射关系，执行器对接到用户认证框架时，会读取用户身份认证框架内保存的该执行器的模板ID列表，执行器需要与自己维护的模板ID列表进行比对，并删除冗余信息。
- IDL接口
接口定义语言（Interface Definition Language）通过IDL编译器编译后，能够生成与编程语言相关的文件：客户端桩文件，服务器框架文件。本文主要是通过IDL接口生成的客户端和服务端来实现Pin_auth服务和驱动的通信，详细使用方法可参考[IDL简介](https://gitee.com/openharmony/ability_idl_tool/blob/master/README.md)。
- IPC通信
IPC（Inter Process Communication），进程间通信是指两个进程的数据之间产生交互，详细原理可参考[IPC通信简介](https://gitee.com/openharmony/communication_ipc/blob/master/README_zh.md)。
- HDI
HDI（Hardware Device Interface），硬件设备接口，位于基础系统服务层和设备驱动层之间，是提供给硬件系统服务开发者使用的、统一的硬件设备功能抽象接口，其目的是为系统服务屏蔽底层硬件设备差异，具体可参考[HDI规范](../../design/hdi-design-specifications.md)。
### 运作机制 ### 运作机制
Pin_auth驱动的主要工作是为上层用户认证框架和Pin_auth服务提供稳定的口令认证的基础能力，保证口令认证的功能可以正常运行。开发者可基于HDF框架对不同芯片进行各自驱动的开发以及HDI层接口的调用。 Pin_auth驱动的主要工作是为上层用户认证框架和Pin_auth服务提供稳定的口令认证的基础能力，保证口令认证的功能可以正常运行。开发者可基于HDF框架对不同芯片进行各自驱动的开发以及HDI层接口的调用。
...@@ -69,15 +81,18 @@ Pin_auth驱动的主要工作是为上层用户认证框架和Pin_auth服务提 ...@@ -69,15 +81,18 @@ Pin_auth驱动的主要工作是为上层用户认证框架和Pin_auth服务提
### 接口说明 ### 接口说明
注：以下接口列举的为IDL接口描述生成的对应C++语言函数接口，接口声明见idl文件（/drivers/interface/pin_auth/v1_0/）。
在本文中，口令凭据的录入、认证和删除相关的HDI接口如表1所示，表2中的回调函数分别用于口令执行器返回操作结果给框架和获取用户输入的口令信息。
**表1** 接口功能介绍 **表1** 接口功能介绍
| 接口名 | 功能介绍 | | 接口名称 | 功能介绍 |
| ------------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------- | ------------------------------------------- |
| GetExecutorList(std::vector<sptr<IExecutor>>& executorList) | 获取执行器列表。 | | GetExecutorList(std::vector<sptr<IExecutor>>& executorList) | 获取执行器列表。 |
| GetExecutorInfo(ExecutorInfo& info) | 获取执行器信息。 | | GetExecutorInfo(ExecutorInfo& info) | 获取执行器信息。 |
| GetTemplateInfo(uint64_t templateId, TemplateInfo& info) | 获取指定templateId的模板信息。 | | GetTemplateInfo(uint64_t templateId, TemplateInfo& info) | 获取指定templateId的模板信息。 |
| OnRegisterFinish(const std::vector<uint64_t>& templateIdList,<br/>const std::vector<uint8_t>& frameworkPublicKey,<br/>const std::vector<uint8_t>& extraInfo) | 执行器注册成功后，获取用户认证框架的公钥信息；获取用户认证框架的template 列表用于对账。 | | OnRegisterFinish(const std::vector<uint64_t>& templateIdList,<br/>const std::vector<uint8_t>& frameworkPublicKey,<br/>const std::vector<uint8_t>& extraInfo) | 执行器注册成功后，获取用户认证框架的公钥信息；获取用户认证框架的template 列表用于对账。 |
| OnSetData(uint64_t scheduleId, uint64_t authSubType, <br/>const std::vector<uint8_t> &data) | 用于回调传pin码认证的子类型和脱敏数据。 | | OnSetData(uint64_t scheduleId, uint64_t authSubType, <br/>const std::vector<uint8_t> &data) | 回调函数，返回用户录入的口令子类型和录入的口令脱敏数据。 |
| Enroll(uint64_t scheduleId, const std::vector<uint8_t>& extraInfo,<br/>const sptr<IExecutorCallback>& callbackObj) | 录入pin码。 | | Enroll(uint64_t scheduleId, const std::vector<uint8_t>& extraInfo,<br/>const sptr<IExecutorCallback>& callbackObj) | 录入pin码。 |
| Authenticate(uint64_t scheduleId, uint64_t templateId, const std::vector<uint8_t>& extraInfo, const sptr<IExecutorCallback>& callbackObj) | pin码认证。 | | Authenticate(uint64_t scheduleId, uint64_t templateId, const std::vector<uint8_t>& extraInfo, const sptr<IExecutorCallback>& callbackObj) | pin码认证。 |
| Delete(uint64_t templateId) | 删除pin码模板。 | | Delete(uint64_t templateId) | 删除pin码模板。 |
...@@ -86,7 +101,7 @@ Pin_auth驱动的主要工作是为上层用户认证框架和Pin_auth服务提 ...@@ -86,7 +101,7 @@ Pin_auth驱动的主要工作是为上层用户认证框架和Pin_auth服务提
**表2** 回调函数介绍 **表2** 回调函数介绍
| 接口名 | 功能介绍 | | 接口名称 | 功能介绍 |
| ------------------------------------------------------------ | -------------------- | | ------------------------------------------------------------ | -------------------- |
| IExecutorCallback::OnResult(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的最终结果。 | | IExecutorCallback::OnResult(int32_t code, const std::vector<uint8_t>& extraInfo) | 返回操作的最终结果。 |
| IExecutorCallback::OnGetData(uint64_t scheduleId, const std::vector<uint8_t>& salt,<br/> uint64_t authSubType)| 返回获取pin码数据信息。 | | IExecutorCallback::OnGetData(uint64_t scheduleId, const std::vector<uint8_t>& salt,<br/> uint64_t authSubType)| 返回获取pin码数据信息。 |
...@@ -108,7 +123,7 @@ Pin_auth驱动的主要工作是为上层用户认证框架和Pin_auth服务提 ...@@ -108,7 +123,7 @@ Pin_auth驱动的主要工作是为上层用户认证框架和Pin_auth服务提
├── main # 口令相关功能实现入口 ├── main # 口令相关功能实现入口
└── service # Pin_auth驱动实现入口 └── service # Pin_auth驱动实现入口
├── inc # 头文件 ├── inc # 头文件
└── src └── src # 源文件
├── executor_impl.cpp # 认证、录入等功能接口实现 ├── executor_impl.cpp # 认证、录入等功能接口实现
├── pin_auth_interface_driver.cpp # Pin_auth驱动入口 ├── pin_auth_interface_driver.cpp # Pin_auth驱动入口
└── pin_auth_interface_service.cpp # 获取执行器列表接口实现 └── pin_auth_interface_service.cpp # 获取执行器列表接口实现
......
zh-cn/device-dev/driver/driver-peripherals-user-auth-des.md
浏览文件 @ 62e0338f
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
- 认证凭据模板 - 认证凭据模板
认证凭据模板在用户设置认证凭据时由认证服务产生并存储。每个模板有一个ID，用于索引模板信息文件。在认证时，读取模板信息并用和当次认证过程中产生的认证数据做对比，完成身份认证。 认证凭据模板在用户设置认证凭据时由认证服务产生并存储。每个模板有一个ID，用于索引模板信息文件。在认证时，读取模板信息并和当次认证过程中产生的认证数据做对比，完成身份认证。
- 执行器 - 执行器
...@@ -41,7 +41,7 @@ ...@@ -41,7 +41,7 @@
- 执行器安全等级 - 执行器安全等级
执行器提供能力时运行环境所达到的安全级别，如操作运行在无访问控制安全等级低于操作运行硬件可信执行环境的安全等级。 执行器提供能力时所在运行环境达到的安全级别。
- 用户认证框架公钥 & 执行器公钥 - 用户认证框架公钥 & 执行器公钥
...@@ -76,6 +76,18 @@ ...@@ -76,6 +76,18 @@
OpenHarmony系统向系统应用提供的应用编程接口。 OpenHarmony系统向系统应用提供的应用编程接口。
- IDL接口
接口定义语言（Interface Definition Language），通过IDL编译器编译后，能够生成与编程语言相关的文件：客户端桩文件，服务器框架文件。本文主要是通过IDL接口生成的客户端和服务端来实现User_auth服务和驱动的通信，详细使用方法可参考[IDL简介](https://gitee.com/openharmony/ability_idl_tool/blob/master/README.md)。
- IPC通信
IPC（Inter Process Communication），进程间通信是指两个进程的数据之间产生交互，详细原理可参考[IPC通信简介](https://gitee.com/openharmony/communication_ipc/blob/master/README_zh.md)。
- HDI
HDI（Hardware Device Interface），硬件设备接口，位于基础系统服务层和设备驱动层之间，是提供给硬件系统服务开发者使用的、统一的硬件设备功能抽象接口，其目的是为系统服务屏蔽底层硬件设备差异，具体可参考[HDI规范](../../design/hdi-design-specifications.md)。
### 运作机制 ### 运作机制
User_auth驱动主要工作是屏蔽不同安全器件和安全环境的差异，通过统一的认证能力注册、录入、认证接口，向User_auth服务提供认证执行器管理、认证凭据管理和认证方案生成管理等能力。 User_auth驱动主要工作是屏蔽不同安全器件和安全环境的差异，通过统一的认证能力注册、录入、认证接口，向User_auth服务提供认证执行器管理、认证凭据管理和认证方案生成管理等能力。
...@@ -97,10 +109,13 @@ User_auth驱动的主要工作是为User_auth服务提供稳定的用户凭据 ...@@ -97,10 +109,13 @@ User_auth驱动的主要工作是为User_auth服务提供稳定的用户凭据
### 接口说明 ### 接口说明
注：以下接口列举的为IDL接口描述生成的对应C++语言函数接口，接口声明见idl文件（/drivers/interface/user_auth/v1_0/）。
在本文中，执行器注册、凭据录入、凭据删除、用户认证和用户识别相关的HDI接口如表1所示。
**表1** 接口功能介绍 **表1** 接口功能介绍
| 接口名 | 功能介绍 | | 接口名称 | 功能介绍 |
| ------------------------------------------------------------ | ------------------------------------------------------------ | | --------------------------- | --------------------------- |
| Init() | 初始化缓存信息。 | | Init() | 初始化缓存信息。 |
| AddExecutor(const ExecutorRegisterInfo& info, uint64_t& index, std::vector<uint8_t>& publicKey,<br/> std::vector<uint64_t>& templateIds) | 添加认证执行器，获得此认证能力。 | | AddExecutor(const ExecutorRegisterInfo& info, uint64_t& index, std::vector<uint8_t>& publicKey,<br/> std::vector<uint64_t>& templateIds) | 添加认证执行器，获得此认证能力。 |
| DeleteExecutor(uint64_t index) | 根据索引值index删除认证执行器。 | | DeleteExecutor(uint64_t index) | 根据索引值index删除认证执行器。 |
...@@ -494,66 +509,59 @@ User_auth驱动的主要工作是为User_auth服务提供稳定的用户凭据 ...@@ -494,66 +509,59 @@ User_auth驱动的主要工作是为User_auth服务提供稳定的用户凭据
驱动开发完成后，通过[用户认证API接口](../../application-dev/reference/apis/js-apis-useriam-userauth.md)开发JS应用，基于Hi3516DV300平台验证。认证和取消功能验证的JS测试代码如下： 驱动开发完成后，通过[用户认证API接口](../../application-dev/reference/apis/js-apis-useriam-userauth.md)开发JS应用，基于Hi3516DV300平台验证。认证和取消功能验证的JS测试代码如下：
```js ```js
// API version 8 // API version 9
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();
let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
export default { let authType = userIAM_userAuth.UserAuthType.FACE;
getVersion() { let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
console.info("start get version");
let version = this.auth.getVersion(); // 获取认证对象
console.info("auth version = " + version); let auth;
},
startAuth() {
console.info("start auth");
this.auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
try { try {
console.info("auth onResult result = " + result); auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo)); console.log("get auth instance success");
if (result == 'SUCCESS') { } catch (error) {
// 此处添加认证成功逻辑 console.log("get auth instance failed" + error);
} else {
// 此处添加认证失败逻辑
} }
} catch (e) {
console.info("auth onResult error = " + e);
}
},
onAcquireInfo: (module, acquire, extraInfo) => { // 订阅认证结果
try { try {
console.info("auth onAcquireInfo module = " + module); auth.on("result", {
console.info("auth onAcquireInfo acquire = " + acquire); callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.info("auth onAcquireInfo extraInfo = " + JSON.stringify(extraInfo)); console.log("authV9 result " + result.result);
} catch (e) { console.log("authV9 token " + result.token);
console.info("auth onAcquireInfo error = " + e); console.log("authV9 remainAttempts " + result.remainAttempts);
} console.log("authV9 lockoutDuration " + result.lockoutDuration);
} }
}); });
}, console.log("subscribe authentication event success");
} catch (error) {
cancelAuth() { console.log("subscribe authentication event failed " + error);
console.info("start cancel auth"); }
// contextId通过auth接口获取
let contextId = auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
console.info("auth onResult result = " + result);
},
onAcquireInfo: (module, acquire, extraInfo) => { // 开始认证
console.info("auth onAcquireInfo module = " + module); try {
auth.start();
console.info("authV9 start auth success");
} catch (error) {
console.info("authV9 start auth failed, error = " + error);
} }
});
let cancelCode = this.auth.cancel(contextId); // 取消认证
if (cancelCode == userIAM_userAuth.Result.SUCCESS) { try {
auth.cancel();
console.info("cancel auth success"); console.info("cancel auth success");
} else { } catch (error) {
console.error("cancel auth fail"); console.info("cancel auth failed, error = " + error);
}
} }
}
```
// 取消订阅认证结果
try {
auth.off("result");
console.info("cancel subscribe authentication event success");
} catch (error) {
console.info("cancel subscribe authentication event failed, error = " + error);
}
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或