Nucypher
/
nucypher
mirror of https://github.com/nucypher/nucypher.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #924 from cygnusv/readme 

Updates README: Slight touch to first paragraph. Codecov badge
pull/944/head
K Prasch 2019-04-10 19:26:58 +03:00 committed by GitHub
parent 8e1ee72776 835800d567
commit 2f81e61ca1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -4,24 +4,27 @@
[![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/)
[![coveralls](https://coveralls.io/repos/github/nucypher/nucypher/badge.svg?branch=master)](https://coveralls.io/github/nucypher/nucypher?branch=master)
[![codecov](https://codecov.io/gh/nucypher/nucypher/branch/master/graph/badge.svg)](https://codecov.io/gh/nucypher/nucypher)
[![circleci](https://img.shields.io/circleci/project/github/nucypher/nucypher.svg?logo=circleci)](https://circleci.com/gh/nucypher/nucypher/tree/master)
[![discord](https://img.shields.io/discord/411401661714792449.svg)](https://discord.gg/7rmXa3S)
[![discord](https://img.shields.io/discord/411401661714792449.svg?logo=discord)](https://discord.gg/7rmXa3S)
[![Documentation Status](https://readthedocs.org/projects/nucypher/badge/?version=latest)](https://nucypher.readthedocs.io/en/latest/)
[![license](https://img.shields.io/pypi/l/nucypher.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
----
The NuCypher network uses the [Umbral](https://github.com/nucypher/pyUmbral)
threshold proxy re-encryption scheme to provide cryptographic access control
The NuCypher network facilitates end-to-end encrypted data sharing
for distributed apps and protocols.
Applications can use the NuCypher network to facilitate end-to-end encrypted
data sharing via sharing policies. Access permissions are baked into the
underlying encryption, and access can only be explicitly granted by the data owner.
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](https://github.com/nucypher/pyUmbral)
threshold proxy re-encryption scheme to provide cryptographic access control.
# How does NuCypher work?
01. 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.

19
docs/source/index.rst
View File

@ -15,8 +15,8 @@ NuCypher
:target: https://circleci.com/gh/nucypher/nucypher/tree/master
:alt: CircleCI build status
.. image:: https://coveralls.io/repos/github/nucypher/nucypher/badge.svg?branch=master
:target: https://coveralls.io/github/nucypher/nucypher?branch=master
.. image:: https://codecov.io/gh/nucypher/nucypher/branch/master/graph/badge.svg
:target: https://codecov.io/gh/nucypher/nucypher
.. image:: https://img.shields.io/discord/411401661714792449.svg?logo=discord
:target: https://discord.gg/7rmXa3S
@ -31,8 +31,19 @@ NuCypher
.. _Umbral: https://github.com/nucypher/pyUmbral
The NuCypher network uses the Umbral_ threshold proxy re-encryption scheme
to provide cryptographic access controls for distributed apps and protocols.
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