nucypher/README.md

53 lines
3.0 KiB
Markdown
Raw Permalink Normal View History

![](nucypher.png)
*Cryptographic primitives, hosted on the decentralized nodes of the Threshold network, offering accessible, intuitive, and extensible runtimes and interfaces for
2023-10-25 13:45:24 +00:00
secrets management and dynamic access control.*
2019-02-20 11:29:27 +00:00
[![pypi](https://img.shields.io/pypi/v/nucypher.svg?style=flat)](https://pypi.org/project/nucypher/)
[![pyversions](https://img.shields.io/pypi/pyversions/nucypher.svg)](https://pypi.org/project/nucypher/)
[![codecov](https://codecov.io/gh/nucypher/nucypher/branch/development/graph/badge.svg?token=9w1dAFqog5)](https://codecov.io/gh/nucypher/nucypher)
2019-04-09 09:43:27 +00:00
[![discord](https://img.shields.io/discord/411401661714792449.svg?logo=discord)](https://discord.gg/7rmXa3S)
2019-02-20 11:29:27 +00:00
[![license](https://img.shields.io/pypi/l/nucypher.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
----
# Threshold Access Control (TACo)
2019-01-25 22:05:18 +00:00
TACo is end-to-end encrypted data sharing and communication, without the requirement of
2023-10-25 13:45:24 +00:00
trusting a centralized authority, who might unilaterally deny service or even decrypt private user data. It is the only
access control layer available to Web3 developers that can offer a decentralized service, through a live,
well-collateralized and battle-tested network. See more here: [https://docs.threshold.network/applications/threshold-access-control](https://docs.threshold.network/applications/threshold-access-control)
2019-02-05 00:25:25 +00:00
# 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](https://discord.gg/threshold), where we're happy to answer
2023-10-25 13:45:24 +00:00
technical questions, discuss feature requests,
and accept bug reports.
2023-10-25 13:45:24 +00:00
If you're interested in contributing code, please check out
2023-10-25 14:40:28 +00:00
our [Contribution Guide](CONTRIBUTING.rst)
and browse our [Open Issues](https://github.com/nucypher/nucypher/issues) for potential areas to contribute.
2019-02-05 00:25:25 +00:00
# Security
2023-10-25 13:45:24 +00:00
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.
2019-02-05 00:25:25 +00:00
2023-10-25 13:45:24 +00:00
Throughout the reporting process, we expect researchers to honor an embargo period that may vary depending on the
severity of the disclosure.
2019-02-05 03:20:15 +00:00
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.
2023-10-25 14:40:28 +00:00
Please see our [documentation](https://docs.threshold.network) to get started.
2019-02-05 03:20:15 +00:00
We ask that you please respect testnet machines and their owners.
2023-10-25 13:45:24 +00:00
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.