https://github.com/vsajip/pagesign

A Python library which wraps age and minisign to provide key management, encryption/decryption and signing/verification functionality.
https://github.com/vsajip/pagesign

age encryption minisign signing

Last synced: 30 days ago
JSON representation

A Python library which wraps age and minisign to provide key management, encryption/decryption and signing/verification functionality.

• Host: GitHub
• URL: https://github.com/vsajip/pagesign
• Owner: vsajip
• License: other
• Created: 2021-12-04T21:09:50.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T10:20:53.000Z (3 months ago)
• Last Synced: 2024-10-08T19:41:43.564Z (3 months ago)
• Topics: age, encryption, minisign, signing
• Language: Python
• Homepage: https://docs.red-dove.com/pagesign/
• Size: 291 KB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
|badge1| |badge2| |badge3|

.. |badge1| image:: https://img.shields.io/github/actions/workflow/status/vsajip/pagesign/tests.yml

   :alt: GitHub test status

.. |badge2| image:: https://img.shields.io/codecov/c/github/vsajip/pagesign

   :target: https://app.codecov.io/gh/vsajip/pagesign

   :alt: GitHub coverage status

.. |badge3| image:: https://img.shields.io/pypi/v/pagesign

   :target: https://pypi.org/project/pagesign/

   :alt: 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.