git-cryptx

Automatically encrypt/decrypt sensitive files in Git repositories.

自动加密/解密 Git 仓库中的敏感文件。

Visit our GitHub repository: git-cryptx

Features

功能特点

• 🔒 Transparent file encryption/decryption
• 🔒 透明的文件加密/解密
• 🔄 Seamless Git workflow integration
• 🔄 无缝集成 Git 工作流
• 🎯 Precise file pattern matching
• 🎯 精确的文件匹配控制
• 👥 Team collaboration support
• 👥 支持团队协作
• 💻 Cross-platform support
• 💻 跨平台支持

Installation

安装

Build from Source

从源代码编译

To compile the project, use the following command:

要编译该项目，请使用以下命令：

cargo build --release

After building, make sure to add the binary to your system's PATH permanently:

编译完成后，请确保将可执行文件永久添加到系统的 PATH 中：

Linux/macOS:

Linux/macOS:

Add the following line to your ~/.bashrc, ~/.bash_profile, or ~/.zshrc file:

将以下行添加到您的 ~/.bashrc、~/.bash_profile 或 ~/.zshrc 文件中：

export PATH="$PATH:/path/to/your/project/target/release"

Then, run:

然后运行：

source ~/.bashrc  # or source ~/.bash_profile or source ~/.zshrc

Windows:

Windows:

1. Search for "Environment Variables" in the Start menu.
2. 在开始菜单中搜索"环境变量"。
3. Click on "Environment Variables".
4. 点击"环境变量"。
5. Under "System variables", find the Path variable and click "Edit".
6. 在"系统变量"下，找到 Path 变量并点击"编辑"。
7. Add the path to your project's target/release directory.
8. 添加项目的 target/release 目录路径。
9. Click "OK" to save changes.
10. 点击"确定"以保存更改。

Install via Homebrew

使用 Homebrew 安装

For macOS users, you can install git-cryptx using Homebrew:

对于 macOS 用户，您可以使用 Homebrew 安装 git-cryptx：

brew tap ChrisHyperFunc/brew

brew install git-cryptx

brew upgrade git-cryptx

Quick Start

快速开始

1. Initialize repository: git-cryptx init
2. 初始化仓库：git-cryptx init
3. Set encryption key: git-cryptx set-key <your-key>
4. 设置加密密钥：git-cryptx set-key <your-key>
5. Configure files to encrypt (edit .gitattributes and the file must not be encrypted):
6. 配置需要加密的文件（编辑 .gitattributes 并且该文件不得加密）：

example.secret filter=git-cryptx diff=git-cryptx
*.secret filter=git-cryptx diff=git-cryptx
config/*.key filter=git-cryptx diff=git-cryptx
sensitive/* filter=git-cryptx diff=git-cryptx
sub_tree_directories/** filter=git-cryptx diff=git-cryptx

如有必要：
.gitattributes !filter !diff

Commands

命令说明

• init: Initialize git-cryptx
• init: 初始化 git-cryptx
• set-key <key>: Add encryption key
• set-key <key>: 添加加密密钥
• rm-key: Remove encryption key
• rm-key: 移除加密密钥
• status: Show encryption status
• status: 显示加密状态

How It Works

工作原理

git-cryptx uses Git's filter mechanism to automatically encrypt and decrypt files:

git-cryptx 使用 Git 的过滤器机制实现文件的自动加密和解密：

1. When files are added to Git, the clean filter encrypts content.
2. 当文件被添加到 Git 时，clean 过滤器自动加密内容。
3. When files are checked out, the smudge filter decrypts content.
4. 当文件被检出时，smudge 过滤器自动解密内容。
5. Files remain in plaintext in the working directory.
6. 工作目录中始终保持文件明文。
7. Files remain encrypted in the Git repository.
8. Git 仓库中始终保持文件密文。

Security Notes

安全说明

• Uses AES-256-GCM for encryption.
• 使用 AES-256-GCM 进行加密。
• Keys stored in .git/cryptx directory.
• 密钥存储在 .git/cryptx 目录中。
• Supports file integrity verification.
• 支持文件完整性验证。
• Encrypted files marked with magic number.
• 加密文件使用魔数标记。

FAQ

常见问题

Q: How to share keys with team members?

Q: 如何与团队成员共享密钥？

A: Share the .git/cryptx/keys/global_ase_key file through a secure channel.

A: 请通过安全渠道共享 .git/cryptx/keys/global_ase_key 文件。

Q: How to view differences in encrypted files?

Q: 如何查看加密文件的差异？

A: git-cryptx supports viewing plaintext differences directly using regular git diff.

A: git-cryptx 支持直接查看加密文件的明文差异，使用普通的 git diff 即可。

Q: What to do if git pull prompts that local files will be overwritten?

Q: git pull 时提示本地文件会被覆盖怎么办？

A: You can resolve this by:

A: 可以使用以下方法解决：

1. If you are sure that the local file has not been modified, just the decryption status is different:
2. 如果确定本地文件没有修改，只是解密状态不同：

git-cryptx reset 

3. If the local file has indeed been modified:
4. 如果本地文件确实有修改：

# Store local modifications
git stash
# Pull updates
git pull
# Restore local modifications
git stash pop

5. If conflicts occur, resolve them manually before committing.
6. 如果发生冲突，需要手动解决冲突后再提交。

Team Collaboration

团队协作

When a new team member joins the project, follow these steps:

当新团队成员加入项目时，需要执行以下步骤：

1. Clone the repository: git clone <repository-url>
2. 克隆仓库：git clone <repository-url>
3. Initialize git-cryptx: git-cryptx init
4. 初始化 git-cryptx：git-cryptx init
5. Obtain the key file from other team members:
6. 从团队其他成员处获取密钥文件：
• Get the .git/cryptx/keys/global_ase_key file.
• 获取 .git/cryptx/keys/global_ase_key 文件。
• Place it in the same location in your local repository.
• 将密钥文件放入本地仓库的相同位置。
• Or git-cryptx set-key <your-key>
• 或执行 git-cryptx set-key <your-key>
7. Check configuration status: git-cryptx status
8. 验证文件状态：git-cryptx status
9. Update working directory files:
10. 更新工作目录文件：

# Clean working directory
git clean -fd
# Checkout files to trigger decryption
git checkout .

Important notes:

注意事项：

• Transfer the key file through secure channels (encrypted email, secure messaging, etc.).
• 确保密钥文件正确放置。
• Never commit the key file to the Git repository.
• 如果文件仍然是加密状态，尝试删除文件后重新检出。
• Each cloned repository needs its own key configuration.
• 检查 git-cryptx status 确保所有配置正确。
• If files appear encrypted, the key is not properly configured.
• 如果文件仍然是加密状态，尝试删除文件后重新检出。

Contributing

贡献指南

Pull requests and issues are welcome.

欢迎提交 Pull Request 或创建 Issue。

License

许可证

MIT License

MIT License