# @govtechsg/oa-encryption 中文文档

规范地址：https://npmcn.com/package/%40govtechsg/oa-encryption/

版本：1\.3\.5
npm 元数据更新时间：2026-07-03T07:14:50.667Z
中文译文更新时间：2026-11-17T03:32:49.999Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40govtechsg/oa-encryption
原文对照：https://npmcn.com/package/%40govtechsg/oa-encryption/?lang=original
项目主页：https://github.com/Open-Attestation/oa-encryption#readme
源码仓库：https://github.com/Open-Attestation/oa-encryption

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：34.2 kB，12 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2019-12-05T06:41:08.812Z
- 最新版本发布：2022-06-14T04:28:34.175Z
- 近 30 天下载量：7452（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

管理 oa 加密文件传输的共享库

## 安装

```sh
npm install @govtechsg/oa-encryption
```

也可以使用：`pnpm add @govtechsg/oa-encryption`、`yarn add @govtechsg/oa-encryption`、`bun add @govtechsg/oa-encryption`

## README

# 打开验证( 复制)

这个 [打开验证( 复制)](https://github.com/Open-Attestation/oa-encryption) 仓库是 npm 模块的代码库,允许您加密文档,以便共享和安全存储.

此模块不提供以下功能:

-   对 OA 文档进行程序包装(参见 [打开证明](https://www.openattestation.com/docs/developer-section/libraries/remote-files/open-attestation#wrapping-documents)(中文(简体) )
-   对OA文件进行程序核查(参见 [打开验证( 验证)](https://www.openattestation.com/docs/developer-section/libraries/remote-files/open-attestation-verify)(中文(简体) )
-   在Ethereum区块链上按程序印发/撤销文件

此库用于加密在中转中的 OpenAttestation 文件

## 安装

```bash
npm i @govtechsg/oa-encryption
```

* * *

## 使用量

### 加密文档

```javascript
const { encryptString } = require("@govtechsg/oa-encryption");

const document = {
  version: "https://schema.openattestation.com/2.0/schema.json",
  data: {
    issuers: [
      {
        documentStore: "5924d910-8916-446a-b1c3-55e2f86dd8f3:string:0xabcdabcdabcdabcdabcdabcdabcdabcdabcdabcd",
        name: "0f737b20-9e5e-4ec4-bffd-c63002616bfd:string:University of Blockchain",
        identityProof: {
          type: "5fc379dd-cd24-4c91-a4c7-cf76f9c96d8d:string:DNS-TXT",
          location: "62e1c6c3-09a9-4e52-aaf6-9daf24d43657:string:example.com",
        },
      },
    ],
  },
  privacy: { obfuscatedData: [] },
  signature: {
    type: "SHA3MerkleProof",
    targetHash: "956e27c86d4893a971600d328e235ede886f1c00b183257a822667b69886fced",
    proof: [],
    merkleRoot: "956e27c86d4893a971600d328e235ede886f1c00b183257a822667b69886fced",
  },
};

const encryptedDocument = encryptString(JSON.stringify(document));
console.log(encryptedDocument);
```

将显示类似的东西( 当您运行时, 值会不同 ) :

```javascript
{
  cipherText:
   'S7jca6lGDvN3ZDsPX4xc+6zLCkvRN1b1g6b0LL/IHiWn9c4JmIdmfg7fMd98fehkPMlkvScYn1/XI9ZoYA6NRjf61Kpam2A0Dx7kBR866TW+Stzbbb4AAqoXm0GX3BBvPgjhQCoGS9vJBkD0coK+DCO0Vrcdptuo2io3/zbBD6GbE5zLhnqizLrLO+RffnCeJ6LFYSUbAwBvSJv+OnNJjf+99ejaT3zKZNLB+NSu1WNG23nyzJoeYgEqg/E7i5jhD5+pZ8FvGsVQ2hM4zrnw5CvC8AfnRkR5KUEpJ4A0XJly3gQnCBN2HtIEHRmxBgPOnM2Mcm/mNVct2tqogrfyksXrLqS2YvYAEP9uGmSu3/iP2aTzS5xqiBg0UedFVQcc3cEjzaI4lXWa5t+cjzS08pssN2lT55WHsLo/XqVSTMx4/nekDl1SVm6wpfHl2htvhxvGiUF9F1tS7VpoE/+OMS7fCPkncmPKMpuUmWN79KhZS+/R0wM1sB7+HYTulYIZ3Z/vxX1YuNFSR0V6lCsVavl4tV9IhA9PvQPvmKDSyJyrD+v4AUrtEgnvyEPttfHW2MqJGGK6w9sUB3It2OvHQVXmAtVJgqpuP6cZwMlswQWfJfcjkfxWnQGCJtsCXhc7qePwxuL3C74QTFkKQcrGLGoMNcSTV5xhPxtg7zBocVs689RJkbjirhBOJajlY4NwplFga7qgyNA6yYI2BamX4fRaMq1XEuYRo8+d2kiJXSQSTEaUNQuIIsO3Nd+u8p/Dapw0xZBeyqj1Ys1N4aPFlx26OigiabXpwQNxH+ioaceU4LUsjCmF+MsPuxi3L0HLIsnvqy1LgffOswih+hqaqjHdpOMlpLcwQziD47HSOmW83jPezEEaWwiSH5eYYy4JwgsatCc+hCJEB8A8PXG1aSdRTRg+nqZQlJ4ONs+C55Svdj+6K+mdtK21qpQBIOOZjxMztubv/0/BETbPp8HDtaZdS80uLwXSNWAaf2dnbaNQkAW3idHYTgi8375FRr63/TUIeoo9Wh4YHTyjlEay/+CBokN0zREGQMaXKS/TEGxsdOIjsJjR8URyPBVFIhHNXcN1RQnxcD0WU+JvsheaoFLs/x1ITc7E',
  iv: 'TG47WMwppeS9oICk',
  tag: 'Iox0laR51y8czUw8Yx6mGQ==',
  key:
   '04d49fe8ac0a0afa5e9e2fa617551b5d7be532d0c8586a0809d7d223316d7cc5',
  type: 'OPEN-ATTESTATION-TYPE-1'
}
```

加密文档中的密钥可以被取出,其余的文档可以被存储在任何地方. 要解密文档, 需要密钥, 您的文件内容是安全的 .

### 解密文档

```javascript
const { decryptString } = require("@govtechsg/oa-encryption");

const encryptedDocument = {
  cipherText:
    "H/smVRcwLrv7KzeMtHVYAxouaO+aaEm1jxXMw5fvHJSj3dszKK76ap17rPSa/JpiNEMXFn5pCBqnmfbveuRhjHcxKvKVSyMlbh6R+zFoge0VPwP6KDsKat/39FQddfXbbaoDz+B1vFoTc2hWFQw/IEd5DQIbj08hZiZ14A6xPfutbIiR0y5DnWQjRPWi/tPoE7aSuImWa6gr5MlJSUDcEoJ7HSqSxUS29UCn3F8WWLkaM98XYQrBDdqaKXGoG6yFyLpJkyOpdXq17qhhj5/2CNPqxZIBqIgLeVw1uUvS9XAm8QivMdtmNvTQEl1vmBALVif8FbQGuQGNnRycLo4rJpCu745qtyt9fkCblZ6aGPTt4Ghf/XtW4/dwXDJYqKotl45aY8O06/z6beWh0YOgq6qYKXdW2KscprMPtFMnoK7brKej631/NX9o7a0L83lQXQ1lL+k4JCbrQ/ZpWe3VwE8rIVd1OdVhAHDKOcAGR2n/GY1kfZ+yRjvkIuylti/bGTCl3DzBdwCi4F8ulh2uypsH1mplO+/Of1zpH/UOMLnmEOPg/ENrGZSWJSYpi/We3jVirE4rH+pXLqGLNxczS9hintWFvoV2mVFw8CqmRfakGcrEq2E5PzImBViUDZ/AUxawHtxJxKyCl9yEo/my8Mu9PFpuxQW3BryVmW1X7zCJL0DoqkoaH9hwlP2FS/cWjqiPwOSTjp+DkIuxjjnOYTcLskwEJNBpjXckvzUoz/wZ7W8gOc5cnxvY269+fEmUrsxWHcNbMu3EEFFm02EE66p9sFVQZcZqOP2Z0lINuvTh10r9fuDYDSp/u2YruZbeqJVOPHeC+5yoha8FqvmDtZ3iZcexu0X6d03Ay0xiVeIQ39+SwWs2eHspFC5FvygFJDnS4N84fuyg6E6rxpc9CUfW4YC5lyiqZfKdFHCUZ1+p8BdP0F0wMBdQmuMw1VS/CVmjW9c9P3gGAKtr5wN6XdXJY/uICdDW0RukV9JNfsdfOk0XLEqwBTbvaoRGYXoRy9Jk3KOz3xxRcWn2PwZbuf0CaZQIPJJTmU5KUBFhnFxyOZCCP6JPuHamv7ZTU5kO1b2/gZRTO9Y6RLpAFq64uFrKjzXrZWSZ",
  iv: "WK7OMSRG5ODxonBO",
  tag: "pXV7QvmTRA00OkL510pSvw==",
  key: "46b1f4f0b53e5a5b92dd8e7c9a53826a41a03d9333a501ebeb1710fcd2741420",
  type: "OPEN-ATTESTATION-TYPE-1",
};
const decryptedDocument = decryptString(encryptedDocument);
console.log(JSON.parse(decryptedDocument));
```

您的文件内容已检索 .

> 别忘了把钥匙放回去 `decryptString` 函数,当您将密钥从加密文档中分离时.

-   找到窃听器了吗? 有问题吗? 想分享一个想法吗? 联系我们 [Github 仓库](https://github.com/Open-Attestation/oa-encryption)。 。 。 .

* * *

## API 密码

#### 目录

-   [(原始内容存档于2018-10-21) (英语). ENCRYPTION PARATERS](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-encryption_parameters)
    -   [算法](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-algorithm)
    -   [密钥Length](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-keylength)
    -   [伊夫伦斯](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-ivlength)
    -   [标记Length](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-taglength)
    -   [版本](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-version)
-   [生成 Encription Key 键](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-generateencryptionkey)
    -   [参数](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-parameters)
-   [编码文档](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-encodedocument)
    -   [参数](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-parameters-1)
-   [解码文档](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-decodedocument)
    -   [参数](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-parameters-2)
-   [催化结果](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-iencryptionresults)
-   [加密结构](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-encryptstring)
    -   [参数](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-parameters-3)
-   [解密结构](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-decryptstring)
    -   [参数](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-parameters-4)

### (原始内容存档于2018-10-21) (英语). ENCRYPTION PARATERS

此处响应的默认选项 [https://crypto.stack exchange.com/ questions/26783/ciphertext-and-tag-size-and-iv-transmission- with-aes-in-gcm-mode/26787 (中文(简体) )](https://crypto.stackexchange.com/questions/26783/ciphertext-and-tag-size-and-iv-transmission-with-aes-in-gcm-mode/26787)

#### 算法

#### 密钥Length

#### 伊夫伦斯

#### 标记Length

#### 版本

### 生成 Encription Key 键

生成以十六进制字符串表示的随机键

#### 参数

-   `keyLengthInBits` **[编号](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 密钥长度( 可选, 默认) `ENCRYPTION_PARAMETERS.keyLength`(中文(简体) )

### 编码文档

#### 参数

-   `document` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**

### 解码文档

#### 参数

-   `encoded` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**

### 催化结果

### 加密结构

用对称 AES 加密给定的字符串

#### 参数

-   `document` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 要加密的输入字符串
-   `key` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)? 吗?**

回返 **[催化结果](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-iencryptionresults)** base64 的密码文本

回返 **任意** 四. 基数64

回返 **任意** 在 base64 有标记认证的加密标记

回返 **任意** 十六进制密钥加密

回返 **任意** 类型 加密算法标识符

### 解密结构

解密给定的密码文本及其相关的变量

#### 参数

-   `$0` **[催化结果](https://npmcn.com/package/%40govtechsg/oa-encryption/#readme-iencryptionresults)**
    
    -   `$0.cipherText`
    -   `$0.tag`
    -   `$0.iv`
    -   `$0.key`
    -   `$0.type`
-   `cipherText` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 密码文本基础64已编码
    
-   `tag` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** aes 认证标记基础64已编码
    
-   `iv` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** iv base64 编码
    
-   `key` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 解密六相密码
    
-   `type` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 加密算法标识符
    

回返 **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**

## 常见问题

### @govtechsg/oa-encryption 是什么？

管理 oa 加密文件传输的共享库

### 如何安装 @govtechsg/oa-encryption？

在项目目录运行 npm install @govtechsg/oa-encryption，或使用 pnpm add / yarn add / bun add。

### @govtechsg/oa-encryption 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @govtechsg/oa-encryption 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @govtechsg/oa-encryption 可以商用吗？

@govtechsg/oa-encryption 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @govtechsg/oa-encryption 的下载量有多少？

根据 npm 官方下载统计，@govtechsg/oa-encryption 在 2026/10/17 – 2026/11/15 这 30 天内被下载 7,452 次，日均约 248 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @govtechsg/oa-encryption 还在维护吗？

最新版本 1\.3\.5 发布于 2022/06/14（4 年前）；至今共发布 6 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/12/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

