mirror of https://github.com/nucypher/pyUmbral.git
62 lines
1.6 KiB
ReStructuredText
62 lines
1.6 KiB
ReStructuredText
.. pyUmbral documentation master file
|
|
created Thu Feb 15 12:47:25 2018.
|
|
|
|
========
|
|
pyUmbral
|
|
========
|
|
|
|
.. image:: https://travis-ci.org/nucypher/pyUmbral.svg?branch=master
|
|
:target: https://travis-ci.org/nucypher/pyUmbral
|
|
|
|
pyUmbral is a python implementation of David Nuñez's threshold proxy rencryption scheme: Umbral_.
|
|
Implemented with OpenSSL_ and Cryptography.io_, pyUmbral is a referential and open-source cryptography library
|
|
extending the traditional cryptological narrative of "Alice and Bob" by introducing a new actor,
|
|
*Ursula*, who has the ability to take secrets encrypted for Alice and *re-encrypt* them for Bob.
|
|
|
|
.. _Umbral: https://github.com/nucypher/umbral-doc/blob/master/umbral-doc.pdf
|
|
.. _Cryptography.io: https://cryptography.io/en/latest/
|
|
.. _OpenSSL: https://www.openssl.org/
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: Table of Contents:
|
|
|
|
installation
|
|
using_pyumbral
|
|
|
|
|
|
Features
|
|
==========
|
|
- Re-encryption Toolkit
|
|
- Re-encryption Key Fragmentation
|
|
- Key Encapsulation
|
|
- Elliptic Curve Arithmetic
|
|
|
|
|
|
Academic Whitepaper
|
|
====================
|
|
|
|
The Umbral scheme academic whitepaper and cryptographic specifications
|
|
are availible on GitHub_.
|
|
|
|
"Umbral A Threshold Proxy Re-Encryption Scheme"
|
|
*by David Nuñez*
|
|
https://github.com/nucypher/umbral-doc/blob/master/umbral-doc.pdf
|
|
|
|
.. _GitHub: https://github.com/nucypher/umbral-doc/
|
|
|
|
|
|
Support & Contribute
|
|
=====================
|
|
|
|
- Issue Tracker: https://github.com/nucypher/pyUmbral/issues
|
|
- Source Code: https://github.com/nucypher/pyUmbral
|
|
|
|
|
|
Indices and Tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|