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

相关文章

Eclipse+ADT与Android Studio开发的区别

Eclipse+ADT与Android Studio开发的区别

下文的EA指Eclipse+ADT,AS就是指Android Studio。 就编写界面布局来说AS可以边开发边预览（所见即所得,以及多个屏幕预览），这个优势比较大。AS运行时占的内存比EA的要小。AS创建项目时要创建gradle项目框架，so,创建项目时AS比较慢。android studio基于gradle构建项目，你无法同时集中管理和维护多个项目的源码，而eclipse ADT可以同时打开
阅读更多...
Python应用开发——30天学习Streamlit Python包进行APP的构建（9）

Python应用开发——30天学习Streamlit Python包进行APP的构建（9）

st.area_chart 显示区域图。 这是围绕 st.altair_chart 的语法糖。主要区别在于该命令使用数据自身的列和指数来计算图表的 Altair 规格。因此，在许多 "只需绘制此图 "的情况下，该命令更易于使用，但可定制性较差。 如果 st.area_chart 无法正确猜测数据规格，请尝试使用 st.altair_chart 指定所需的图表。 Function signa
阅读更多...
vue3项目将所有访问后端springboot的接口统一管理带跨域

vue3项目将所有访问后端springboot的接口统一管理带跨域

vue3项目将所有访问后端springboot的接口统一管理带跨域 一、前言1.安装Axios2.创建Axios实例3.创建API服务文件4.在组件中使用API服务 二、跨域三、总结 一、前言 在Vue 3项目中，统一管理所有访问后端Spring Boot接口的最佳实践是创建一个专门的API服务层。这可以让你的代码更加模块化、可维护和集中管理。你可以使用Axios库作为HTT
阅读更多...
9 个 GraphQL 安全最佳实践

9 个 GraphQL 安全最佳实践

GraphQL 已被最大的平台采用 - Facebook、Twitter、Github、Pinterest、Walmart - 这些大公司不能在安全性上妥协。但是，尽管 GraphQL 可以成为您的 API 的非常安全的选项，但它并不是开箱即用的。事实恰恰相反：即使是最新手的黑客，所有大门都是敞开的。此外，GraphQL 有自己的一套注意事项，因此如果您来自 REST，您可能会错过一些重要步骤！
阅读更多...
数据库原理与安全复习笔记（未完待续）

数据库原理与安全复习笔记（未完待续）

1 概念 产生与发展：人工管理阶段 → \to → 文件系统阶段 → \to → 数据库系统阶段。 数据库系统特点：数据的管理者（DBMS）；数据结构化；数据共享性高，冗余度低，易于扩充；数据独立性高。DBMS 对数据的控制功能：数据的安全性保护；数据的完整性检查；并发控制；数据库恢复。 数据库技术研究领域：数据库管理系统软件的研发；数据库设计；数据库理论。数据模型要素 数据结构：描述数据库
阅读更多...
WDF驱动开发-WDF总线枚举(一)

WDF驱动开发-WDF总线枚举(一)

支持在总线驱动程序中进行 PnP 和电源管理 某些设备永久插入系统，而其他设备可以在系统运行时插入和拔出电源。 总线驱动 必须识别并报告连接到其总线的设备，并且他们必须发现并报告系统中设备的到达和离开情况。 总线驱动程序标识和报告的设备称为总线的 子设备。 标识和报告子设备的过程称为 总线枚举。 在总线枚举期间，总线驱动程序会为其子 设备创建设备对象 。  总线驱动程序本质上是同时处理总线枚
阅读更多...
使用JWT进行安全通信

使用JWT进行安全通信

在现代Web应用中，安全通信是至关重要的。JSON Web Token（JWT）是一种流行的安全通信方式，它允许用户和服务器之间安全地传输信息。JWT是一种紧凑的、URL安全的表示方法，用于在两方之间传输信息。本文将详细介绍JWT的工作原理，并提供代码示例帮助新人理解和实现JWT。 什么是JWT？ JWT是一种开放标准（RFC 7519），它定义了一种紧凑且自包含的方式，用于在各方之间以JSO
阅读更多...
JavaWeb系列六: 动态WEB开发核心(Servlet) 上

JavaWeb系列六: 动态WEB开发核心(Servlet) 上

韩老师学生 官网文档为什么会出现Servlet什么是ServletServlet在JavaWeb项目位置Servlet基本使用Servlet开发方式说明快速入门- 手动开发 servlet浏览器请求Servlet UML分析Servlet生命周期GET和POST请求分发处理通过继承HttpServlet开发ServletIDEA配置ServletServlet注意事项和细节 Servlet注
阅读更多...
手把手教你入门vue+springboot开发（五）--docker部署

手把手教你入门vue+springboot开发（五）--docker部署

文章目录 前言一、前端打包二、后端打包三、docker运行总结 前言 前面我们重点介绍了vue+springboot前后端分离开发的过程，本篇我们结合docker容器来研究一下打包部署过程。 一、前端打包 在VSCode的命令行中输入npm run build可以打包前端代码，出现下图提示表示打包完成。 打包成功后会在前端工程目录生成dist目录，如下图所示： 把
阅读更多...
Sapphire开发日志 (十) 关于页面

Sapphire开发日志 (十) 关于页面

关于页面 任务介绍 关于页面用户对我组工作量的展示。 实现效果 代码解释 首先封装一个子组件用于展示用户头像和名称。 const UserGrid = ({src,name,size,link,}: {src: any;name: any;size?: any;link?: any;}) => (<Box sx={{ display: "flex", flexDirecti
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2