Go to file
derekpierre 4f5b6c6d36 Update clef URIs to use the "clef://" scheme prefix 2020-05-28 17:21:24 -04:00
.circleci circleCi adjustments; Dont install deps for package only jobs. 2020-05-28 11:59:08 -07:00
.github Add "end-of-file-fixer" to pre-commit hooks 2020-05-19 14:28:29 -04:00
deploy Include optional prometheus installation with pip install nucypher[ursula] and inclusion in Dockerfile 2020-05-28 11:59:08 -07:00
dev/docker install nucypher before solc in dev/docker 2020-05-06 17:56:27 -07:00
docs Update clef URIs to use the "clef://" scheme prefix 2020-05-28 17:21:24 -04:00
examples Add pre-commit hook to ensure that AGPL license is included in python source files 2020-05-22 08:55:06 -04:00
newsfragments Initial setup for towncrier 2020-05-28 11:59:08 -07:00
nucypher Remove circleci CLI instalation from post-install; Correct __about__ module docstring location. 2020-05-28 12:01:18 -07:00
scripts Initial setup for towncrier 2020-05-28 11:59:08 -07:00
tests Skip an inaccurate test. 2020-05-28 11:59:46 -07:00
.bandit Add "end-of-file-fixer" to pre-commit hooks 2020-05-19 14:28:29 -04:00
.bumpversion.cfg Bump version: 2.1.0-beta.8 → 2.1.0-beta.9 2020-05-28 02:25:45 +02:00
.coveragerc Include pytest option -s in pytest.ini (compliments stdout trap fixture) 2020-05-20 21:42:23 -07:00
.flake8 Add flake8 to pre-commit 2020-04-23 17:23:43 -07:00
.gitignore Add "end-of-file-fixer" to pre-commit hooks 2020-05-19 14:28:29 -04:00
.nucypher-license Add pre-commit hook to ensure that AGPL license is included in python source files 2020-05-22 08:55:06 -04:00
.pre-commit-config.yaml Use specific commit hash for versioning of `insert-license` pre-commit hook. 2020-05-22 08:55:15 -04:00
CODE_OF_CONDUCT.md Add "end-of-file-fixer" to pre-commit hooks 2020-05-19 14:28:29 -04: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
MANIFEST.in Document makefile commands in make help 2020-05-28 11:59:47 -07:00
Makefile Document makefile commands in make help 2020-05-28 11:59:47 -07:00
Pipfile Relock dependencies with 'make lock' 2020-05-28 11:59:47 -07:00
Pipfile.lock Relock dependencies with 'make lock' 2020-05-28 11:59:47 -07:00
README.md Use png image for README 2019-10-04 09:49:08 -04:00
SECURITY.md Create SECURITY.md 2020-03-31 18:25:15 +00:00
dev-requirements.txt Relock dependencies with 'make lock' 2020-05-28 11:59:47 -07:00
docs-requirements.txt Readability improvements for setup.py, include twine in deploy extra; pip flags for docs-reqs. 2020-05-28 11:59:08 -07:00
mypy.ini Ignore setup.py in mypy configuration. 2020-05-28 11:59:47 -07:00
pyproject.toml Initial setup for towncrier 2020-05-28 11:59:08 -07:00
pytest.ini Add an explicit junit_family=xunit1 to pytest.ini to silence the deprecation warning 2020-05-26 10:26:42 -07:00
readthedocs.yml Reintroduce pip extras docs, dev, deploy, and benchmark. 2020-05-28 11:59:08 -07:00
requirements.txt Relock dependencies with 'make lock' 2020-05-28 11:59:47 -07:00
setup.cfg Reconfigure setup.py; External deps, code cleanup, post install hook, installation options. 2020-05-28 11:59:08 -07:00
setup.py Remove circleci CLI instalation from post-install; Correct __about__ module docstring location. 2020-05-28 12:01:18 -07:00
tox.ini Minimal example tox config for py36,37,38 2020-05-28 11:59:08 -07:00

README.md

A decentralized cryptological network offering accessible, intuitive, and extensible runtimes and interfaces for secrets management and dynamic access control.

pypi pyversions codecov circleci discord Documentation Status license


The NuCypher network provides accessible, intuitive, and extensible runtimes and interfaces for secrets management and dynamic access control.

  • Accessible - The network is permissionless and censorship-resistant. There are no gate-keepers and anyone can use it.
  • Intuitive - The network leverages the classic cryptological narrative of Alice and Bob (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.

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. A group of Ursulas, which are nodes on the NuCypher network, 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.

  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. 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.

  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 and he can decrypt it with his private key.

  5. Ursulas earn fees and token rewards for performing re-encryption operations.

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.