Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 2.77 KB

README.rst

File metadata and controls

90 lines (61 loc) · 2.77 KB
Raw

GitHub test status GitHub coverage status PyPI package

What is it?

age and minisign are modern command-line programs which respectively provide support for encryption/decryption and signing/verification of data. It is possible to provide programmatic access to their functionality by spawning separate processes to run them and then communicating with those processes from your program.

This project, pagesign (for 'Python-age-sign'), implements a Python library which takes care of the internal details and allows its users to generate and manage keys, encrypt and decrypt data, and sign and verify messages using age and minisign.

This library does not install age or minisign for you: you will need to install them yourself (see the documentation for more information). It expects functionality found in age v1.0.0 or later, and minisign v0.8 or later. Three programs are expected to be found on the PATH: age-keygen, age and minisign. If any of them aren't found, this library won't work as expected.

Installation

Installing from PyPI

You can install this package from the Python Package Index (pyPI) by running:

pip install pagesign

Installing from a source distribution archive

To install this package from a source distribution archive, do the following:

  1. Extract all the files in the distribution archive to some directory on your system.
  2. In that directory, run pip install ., referencing a suitable pip (e.g. one from a specific venv which you want to install to).
  3. Optionally, run python test_pagesign.py to ensure that the package is working as expected.

Credits

  • The developers of age and minisign.

API Documentation

https://docs.red-dove.com/pagesign/

Change log

0.1.1

Released: Not yet.

  • Add the CryptException class and code to raise it when an operation fails.
  • Make a change so that clear_identities() now takes no arguments.
  • Add encrypt_mem() and decrypt_mem() functions to perform operations in memory.
  • Use a better algorithm for encryption and signing at the same time.

0.1.0

Released: 2021-12-05

  • Initial release.