Go to file
Kieran Prasch 52f5440991 preserve CONTRIBUTING.rst 2023-10-30 23:13:12 +01:00
.github use v*.*.* branches instead of development 2023-10-23 19:22:48 +02:00
deploy Don't modify pip install in Dockerfile since requirements.txt is now being configured for the correct versions of nucypher-core/ferveo which may/may not be git refs. 2023-05-02 10:23:24 -07:00
docs/source preserve a simplified version of the README 2023-10-30 23:13:12 +01:00
examples Use ConditionType enum values instead of constants across codebase. 2023-10-18 20:25:56 -04:00
newsfragments newsfragment for PR #3311 2023-10-30 23:13:12 +01:00
nucypher apply code formatting 2023-10-30 23:13:12 +01:00
scripts removes documentation build support. 2023-10-30 23:13:12 +01:00
tests respond to RFCs in PR #3317 2023-10-30 20:58:03 +01:00
.bumpversion.cfg removes documentation build support. 2023-10-30 23:13:12 +01:00
.coveragerc Update coverage configuration to allow for better categorization of coverage reporting. 2022-11-14 18:07:53 -05:00
.dockerignore cloudworkers: clean disk space more thoroughly, stop containers first 2021-03-27 12:11:57 -07:00
.flake8 removes documentation build support. 2023-10-30 23:13:12 +01:00
.gitignore Move PRE examples to their own subfolder. 2023-09-28 11:53:20 -04:00
.pre-commit-config.yaml removes documentation build support. 2023-10-30 23:13:12 +01:00
CODE_OF_CONDUCT.md Add "end-of-file-fixer" to pre-commit hooks 2020-05-19 14:28:29 -04:00
CONTRIBUTING.rst preserve CONTRIBUTING.rst 2023-10-30 23:13:12 +01:00
LICENSE Relicense to AGPLv3 for more freedom 2019-03-04 18:55:28 -08:00
MANIFEST.in removes documentation build support. 2023-10-30 23:13:12 +01:00
Makefile removes documentation build support. 2023-10-30 23:13:12 +01:00
Pipfile relock depdendencies (without jinja pin) 2023-10-30 23:13:12 +01:00
Pipfile.lock relock depdendencies (without jinja pin) 2023-10-30 23:13:12 +01:00
README.md preserve a simplified version of the README 2023-10-30 23:13:12 +01:00
SECURITY.md removes documentation build support. 2023-10-30 23:13:12 +01:00
codecov.yml Fix code coverage to only focus on the `nucypher` folder. 2023-01-09 09:37:27 -05:00
dev-requirements.txt updates dependency on nucypher-core to v0.13.0 2023-10-24 20:28:38 +02:00
mypy.ini Ignore setup.py in mypy configuration. 2020-05-28 11:59:47 -07:00
pyproject.toml Add ruff linting to pre-commit and github actions workflow 2023-06-29 11:58:18 +01:00
pytest.ini Run coverage directly and not through pytest-cov - there are discrepancy in reports. 2022-11-16 11:14:32 -05:00
requirements.txt relock depdendencies (without jinja pin) 2023-10-30 23:13:12 +01: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 removes documentation build support. 2023-10-30 23:13:12 +01: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 discord license


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 - Staking Protocol & Economics"

by Michael Egorov, MacLane Wilkison, Arjun Hassard - NuCypher

"NuCypher - Pricing Protocol & Economics"

by Arjun Hassard - 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.