pyAesCrypt 使用教程

1. 项目介绍

pyAesCrypt 是一个基于 Python 3 开发的文件加密模块和脚本，它使用了 AES256-CBC 算法来加密和解密文件以及二进制流。pyAesCrypt 与 AES Crypt 文件格式（版本 2）兼容，是一款遵循 Apache 2.0 许可的开源软件。

2. 项目快速启动

首先，确保您的环境中已安装 Python 3。以下是一个简单的示例，展示如何使用 pyAesCrypt 加密和解密文件：

from pyAesCrypt import encryptFile, decryptFile

password = "please-use-a-long-and-random-password"

# 加密文件
encryptFile("data.txt", "data.txt.aes", password)

# 解密文件
decryptFile("data.txt.aes", "dataout.txt", password)

如果您需要指定自定义的缓冲区大小（默认为 64KB），可以将其作为可选参数传递：

bufferSize = 128 * 1024

# 加密文件，使用自定义缓冲区大小
encryptFile("data.txt", "data.txt.aes", password, bufferSize)

# 解密文件，使用自定义缓冲区大小
decryptFile("data.txt.aes", "dataout.txt", password, bufferSize)

3. 应用案例和最佳实践

加密二进制流

当需要加密二进制文件时，可以使用 encryptStream 和 decryptStream 方法：

from pyAesCrypt import encryptStream, decryptStream
from os import stat, remove
import io

bufferSize = 64 * 1024
password = "please-use-a-long-and-random-password"

# 加密二进制流
with open("data.bin", "rb") as fIn:
    with open("data.bin.aes", "wb") as fOut:
        encryptStream(fIn, fOut, password, bufferSize)

# 解密二进制流
with open("data.bin.aes", "rb") as fIn:
    try:
        with open("dataout.bin", "wb") as fOut:
            decryptStream(fIn, fOut, password, bufferSize)
    except ValueError:
        remove("dataout.bin")

内存中的加密和解密

还可以在内存中执行加密和解密操作，使用 BytesIO 对象：

from pyAesCrypt import encryptStream, decryptStream
import io

bufferSize = 64 * 1024
password = "please-use-a-long-and-random-password"

# 待加密的二进制数据
pbdata = b"This is binary plaintext\x00\x01"

# 创建内存中的输入流
fIn = io.BytesIO(pbdata)

# 创建内存中的输出流
fCiph = io.BytesIO()

# 加密内存中的数据
encryptStream(fIn, fCiph, password, bufferSize)

# 输出加密后的数据
print("Encrypted data:")
print(fCiph.getvalue())

# 重置加密流的位置
fCiph.seek(0)

# 创建内存中的解密输出流
fDec = io.BytesIO()

# 解密内存中的数据
decryptStream(fCiph, fDec, password, bufferSize)

# 输出解密后的数据
print("Decrypted data:")
print(fDec.getvalue())

4. 典型生态项目

目前尚无明确的生态项目列表。pyAesCrypt 可以作为独立的加密工具使用，也可以被集成到其他需要文件加密功能的项目中。开发者可以根据具体需求，将 pyAesCrypt 模块融入到自己的项目中。