django-secure-mail 1.3.0

简介

django-secure-mail是一个Django可重用应用程序，提供邮件后端以发送机会性签名和加密的电子邮件使用PGP。还提供了模型和管理上传的PGP密钥的管理员页面。

请注意，提供的后端仅在收件人已上传有效的公钥时才对发出的邮件进行签名。没有有效公钥的用户 不会 对其发出的邮件进行签名或加密。

依赖项

• 需要python-gnupg来发送PGP加密的电子邮件。

安装

安装django-secure-mail最简单的方法是直接从PyPi使用pip，运行以下命令

$ pip install django-secure-mail

否则，您可以下载django-secure-mail并直接从源安装它

$ python setup.py install

配置

1. 将secure_mail添加到您的INSTALLED_APPS设置中，并运行数据库迁移

   $ python manage.py migrate secure_mail

2. 在您的设置模块中将EMAIL_BACKEND设置为secure_mail.backends.EncryptingSmtpEmailBackend或开发和测试中列出的开发/测试后端之一。

3. 将SECURE_MAIL_GNUPG_HOME设置为一个包含GPG密钥环的目录。如果您正在运行多个Django节点，每个节点都需要对这个目录有读写访问。

4. 将SECURE_MAIL_GNUPG_ENCODING变量设置为GPG可执行文件所需的编码。对于GPG 1.x通常是latin-1，对于GPG 2.x通常是utf-8。

5. 虽然发送加密邮件不是必需的，但强烈建议为外发邮件生成一个签名密钥。请按照生成签名密钥部分中的说明操作。所有将要发送外发邮件的节点都需要对由SECURE_MAIL_GNUPG_HOME指定的目录有读取访问权限。

还有其他配置选项可用。请参阅选项部分以获取完整列表。

SECURE_MAIL_SIGNING_KEY_DATA = {
    'key_type': "RSA",
    'key_length': 4096,
    'name_real': settings.SITE_NAME,
    'name_comment': "Outgoing email server",
    'name_email': settings.DEFAULT_FROM_EMAIL,
    'expire_date': '2y',
}

$ python manage.py email_signing_key --generate

$ python manage.py email_signing_key 7AB59FE794A7AC12EBA87507EF33F601153CFE28

$ python manage.py email_signing_key 7AB59FE794A7AC12EBA87507EF33F601153CFE28 --print-private-key

$ python manage.py email_signing_key 7AB59FE794A7AC12EBA87507EF33F601153CFE28 -k keys.ubuntu.com keys.redhat.com -k pgp.mit.edu

$ python manage.py email_signing_key --generate --keyserver pgp.mit.edu --print-private-key

发送 PGP 加密电子邮件

一旦后端配置完成并由 EMAIL_BACKEND 设置指定，所有外发邮件都将被尝试签名和加密。这意味着如果消息被发送到数据库和 GPG/PGP 密钥链中具有有效公钥的接收者，后端将尝试为该接收者签名和加密外发邮件。

错误处理

此后端允许用户在以下对象加密失败时指定自定义错误处理程序

• 纯文本消息本身

• 任何消息附件

• 任何消息替代品（例如：带纯文本回退的 HTML 邮件）

当引发异常时调用错误处理程序，并将引发异常传递给它们。

def handle_failed_encryption(exception):
    # Handle errors

def handle_failed_alternative_encryption(exception):
    # Handle errors

def handle_failed_attachment_encryption(exception):
    # Handle errors

默认错误处理程序简单地重新引发异常，但这可能不是所有情况都希望的。

为了帮助处理错误，该包提供了一些辅助函数，可以在自定义错误处理程序中使用

• force_send_message - 接受未加密的消息作为参数，并发送消息而不尝试加密或签名它。

• force_delete_key - 接受接收者的地址作为参数，并强制从数据库和 GPG/PGP 密钥链中删除所有密钥。

• force_mail_admins - 接受未加密的消息和失败的地址作为参数。如果地址在 ADMINS 设置中，它将未加密地发送消息，否则，它将给管理员发送包含原始消息主题和原始预期接收者的消息。

• get_variable_from_exception - 接受异常和变量名作为参数，然后回溯堆栈跟踪以找到第一个具有指定名称的变量。

要指定自定义错误处理程序，请将项目 settings.py 中的 SECURE_MAIL_FAILURE_HANDLERS 设置字典中的键设置为错误处理程序/的点分路径

SECURE_MAIL_FAILURE_HANDLERS = {
    'message': 'myapp.handlers.handle_failed_encryption',
    'alternative': 'myapp.handlers.handle_failed_alternative_encryption',
    'attachment': 'myapp.handlers.handle_failed_attachment_encryption',
}

您不必覆盖所有处理程序，可以覆盖您想要的任意多个或任意少。

开发和测试

如果您想扩展后端或创建自己的自定义后端，此包提供了一个后端混入（EncryptingEmailBackendMixin）

class EncryptingLocmemEmailBackend(EncryptingEmailBackend, LocmemBackend):
    pass

有关在另一个 Django 应用中使用 EncryptingEmailBackendMixin 的实际、真实示例，请参阅来自django-emailhub项目的 emailhub.backends.secure_mail.EncryptingEmailBackendMixin。

除了提供的EncryptingSmtpEmailBackend之外，这个包还包含了一些与内置Django后端相似的更多后端。

• EncryptingConsoleEmailBackend

• EncryptingLocmemEmailBackend

• EncryptingFilebasedEmailBackend

其他Django应用程序

具有类似功能的其他Django应用程序包括：

• django-email-extras - 提供两个函数，用于使用Django模板系统发送PGP加密的多部分电子邮件。还提供了一个在开发期间在浏览器中显示HTML电子邮件的邮件后端。

• django-gnupg-mails - 提供了一个GnuPGMessage（Django的EmailMessage的子类），用于发送PGP/MIME签名电子邮件。

这两个应用程序都需要第三方应用程序开发者“选择”发送加密邮件。本项目自动为所有应用程序加密和签名所有发出的邮件。