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

加解密(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]删除密钥,具体请参考[密钥删除]。

复制代码
`HarmonyOS与OpenHarmony鸿蒙文档籽料: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)}`);
    })
}
相关推荐
一叶遮惊鸿2 小时前
从0开始搭建mcp
程序员
Python私教2 小时前
鸿蒙 NEXT 也能接 MCP?用 ArkTS 跑通 AI Agent 工具链
人工智能·华为·harmonyos
Duang3 小时前
我把 Claude、Codex、Copilot、Gemini 拼成了一个工作流,接力写代码
人工智能·程序员·架构
SimonKing4 小时前
别再死磕 Elasticsearch 了,这个轻量级搜索引擎更香
java·后端·程序员
Swift社区5 小时前
分布式能力在鸿蒙 PC 上到底怎么用?
分布式·华为·harmonyos
nashane14 小时前
HarmonyOS 6学习:外接键盘CapsLock与长截图功能的实战调试与完整解决方案
学习·华为·计算机外设·harmonyos
AI绘画哇哒哒20 小时前
Agent三种思考模式深度解析:CoT/ReAct/Plan-and-Execute,小白程序员必看,助你轻松掌握大模型精髓(收藏版)
人工智能·学习·ai·程序员·大模型·产品经理·转行
aqi001 天前
一文理清 HarmonyOS 6.0.2 涵盖的十个升级点
android·华为·harmonyos·鸿蒙·harmony
环信即时通讯云1 天前
环信Flutter UIKit适配鸿蒙实战指南
flutter·华为·harmonyos