@bingtang-rn/react-native-aes-gcm-crypto for HarmonyOS

本项目基于 react-native-aes-gcm-crypto 开发，为 React Native 鸿蒙（OpenHarmony）适配版本。如果在使用过程中有任何问题，可以在GitCode提Issue，会及时跟进。issue地址：issues。

版本对应关系

| 鸿蒙适配包版本 | 原始库版本 | 支持 RN 版本 | Autolink | 编译 API 版本 | | ------------ | ---------- | ------------ | -------- | ------------- | | 见发布记录 | 0.2.2 | 0.72+ | 是 | API17+ |

安装

npm install @bingtang-rn/react-native-aes-gcm-crypto

使用

import AesGcmCrypto from 'react-native-aes-gcm-crypto';

// 加密文本
const encrypted = await AesGcmCrypto.encrypt('Hello World', false, base64Key);
// encrypted: { iv: hex, tag: hex, content: base64 }

// 解密文本
const decrypted = await AesGcmCrypto.decrypt(
  encrypted.content, base64Key, encrypted.iv, encrypted.tag, false
);
// decrypted: 'Hello World'

// 加密文件（HarmonyOS）
const fileResult = await AesGcmCrypto.encryptFile(inputPath, outputPath, base64Key);
// fileResult: { iv: hex, tag: hex }

// 解密文件（HarmonyOS）
const success = await AesGcmCrypto.decryptFile(
  encPath, decPath, base64Key, fileResult.iv, fileResult.tag
);
// success: true

import 时使用原库名 'react-native-aes-gcm-crypto'，而非鸿蒙包名。

平台差异：

• encryptFile / decryptFile 仅在 HarmonyOS 平台可用，需要应用沙箱路径中的文件

权限要求：

• 无需额外权限（cryptoFramework 和应用沙箱内 fileIo 均不需要权限声明）

Link

| 版本 | 是否支持 Autolink | |------|------------------| | 当前版本 | 是 |

如使用版本支持 Autolink 且工程已接入，可跳过手动配置。

说明：本模块需要同时在 C++ 侧和 ETS 侧注册 Package。

1. Overrides RN SDK

在工程根目录 oh-package.json5 添加：

{
  "overrides": {
    "@rnoh/react-native-openharmony": "./react_native_openharmony"
  }
}

2. 引入原生端依赖

打开 entry/oh-package.json5，添加：

"dependencies": {
  "@bingtang-rn/react-native-aes-gcm-crypto": "file:../../node_modules/@bingtang-rn/react-native-aes-gcm-crypto/harmony/aes_gcm_crypto.har"
}

执行 ohpm install。

3. 配置 CMakeLists

打开 entry/src/main/cpp/CMakeLists.txt，添加：

set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")

add_subdirectory("${OH_MODULES}/@bingtang-rn/react-native-aes-gcm-crypto/src/main/cpp" ./aes_gcm_crypto)

target_link_libraries(rnoh_app PUBLIC aes_gcm_crypto)

4. 注册 Package（C++ 侧）

打开 entry/src/main/cpp/PackageProvider.cpp，添加：

#include "AesGcmCryptoPackage.h"

std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
    return {
        std::make_shared<AesGcmCryptoPackage>(ctx),
    };
}

5. 注册 Package（ETS 侧）

打开 entry/src/main/ets/RNPackagesFactory.ets，添加：

import { AesGcmCryptoPackage } from '@bingtang-rn/react-native-aes-gcm-crypto/ts';

export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
  return [
    new AesGcmCryptoPackage(ctx),
  ];
}

属性 / API

| API | 描述 | 参数 | 返回值 | HarmonyOS 支持 | |-----|------|------|--------|----------------| | encrypt | 加密文本或二进制数据 | plainText: string, inBinary: boolean, key: string | Promise<{ iv: string, tag: string, content: string }> | ✅ 完全支持 | | decrypt | 解密密文 | base64Ciphertext: string, key: string, iv: string, tag: string, isBinary: boolean | Promise<string> | ✅ 完全支持 | | encryptFile | 加密文件 | inputFilePath: string, outputFilePath: string, key: string | Promise<{ iv: string, tag: string }> | ✅ 完全支持 | | decryptFile | 解密文件 | inputFilePath: string, outputFilePath: string, key: string, iv: string, tag: string | Promise<boolean> | ✅ 完全支持 |

平台差异

• AES-GCM 算法字符串：HarmonyOS 使用 'AES128|GCM|PKCS7'，Android 使用 "AES/GCM/NoPadding"，行为等价
• GCM 参数：HarmonyOS GcmParamsSpec 要求显式传入 aad（可传空 Uint8Array），与原库未使用 aad 的行为一致
• authTag 固定 16 字节（128 位），与原库 Android 端 GCM_TAG_LENGTH = 16 一致
• 文件路径：encryptFile / decryptFile 需使用 HarmonyOS 应用沙箱路径（如 /data/storage/el2/base/files/）

未实现功能

无

使用限制

• 密钥为 Base64 编码的 128-bit AES 密钥（16 字节解码后）
• IV 为 12 字节随机生成，输出为 hex 编码
• authTag 为 16 字节，输出为 hex 编码
• 密文 content 为 Base64 编码

快速验证（运行 Example）

前置条件

| 依赖 | 版本要求 | |------|----------| | Node.js | >= 18 | | DevEco Studio | 5.0+ / 6.0+ | | HarmonyOS SDK | API 17+ |

运行步骤

1. 克隆仓库

git clone <仓库地址>
cd <仓库目录>

2. 安装依赖并构建

npm install --legacy-peer-deps
npm pack           # 生成 tgz 包（会自动触发 prepare 构建 JS 产物）

3. 进入 example 目录，安装依赖

cd example
npm install --legacy-peer-deps

4. 生成 JS Bundle

npm run dev

产物：harmony/entry/src/main/resources/rawfile/bundle.harmony.js

5. 用 DevEco Studio 打开鸿蒙工程

• 打开 DevEco Studio
• 选择 example/harmony 目录
• 等待 Sync 完成

6. 编译并运行 HAP

在 DevEco Studio 中点击运行按钮，将 HAP 安装到设备/模拟器。

注意：Example 中已预置插件依赖和 Package 注册，无需手动配置 Link。

约束与限制

兼容性

• RNOH: 0.72+
• HarmonyOS SDK: API 17+
• DevEco Studio: 5.0+

遗留问题

无

开源协议

本项目基于 MIT 协议，详见 LICENSE 文件。