【鸿蒙NEXT】鸿蒙里面类似iOS的Keychain——关键资产(@ohos.security.asset)实现设备唯一标识

news2025/1/4 22:10:33

前言

在iOS开发中Keychain 是一个非常安全的存储系统,用于保存敏感信息,如密码、证书、密钥等。与 NSUserDefaults 或文件系统不同,Keychain 提供了更高的安全性,因为它对数据进行了加密,并且只有经过授权的应用程序才能访问存储的数据。那么在鸿蒙里面对应的是什么呢?

1、关键资产(@ohos.security.asset)

在鸿蒙里面也有类似的东西,叫做关键资产(@ohos.security.asset),关键资产存储服务提供了用户短敏感数据的安全存储及管理能力。其中,短敏感数据可以是密码类(账号/密码)、Token类(应用凭据)、其他关键明文(如银行卡号)等长度较短的用户敏感数据。

从API version 11 开始支持

使用关键资产需要导入模块AssetStoreKit

import { asset } from '@kit.AssetStoreKit';

2、asset常用操作

version 11 开始支持,异步方法,如下

  1. asset.add:add(attributes: AssetMap): Promise,新增一条关键资产,使用Promise方式异步返回结果。

  2. asset.remove:removeSync(query: AssetMap): void,删除符合条件的一条或多条关键资产,使用异步方式。

  3. asset.update:update(query: AssetMap, attributesToUpdate: AssetMap): Promise,更新符合条件的一条关键资产,使用Promise方式异步返回结果。

  4. asset.query:query(query: AssetMap): Promise<Array>,查询一条或多条符合条件的关键资产。若查询需要用户认证的关键资产,则需要在本函数前调用asset.preQuery,在本函数后调用asset.postQuery,使用Promise回调异步返回结果。

  5. asset.preQuery:preQuery(query: AssetMap): Promise,查询的预处理,用于需要用户认证的关键资产。在用户认证成功后,应当随后调用asset.query、asset.postQuery。使用Promise方式异步返回结果。

  6. asset.postQuery:postQuery(handle: AssetMap): Promise,查询的后置处理,用于需要用户认证的关键资产。需与asset.preQuery函数成对出现。使用Promise方式异步返回结果。

    version 12 开始支持,同步方法,如下

  7. asset.addSync:新增一条关键资产,使用Promise方式同步步返回结果。

  8. asset.removeSync:removeSync(query: AssetMap): void,删除符合条件的一条或多条关键资产,使用同步方式。

  9. asset.addSync:新增一条关键资产,使用Promise方式同步步返回结果。

  10. asset.removeSync:removeSync(query: AssetMap): void,删除符合条件的一条或多条关键资产,使用同步方式。

  11. asset.updateSync:updateSync(query: AssetMap, attributesToUpdate: AssetMap): void,更新符合条件的一条关键资产,使用同步方式返回结果。

  12. asset.querySync:querySync(query: AssetMap): Array,查询一条或多条符合条件的关键资产。若查询需要用户认证的关键资产,则需要在本函数前调用asset.preQuerySync,在本函数后调用asset.postQuerySync,使用同步方式返回结果。

  13. asset.preQuerySync:preQuerySync(query: AssetMap): Uint8Array,查询的预处理,用于需要用户认证的关键资产。在用户认证成功后,应当随后调用asset.querySync、asset.postQuerySync。使用同步方式返回结果。

  14. asset.postQuerySync:postQuerySync(handle: AssetMap): void,查询的后置处理,用于需要用户认证的关键资产。需与asset.preQuerySync函数成对出现。使用同步方式返回结果。

关键资产需要使用到的系统能力: SystemCapability.Security.Asset

3、asset的封装使用

在iOS中使用Keychain 比较常见的功能是存储一个值作为设备唯一标识,那么asset也以此作为示例封装一个,刚好前阵子项目里面也使用了。我也封装了一个工具类hmDeviceTools

3.1 导入需要的头文件

import { util } from '@kit.ArkTS'
import { asset } from '@kit.AssetStoreKit';
import { BusinessError } from '@kit.BasicServicesKit';

3.2 封装工具类

hmDeviceTools类内容

export class hmDeviceTools {

  private static deviceIdCacheKey = "testdevice_id_cache_key" //testkey
  private static deviceId = ""

  /**
   * * 判断字符串是否为空
   * @param property 被检测的字符串
   * @return Boolean
   */
  static isEmpty(property?: string | null): Boolean {
    if (property == '' || property == null || property == undefined || property == 'undefined' ||
      property.length == 0) {
      return true
    }
    return false
  }

  /**
   * 获取设备id
   */
  static getDeviceId() {
    let deviceId = hmDeviceTools.deviceId
    //如果内存缓存为空,则从AssetStore中读取
    if (hmDeviceTools.isEmpty(deviceId)) {
      deviceId = getAssetMap(hmDeviceTools.deviceIdCacheKey)
    }
    //如果AssetStore中未读取到,则随机生成32位随机码,然后缓存到AssetStore中
    if (hmDeviceTools.isEmpty(deviceId)) {
      deviceId = util.generateRandomUUID(true).replace(new RegExp('-', "gm"), '')
      deviceId = deviceId.slice(0,Math.min(10,deviceId.length))//可以确保不会超出字符串的长度。
      setAssetMap(hmDeviceTools.deviceIdCacheKey, deviceId)
    }
    hmDeviceTools.deviceId = deviceId
    return deviceId
  }
}

getDeviceId函数里面,我是截取的10位,大家可以工具自己的具体业务来自行截取,或者使用使用generateRandomUUID返回的32位。

3.3 addSync 设置数据

既然有异步和同步可选,我当然是使用addSync同步来写了,后面的方法都是使用同步来实现。

    
/**
 * 设置数据
 * @param key  要查找的索引
 * @param value 需要存的值
 */
function setAssetMap(key: string, value: string) {

  let attr: asset.AssetMap = new Map();
  let result: Boolean
  if (canIUse("SystemCapability.Security.Asset")) {
    // 关键资产别名,每条关键资产的唯一索引。
    // 类型为Uint8Array,长度为1-256字节。
    attr.set(asset.Tag.ALIAS, stringToArray(key));
    // 关键资产明文。
    // 类型为Uint8Array,长度为1-1024字节
    attr.set(asset.Tag.SECRET, stringToArray(value));

    // 关键资产同步类型>THIS_DEVICE只在本设备进行同步,如仅在本设备还原的备份场景。
    attr.set(asset.Tag.SYNC_TYPE, asset.SyncType.THIS_DEVICE);

    //枚举,新增关键资产时的冲突(如:别名相同)处理策略。OVERWRITE》抛出异常,由业务进行后续处理。
    // attr.set(asset.Tag.CONFLICT_RESOLUTION,asset.ConflictResolution.THROW_ERROR)
    // 在应用卸载时是否需要保留关键资产。
    // 需要权限: ohos.permission.STORE_PERSISTENT_DATA。
    // 类型为bool。
    // attr.set(asset.Tag.IS_PERSISTENT, true);//我项目里面没有使用就先注释了,后续有需要这个再打开,并且要设置对应权限
  }

  if (isHasKey(key)) {
    result = updateAssetMap(attr, attr);
  } else {
    try {
      asset.addSync(attr);
      result = true
    } catch (error) {
      let err = error as BusinessError;
      console.error(`Failed to add Asset. Code is ${err.code}, message is ${err.message}`);
      result = false
    }
  }

}

3.4 querySync 获取数据

/**
 * 获取数据
 * @param key  要查找的索引
 * @returns string 表示操作的结果
 */
function getAssetMap(key: string): string {

  if (canIUse("SystemCapability.Security.Asset")) {

    let query: asset.AssetMap = new Map();
    // 关键资产别名,每条关键资产的唯一索引。
    // 类型为Uint8Array,长度为1-256字节。
    query.set(asset.Tag.ALIAS, stringToArray(key));
    //  关键资产查询返回的结果类型。
    query.set(asset.Tag.RETURN_TYPE, asset.ReturnType.ALL);
    // query.set(asset.Tag.RETURN_TYPE, asset.ReturnType.ATTRIBUTES); // 此处表示仅返回关键资产属性,不包含关键资产明文

    try {

      let res: Array<asset.AssetMap> = asset.querySync(query);

      for (let i = 0; i < res.length; i++) {
        // parse the attribute.
        if (res[i] != null) {
          // parse the secret.
          let secret: Uint8Array = res[0].get(asset.Tag.SECRET) as Uint8Array;
          // parse uint8array to string
          let secretStr: string = arrayToString(secret);

          return secretStr;
        }

      }

    } catch (error) {
      let err = error as BusinessError;
      console.error(`Failed to query Asset. Code is ${err.code}, message is ${err.message}`);
      return "";
    }
  }

  return "";
}

3.4 querySync 查询key

/**
 * 判断key是否存在
 * @param key 要查找的索引
 * @returns Boolean 表示添加操作的结果
 */
function isHasKey(key: string): Boolean {

  if (canIUse("SystemCapability.Security.Asset")) {

    let query: asset.AssetMap = new Map();

    // 关键资产别名,每条关键资产的唯一索引。
    // 类型为Uint8Array,长度为1-256字节。
    query.set(asset.Tag.ALIAS, stringToArray(key));

    //  关键资产查询返回的结果类型。
    query.set(asset.Tag.RETURN_TYPE, asset.ReturnType.ALL);

    const res = queryAssetMap(query);

    if (!res || res.length < 1) {
      return false;
    }

    return true;
  }

  return false;
}

3.5 querySync 查询数据

/**
* 查找数据
* @param key  要查找的索引
* @returns Array<asset.AssetMap> 表示添加操作的结果
*/
function queryAssetMap(query: asset.AssetMap): Array<asset.AssetMap> {

 const assetMaps: asset.AssetMap[] = [];

 try {

   if (canIUse("SystemCapability.Security.Asset")) {
     const res: asset.AssetMap[] = asset.querySync(query);
     return res;
   }

   return assetMaps;

 } catch (error) {

   const err = error as BusinessError;
   console.error(`Failed to query Asset. Code is ${err.code}, message is ${err.message}`);
   return assetMaps;

 }
}

3.6 updateSync 更新数据

/**
 * 查找数据
 * @param key  要查找的索引
 * @returns Array<asset.AssetMap> 表示添加操作的结果
 */
function queryAssetMap(query: asset.AssetMap): Array<asset.AssetMap> {

  const assetMaps: asset.AssetMap[] = [];

  try {

    if (canIUse("SystemCapability.Security.Asset")) {
      const res: asset.AssetMap[] = asset.querySync(query);
      return res;
    }

    return assetMaps;

  } catch (error) {

    const err = error as BusinessError;
    console.error(`Failed to query Asset. Code is ${err.code}, message is ${err.message}`);
    return assetMaps;

  }
}

使用到的其他函数

function stringToArray(str: string): Uint8Array {
  let textEncoder = new util.TextEncoder();
  return textEncoder.encodeInto(str);
}

function arrayToString(arr: Uint8Array): string {

  let textDecoder = util.TextDecoder.create('utf-8', { fatal: false, ignoreBOM: true });
  let decodeToStringOptions: util.DecodeToStringOptions = {
    stream: false
  }

  let str = textDecoder.decodeToString(arr, decodeToStringOptions);

  return str;
}

4、特别说明

如果需要卸载之后获取的值不变,需要设置IS_PERSISTENT属性,需要申请ohos.permission.STORE_PERSISTENT_DATA权限。

在这里插入图片描述

完整项目的结构如下:
在这里插入图片描述

5、参考

1、华为官网:@ohos.security.asset (关键资产存储服务)

2、冉冉同学:【HarmonyOS NEXT】获取卸载APP后不变的设备ID

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2268968.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

visual studio连接sql server数据库

目录 1、为什么要建立连接2、在sql server中建立数据库3、visual studio连接sql server数据库4、学生信息管理系统页面布局5、添加事件逻辑 5.1 页面跳转5.2 读取学生信息5.3 查询学生信息5.4 修改学生信息5.5 删除学生信息5.6 添加学生信息 bilibili演示视频 github源码 1、…

STM32-笔记23-超声波传感器HC-SR04

一、简介 HC-SR04 工作参数&#xff1a; • 探测距离&#xff1a;2~600cm • 探测精度&#xff1a;0.1cm1% • 感应角度&#xff1a;<15 • 输出方式&#xff1a;GPIO • 工作电压&#xff1a;DC 3~5.5V • 工作电流&#xff1a;5.3mA • 工作温度&#xff1a;-40~85℃ 怎么…

vuex - 第一天

思维逻辑 解决问题 代码能力2 vue2的项目 北京前端鸿蒙6期 语雀 vuex 在组件中使用 插件支持v2和v3 宏任务 和 微任务 多问问自己为什么 new的四步 查找数组里是否包含某个元素 同步任务、异步任务、微任务、宏任务

三大行业案例:AI大模型+Agent实践全景

本文将从AI Agent和大模型的发展背景切入&#xff0c;结合51Talk、哈啰出行以及B站三个各具特色的行业案例&#xff0c;带你一窥事件驱动架构、RAG技术、人机协作流程&#xff0c;以及一整套行之有效的实操方法。具体包含内容有&#xff1a;51Talk如何让智能客服“主动进攻”&a…

STM32G0B1 can Error_Handler 解决方法

问题现象 MCU上电&#xff0c;发送0x13帧数据固定进入 Error_Handler 硬件介绍 MCU :STM32G0B1 can:NSI1042 tx 接TX RX 接RX 折腾了一下午&#xff0c;无解&#xff0c;问题依旧&#xff1b; 对比测试 STM32G431 手头有块G431 官方评估版CAN 模块&#xff1b; 同样的…

【服务器】上传文件到服务器并训练深度学习模型下载服务器文件到本地

前言&#xff1a;本文教程为&#xff0c;上传文件到服务器并训练深度学习模型&#xff0c;与下载服务器文件到本地。演示指令输入&#xff0c;完整的上传文件到服务器&#xff0c;并训练模型过程&#xff1b;并演示完整的下载服务器文件到本地的过程。 本文使用的服务器为云服…

基于微博热搜评论的情感分析与热点主题挖掘研究

目录 1、绪论 1.1 研究背景与研究意义 1.2 数据来源 1.3 技术路线 2、数据预处理 2.1 数据清洗与准备 2.2 导入必要库与加载数据 2.3 加载停用词表与分词处理 2.4 统计词频与高频词分析 3、情感分析与主题建模 3.1 情感分析 3.2 主题建模 3.3 热点主题识别 4、数据可视…

“进制转换”公式大集合

咱们都知道十进制是“逢10进1 ”&#xff0c;同理&#xff0c;N进制就是 “逢N进1”。进制其实就这么简单。它的麻烦之处在于各种进制之间的转换。 一、十进制整数转N进制 1&#xff0e;十进制转二进制 除2取余法&#xff1a;连续除以2&#xff0c;直到商为0&#xff0c;逆序…

【React】- 跨域PDF预览、下载(改文件名)、打印

我们经常会碰到跨域来方位PDF&#xff0c;同时需要下载、打印的需求&#xff0c;通常由于浏览器的安全策略&#xff0c;可以预览&#xff0c;但是下载和打印可能会受限&#xff0c;这时候怎么办呢&#xff1f; 1.创建一个隐藏的标签 要下载 iframe 中的 PDF 文件&#xff0c;…

echarts 柱形图重叠柱形图legend,双y轴

echarts 图表组件&#xff1a; <template><div :style"{ height: 100% }"><div class"foldLine" ref"foldLine" :style"{ width: widths, height: heights }"></div></div> </template> <scr…

MySQL5.7主从同步配置

环境&#xff1a; 使用2台虚拟机&#xff0c;如图-1所示。其中192.168.4.51是主服务器,另一台192.168.4.52作为从服务器&#xff0c;通过调取主服务器上的binlog日志&#xff0c;在本地重做对应的库、表&#xff0c;实现与主服务器的数据同步。 主服务器、从服务器都已安装好m…

方正畅享全媒体新闻采编系统 imageProxy.do 任意文件读取漏洞复现

0x01 产品简介 方正畅享全媒体新闻生产系统是以内容资产为核心的智能化融合媒体业务平台,融合了报、网、端、微、自媒体分发平台等全渠道内容。该平台由协调指挥调度、数据资源聚合、融合生产、全渠道发布、智能传播分析、融合考核等多个平台组成,贯穿新闻生产策、采、编、发…

Ubuntu安装Apache Airflow详细指南

本文我们介绍如何在Ubuntu上安装Apache Airflow。Apache Airflow旨在通过编程方式编写、调度和监控工作流。随着数据编排在现代数据工程中变得越来越重要&#xff0c;掌握Apache Airflow等工具可以显著提高您的生产力和效率。 学习Apache Airflow的首要任务是安装单机版本进行测…

生物信息学软件开发综述学习

目录 ①编程语言和开源工具和库 ②轻量级 R 包开发 ③大规模组学软件开发 ④示例 1.轻量级 R 包开发示例及数据 2.大规模组学软件开发 文献&#xff1a;Bioinformatics software development: Principles and future directions ①编程语言和开源工具和库 在生物信息学…

哈夫曼编码(Huffman Coding)与哈夫曼树(Huffman Tree)

已知字符集{a,b,c,d,e,f}&#xff0c;若各字符出现的次数分别为6&#xff0c;3&#xff0c;8&#xff0c;2&#xff0c;10&#xff0c;4&#xff0c;则对应字符集中各字符的哈夫曼编码可能是&#xff08; &#xff09;。 A.00&#xff0c;1011&#xff0c;01&#xff0…

Eureka 介绍与原理详解

在微服务架构中&#xff0c;服务发现&#xff08;Service Discovery&#xff09;是一个至关重要的组件。随着服务数量的增加&#xff0c;手动管理服务的地址和端口变得不切实际。Eureka 是 Netflix 开源的一款服务发现工具&#xff0c;旨在解决微服务架构中的服务注册与发现问题…

C++和OpenGL实现3D游戏编程【连载19】——着色器光照初步(平行光和光照贴图)(附源码)

1、本节要实现的内容 我们在前期的教程中,讨论了在即时渲染模式下的光照内容。但在我们后期使用着色器的核心模式下,会经常在着色器中使光照,我们这里就讨论一下着色器光照效果,以及光照贴图效果,同时这里知识会为后期的更多光照效果做一些铺垫。本节我们首先讨论冯氏光照…

RedisDesktopManager新版本不再支持SSH连接远程redis后

背景 RedisDesktopManager(又名RDM)是一个用于Windows、Linux和MacOS的快速开源Redis数据库管理应用程序。这几天从新下载RedisDesktopManager最新版本&#xff0c;结果发现新版本开始不支持SSH连接远程redis了。 解决方案 第一种 根据网上有效的信息&#xff0c;可以回退版…

【图像处理lec10】图像压缩

目录 一、图像压缩基础 1、图像压缩的基本概念 2、数据冗余与压缩比 3、三种主要的数据冗余类型 4、保真度评估标准&#xff08;Fidelity Criteria&#xff09; 5、应用与实践 二、图像压缩模型 1、图像压缩模型概述 &#xff08;1&#xff09;压缩系统的结构 &#…

Python-网络爬虫

随着网络的迅速发展&#xff0c;如何有效地提取并利用信息已经成为一个巨大的挑战。为了更高效地获取指定信息&#xff0c;需定向抓取并分析网页资源&#xff0c;从而促进了网络爬虫的发展。本章将介绍使用Python编写网络爬虫的方法。 学习目标&#xff1a; 理解网络爬虫的基本…