鸿蒙开发接口安全：【@ohos.userIAM.userAuth (用户认证)】

2024-06-05 22:36
文章标签 接口 认证 安全 开发 用户 鸿蒙 ohos useriam userauth

本文主要是介绍鸿蒙开发接口安全：【@ohos.userIAM.userAuth (用户认证)】，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

用户认证

icon-note.gif 说明：  本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import userIAM_userAuth from '@ohos.userIAM.userAuth';

完整示例

// API version 6
import userIAM_userAuth from '@ohos.userIAM.userAuth';export default {startAuth() {console.info("start auth");let auth = userIAM_userAuth.getAuthenticator();auth.execute("FACE_ONLY", "S2").then((code)=>{console.info("auth success");// 此处添加认证成功逻辑}).catch((code)=>{console.error("auth fail, code = " + code);// 此处添加认证失败逻辑});}
}

// API version 8
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();export default {getVersion() {console.info("start get version");let version = this.auth.getVersion();console.info("auth version = " + version);},startAuth() {console.info("start auth");this.auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {onResult: (result, extraInfo) => {try {console.info("auth onResult result = " + result);console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo));if (result == 'SUCCESS') {// 此处添加认证成功逻辑}  else {// 此处添加认证失败逻辑}} catch (e) {console.info("auth onResult error = " + e);}},onAcquireInfo: (module, acquire, extraInfo) => {try {console.info("auth onAcquireInfo module = " + module);console.info("auth onAcquireInfo acquire = " + acquire);console.info("auth onAcquireInfo extraInfo = " + JSON.stringify(extraInfo));} catch (e) {console.info("auth onAcquireInfo error = " + e);}}});},checkAuthSupport() {console.info("start check auth support");let checkCode = this.auth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);if (checkCode == userIAM_userAuth.ResultCode.SUCCESS) {console.info("check auth support success");// 此处添加支持指定类型认证的逻辑} else {console.error("check auth support fail, code = " + checkCode);// 此处添加不支持指定类型认证的逻辑}},cancelAuth() {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);}});let cancelCode = this.auth.cancel(contextId);if (cancelCode == userIAM_userAuth.Result.SUCCESS) {console.info("cancel auth success");} else {console.error("cancel auth fail");}}
}

userIAM_userAuth.getAuthenticator(deprecated)

getAuthenticator(): Authenticator

说明：  从 API Version 8 开始废弃，建议使用[constructor]替代。

获取Authenticator对象，用于执行用户身份认证。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

返回值：

类型说明
[Authenticator]认证器对象。

示例：

let authenticator = userIAM_userAuth.getAuthenticator();

Authenticator(deprecated)

说明：  从 API Version 8 开始废弃，建议使用[UserAuth]替代。

认证器对象。

execute(deprecated)

execute(type: string, level: string, callback: AsyncCallback): void

说明：  从 API Version 8 开始废弃，建议使用auth替代。

执行用户认证，使用callback方式作为异步方法。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名类型必填说明
typestring是认证类型，当前只支持FACE_ONLY。 ALL为预留参数，当前版本暂不支持ALL类型的认证。
levelstring是安全级别，对应认证的安全级别，有效值为S1（最低）、S2、S3、S4（最高）。 具备3D人脸识别能力的设备支持S3及以下安全级别的认证。 具备2D人脸识别能力的设备支持S2及以下安全级别的认证。
callbackAsyncCallback否回调函数。

callback返回值：

类型说明
number表示认证结果，参见[AuthenticationResult]。

示例：

authenticator.execute("FACE_ONLY", "S2", (code)=>{if (code == userIAM_userAuth.AuthenticationResult.SUCCESS) {console.info("auth success");return;}console.error("auth fail, code = " + code);
})

execute(deprecated)

execute(type:string, level:string): Promise

说明：  从 API Version 8 开始废弃，建议使用[auth]替代。

执行用户认证，使用promise方式作为异步方法。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名类型必填说明
typestring是认证类型，当前只支持FACE_ONLY。 ALL为预留参数，当前版本暂不支持ALL类型的认证。
levelstring是安全级别，对应认证的安全级别，有效值为S1（最低）、S2、S3、S4（最高）。 具备3D人脸识别能力的设备支持S3及以下安全级别的认证。 具备2D人脸识别能力的设备支持S2及以下安全级别的认证。

返回值：

类型说明
Promise返回携带一个number的Promise。number 为认证结果，参见[AuthenticationResult]。

示例：

let authenticator = userIAM_userAuth.getAuthenticator();
authenticator.execute("FACE_ONLY", "S2").then((code)=>{console.info("auth success");
}).catch((code)=>{console.error("auth fail, code = " + code);
});

AuthenticationResult(deprecated)

说明：  从 API Version 8 开始废弃，建议使用[ResultCode](替代。

表示认证结果的枚举。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称默认值描述
NO_SUPPORT-1设备不支持当前的认证方式。
SUCCESS0认证成功。
COMPARE_FAILURE1比对失败。
CANCELED2用户取消认证。
TIMEOUT3认证超时。
CAMERA_FAIL4开启相机失败。
BUSY5认证服务忙，请稍后重试。
INVALID_PARAMETERS6认证参数无效。
LOCKED7认证失败次数过多，已锁定。
NOT_ENROLLED8未录入认证凭据。
GENERAL_ERROR100其他错误。

UserAuth8+

认证器的对象。

constructor8+

constructor()

表示获取的认证器对象。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

返回值：

类型说明
[UserAuth]UserAuth认证器对象。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';let auth = new userIAM_userAuth.UserAuth();

getVersion8+

getVersion() : number

表示获取的认证器版本信息。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

返回值：

类型说明
number获取的认证器版本信息。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';let auth = new userIAM_userAuth.UserAuth();
let version = auth.getVersion();
console.info("auth version = " + version);

getAvailableStatus8+

getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : number

表示检查指定的认证等级的认证能力是否可用。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名类型必填说明
authType[UserAuthType]是认证类型，当前只支持FACE。
authTrustLevel[AuthTrustLevel]是认证结果的信任等级。

返回值：

类型说明
number获取指定的认证等级的认证能力是否可用的检查结果，返回值参见[ResultCode]。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';let auth = new userIAM_userAuth.UserAuth();
let checkCode = auth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
if (checkCode == userIAM_userAuth.ResultCode.SUCCESS) {console.info("check auth support success");// 此处添加支持指定类型认证的逻辑
} else {console.error("check auth support fail, code = " + checkCode);// 此处添加不支持指定类型认证的逻辑
}

auth8+

auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array

表示执行用户认证，使用callback方式作为异步方法。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名类型必填说明
challengeUint8Array是挑战值，可以填null。
authType[UserAuthType]是认证类型，当前支持FACE。
authTrustLevel[AuthTrustLevel]是信任等级。
callback[IUserAuthCallback]是回调函数。

返回值：

类型说明
Uint8ArrayContextId，作为取消认证[cancelAuth]接口的入参。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {onResult: (result, extraInfo) => {try {console.info("auth onResult result = " + result);console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo));if (result == userIAM_userAuth.ResultCode.SUCCESS) {// 此处添加认证成功逻辑} else {// 此处添加认证失败逻辑}} catch (e) {console.info("auth onResult error = " + e);}}
});

cancelAuth8+

cancelAuth(contextID : Uint8Array) : number

表示通过contextID取消本次认证操作。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名类型必填说明
contextIDUint8Array是上下文ID信息，通过[auth]接口获得。

返回值：

类型说明
number取消本次认证操作的结果。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';// contextId可通过auth接口获取，此处直接定义
let contextId = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7]);
let cancelCode = auth.cancel(contextId);
if (cancelCode == userIAM_userAuth.ResultCode.SUCCESS) {console.info("cancel auth success");
} else {console.error("cancel auth fail");
}

IUserAuthCallback8+

认证过程中回调结果的对象。

onResult8+

onResult: (result : number, extraInfo : AuthResult) => void

表示在认证操作中，获取认证结果。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名类型必填说明
resultnumber是认证结果，参见[ResultCode]。
extraInfo[AuthResult]是扩展信息，不同情况下的具体信息， 如果身份验证通过，则在extrainfo中返回用户认证令牌， 如果身份验证失败，则在extrainfo中返回剩余的用户认证次数， 如果身份验证执行器被锁定，则在extrainfo中返回冻结时间。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {onResult: (result, extraInfo) => {try {console.info("auth onResult result = " + result);console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo));if (result == SUCCESS) {// 此处添加认证成功逻辑}  else {// 此处添加认证失败逻辑}} catch (e) {console.info("auth onResult error = " + e);}},onAcquireInfo: (module, acquire, extraInfo) => {try {console.info("auth onAcquireInfo module = " + module);console.info("auth onAcquireInfo acquire = " + acquire);console.info("auth onAcquireInfo extraInfo = " + JSON.stringify(extraInfo));} catch (e) {console.info("auth onAcquireInfo error = " + e);}}
});

onAcquireInfo8+

onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void

表示在认证过程中，获取提示码信息，非必须实现。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名类型必填说明
modulenumber是认证执行器的类型。
acquirenumber是认证执行器认证过程的交互信息。
extraInfoany是预留字段。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {onResult: (result, extraInfo) => {try {console.info("auth onResult result = " + result);console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo));if (result == SUCCESS) {// 此处添加认证成功逻辑}  else {// 此处添加认证失败逻辑}} catch (e) {console.info("auth onResult error = " + e);}},onAcquireInfo: (module, acquire, extraInfo) => {try {console.info("auth onAcquireInfo module = " + module);console.info("auth onAcquireInfo acquire = " + acquire);console.info("auth onAcquireInfo extraInfo = " + JSON.stringify(extraInfo));} catch (e) {console.info("auth onAcquireInfo error = " + e);}}
});

AuthResult8+

表示认证结果的对象。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称参数类型必填说明
tokenUint8Array否身份认证令牌。
remainTimesnumber否剩余的认证操作次数。
freezingTimenumber否认证操作的冻结时间。

ResultCode8+

表示执行结果的枚举。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称默认值描述
SUCCESS0执行成功。
FAIL1执行失败。
GENERAL_ERROR2操作通用错误。
CANCELED3操作取消。
TIMEOUT4操作超时。
TYPE_NOT_SUPPORT5不支持的认证类型。
TRUST_LEVEL_NOT_SUPPORT6不支持的认证等级。
BUSY7忙碌状态。
INVALID_PARAMETERS8无效参数。
LOCKED9认证器已锁定。
NOT_ENROLLED10用户未录入认证信息。

FaceTips8+

表示人脸认证过程中提示码的枚举。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称默认值描述
FACE_AUTH_TIP_TOO_BRIGHT1光线太强，获取的图像太亮。
FACE_AUTH_TIP_TOO_DARK2光线太暗，获取的图像太暗。
FACE_AUTH_TIP_TOO_CLOSE3人脸距离设备过近。
FACE_AUTH_TIP_TOO_FAR4人脸距离设备过远。
FACE_AUTH_TIP_TOO_HIGH5设备太高，仅获取到人脸上部。
FACE_AUTH_TIP_TOO_LOW6设备太低，仅获取到人脸下部。
FACE_AUTH_TIP_TOO_RIGHT7设备太靠右，仅获取到人脸右部。
FACE_AUTH_TIP_TOO_LEFT8设备太靠左，仅获取到人脸左部。
FACE_AUTH_TIP_TOO_MUCH_MOTION9在图像采集过程中，用户人脸移动太快。
FACE_AUTH_TIP_POOR_GAZE10没有正视摄像头。
FACE_AUTH_TIP_NOT_DETECTED11没有检测到人脸信息。

FingerprintTips8+

表示指纹认证过程中提示码的枚举。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称默认值描述
FINGERPRINT_AUTH_TIP_GOOD0获取的指纹图像良好。
FINGERPRINT_AUTH_TIP_DIRTY1由于传感器上可疑或检测到的污垢，指纹图像噪音过大。
FINGERPRINT_AUTH_TIP_INSUFFICIENT2由于检测到的情况，指纹图像噪声太大，无法处理。
FINGERPRINT_AUTH_TIP_PARTIAL3仅检测到部分指纹图像。
FINGERPRINT_AUTH_TIP_TOO_FAST4快速移动，指纹图像不完整。
FINGERPRINT_AUTH_TIP_TOO_SLOW5缺少运动，指纹图像无法读取。

UserAuthType8+

表示身份认证的凭据类型枚举。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称默认值描述
FACE2人脸认证。
FINGERPRINT4指纹认证。

AuthTrustLevel8+

表示认证结果的信任等级枚举。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称默认值描述
ATL110000认证结果的信任等级级别1。
ATL220000认证结果的信任等级级别2。
ATL330000认证结果的信任等级级别3。
ATL440000认证结果的信任等级级别4。

这篇关于鸿蒙开发接口安全：【@ohos.userIAM.userAuth (用户认证)】的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1034362。

相关文章

基于Python开发Windows屏幕控制工具

基于Python开发Windows屏幕控制工具

《基于Python开发Windows屏幕控制工具》在数字化办公时代,屏幕管理已成为提升工作效率和保护眼睛健康的重要环节,本文将分享一个基于Python和PySide6开发的Windows屏幕控制工具,... 目录概述功能亮点界面展示实现步骤详解1. 环境准备2. 亮度控制模块3. 息屏功能实现4. 息屏时间
阅读更多...
springboot下载接口限速功能实现

springboot下载接口限速功能实现

《springboot下载接口限速功能实现》通过Redis统计并发数动态调整每个用户带宽,核心逻辑为每秒读取并发送限定数据量,防止单用户占用过多资源,确保整体下载均衡且高效,本文给大家介绍spring... 目录 一、整体目标 二、涉及的主要类/方法✅ 三、核心流程图解（简化） 四、关键代码详解1️⃣ 设置
阅读更多...
spring中的ImportSelector接口示例详解

spring中的ImportSelector接口示例详解

《spring中的ImportSelector接口示例详解》Spring的ImportSelector接口用于动态选择配置类,实现条件化和模块化配置,关键方法selectImports根据注解信息返回... 目录一、核心作用二、关键方法三、扩展功能四、使用示例五、工作原理六、应用场景七、自定义实现Impor
阅读更多...
Python实例题之pygame开发打飞机游戏实例代码

Python实例题之pygame开发打飞机游戏实例代码

《Python实例题之pygame开发打飞机游戏实例代码》对于python的学习者,能够写出一个飞机大战的程序代码,是不是感觉到非常的开心,：本文主要介绍Python实例题之pygame开发打飞机... 目录题目pygame-aircraft-game使用 Pygame 开发的打飞机游戏脚本代码解释初始化部
阅读更多...
使用Python开发一个现代化屏幕取色器

使用Python开发一个现代化屏幕取色器

《使用Python开发一个现代化屏幕取色器》在UI设计、网页开发等场景中,颜色拾取是高频需求,：本文主要介绍如何使用Python开发一个现代化屏幕取色器,有需要的小伙伴可以参考一下... 目录一、项目概述二、核心功能解析2.1 实时颜色追踪2.2 智能颜色显示三、效果展示四、实现步骤详解4.1 环境配置4.
阅读更多...
MybatisPlus service接口功能介绍

MybatisPlus service接口功能介绍

《MybatisPlusservice接口功能介绍》：本文主要介绍MybatisPlusservice接口功能介绍,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友... 目录Service接口基本用法进阶用法总结：Lambda方法Service接口基本用法MyBATisP
阅读更多...
华为鸿蒙HarmonyOS 5.1官宣7月开启升级! 首批支持名单公布

华为鸿蒙HarmonyOS 5.1官宣7月开启升级! 首批支持名单公布

《华为鸿蒙HarmonyOS5.1官宣7月开启升级!首批支持名单公布》在刚刚结束的华为Pura80系列及全场景新品发布会上，除了众多新品的发布，还有一个消息也点燃了所有鸿蒙用户的期待，那就是Ha... 在今日的华为 Pura 80 系列及全场景新品发布会上，华为宣布鸿蒙 HarmonyOS 5.1 将于 7
阅读更多...
Python使用smtplib库开发一个邮件自动发送工具

Python使用smtplib库开发一个邮件自动发送工具

《Python使用smtplib库开发一个邮件自动发送工具》在现代软件开发中,自动化邮件发送是一个非常实用的功能,无论是系统通知、营销邮件、还是日常工作报告,Python的smtplib库都能帮助我们... 目录代码实现与知识点解析1. 导入必要的库2. 配置邮件服务器参数3. 创建邮件发送类4. 实现邮件
阅读更多...
Java中常见队列举例详解(非线程安全)

Java中常见队列举例详解(非线程安全)

《Java中常见队列举例详解(非线程安全)》队列用于模拟队列这种数据结构,队列通常是指先进先出的容器,：本文主要介绍Java中常见队列(非线程安全)的相关资料,文中通过代码介绍的非常详细,需要的朋... 目录一.队列定义 二.常见接口 三.常见实现类3.1 ArrayDeque3.1.1 实现原理3.1.2
阅读更多...
基于Python开发一个有趣的工作时长计算器

基于Python开发一个有趣的工作时长计算器

《基于Python开发一个有趣的工作时长计算器》随着远程办公和弹性工作制的兴起,个人及团队对于工作时长的准确统计需求日益增长,本文将使用Python和PyQt5打造一个工作时长计算器,感兴趣的小伙伴可... 目录概述功能介绍界面展示php软件使用步骤说明代码详解1.窗口初始化与布局2.工作时长计算核心逻辑3
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2