autocrypt邮件代理的支持工具和api
muacrypt的Python项目详细描述
muacrypt是实现Autocrypt Level 1兼容邮件代理的支持工具。 autocrypt状态保存在一个或多个处理和生成 来自相应的传入和传出电子邮件的autocrypt头。每个帐户是 绑定到一组电子邮件地址,指定为正则表达式。 功能通过命令行工具muacrypt和 通过import muacrypt获得的python api。有一个不断发展的插件 允许添加和修改muacrypt行为的架构。
本自述文件旨在帮助参与者设置运行 测试并使用命令行工具。在线文档位于
https://muacrypt.readthedocs.io
包含有关项目总体目标的更多文档。
测试
要使用代码并运行您需要安装的测试:
- 命令行客户机“gpg”,可选“gpg2”, 可通过Debian上的“gnupg”和“gnugp2”获得。
- 加快gpg密钥创建速度的东西,例如。 在debian上安装“rng工具”。
- Python2.7和Python3.5,包括头部 (“Debian上的python2.7-dev”和“python3.5-dev”)。
- “tox”运行自动测试(Debian上的“python tox”)
在Debian上的一个安装命令中:
apt install gnupg2 rng-tools python2.7-dev python3.5-dev python-tox
之后,您可以运行所有测试:
$ tox
安装
您需要命令行客户机“gpg”,也可以选择“gpg2”, 可通过Debian上的“gnupg”和“gnugp2”获得。
要安装muacrypt命令行工具,可以安装 “muacrypt”python包到您的虚拟环境中 可供选择。如果你不知道python的虚拟环境 您可以只安装debian包“python pip”,然后 使用“pip”也可以安装muacrypt库和命令行:
$ pip install --user muacrypt
muacrypt命令行工具将安装到 $HOME/.local/bin它需要在您的PATH中。
开发安装
如果您计划工作/修改源,并且 强烈建议创建github签出 激活python virtualenv,然后使用 pip在编辑模式下不带sudo:
$ virtualenv venv $ source venv/bin/activate $ pip install -e .
您随后对源代码所做的更改将是 无需进一步安装Muacrypt即可使用 再次打包。
运行命令行
安装后,只需运行主命令:
muacrypt
查看可用的子命令和选项。开始于 初始化将维护的autocrypt帐户 它自己的钥匙圈不会干扰你的 现有GPG默认密钥环:
$ muacrypt add-account
然后您可以创建一个autocrypt头 电子邮件地址:
$ muacrypt make-header x@example.org
您可以处理和集成peer的autocrypt 通过将电子邮件发送到process-incoming子命令来设置键:
$ muacrypt process-incoming <EMAIL_MESSAGE_FILE
在任何时候你都可以显示你的穆斯林身份 帐户:
$ muacrypt status