
本文档旨在解决从 YAML 文件中读取 cryptography.fernet 生成的加密密钥时,如何将其转换为字符串格式的问题。YAML 默认会将密钥识别为二进制数据,导致读取后需要进行额外的转换。本文将介绍如何处理这种情况,确保密钥能以正确的字符串形式被使用。
在使用 cryptography.fernet 进行数据加密时,通常会将生成的加密密钥存储在配置文件中,例如 YAML 文件。然而,YAML 库在加载包含二进制数据的 YAML 文件时,可能会将密钥识别为二进制格式,而不是我们期望的字符串格式。这会导致后续使用密钥时出现类型错误。
下面我们将介绍如何解决这个问题,确保从 YAML 文件中读取的密钥是字符串类型。
解决方案:使用 base64 库进行编码和解码
当 YAML 文件将密钥存储为二进制数据时,实际上它是经过 Base64 编码的。因此,我们需要使用 base64 库对其进行解码。
以下是一个示例,展示了如何从 YAML 文件中读取加密密钥,并将其转换为字符串:
import yaml
import base64
with open("credentials.yml", 'r') as file:
yaml_data = yaml.safe_load(file) # 使用 safe_load 更安全
# 从 YAML 数据中获取加密密钥,此时它可能是 bytes 类型
encrypted_key = yaml_data['encryption_key']
# 检查密钥是否为 bytes 类型,如果是,则进行解码
if isinstance(encrypted_key, bytes):
decoded_key = base64.b64encode(encrypted_key).decode('utf-8') #先编码成base64,再解码成字符串
else:
decoded_key = encrypted_key
print(decoded_key)
代码解释:
- yaml.safe_load(file): 使用 safe_load 函数可以防止执行 YAML 文件中潜在的恶意代码,提高了安全性。
- yaml_data['encryption_key']: 从加载的 YAML 数据中获取名为 encryption_key 的值。
- isinstance(encrypted_key, bytes): 检查从yaml读取到的key是否是bytes类型,如果是,则需要解码。
- base64.b64encode(encrypted_key).decode('utf-8'): 首先使用 base64.b64encode() 将 bytes 类型的密钥编码为 Base64 格式的 bytes 对象,然后使用 .decode('utf-8') 将其解码为 UTF-8 字符串。
示例 credentials.yml 文件:
encryption_key: !!binary | Rkl5ZVFTQnZhNG1LcVhsSU1LV3FUZzNETGVRcWx0VTQyMzFyRDJlTWR4UT0= username: Jack encrypted_password: gAAAAABlXhuUZimgsD1eN7gLZpfzvxKc4Bz9fIPmVhWvwGoKkaUiSWOSf7gkFJBM8XRU-kgn37kKH3KC2XTz-CHLVX2PFerckQ==
注意事项:
- 安全性: 请务必安全地存储加密密钥,避免泄露。不要将密钥硬编码到代码中,而是使用环境变量或安全的文件存储方式。
- YAML 库: 确保安装了 PyYAML 库。可以使用 pip install pyyaml 命令进行安装。
- 编码格式: 在解码时,使用正确的编码格式(例如 UTF-8)以避免出现乱码。
总结:
通过使用 base64 库,我们可以轻松地将从 YAML 文件中读取的二进制格式的加密密钥转换为字符串格式。这种方法确保了密钥能够正确地被 cryptography.fernet 库使用,从而实现数据的加密和解密。记住,安全性至关重要,请妥善保管你的加密密钥。










