Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

muacrypt: Autocrypt and more for mail user agents

this tool is under heavy development, use at your own risk

muacrypt implements the Autocrypt Level 1 specification and offers a way to robustly manage identities through which Autocrypt headers can be added or parsed with outgoing or incoming messages. Each identitiy relates to an e-mail account and has an Autocrypt key.

This README is intended to help contributors to get setup with running tests and using the command line. The online docs at https://muacrypt.readthedocs.io contain more documentation about overall goals of the project.

testing

To use the code and run tests you need to have installed:

  • the command line client “gpg”, optionally “gpg2”, available through “gnupg” and “gnugp2” on debian.

  • something to speed up gpg key creation, e.g. by installing “rng-tools” on debian.

  • python2.7 and python3.5 including headers (“python2.7-dev” and “python3.5-dev” on debian).

  • tox either installed via pip install tox or apt install python-tox.

In one command on Debian:

apt install gnupg2 rng-tools python2.7-dev python3.5-dev python-tox

Afterwards you can run all tests:

$ tox

this runs all automated tests.

installation

You’ll need the command line client “gpg”, optionally “gpg2”, available through “gnupg” and “gnugp2” on debian.

To install the muacrypt command line tool you can install the “muacrypt” python package into your virtual environment of choice. If you don’t know about python’s virtual environments you may just install the debian package “python-pip” and then use “pip” to install the muacrypt library and command line too:

$ sudo pip install muacrypt

This will install the required dependency “click”, a python framework for writing command line clients.

installation for development

If you plan to work/modify the sources and have a github checkout we strongly recommend to create and activate a python virtualenv and then once use pip without sudo in edit mode:

$ virtualenv venv
$ source venv/bin/activate
$ pip install -e .

Changes you subsequently make to the sources will be available without further installing the muacrypt package again.

running the command line

After installation simply run the main command:

muacrypt

to see available sub commands and options. Start by initializing an Autocrypt account which will maintain its own keyring and not interfere with your possibly existing gpg default keyring:

$ muacrypt init

Afterwards you can create an Autocrypt header for an email address:

$ muacrypt make-header x@example.org

You can process and integrate peer’s Autocrypt keys by piping an email message into the process-incoming subcommand:

$ muacrypt process-incoming <EMAIL_MESSAGE_FILE

At any point you can show the status of your muacrypt account:

$ muacrypt status

Metadata

Release files for muacrypt 0.8.0.dev1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for muacrypt 0.8.0.dev1
File Size Uploaded Provenance Actions
muacrypt-0.8.0.dev1.tar.gz 44.6 kB Without provenance Details for muacrypt-0.8.0.dev1.tar.gz

Release files / muacrypt-0.8.0.dev1.tar.gz

Download URL muacrypt-0.8.0.dev1.tar.gz
Size 44.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0eaa97a81ad730f7d239836adb83036454da838787749639d7a3d7e4ffda6c34
BLAKE2b-256 checksum
How to use checksums
c794a16b9d4baf40109fd605ba639491d9385f3434aee2cd899779a67cc2b599
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for muacrypt 0.8.0.dev1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page