2018-02-16 23:52:24 +00:00
|
|
|
.. pyUmbral documentation master file
|
|
|
|
|
created Thu Feb 15 12:47:25 2018.
|
2018-02-15 20:51:23 +00:00
|
|
|
|
2018-02-20 22:06:33 +00:00
|
|
|
========
|
2018-02-16 23:52:24 +00:00
|
|
|
pyUmbral
|
|
|
|
|
========
|
2019-02-19 12:18:24 +00:00
|
|
|
.. start-badges
|
2018-08-19 00:50:46 +00:00
|
|
|
|
2019-02-19 12:18:24 +00:00
|
|
|
.. list-table::
|
|
|
|
|
:stub-columns: 1
|
|
|
|
|
|
|
|
|
|
* - info
|
|
|
|
|
- |docs| |discord|
|
|
|
|
|
* - tests
|
|
|
|
|
- | |circleci|
|
|
|
|
|
* - package
|
|
|
|
|
- | |version| |commits-since|
|
|
|
|
|
|
|
|
|
|
.. |docs| image:: https://readthedocs.org/projects/pyumbral/badge/?style=flat
|
|
|
|
|
:target: https://readthedocs.org/projects/pyumbral
|
|
|
|
|
:alt: Documentation Status
|
|
|
|
|
|
|
|
|
|
.. |discord| image:: https://img.shields.io/discord/411401661714792449.svg?logo=discord
|
|
|
|
|
:target: https://discord.gg/xYqyEby
|
|
|
|
|
:alt: Discord
|
|
|
|
|
|
|
|
|
|
.. |circleci| image:: https://img.shields.io/circleci/project/github/nucypher/pyUmbral.svg?logo=circleci
|
2018-08-19 03:05:43 +00:00
|
|
|
:target: https://circleci.com/gh/nucypher/pyUmbral/tree/master
|
2019-02-19 12:18:24 +00:00
|
|
|
:alt: CircleCI build status
|
|
|
|
|
|
|
|
|
|
.. |version| image:: https://img.shields.io/pypi/v/umbral.svg
|
|
|
|
|
:alt: PyPI Package latest release
|
|
|
|
|
:target: https://pypi.org/project/umbral
|
2018-02-16 23:52:24 +00:00
|
|
|
|
2019-02-19 12:18:24 +00:00
|
|
|
.. |commits-since| image:: https://img.shields.io/github/commits-since/nucypher/pyumbral/v0.1.3-alpha.0.svg
|
|
|
|
|
:alt: Commits since latest release
|
|
|
|
|
:target: https://github.com/nucypher/pyUmbral/compare/v0.1.3-alpha.0...master
|
|
|
|
|
|
|
|
|
|
.. end-badges
|
|
|
|
|
|
|
|
|
|
pyUmbral is a Python implementation of David Nuñez's threshold proxy re-encryption scheme: Umbral_.
|
2018-02-20 22:06:33 +00:00
|
|
|
Implemented with OpenSSL_ and Cryptography.io_, pyUmbral is a referential and open-source cryptography library
|
2018-02-21 07:28:55 +00:00
|
|
|
extending the traditional cryptological narrative of "Alice and Bob" by introducing a new actor,
|
2019-02-19 12:18:24 +00:00
|
|
|
*Ursula*, who has the ability to take secrets encrypted for Alice and *re-encrypt* them for Bob,
|
|
|
|
|
without being able to learn any information about the original secret.
|
|
|
|
|
|
|
|
|
|
pyUmbral is the cryptographic engine behind nucypher_,
|
|
|
|
|
a proxy re-encryption network to empower privacy in decentralized systems.
|
2018-02-20 22:06:33 +00:00
|
|
|
|
|
|
|
|
.. _Umbral: https://github.com/nucypher/umbral-doc/blob/master/umbral-doc.pdf
|
|
|
|
|
.. _Cryptography.io: https://cryptography.io/en/latest/
|
|
|
|
|
.. _OpenSSL: https://www.openssl.org/
|
2019-02-19 12:18:24 +00:00
|
|
|
.. _nucypher: https://github.com/nucypher/nucypher
|
2018-02-15 20:51:23 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
2018-02-17 06:30:28 +00:00
|
|
|
:maxdepth: 3
|
2018-02-16 23:52:24 +00:00
|
|
|
:caption: Table of Contents:
|
|
|
|
|
|
|
|
|
|
installation
|
2018-02-17 04:58:45 +00:00
|
|
|
using_pyumbral
|
2018-02-16 23:52:24 +00:00
|
|
|
|
2018-02-20 22:06:33 +00:00
|
|
|
|
|
|
|
|
Academic Whitepaper
|
|
|
|
|
====================
|
2018-02-15 20:51:23 +00:00
|
|
|
|
2018-02-20 22:06:33 +00:00
|
|
|
The Umbral scheme academic whitepaper and cryptographic specifications
|
|
|
|
|
are availible on GitHub_.
|
2018-02-20 03:05:20 +00:00
|
|
|
|
2018-02-20 22:06:33 +00:00
|
|
|
"Umbral A Threshold Proxy Re-Encryption Scheme"
|
|
|
|
|
*by David Nuñez*
|
|
|
|
|
https://github.com/nucypher/umbral-doc/blob/master/umbral-doc.pdf
|
2018-02-17 00:36:49 +00:00
|
|
|
|
2018-02-20 22:06:33 +00:00
|
|
|
.. _GitHub: https://github.com/nucypher/umbral-doc/
|
2018-02-17 00:36:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Support & Contribute
|
|
|
|
|
=====================
|
|
|
|
|
|
|
|
|
|
- Issue Tracker: https://github.com/nucypher/pyUmbral/issues
|
|
|
|
|
- Source Code: https://github.com/nucypher/pyUmbral
|
|
|
|
|
|
|
|
|
|
|
2018-02-20 22:06:33 +00:00
|
|
|
Indices and Tables
|
2018-02-15 20:51:23 +00:00
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
