Go to file
Kieran Prasch 8407f22ebf
Felix expressing ideas on how to wait for chain sync using bootnodes
2019-06-03 22:50:40 +03:00
.circleci Show tests timings in CircleCI 2019-05-16 16:12:08 +02:00
deploy Felix expressing ideas on how to wait for chain sync using bootnodes 2019-06-03 22:50:40 +03:00
dev/docker add pipenv rebuild script 2019-05-27 07:13:46 +02:00
docs New endpoint name in docs. 2019-05-22 18:08:42 +02:00
examples Improved API for Character.from_public_bytes(). 2019-05-16 16:12:07 +02:00
nucypher Felix expressing ideas on how to wait for chain sync using bootnodes 2019-06-03 22:50:40 +03:00
scripts Support Constantinople 2019-05-28 11:27:38 -07:00
tests Another pass on handling published registry fetching. Found ancient stubs! 2019-06-03 22:50:40 +03:00
.bumpversion.cfg Bump version: 0.1.0-alpha.21 → 0.1.0-alpha.22 2019-04-06 15:00:44 -07:00
.coveragerc
.coveralls.yml
.gitignore Adding pyenv meta to gitignore. 2019-02-15 00:28:53 -07:00
CODE_OF_CONDUCT.md Add Getting Started section, Code of Conduct, and symlink to Contribution Guide 2019-02-05 15:13:23 -08:00
CONTRIBUTING.rst Add Getting Started section, Code of Conduct, and symlink to Contribution Guide 2019-02-05 15:13:23 -08:00
LICENSE Relicense to AGPLv3 for more freedom 2019-03-04 18:55:28 -08:00
Pipfile allow pytest 4 once again 2019-05-27 12:05:42 +02:00
Pipfile.lock allow pytest 4 once again 2019-05-27 12:05:42 +02:00
README.md Open New Epic Effort 2019-06-03 22:50:40 +03:00
dev-requirements.txt allow pytest 4 once again 2019-05-27 12:05:42 +02:00
mypy.ini
pytest.ini Test results were not captured by CircleCI. Fixed. 2019-01-05 00:54:34 +01:00
readthedocs.yml Include readthedocs.yml 2019-01-28 14:52:07 -08:00
requirements.txt fix dependency conflicts, update pipenv 2019-05-27 05:39:12 +02:00
setup.cfg Extrapolate more testing steps for CI workflows; Skip publication steps (preversion). 2018-12-05 16:16:59 -08:00
setup.py Include aafigure package in Pipfile, setup.py and docs 2019-03-27 11:05:15 +01:00

README.md

A proxy re-encryption network to empower privacy in decentralized systems

pypi pyversions codecov circleci discord Documentation Status license


The NuCypher network facilitates end-to-end encrypted data sharing for distributed apps and protocols. 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?

  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. Using her policy's public key, any entity can encrypt data on Alice's behalf. 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 for example, a lab analyzing medical tests. The resulting encrypted data can be uploaded to IPFS, Swarm, S3, or any other storage layer.

  3. A group of Ursulas, which are nodes of the NuCypher network, receive the access policy and 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.

  4. Bob, a data recipient, sends an access request to the NuCypher network. If Bob was granted an access policy by Alice, the data is re-encrypted for his public key, and he can subsequently decrypt it with his private key.

More detailed information:

Whitepapers

Network

"NuCypher - A proxy re-encryption network to empower privacy in decentralized systems"

by Michael Egorov, David Nuñez, and MacLane Wilkison - NuCypher

Economics

"NuCypher - Mining & Staking Economics"

by Michael Egorov, MacLane Wilkison - NuCypher

Cryptography

"Umbral: A Threshold Proxy Re-Encryption Scheme"

by David Nuñez

Getting Involved

NuCypher is a community-driven project and we're very open to outside contributions.

All our development discussions happen in our Discord server, where we're happy to answer technical questions, discuss feature requests, and accept bug reports.

If you're interested in contributing code, please check out our Contribution Guide and browse our Open Issues for potential areas to contribute.

Get up and running quickly by using our docker development setup

Security

If you identify vulnerabilities with any nucypher code, please email security@nucypher.com with relevant information to your findings. We will work with researchers to coordinate vulnerability disclosure between our stakers, partners, and users to ensure successful mitigation of vulnerabilities.

Throughout the reporting process, we expect researchers to honor an embargo period that may vary depending on the severity of the disclosure. This ensures that we have the opportunity to fix any issues, identify further issues (if any), and inform our users.

Sometimes vulnerabilities are of a more sensitive nature and require extra precautions. We are happy to work together to use a more secure medium, such as Signal. Email security@nucypher.com and we will coordinate a communication channel that we're both comfortable with.

A great place to begin your research is by working on our testnet. Please see our documentation to get started. We ask that you please respect testnet machines and their owners. If you find a vulnerability that you suspect has given you access to a machine against the owner's permission, stop what you're doing and immediately email security@nucypher.com.