mirror of https://github.com/nucypher/nucypher.git
144 lines
3.7 KiB
ReStructuredText
144 lines
3.7 KiB
ReStructuredText
NuCypher
|
|
========
|
|
*A proxy re-encryption network to empower privacy in decentralized systems*
|
|
|
|
|
|
----
|
|
|
|
.. image:: https://img.shields.io/pypi/v/nucypher.svg?style=flat
|
|
:target: https://pypi.org/project/nucypher/
|
|
|
|
.. image:: https://img.shields.io/pypi/pyversions/nucypher.svg
|
|
:target: https://pypi.org/project/nucypher/
|
|
|
|
.. image:: https://img.shields.io/circleci/project/github/nucypher/nucypher.svg?logo=circleci
|
|
:target: https://circleci.com/gh/nucypher/nucypher/tree/master
|
|
:alt: CircleCI build status
|
|
|
|
.. image:: https://coveralls.io/repos/github/nucypher/nucypher/badge.svg?branch=master
|
|
:target: https://coveralls.io/github/nucypher/nucypher?branch=master
|
|
|
|
.. image:: https://img.shields.io/discord/411401661714792449.svg?logo=discord
|
|
:target: https://discord.gg/7rmXa3S
|
|
:alt: Discord
|
|
|
|
.. image:: https://readthedocs.org/projects/nucypher/badge/?version=latest
|
|
:target: https://nucypher.readthedocs.io/en/latest/
|
|
:alt: Documentation Status
|
|
|
|
.. image:: https://img.shields.io/pypi/l/nucypher.svg
|
|
:target: https://www.gnu.org/licenses/gpl-3.0.html
|
|
|
|
.. _Umbral: https://github.com/nucypher/pyUmbral
|
|
|
|
The NuCypher network uses the Umbral_ threshold proxy re-encryption scheme
|
|
to provide cryptographic access controls for distributed apps and protocols.
|
|
|
|
1. Alice, the data owner, grants access to her encrypted data to
|
|
anyone she wants by creating a policy and uploading it to
|
|
the NuCypher network.
|
|
|
|
2. Anyone can encrypt data using Alice's policy public key.
|
|
The resulting encrypted data can be uploaded to IPFS, Swarm, S3,
|
|
or any other storage layer.
|
|
|
|
3. Ursula, a miner, receives the access policy and stands ready to
|
|
re-encrypt data in exchange for payment in fees and block rewards.
|
|
Thanks to the use of proxy re-encryption,
|
|
Ursula and the storage layer never have access to Alice's plaintext data.
|
|
|
|
4. Bob, a data recipient, sends an access request to the NuCypher network.
|
|
If the policy is satisfied, the data is re-encrypted to his public key
|
|
and he can decrypt it with his private key.
|
|
|
|
More detailed information:
|
|
|
|
- GitHub https://www.github.com/nucypher/nucypher
|
|
- Website https://www.nucypher.com/
|
|
|
|
|
|
Whitepapers
|
|
-----------
|
|
|
|
**Network**
|
|
|
|
https://github.com/nucypher/whitepaper/blob/master/whitepaper.pdf
|
|
|
|
*"NuCypher - A proxy re-encryption network to empower privacy in decentralized systems"*
|
|
*by Michael Egorov, David Nuñez, and MacLane Wilkison - NuCypher*
|
|
|
|
|
|
**Economics**
|
|
|
|
https://github.com/nucypher/mining-paper/blob/master/mining-paper.pdf
|
|
|
|
*"NuCypher - Mining & Staking Economics"*
|
|
*by Michael Egorov, MacLane Wilkison - NuCypher*
|
|
|
|
|
|
**Cryptography**
|
|
|
|
https://github.com/nucypher/umbral-doc/blob/master/umbral-doc.pdf
|
|
|
|
*"Umbral A Threshold Proxy Re-Encryption Scheme"*
|
|
*by David Nuñez - NuCypher*
|
|
|
|
|
|
.. warning::
|
|
|
|
NuCypher is currently in the *Alpha* development stage and is **not** intended for use in production.
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Guides
|
|
|
|
guides/quickstart
|
|
guides/federated_testnet_guide
|
|
guides/installation_guide
|
|
guides/ursula_configuration_guide
|
|
guides/contribution_guide
|
|
guides/character_control_guide
|
|
guides/staking_guide
|
|
guides/deployment_guide
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Demos
|
|
|
|
demos/local_fleet_demo
|
|
demos/finnegans_wake_demo
|
|
demos/heartbeat_demo
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Architecture
|
|
|
|
architecture/contracts
|
|
architecture/upgradeable_proxy_contracts
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: API
|
|
|
|
api/characters
|
|
api/config
|
|
api/crypto
|
|
api/keyring
|
|
api/keystore
|
|
api/network
|
|
api/policy
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Release Notes
|
|
|
|
release_notes/genesis_release
|
|
|
|
|
|
Indices and Tables
|
|
==================
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|