git-simple-encrypt 2.0.0

# git-simple-encrypt

[English](../README.md) | 简体中文

这是一个简单、安全的 git 加密工具。只需一个密码，即可在任何设备上加密/解密您的 git 仓库。

- 相比 [git-crypt](https://github.com/AGWA/git-crypt)，它不需要管理 GPG 密钥或备份密钥文件。**单密码对称加密**是核心原则。
- 安全性：v2.0.0+ 版本进行了彻底重构，采用 **Argon2 + XChaCha20-Poly1305** 保证安全性，适用于生产环境。
- 流式处理与防篡改：采用 64KB 分块加密，降低大文件加密的内存占用。每个分块包含 AEAD 校验，可感知文件篡改。
- 并行加速：多线程并行加解密，充分利用 CPU 多核性能。
- 元数据保留：加解密过程实现原子写入，保留原文件的权限与时间戳。
- Zstd 压缩：默认开启，可选择关闭，减少空间占用。

## 安装

您可以选择以下**任意一种**方式：

- 在 [Releases](https://github.com/lxl66566/git-simple-encrypt/releases) 中下载文件并解压，放入任意存在于 `PATH` 环境变量的目录下。
- 使用 [bpm](https://github.com/lxl66566/bpm)：
  ```sh
  bpm i git-simple-encrypt -b git-se -q
  ```
- 使用 [scoop](https://scoop.sh/)：
  ```sh
  scoop bucket add absx https://github.com/absxsfriends/scoop-bucket
  scoop install git-simple-encrypt
  ```
- 使用 [cargo-binstall](https://github.com/cargo-bins/cargo-binstall)：
  ```sh
  cargo binstall git-simple-encrypt
  ```
- 从源码编译：
  ```sh
  cargo install git-simple-encrypt
  ```

## 使用

```sh
git-se p                    # 设置/更新主密码
git-se add file.txt         # 将文件添加到加密列表
git-se add mydir            # 将文件夹添加到加密列表，之后会递归加密文件夹下的所有文件
git-se e                    # 加密列表中的所有文件
git-se d                    # 解密列表中的所有文件
git-se e xxx.txt dir1 ...   # 部分加密文件
git-se d xxx.txt dir1 ...   # 部分解密文件
```

## 注意事项

- 配置文件：加密列表与配置存储在 `git_simple_encrypt.toml` 中，如需从列表中删除文件，请手动编辑该文件。
- 迁移须知：v1.x 与 v2.x 算法不兼容，请先解密仓库的所有文件，去除 `git_simple_encrypt.toml` 列表里的所有 wildcard 格式（v2.x 不支持 wildcard），然后再升级到 v2.x 版本。

---

## 原理

v2.0.0+ 版本的加密流程如下：

### 1\. 密钥派生

- 程序通过 Argon2 算法结合文件的 16B Salt 派生出 32B 的强密钥。（同一批次加密的文件具有相同的 Salt）
- 利用 DashMap 缓存已派生的密钥，减少重复 Argon2 运算。

### 2\. 头部结构

每个加密文件都包含一个标准头部：

```text
 00          04  05  06  07           17                  2F              3F
 +-----------+---+---+---+-----------+-------------------+---------------+
 |   MAGIC   | V | F | A |   SALT    |     NONCE         |   RESERVED    |
 |  "GITSE"  |   |   |   | (16 bytes)|    (24 bytes)     |  (16 bytes)   |
 +-----------+---+---+---+-----------+-------------------+---------------+
      |        |   |   |
      |        |   |   +--- 加密算法 (1 = XChaCha20-Poly1305)
      |        |   +------- 压缩标志位 (Bit 0: 是否 Zstd 压缩)
      |        +----------- 版本号 (当前为 2)
      +-------------------- 魔数
```

### 3\. 加密逻辑

- 算法： 文件被切分为 64KB 的块，使用 XChaCha20-Poly1305 进行加密。
- Nonce 派生： 每个分块使用不同的 Nonce。派生规则：`Base Nonce (24字节) Overwrite [16..24] 字节位为分块索引 i`。
- AAD： 非末尾块：`AAD = "MORE"`，末尾块：`AAD = "LAST"`

```mermaid
sequenceDiagram
    participant F as 原始文件 (Disk)
    participant M as 内存缓冲区 (64KB)
    participant E as 加密引擎 (XChaCha20-Poly1305)
    participant T as 临时文件 (TempFile)

    F->>M: 1. 读取 64KB 数据
    M->>M: 2. Zstd 压缩 (可选)
    Note over M,E: 生成分块索引 i & Nonce_i
    M->>E: 3. 加入 AAD (MORE/LAST) 并加密
    E->>T: 4. 写入密文 + Tag
    loop 持续处理直至 EOF
        F->>T: 循环上述流程
    end
    T->>T: 5. 复制元数据 (Permissions/Timestamps)
    T->>F: 6. 原子覆写 (fs::rename)
```