Skip to content
/ pyage Public

Actually good encryption. In Python.

License

Notifications You must be signed in to change notification settings

jojonas/pyage

Repository files navigation

pyage

Build and Test Compatibility Check Documentation Status License

pyage screenshot

pyage is an experimental implementation of @FiloSottile and @Benjojo12 's project "age". The spec is currently available as seven-page Google doc at age-encryption.org/v1.

This project is still work-in-progress.

⚠️ pyage is not intended to be a secure age implementation! My original intention was to better understand the spec, find mistakes early and provide a redundant implementation for validation. I'm not a cryptographer (IANAC) and did not (yet) find the time to address implementation-specific security issues (such as DoS attacks or side-channel attacks).

So: Use at your own risk.

Quick Start

Install from pip:

pip install age

Generate a key pair:

mkdir -p ~/.config/age
pyage generate > ~/.config/age/keys.txt

Encrypt a file:

pyage encrypt -i hello.txt -o hello.age pubkey:<recipient public key>

Decrypt a file (uses ~/.config/age/keys.txt):

pyage decrypt -i hello.age

For a real tutorial, see the Tutorial section in the documentation.

Documentation

The full documentation can be found at pyage.readthedocs.io.