鸿蒙开发接口安全：【@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如何开发游戏

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,：本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D
阅读更多...
基于Python开发Windows自动更新控制工具

基于Python开发Windows自动更新控制工具

《基于Python开发Windows自动更新控制工具》在当今数字化时代,操作系统更新已成为计算机维护的重要组成部分,本文介绍一款基于Python和PyQt5的Windows自动更新控制工具,有需要的可... 目录设计原理与技术实现系统架构概述数学建模工具界面完整代码实现技术深度分析多层级控制理论服务层控制注
阅读更多...
springboot依靠security实现digest认证的实践

springboot依靠security实现digest认证的实践

《springboot依靠security实现digest认证的实践》HTTP摘要认证通过加密参数（如nonce、response）验证身份,避免明文传输,但存在密码存储风险,相比基本认证更安全,却因... 目录概述参数Demopom.XML依赖Digest1Application.JavaMyPasswo
阅读更多...
MySQL中C接口的实现

MySQL中C接口的实现

《MySQL中C接口的实现》本节内容介绍使用C/C++访问数据库,包括对数据库的增删查改操作,主要是学习一些接口的调用,具有一定的参考价值,感兴趣的可以了解一下... 目录准备mysql库使用mysql库编译文件官方API文档对象的创建和关闭链接数据库下达sql指令select语句前言：本节内容介绍使用C/
阅读更多...
Spring Boot分层架构详解之从Controller到Service再到Mapper的完整流程(用户管理系统为例)

Spring Boot分层架构详解之从Controller到Service再到Mapper的完整流程(用户管理系统为例)

《SpringBoot分层架构详解之从Controller到Service再到Mapper的完整流程(用户管理系统为例)》本文将以一个实际案例（用户管理系统）为例,详细解析SpringBoot中Co... 目录引言：为什么学习Spring Boot分层架构？第一部分：Spring Boot的整体架构1.1
阅读更多...
k8s admin用户生成token方式

k8s admin用户生成token方式

《k8sadmin用户生成token方式》用户使用Kubernetes1.28创建admin命名空间并部署,通过ClusterRoleBinding为jenkins用户授权集群级权限,生成并获取其t... 目录k8s admin用户生成token创建一个admin的命名空间查看k8s namespace 的
阅读更多...
Java JUC并发集合详解之线程安全容器完全攻略

Java JUC并发集合详解之线程安全容器完全攻略

《JavaJUC并发集合详解之线程安全容器完全攻略》Java通过java.util.concurrent（JUC）包提供了一整套线程安全的并发容器,它们不仅是简单的同步包装,更是基于精妙并发算法构建... 目录一、为什么需要JUC并发集合？二、核心并发集合分类与详解三、选型指南：如何选择合适的并发容器？在多
阅读更多...
Java中的分布式系统开发基于 Zookeeper 与 Dubbo 的应用案例解析

Java中的分布式系统开发基于 Zookeeper 与 Dubbo 的应用案例解析

《Java中的分布式系统开发基于Zookeeper与Dubbo的应用案例解析》本文将通过实际案例,带你走进基于Zookeeper与Dubbo的分布式系统开发,本文通过实例代码给大家介绍的非常详... 目录Java 中的分布式系统开发基于 Zookeeper 与 Dubbo 的应用案例一、分布式系统中的挑战二
阅读更多...
基于Go语言开发一个 IP 归属地查询接口工具

基于Go语言开发一个 IP 归属地查询接口工具

《基于Go语言开发一个IP归属地查询接口工具》在日常开发中,IP地址归属地查询是一个常见需求,本文将带大家使用Go语言快速开发一个IP归属地查询接口服务,有需要的小伙伴可以了解下... 目录功能目标技术栈项目结构核心代码（main.go）使用方法扩展功能总结在日常开发中，IP 地址归属地查询是一个常见需求：
阅读更多...
基于 Cursor 开发 Spring Boot 项目详细攻略

基于 Cursor 开发 Spring Boot 项目详细攻略

《基于Cursor开发SpringBoot项目详细攻略》Cursor是集成GPT4、Claude3.5等LLM的VSCode类AI编程工具,支持SpringBoot项目开发全流程,涵盖环境配... 目录cursor是什么？基于 Cursor 开发 Spring Boot 项目完整指南1. 环境准备2. 创建
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2