0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

鸿蒙开发:Universal Keystore Kit 密钥管理服务 加解密ArkTS

jf_46214456 来源:jf_46214456 作者:jf_46214456 2024-07-09 09:30 次阅读

加解密(ArkTS)

以AES 128密钥为例,完成加解密。具体的场景介绍及支持的算法规格

开发步骤

生成密钥

  1. 指定密钥别名。
  2. 初始化密钥属性集。
  3. 调用[generateKeyItem]生成密钥,具体请参考[密钥生成]。
  4. 开发前请熟悉鸿蒙开发指导文档 :[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

除此之外,开发者也可以参考[密钥导入],导入已有的密钥。

加密

  1. 获取密钥别名。
  2. 获取待加密的数据。
  3. 获取加密[算法参数配置]。 在下方示例中,使用算法AES进行加密时,必须要选择其对应分组模式以及填充模式,用例中选取的分组模式为CBC、填充模式为PKCS7,此时必须要填参数IV。
  4. 调用[initSession]初始化密钥会话,并获取会话的句柄handle。
  5. 调用[finishSession]结束密钥会话,获取加密后的密文。

解密

  1. 获取密钥别名。
  2. 获取待解密的密文。
  3. 获取解密[算法参数配置]。 不同的解密算法需写入不同的参数配置,具体请参考[密钥生成支持的算法]。
    在下方示例中,使用算法AES进行解密时,必须要选择其对应分组模式以及填充模式,用例中选取的分组模式为CBC、填充模式为PKCS7,此时必须要填参数IV。
  4. 调用[initSession]初始化密钥会话,并获取会话的句柄handle。
  5. 调用[finishSession]结束密钥会话,获取解密后的数据。

删除密钥

当密钥废弃不用时,需要调用[deleteKeyItem]删除密钥,具体请参考[密钥删除]。

QQ截图20240705211052.png

`HarmonyOSOpenHarmony鸿蒙文档籽料:mau123789是v直接拿`

/*
 * 以下以AES 128密钥的Promise操作使用为例
 */
import { huks } from "@kit.UniversalKeystoreKit";
let aesKeyAlias = 'test_aesKeyAlias';
let handle:number;
let plainText = '123456';
let IV = '001122334455';
let cipherData:Uint8Array;
function StringToUint8Array(str: String) {
    let arr:number[]=new Array();
    for (let i = 0, j = str.length; i < j; ++i) {
        arr.push(str.charCodeAt(i));
    }
    return new Uint8Array(arr);
}
function Uint8ArrayToString(fileData:Uint8Array) {
    let dataString = '';
    for (let i = 0; i < fileData.length; i++) {
        dataString += String.fromCharCode(fileData[i]);
    }
    return dataString;
}
function GetAesGenerateProperties() {
    let properties: Array< huks.HuksParam > =[{
        tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
        value: huks.HuksKeyAlg.HUKS_ALG_AES
    }, {
        tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
        value: huks.HuksKeySize.HUKS_AES_KEY_SIZE_128
    }, {
        tag: huks.HuksTag.HUKS_TAG_PURPOSE,
        value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT |
        huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_DECRYPT
    }];
    return properties;
}
function GetAesEncryptProperties() {
    let properties: Array< huks.HuksParam > = [{
        tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
        value: huks.HuksKeyAlg.HUKS_ALG_AES
    }, {
        tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
        value: huks.HuksKeySize.HUKS_AES_KEY_SIZE_128
    }, {
        tag: huks.HuksTag.HUKS_TAG_PURPOSE,
        value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_ENCRYPT
    }, {
        tag: huks.HuksTag.HUKS_TAG_PADDING,
        value: huks.HuksKeyPadding.HUKS_PADDING_PKCS7
    }, {
        tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
        value: huks.HuksCipherMode.HUKS_MODE_CBC
    }, {
        tag: huks.HuksTag.HUKS_TAG_IV,
        value: StringToUint8Array(IV)
    }];
    return properties;
}
function GetAesDecryptProperties() {
    let properties: Array< huks.HuksParam > = [{
        tag: huks.HuksTag.HUKS_TAG_ALGORITHM,
        value: huks.HuksKeyAlg.HUKS_ALG_AES
    }, {
        tag: huks.HuksTag.HUKS_TAG_KEY_SIZE,
        value: huks.HuksKeySize.HUKS_AES_KEY_SIZE_128
    }, {
        tag: huks.HuksTag.HUKS_TAG_PURPOSE,
        value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_DECRYPT
    }, {
        tag: huks.HuksTag.HUKS_TAG_PADDING,
        value: huks.HuksKeyPadding.HUKS_PADDING_PKCS7
    }, {
        tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE,
        value: huks.HuksCipherMode.HUKS_MODE_CBC
    }, {
        tag: huks.HuksTag.HUKS_TAG_IV,
        value: StringToUint8Array(IV)
    }];
    return properties;
}
async function GenerateAesKey() {
    /*
    * 模拟生成密钥场景
    * 1. 确定密钥别名
    */
    /*
    * 2. 获取生成密钥算法参数配置
    */
    let genProperties = GetAesGenerateProperties();
    let options: huks.HuksOptions = {
        properties: genProperties
    }
    /*
    * 3. 调用generateKeyItem
    */
    await huks.generateKeyItem(aesKeyAlias, options)
    .then((data) = > {
        console.info(`promise: generate AES Key success, data = ${JSON.stringify(data)}`);
    }).catch((error: Error)= >{
        console.error(`promise: generate AES Key failed, ${JSON.stringify(error)}`);
    })
}
async function EncryptData() {
    /*
    * 模拟加密场景
    * 1. 获取密钥别名
    */
    /*
    * 2. 获取待加密的数据
    */
    /*
    * 3. 获取加密算法参数配置
    */
    let encryptProperties = GetAesEncryptProperties();
    let options: huks.HuksOptions = {
        properties: encryptProperties,
        inData: StringToUint8Array(plainText)
    }
    /*
    * 4. 调用initSession获取handle
    */
    await huks.initSession(aesKeyAlias, options)
    .then((data) = > {
        handle = data.handle;
    }).catch((error: Error)= >{
        console.error(`promise: init EncryptData failed, ${JSON.stringify(error)}`);
    })
    /*
    * 5. 调用finishSession获取加密后的密文
    */
    await huks.finishSession(handle, options)
    .then((data) = > {
        console.info(`promise: encrypt data success, data is `+ Uint8ArrayToString(data.outData as Uint8Array));
        cipherData = data.outData as Uint8Array;
    }).catch((error: Error)= >{
        console.error(`promise: encrypt data failed, ${JSON.stringify(error)}`);
    })
}
async function DecryptData() {
    /*
    * 模拟解密场景
    * 1. 获取密钥别名
    */
    /*
    * 2. 获取待解密的密文
    */
    /*
    * 3. 获取解密算法参数配置
    */
    let decryptOptions = GetAesDecryptProperties()
    let options: huks.HuksOptions = {
        properties: decryptOptions,
        inData: cipherData
    }
    /*
    * 4. 调用initSession获取handle
    */
    await huks.initSession(aesKeyAlias, options)
    .then((data) = > {
        handle = data.handle;
    }).catch((error: Error)= >{
        console.error(`promise: init DecryptData failed, ${JSON.stringify(error)}`);
    })
    /*
    * 5. 调用finishSession获取解密后的数据
    */
    await huks.finishSession(handle, options)
    .then((data) = > {
        console.info(`promise: decrypt data success, data is ` + Uint8ArrayToString(data.outData as Uint8Array));
    }).catch((error: Error)= >{
        console.error(`promise: decrypt data failed, ${JSON.stringify(error)}`);
    })
}
async function DeleteKey() {
    /*
    * 模拟删除密钥场景
    * 1. 获取密钥别名
    */
    let emptyOptions: huks.HuksOptions = {
        properties: []
    }
    /*
    * 2. 调用deleteKeyItem删除密钥
    */
    await huks.deleteKeyItem(aesKeyAlias, emptyOptions)
    .then((data) = > {
        console.info(`promise: delete data success`);
    }).catch((error: Error)= >{
        console.error(`promise: delete data failed, ${JSON.stringify(error)}`);
    })
}

审核编辑 黄宇

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 鸿蒙
    +关注

    关注

    57

    文章

    2339

    浏览量

    42805
收藏 人收藏

    评论

    相关推荐

    鸿蒙开发Universal Keystore Kit密钥管理服务简介

    Universal Keystore Kit密钥管理服务,下述简称为HUKS)向业务/应用提供
    的头像 发表于 07-04 14:20 435次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b>:<b class='flag-5'>Universal</b> <b class='flag-5'>Keystore</b> <b class='flag-5'>Kit</b><b class='flag-5'>密钥</b><b class='flag-5'>管理</b><b class='flag-5'>服务</b>简介

    鸿蒙开发Universal Keystore Kit密钥管理服务 通用密钥库基础概念

    在使用通用密钥库完成应用开发前,开发者需要了解以下相关概念,以下概念将贯穿整个开发过程。
    的头像 发表于 07-05 10:57 425次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b>:<b class='flag-5'>Universal</b> <b class='flag-5'>Keystore</b> <b class='flag-5'>Kit</b><b class='flag-5'>密钥</b><b class='flag-5'>管理</b><b class='flag-5'>服务</b> 通用<b class='flag-5'>密钥</b>库基础概念

    鸿蒙开发Universal Keystore Kit密钥管理服务 生成密钥ArkTS

    以生成DH密钥为例,生成随机密钥。具体的场景介绍及支持的算法规格
    的头像 发表于 07-05 15:17 316次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b>:<b class='flag-5'>Universal</b> <b class='flag-5'>Keystore</b> <b class='flag-5'>Kit</b><b class='flag-5'>密钥</b><b class='flag-5'>管理</b><b class='flag-5'>服务</b> 生成<b class='flag-5'>密钥</b><b class='flag-5'>ArkTS</b>

    鸿蒙开发Universal Keystore Kit密钥管理服务 密钥导入介绍及算法规格

    如果业务在HUKS外部生成密钥(比如应用间协商生成、服务器端生成),业务可以将密钥导入到HUKS中由HUKS进行管理密钥一旦导入到HUKS
    的头像 发表于 07-06 10:45 674次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b>:<b class='flag-5'>Universal</b> <b class='flag-5'>Keystore</b> <b class='flag-5'>Kit</b><b class='flag-5'>密钥</b><b class='flag-5'>管理</b><b class='flag-5'>服务</b> <b class='flag-5'>密钥</b>导入介绍及算法规格

    鸿蒙开发Universal Keystore Kit密钥管理服务 明文导入密钥 ArkTS

    分别以导入AES256与RSA2048密钥为例,具体的场景介绍及支持的算法规格
    的头像 发表于 07-08 10:22 375次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b>:<b class='flag-5'>Universal</b> <b class='flag-5'>Keystore</b> <b class='flag-5'>Kit</b><b class='flag-5'>密钥</b><b class='flag-5'>管理</b><b class='flag-5'>服务</b> 明文导入<b class='flag-5'>密钥</b> <b class='flag-5'>ArkTS</b>

    鸿蒙开发Universal Keystore Kit 密钥管理服务 加密导入密钥 ArkTS

    以加密导入ECDH密钥对为例,涉及业务侧加密密钥的[密钥生成]、[协商])等操作不在本示例中体现。
    的头像 发表于 07-08 14:22 357次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b>:<b class='flag-5'>Universal</b> <b class='flag-5'>Keystore</b> <b class='flag-5'>Kit</b> <b class='flag-5'>密钥</b><b class='flag-5'>管理</b><b class='flag-5'>服务</b> 加密导入<b class='flag-5'>密钥</b> <b class='flag-5'>ArkTS</b>

    鸿蒙开发Universal Keystore Kit 密钥管理服务 密钥协商ArkTS

    以协商密钥类型为X25519 256,并密钥仅在HUKS内使用为例,完成密钥协商。
    的头像 发表于 07-10 09:22 317次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b>:<b class='flag-5'>Universal</b> <b class='flag-5'>Keystore</b> <b class='flag-5'>Kit</b> <b class='flag-5'>密钥</b><b class='flag-5'>管理</b><b class='flag-5'>服务</b> <b class='flag-5'>密钥</b>协商<b class='flag-5'>ArkTS</b>

    鸿蒙开发Universal Keystore Kit 密钥管理服务 密钥协商 C、C++

    以协商密钥类型为ECDH,并密钥仅在HUKS内使用为例,完成密钥协商。具体的场景介绍及支持的算法规格,请参考[密钥生成支持的算法]。
    的头像 发表于 07-10 14:27 347次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b>:<b class='flag-5'>Universal</b> <b class='flag-5'>Keystore</b> <b class='flag-5'>Kit</b> <b class='flag-5'>密钥</b><b class='flag-5'>管理</b><b class='flag-5'>服务</b> <b class='flag-5'>密钥</b>协商 C、C++

    鸿蒙开发Universal Keystore Kit密钥管理服务 密钥派生C、C++

    以HKDF256密钥为例,完成密钥派生。具体的场景介绍及支持的算法规格,请参考[密钥生成支持的算法]。
    的头像 发表于 07-11 14:28 287次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b>:<b class='flag-5'>Universal</b> <b class='flag-5'>Keystore</b> <b class='flag-5'>Kit</b><b class='flag-5'>密钥</b><b class='flag-5'>管理</b><b class='flag-5'>服务</b> <b class='flag-5'>密钥</b>派生C、C++

    鸿蒙开发Universal Keystore Kit 密钥管理服务 HMAC ArkTS

    HMAC是密钥相关的哈希运算消息认证码(Hash-based Message Authentication Code),是一种基于Hash函数和密钥进行消息认证的方法。
    的头像 发表于 07-12 18:22 631次阅读

    鸿蒙开发Universal Keystore Kit密钥管理服务 密钥删除ArkTS

    为保证数据安全性,当不需要使用该密钥时,应该删除密钥
    的头像 发表于 07-12 14:56 293次阅读

    鸿蒙开发Universal Keystore Kit密钥管理服务 密钥删除C C++

    为保证数据安全性,当不需要使用该密钥时,应该删除密钥
    的头像 发表于 07-18 15:47 289次阅读

    鸿蒙开发Universal Keystore Kit 密钥管理服务 获取密钥属性ArkTS

    HUKS提供了接口供业务获取指定密钥的相关属性。在获取指定密钥属性前,需要确保已在HUKS中生成或导入持久化存储的密钥
    的头像 发表于 07-17 10:46 305次阅读

    鸿蒙开发Universal Keystore Kit 密钥管理服务 获取密钥属性C C++

    HUKS提供了接口供业务获取指定密钥的相关属性。在获取指定密钥属性前,需要确保已在HUKS中生成或导入持久化存储的密钥
    的头像 发表于 07-17 09:47 360次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b>:<b class='flag-5'>Universal</b> <b class='flag-5'>Keystore</b> <b class='flag-5'>Kit</b> <b class='flag-5'>密钥</b><b class='flag-5'>管理</b><b class='flag-5'>服务</b> 获取<b class='flag-5'>密钥</b>属性C C++

    鸿蒙开发Universal Keystore Kit 密钥管理服务 查询密钥别名集 ArkTS

    HUKS提供了接口供应用查询密钥别名集。
    的头像 发表于 07-18 09:34 339次阅读