OpenPGP.js 技术文档

1. 安装指南

Node.js

1. 使用 npm 安装 OpenPGP.js 并将其保存到依赖项中：

   npm install --save openpgp
   

2. 导入为 CommonJS 模块：

   const openpgp = require('openpgp');
   

   或者作为 ES6 模块，从 .mjs 文件导入：

   import * as openpgp from 'openpgp';
   

Deno（实验性）

1. 导入为 ES6 模块，使用 /dist/openpgp.mjs：

   import * as openpgp from './openpgpjs/dist/openpgp.mjs';
   

浏览器（webpack）

1. 使用 npm 安装 OpenPGP.js 并将其保存到开发依赖项中：

   npm install --save-dev openpgp
   

2. 导入为 ES6 模块：

   import * as openpgp from 'openpgp';
   

   你也可以只导入所需的函数：

   import { readMessage, decrypt } from 'openpgp';
   

   或者使用轻量级构建（更小，按需加载非默认曲线）：

   import * as openpgp from 'openpgp/lightweight';
   

浏览器（普通文件）

1. 从 unpkg.com/openpgp/dist 获取 openpgp.min.js，并在 script 标签中加载：

   <script src="openpgp.min.js"></script>
   

2. 或者，加载为 ES6 模块，获取 openpgp.min.mjs 并导入：

   <script type="module">
   import * as openpgp from './openpgp.min.mjs';
   </script>
   

TypeScript

1. 由于 TypeScript 尚未完全集成到库中，TS 依赖项目前列为 devDependencies，因此需要手动添加 @openpgp/web-stream-tools：

   npm install --save-dev @openpgp/web-stream-tools@0.0.11-patch-0
   

2. 项目的使用说明

平台支持

• dist/openpgp.min.js 适用于最新版本的 Chrome、Firefox、Safari 和 Edge。
• dist/node/openpgp.min.js 适用于 Node.js。

性能

• 版本 3.0.0 引入了对椭圆曲线加密的支持，使用原生实现以提高性能。
• 版本 2.x 使用 Uint8Arrays，性能和内存使用更佳。

示例

使用密码加密和解密 Uint8Array 数据

const { encrypt, decrypt } = require('openpgp');

async function encryptData(data, password) {
    const encrypted = await encrypt({
        message: openpgp.message.fromText(data),
        passwords: [password],
        format: 'binary'
    });
    return encrypted.message;
}

async function decryptData(encryptedData, password) {
    const decrypted = await decrypt({
        message: await openpgp.message.read(encryptedData),
        passwords: [password],
        format: 'binary'
    });
    return decrypted.data;
}

3. 项目API使用文档

加密和解密

• encrypt(options): 加密数据。
• decrypt(options): 解密数据。

生成密钥对

• generateKey(options): 生成新的密钥对。

签名和验证

• sign(options): 签名数据。
• verify(options): 验证签名。

4. 项目安装方式

Node.js

npm install --save openpgp

浏览器（webpack）

npm install --save-dev openpgp

浏览器（普通文件）

从 unpkg.com/openpgp/dist 获取 openpgp.min.js 或 openpgp.min.mjs。

TypeScript

npm install --save-dev @openpgp/web-stream-tools@0.0.11-patch-0

通过以上步骤，你可以成功安装并使用 OpenPGP.js 进行加密、解密、签名和验证等操作。