{"_id":"@bingtang-rn/react-native-aes-gcm-crypto","_rev":"2-8879e9c5b33753d58f13628f8cc721b5","name":"@bingtang-rn/react-native-aes-gcm-crypto","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@bingtang-rn/react-native-aes-gcm-crypto","version":"1.0.0","keywords":["react-native","harmony","harmonyos","react-native-aes-gcm-crypto"],"license":"MIT","_id":"@bingtang-rn/react-native-aes-gcm-crypto@1.0.0","maintainers":[{"name":"luyizouyuan","email":"189605613@qq.com"}],"homepage":"https://gitcode.com/rn_ohos_plugin/react_native_aes_gcm_crypto","dist":{"shasum":"14ebbc04865b4f1e85b77406299714eeb498bd48","tarball":"https://registry.npmjs.org/@bingtang-rn/react-native-aes-gcm-crypto/-/react-native-aes-gcm-crypto-1.0.0.tgz","fileCount":42,"integrity":"sha512-R3CSaS78PSUsEGrMphufZrK8cQgAqm5ZN9bwiLZHAeIMlfYckbyS6/xxv578BQfkfBJoPjhZdh3tq/+vytZbPw==","signatures":[{"sig":"MEQCIDBA1uPCIOORDzcDExcmPe/co7AyWFp5ydEdwC4406WlAiB9yFd4ZXnFPOIxLR9wGfLvpcB/vWLmcp0Z3fyVdTGXNQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":59008},"main":"./src/index.tsx","module":"./src/index.tsx","engines":{"node":">=18"},"gitHead":"1c5233aa4c225cf6761f41d03eb925fbf43c9926","harmony":{"alias":"react-native-aes-gcm-crypto","autolinking":{"ohPackageName":"@oh-rn/react-native-aes-gcm-crypto","cppPackageClassName":"AesGcmCryptoPackage","etsPackageClassName":"AesGcmCryptoPackage","cmakeLibraryTargetName":"aes_gcm_crypto"},"codegenConfig":[{"version":1,"specPaths":["./src/specs/v1"]},{"version":2,"specPaths":["./src/specs/v2"]}]},"private":false,"scripts":{"prepare":"echo skip","codegen-lib":"react-native codegen-harmony --cpp-output-path ./harmony/aes_gcm_crypto/src/main/cpp/generated --ets-output-path ./harmony/aes_gcm_crypto/src/main/ets/generated"},"_npmUser":{"name":"luyizouyuan","email":"189605613@qq.com"},"repository":{"url":"https://gitcode.com/rn_ohos_plugin/react_native_aes_gcm_crypto","type":"git"},"_npmVersion":"11.12.1","description":"适配鸿蒙版本，提供react_native_aes_gcm_crypto组件。","directories":{},"_nodeVersion":"24.15.0","react-native":"./src/index.tsx","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.6.3","metro":"^0.81.0","react":"18.2.0","typescript":"5.0.4","@types/react":"18.2.79","react-native":"0.72.5","@react-native/typescript-config":"0.79.5","@react-native-oh/react-native-harmony-cli":"^0.77.50"},"peerDependencies":{"react-native":">=0.72"},"_npmOperationalInternal":{"tmp":"tmp/react-native-aes-gcm-crypto_1.0.0_1785999756896_0.48727533966547654","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"_id":"@bingtang-rn/react-native-aes-gcm-crypto@1.0.1","dist":{"shasum":"7ea76feb8110f1a62041bb4fa89ac20a95876ee1","tarball":"https://registry.npmjs.org/@bingtang-rn/react-native-aes-gcm-crypto/-/react-native-aes-gcm-crypto-1.0.1.tgz","fileCount":42,"integrity":"sha512-xe7WeYBkLXCG6U/wZXOkmvF0bNUSaetQytvc+F8b0k6/hgy1vnFQmhAOOarAW5P9KO1JDXgGLPz7pxwRqDp06A==","signatures":[{"sig":"MEUCIQDvNlLieIlS3sho92sPfq389MPHlIxUczI/grjru3LROQIgZmHm8pAkB9IFCdLwj0WypQE9105FhrjyUm8m2uDZY6g=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIF6Cvfs+vj91AgeVzFcu2u5hcbJRTbLW97cZhKYFASMvAiEAn6750sV9N6E1tqP3Hi+2isL/WIzYaZrMdCL0PSRcoUI="}],"unpackedSize":58968},"main":"./src/index.tsx","name":"@bingtang-rn/react-native-aes-gcm-crypto","_from":"file:bingtang-rn-react-native-aes-gcm-crypto-1.0.1.tgz","module":"./src/index.tsx","engines":{"node":">=18"},"harmony":{"alias":"react-native-aes-gcm-crypto","autolinking":{"ohPackageName":"@bingtang-rn/react-native-aes-gcm-crypto","cppPackageClassName":"AesGcmCryptoPackage","etsPackageClassName":"AesGcmCryptoPackage","cmakeLibraryTargetName":"aes_gcm_crypto"},"codegenConfig":[{"version":1,"specPaths":["./src/specs/v1"]},{"version":2,"specPaths":["./src/specs/v2"]}]},"license":"MIT","private":false,"scripts":{"prepare":"echo skip","codegen-lib":"react-native codegen-harmony --cpp-output-path ./harmony/aes_gcm_crypto/src/main/cpp/generated --ets-output-path ./harmony/aes_gcm_crypto/src/main/ets/generated"},"version":"1.0.1","_npmUser":{"name":"luyizouyuan","email":"189605613@qq.com"},"homepage":"https://gitcode.com/rn_ohos_plugin/react_native_aes_gcm_crypto","keywords":["react-native","harmony","harmonyos","react-native-aes-gcm-crypto"],"_resolved":"D:\\code\\rn\\npm\\batch\\react_native_aes_gcm_crypto\\bingtang-rn-react-native-aes-gcm-crypto-1.0.1.tgz","_integrity":"sha512-xe7WeYBkLXCG6U/wZXOkmvF0bNUSaetQytvc+F8b0k6/hgy1vnFQmhAOOarAW5P9KO1JDXgGLPz7pxwRqDp06A==","repository":{"url":"https://gitcode.com/rn_ohos_plugin/react_native_aes_gcm_crypto","type":"git"},"_npmVersion":"11.12.1","description":"适配鸿蒙版本，提供react_native_aes_gcm_crypto组件。","directories":{},"maintainers":[{"name":"luyizouyuan","email":"189605613@qq.com"}],"_nodeVersion":"24.15.0","react-native":"./src/index.tsx","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.6.3","metro":"^0.81.0","react":"18.2.0","typescript":"5.0.4","@types/react":"18.2.79","react-native":"0.72.5","@react-native/typescript-config":"0.79.5","@react-native-oh/react-native-harmony-cli":"^0.77.50"},"peerDependencies":{"react-native":">=0.72"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/react-native-aes-gcm-crypto_1.0.1_1790568437648_0.25909830509167064"}}},"time":{"created":"2026-08-06T07:02:36.717Z","modified":"2026-09-28T04:07:17.934Z","1.0.0":"2026-08-06T07:02:37.042Z","1.0.1":"2026-09-28T04:07:17.748Z"},"license":"MIT","homepage":"https://gitcode.com/rn_ohos_plugin/react_native_aes_gcm_crypto","keywords":["react-native","harmony","harmonyos","react-native-aes-gcm-crypto"],"repository":{"url":"https://gitcode.com/rn_ohos_plugin/react_native_aes_gcm_crypto","type":"git"},"description":"适配鸿蒙版本，提供react_native_aes_gcm_crypto组件。","maintainers":[{"name":"luyizouyuan","email":"189605613@qq.com"}],"readme":"# @bingtang-rn/react-native-aes-gcm-crypto for HarmonyOS\r\n\r\n本项目基于 [react-native-aes-gcm-crypto](https://github.com/craftzdog/react-native-aes-gcm-crypto) 开发，为 React Native 鸿蒙（OpenHarmony）适配版本。如果在使用过程中有任何问题，可以在GitCode提Issue，会及时跟进。issue地址：[issues](https://gitcode.com/rn_ohos_plugin/react_native_aes_gcm_crypto/issues)。\r\n\r\n## 版本对应关系\r\n\r\n| 鸿蒙适配包版本 | 原始库版本 | 支持 RN 版本 | Autolink | 编译 API 版本 |\r\n| ------------ | ---------- | ------------ | -------- | ------------- |\r\n| 见发布记录 | 0.2.2 | 0.72+ | 是 | API17+ |\r\n\r\n## 安装\r\n\r\n```bash\r\nnpm install @bingtang-rn/react-native-aes-gcm-crypto\r\n```\r\n\r\n## 使用\r\n\r\n```tsx\r\nimport AesGcmCrypto from 'react-native-aes-gcm-crypto';\r\n\r\n// 加密文本\r\nconst encrypted = await AesGcmCrypto.encrypt('Hello World', false, base64Key);\r\n// encrypted: { iv: hex, tag: hex, content: base64 }\r\n\r\n// 解密文本\r\nconst decrypted = await AesGcmCrypto.decrypt(\r\n encrypted.content, base64Key, encrypted.iv, encrypted.tag, false\r\n);\r\n// decrypted: 'Hello World'\r\n\r\n// 加密文件（HarmonyOS）\r\nconst fileResult = await AesGcmCrypto.encryptFile(inputPath, outputPath, base64Key);\r\n// fileResult: { iv: hex, tag: hex }\r\n\r\n// 解密文件（HarmonyOS）\r\nconst success = await AesGcmCrypto.decryptFile(\r\n encPath, decPath, base64Key, fileResult.iv, fileResult.tag\r\n);\r\n// success: true\r\n```\r\n\r\n> import 时使用原库名 `'react-native-aes-gcm-crypto'`，而非鸿蒙包名。\r\n\r\n**平台差异**：\r\n- `encryptFile` / `decryptFile` 仅在 HarmonyOS 平台可用，需要应用沙箱路径中的文件\r\n\r\n**权限要求**：\r\n- 无需额外权限（`cryptoFramework` 和应用沙箱内 `fileIo` 均不需要权限声明）\r\n\r\n## Link\r\n\r\n| 版本 | 是否支持 Autolink |\r\n|------|------------------|\r\n| 当前版本 | 是 |\r\n\r\n如使用版本支持 Autolink 且工程已接入，可跳过手动配置。\r\n\r\n\r\nManual Link 配置
\r\n\r\n> **说明**：本模块需要同时在 C++ 侧和 ETS 侧注册 Package。\r\n\r\n### 1. Overrides RN SDK\r\n\r\n在工程根目录 `oh-package.json5` 添加：\r\n\r\n```json\r\n{\r\n \"overrides\": {\r\n \"@rnoh/react-native-openharmony\": \"./react_native_openharmony\"\r\n }\r\n}\r\n```\r\n\r\n### 2. 引入原生端依赖\r\n\r\n打开 `entry/oh-package.json5`，添加：\r\n\r\n```json\r\n\"dependencies\": {\r\n \"@bingtang-rn/react-native-aes-gcm-crypto\": \"file:../../node_modules/@bingtang-rn/react-native-aes-gcm-crypto/harmony/aes_gcm_crypto.har\"\r\n}\r\n```\r\n\r\n执行 `ohpm install`。\r\n\r\n### 3. 配置 CMakeLists\r\n\r\n打开 `entry/src/main/cpp/CMakeLists.txt`，添加：\r\n\r\n```cmake\r\nset(OH_MODULES \"${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules\")\r\n\r\nadd_subdirectory(\"${OH_MODULES}/@bingtang-rn/react-native-aes-gcm-crypto/src/main/cpp\" ./aes_gcm_crypto)\r\n\r\ntarget_link_libraries(rnoh_app PUBLIC aes_gcm_crypto)\r\n```\r\n\r\n### 4. 注册 Package（C++ 侧）\r\n\r\n打开 `entry/src/main/cpp/PackageProvider.cpp`，添加：\r\n\r\n```cpp\r\n#include \"AesGcmCryptoPackage.h\"\r\n\r\nstd::vector> PackageProvider::getPackages(Package::Context ctx) {\r\n return {\r\n std::make_shared(ctx),\r\n };\r\n}\r\n```\r\n\r\n### 5. 注册 Package（ETS 侧）\r\n\r\n打开 `entry/src/main/ets/RNPackagesFactory.ets`，添加：\r\n\r\n```typescript\r\nimport { AesGcmCryptoPackage } from '@bingtang-rn/react-native-aes-gcm-crypto/ts';\r\n\r\nexport function createRNPackages(ctx: RNPackageContext): RNPackage[] {\r\n return [\r\n new AesGcmCryptoPackage(ctx),\r\n ];\r\n}\r\n```\r\n\r\n \r\n\r\n## 属性 / API\r\n\r\n| API | 描述 | 参数 | 返回值 | HarmonyOS 支持 |\r\n|-----|------|------|--------|----------------|\r\n| encrypt | 加密文本或二进制数据 | plainText: string, inBinary: boolean, key: string | Promise\\<{ iv: string, tag: string, content: string }\\> | ✅ 完全支持 |\r\n| decrypt | 解密密文 | base64Ciphertext: string, key: string, iv: string, tag: string, isBinary: boolean | Promise\\ | ✅ 完全支持 |\r\n| encryptFile | 加密文件 | inputFilePath: string, outputFilePath: string, key: string | Promise\\<{ iv: string, tag: string }\\> | ✅ 完全支持 |\r\n| decryptFile | 解密文件 | inputFilePath: string, outputFilePath: string, key: string, iv: string, tag: string | Promise\\ | ✅ 完全支持 |\r\n\r\n### 平台差异\r\n- AES-GCM 算法字符串：HarmonyOS 使用 `'AES128|GCM|PKCS7'`，Android 使用 `\"AES/GCM/NoPadding\"`，行为等价\r\n- GCM 参数：HarmonyOS `GcmParamsSpec` 要求显式传入 `aad`（可传空 `Uint8Array`），与原库未使用 aad 的行为一致\r\n- `authTag` 固定 16 字节（128 位），与原库 Android 端 `GCM_TAG_LENGTH = 16` 一致\r\n- 文件路径：`encryptFile` / `decryptFile` 需使用 HarmonyOS 应用沙箱路径（如 `/data/storage/el2/base/files/`）\r\n\r\n### 未实现功能\r\n无\r\n\r\n### 使用限制\r\n- 密钥为 Base64 编码的 128-bit AES 密钥（16 字节解码后）\r\n- IV 为 12 字节随机生成，输出为 hex 编码\r\n- authTag 为 16 字节，输出为 hex 编码\r\n- 密文 content 为 Base64 编码\r\n\r\n## 快速验证（运行 Example）\r\n\r\n### 前置条件\r\n\r\n| 依赖 | 版本要求 |\r\n|------|----------|\r\n| Node.js | >= 18 |\r\n| DevEco Studio | 5.0+ / 6.0+ |\r\n| HarmonyOS SDK | API 17+ |\r\n\r\n### 运行步骤\r\n\r\n**1. 克隆仓库**\r\n\r\n```bash\r\ngit clone <仓库地址>\r\ncd <仓库目录>\r\n```\r\n\r\n**2. 安装依赖并构建**\r\n\r\n```bash\r\nnpm install --legacy-peer-deps\r\nnpm pack # 生成 tgz 包（会自动触发 prepare 构建 JS 产物）\r\n```\r\n\r\n**3. 进入 example 目录，安装依赖**\r\n\r\n```bash\r\ncd example\r\nnpm install --legacy-peer-deps\r\n```\r\n\r\n**4. 生成 JS Bundle**\r\n\r\n```bash\r\nnpm run dev\r\n```\r\n\r\n产物：`harmony/entry/src/main/resources/rawfile/bundle.harmony.js`\r\n\r\n**5. 用 DevEco Studio 打开鸿蒙工程**\r\n\r\n- 打开 DevEco Studio\r\n- 选择 `example/harmony` 目录\r\n- 等待 Sync 完成\r\n\r\n**6. 编译并运行 HAP**\r\n\r\n在 DevEco Studio 中点击运行按钮，将 HAP 安装到设备/模拟器。\r\n\r\n> **注意**：Example 中已预置插件依赖和 Package 注册，无需手动配置 Link。\r\n\r\n## 约束与限制\r\n\r\n### 兼容性\r\n\r\n- RNOH: 0.72+\r\n- HarmonyOS SDK: API 17+\r\n- DevEco Studio: 5.0+\r\n\r\n## 遗留问题\r\n\r\n无\r\n\r\n## 开源协议\r\n\r\n本项目基于 MIT 协议，详见 [LICENSE](./LICENSE) 文件。\r\n","readmeFilename":"README.md"}