鸿蒙开发接口安全：【@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。

相关文章

浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
这15个Vue指令，让你的项目开发爽到爆

这15个Vue指令，让你的项目开发爽到爆

1. V-Hotkey 仓库地址: github.com/Dafrok/v-ho… Demo: 戳这里 https://dafrok.github.io/v-hotkey 安装: npm install --save v-hotkey 这个指令可以给组件绑定一个或多个快捷键。你想要通过按下 Escape 键后隐藏某个组件，按住 Control 和回车键再显示它吗？小菜一碟： <template
阅读更多...
Hadoop企业开发案例调优场景

Hadoop企业开发案例调优场景

需求 （1）需求：从1G数据中，统计每个单词出现次数。服务器3台，每台配置4G内存，4核CPU，4线程。 （2）需求分析： 1G / 128m = 8个MapTask；1个ReduceTask；1个mrAppMaster 平均每个节点运行10个 / 3台 ≈ 3个任务（4    3    3） HDFS参数调优 （1）修改：hadoop-env.sh export HDFS_NAMENOD
阅读更多...
嵌入式QT开发：构建高效智能的嵌入式系统

嵌入式QT开发：构建高效智能的嵌入式系统

摘要： 本文深入探讨了嵌入式 QT 相关的各个方面。从 QT 框架的基础架构和核心概念出发，详细阐述了其在嵌入式环境中的优势与特点。文中分析了嵌入式 QT 的开发环境搭建过程，包括交叉编译工具链的配置等关键步骤。进一步探讨了嵌入式 QT 的界面设计与开发，涵盖了从基本控件的使用到复杂界面布局的构建。同时也深入研究了信号与槽机制在嵌入式系统中的应用，以及嵌入式 QT 与硬件设备的交互，包括输入输出设
阅读更多...
OpenHarmony鸿蒙开发（ Beta5.0）无感配网详解

OpenHarmony鸿蒙开发（ Beta5.0）无感配网详解

1、简介 无感配网是指在设备联网过程中无需输入热点相关账号信息，即可快速实现设备配网，是一种兼顾高效性、可靠性和安全性的配网方式。 2、配网原理 2.1 通信原理 手机和智能设备之间的信息传递，利用特有的NAN协议实现。利用手机和智能设备之间的WiFi 感知订阅、发布能力，实现了数字管家应用和设备之间的发现。在完成设备间的认证和响应后，即可发送相关配网数据。同时还支持与常规Sof
阅读更多...
活用c4d官方开发文档查询代码

活用c4d官方开发文档查询代码

当你问AI助手比如豆包，如何用python禁止掉xpresso标签时候，它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来
阅读更多...
客户案例：安全海外中继助力知名家电企业化解海外通邮困境

客户案例：安全海外中继助力知名家电企业化解海外通邮困境

1、客户背景 广东格兰仕集团有限公司（以下简称“格兰仕”），成立于1978年，是中国家电行业的领军企业之一。作为全球最大的微波炉生产基地，格兰仕拥有多项国际领先的家电制造技术，连续多年位列中国家电出口前列。格兰仕不仅注重业务的全球拓展，更重视业务流程的高效与顺畅，以确保在国际舞台上的竞争力。 2、需求痛点 随着格兰仕全球化战略的深入实施，其海外业务快速增长，电子邮件成为了关键的沟通工具。
阅读更多...
安全管理体系化的智慧油站开源了。

安全管理体系化的智慧油站开源了。

AI视频监控平台简介 AI视频监控平台是一款功能强大且简单易用的实时算法视频监控系统。它的愿景是最底层打通各大芯片厂商相互间的壁垒，省去繁琐重复的适配流程，实现芯片、算法、应用的全流程组合，从而大大减少企业级应用约95%的开发成本。用户只需在界面上进行简单的操作，就可以实现全视频的接入及布控。摄像头管理模块用于多种终端设备、智能设备的接入及管理。平台支持包括摄像头等终端感知设备接入，为整个平台提
阅读更多...
Linux_kernel驱动开发11

Linux_kernel驱动开发11

一、改回nfs方式挂载根文件系统         在产品将要上线之前，需要制作不同类型格式的根文件系统         在产品研发阶段，我们还是需要使用nfs的方式挂载根文件系统         优点：可以直接在上位机中修改文件系统内容，延长EMMC的寿命         【1】重启上位机nfs服务         sudo service nfs-kernel-server resta
阅读更多...
【区块链 + 人才服务】区块链集成开发平台 | FISCO BCOS应用案例

【区块链 + 人才服务】区块链集成开发平台 | FISCO BCOS应用案例

随着区块链技术的快速发展，越来越多的企业开始将其应用于实际业务中。然而，区块链技术的专业性使得其集成开发成为一项挑战。针对此，广东中创智慧科技有限公司基于国产开源联盟链 FISCO BCOS 推出了区块链集成开发平台。该平台基于区块链技术，提供一套全面的区块链开发工具和开发环境，支持开发者快速开发和部署区块链应用。此外，该平台还可以提供一套全面的区块链开发教程和文档，帮助开发者快速上手区块链开发。
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2