2019-01-25 20:07:01 +00:00
NuCypher
========
2019-09-10 20:48:26 +00:00
*A decentralized cryptological network offering accessible, intuitive, and extensible runtimes and interfaces for secrets management and dynamic access control.*
2019-01-25 20:07:01 +00:00
2019-01-29 01:31:13 +00:00
2019-01-25 20:12:31 +00:00
----
2019-01-25 20:07:01 +00:00
2019-02-20 11:29:27 +00:00
.. image :: https://img.shields.io/pypi/v/nucypher.svg?style=flat
2019-01-25 20:07:01 +00:00
:target: https://pypi.org/project/nucypher/
.. image :: https://img.shields.io/pypi/pyversions/nucypher.svg
:target: https://pypi.org/project/nucypher/
2019-01-30 15:55:54 +00:00
.. image :: https://img.shields.io/circleci/project/github/nucypher/nucypher.svg?logo=circleci
2020-07-21 02:08:11 +00:00
:target: https://circleci.com/gh/nucypher/nucypher/tree/main
2019-01-30 15:55:54 +00:00
:alt: CircleCI build status
2020-07-21 02:08:11 +00:00
.. image :: https://codecov.io/gh/nucypher/nucypher/branch/main/graph/badge.svg
2019-04-09 09:18:24 +00:00
:target: https://codecov.io/gh/nucypher/nucypher
2019-01-25 20:07:01 +00:00
2019-01-30 15:55:54 +00:00
.. image :: https://img.shields.io/discord/411401661714792449.svg?logo=discord
:target: https://discord.gg/7rmXa3S
:alt: Discord
2019-01-25 20:07:01 +00:00
2019-01-28 23:00:51 +00:00
.. image :: https://readthedocs.org/projects/nucypher/badge/?version=latest
2019-02-20 11:29:27 +00:00
:target: https://nucypher.readthedocs.io/en/latest/
2019-01-28 23:00:51 +00:00
:alt: Documentation Status
2019-01-25 20:12:31 +00:00
.. image :: https://img.shields.io/pypi/l/nucypher.svg
2019-01-25 22:05:18 +00:00
:target: https://www.gnu.org/licenses/gpl-3.0.html
2019-01-25 20:12:31 +00:00
2019-02-20 11:32:01 +00:00
.. _Umbral: https://github.com/nucypher/pyUmbral
2019-09-10 20:48:26 +00:00
The NuCypher network provides accessible, intuitive, and extensible runtimes and interfaces for secrets management and dynamic access control.
2019-09-21 20:42:53 +00:00
2019-09-03 01:05:45 +00:00
* Accessible - The network is permissionless and censorship-resistant.
2019-09-21 20:42:53 +00:00
There are no gate-keepers and anyone can use it.
2019-09-03 01:05:45 +00:00
* Intuitive - The network leverages the classic cryptological narrative of Alice and Bob
2019-09-21 20:42:53 +00:00
(with additional characters where appropriate). This character-based narrative permeates the code-base and helps
developers write safe, misuse-resistant code.
* Extensible - The network currently supports proxy re-encryption but can be extended to provide support for other cryptographic primitives.
2019-09-03 01:05:45 +00:00
2019-04-09 09:19:37 +00:00
Access permissions are baked into the underlying encryption,
and access can only be explicitly granted by the data owner via sharing policies.
Consequently, the data owner has ultimate control over access to their data.
At no point is the data decrypted nor can the underlying private keys be
determined by the NuCypher network.
Under the hood, the NuCypher network uses the Umbral_
threshold proxy re-encryption scheme to provide cryptographic access control.
How does NuCypher work?
-----------------------
2019-02-20 11:32:01 +00:00
2019-09-25 13:59:33 +00:00
.. image :: ./.static/img/nucypher_overview.svg
:target: ./.static/img/nucypher_overview.svg
2019-02-20 11:32:01 +00:00
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.
2019-10-01 16:59:44 +00:00
2. A group of Ursulas, which are nodes on the NuCypher network,
2019-09-25 13:59:33 +00:00
receive information about the policy, called a PolicyArrangement that include
a re-encryption key share. The Ursulas stand ready to re-encrypt data in exchange for payment
in fees and token rewards. Thanks to the use of proxy re-encryption,
Ursulas and the storage layer never have access to Alice's plaintext data.
2019-10-01 16:59:44 +00:00
3. Each policy created by Alice has an associated encryption key, which can be used
by any entity (Enrico) to encrypt data on Alice's behalf.
2019-02-28 10:16:10 +00:00
This entity could be an IoT device in her car, a collaborator assigned
the task of writing data to her policy, or even a third-party creating
data that belongs to her –
2019-02-20 11:32:01 +00:00
The resulting encrypted data can be uploaded to IPFS, Swarm, S3,
or any other storage layer.
2019-09-25 13:59:33 +00:00
4. Bob, a data recipient, obtains the encrypted data from the storage layer and sends an access request
to the NuCypher network. If the policy is satisfied, the data is re-encrypted to his public key
2019-02-20 11:32:01 +00:00
and he can decrypt it with his private key.
2019-09-28 15:31:31 +00:00
5. Ursulas earn fees and token rewards for performing
2019-09-27 18:43:19 +00:00
re-encryption operations.
2019-09-26 20:05:43 +00:00
2019-02-21 09:12:47 +00:00
More detailed information:
2019-01-25 20:07:01 +00:00
2019-01-26 01:56:14 +00:00
- GitHub https://www.github.com/nucypher/nucypher
2019-01-25 20:07:01 +00:00
- 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*
2020-04-01 17:51:45 +00:00
https://github.com/nucypher/mining-paper/blob/master/2_phase_minting_schedule/twophase_subsidy_model.pdf
2020-03-27 14:06:41 +00:00
*"Temporally equitable subsidies: a two-phase token minting schedule"*
*by Arjun Hassard - NuCypher*
2019-01-25 20:07:01 +00:00
**Cryptography**
https://github.com/nucypher/umbral-doc/blob/master/umbral-doc.pdf
*"Umbral A Threshold Proxy Re-Encryption Scheme"*
2019-01-26 01:56:14 +00:00
*by David Nuñez - NuCypher*
2019-01-25 20:07:01 +00:00
.. warning ::
2020-02-21 17:00:12 +00:00
NuCypher is currently in the *Beta* development stage and is **not** intended for use in production.
2019-01-25 20:07:01 +00:00
.. toctree ::
2019-02-01 16:04:55 +00:00
:maxdepth: 1
:caption: Guides
2019-01-25 20:07:01 +00:00
guides/installation_guide
2020-02-21 17:00:12 +00:00
guides/network_node/network_node
guides/development/development
2020-05-14 18:50:24 +00:00
guides/ethereum_node
2020-02-11 00:35:03 +00:00
guides/worklock_guide
2020-05-14 18:50:24 +00:00
guides/environment_variables
2019-08-21 19:08:32 +00:00
guides/contribution_guide
2019-01-25 20:07:01 +00:00
.. toctree ::
2019-02-01 16:04:55 +00:00
:maxdepth: 1
:caption: Demos
2019-01-25 20:07:01 +00:00
demos/local_fleet_demo
demos/finnegans_wake_demo
demos/heartbeat_demo
2019-01-28 21:10:12 +00:00
.. toctree ::
:maxdepth: 1
2019-02-01 16:04:55 +00:00
:caption: Architecture
2019-01-28 21:10:12 +00:00
2019-09-26 20:05:43 +00:00
architecture/character
2020-04-21 19:20:28 +00:00
architecture/worklock
2019-01-28 21:10:12 +00:00
architecture/contracts
architecture/upgradeable_proxy_contracts
2020-01-09 17:48:43 +00:00
architecture/sub_stakes
2019-02-27 14:02:52 +00:00
architecture/slashing
2020-08-19 13:43:01 +00:00
architecture/service_fees
2019-01-28 21:10:12 +00:00
2019-01-25 20:07:01 +00:00
.. toctree ::
2019-02-01 16:04:55 +00:00
:maxdepth: 1
:caption: API
2019-01-25 20:07:01 +00:00
2020-04-24 15:45:59 +00:00
api/nucypher.blockchain
api/nucypher.characters
api/nucypher.config
api/nucypher.policy
2020-04-28 00:07:01 +00:00
api/nucypher.network
api/nucypher.datastore
api/nucypher.crypto
2019-01-25 20:07:01 +00:00
.. toctree ::
:maxdepth: 1
2019-02-01 16:04:55 +00:00
:caption: Release Notes
2019-01-25 20:07:01 +00:00
release_notes/genesis_release
2019-10-03 18:13:14 +00:00
release_notes/pre_release_epics
2020-05-01 19:16:57 +00:00
release_notes/releases.rst
2019-01-25 20:07:01 +00:00
2019-10-01 13:49:08 +00:00
.. toctree ::
:maxdepth: 1
:caption: Glossary
glossary
2020-01-30 21:25:04 +00:00
.. toctree ::
:maxdepth: 1
:caption: Support
2020-04-14 21:47:44 +00:00
support/node_providers
2020-01-30 21:25:04 +00:00
support/community
support/troubleshooting
support/faq
2019-01-25 20:07:01 +00:00
Indices and Tables
==================
* :ref: `genindex`
* :ref: `modindex`
* :ref: `search`
