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

newsfragment for PR #2897

pull/2897/head
Kieran Prasch 2022-04-04 15:07:21 -07:00
parent a6b3ccd114
commit ffcf2dda39
3 changed files with 2 additions and 207 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
docs/source/demos/finnegans_wake_demo.rst
View File

@ -1,82 +0,0 @@
Finnegan's Wake Demo
====================
.. figure:: https://cdn-images-1.medium.com/max/600/0*b42NPOnflrY07rEf.jpg
:width: 100%
Overview
--------
This demo is an example of a network of PRE nodes allowing Alice to share
data with Bob using proxy re-encryption. This enables the private sharing of data across public consensus networks,
without revealing data keys to intermediary entities.
+------+-----------+----------------------------------------------------------------------------------------------+
| Step | Character | Operation |
+======+===========+==============================================================================================+
| 1 | Alice | Alice sets a Policy on the PRE Nodes in the Threshold Network and grants access to Bob |
+------+-----------+----------------------------------------------------------------------------------------------+
| 2 | Alice | Label and Alice's public key provided to Bob |
+------+-----------+----------------------------------------------------------------------------------------------+
| 3 | Bob | Bob joins the policy with Label and Alice's public key |
+------+-----------+----------------------------------------------------------------------------------------------+
| 4 | Enrico | A data source created for the policy |
+------+-----------+----------------------------------------------------------------------------------------------+
| 5 | Enrico | Each plaintext message gets encrypted by Enrico, which results in a messageKit |
+------+-----------+----------------------------------------------------------------------------------------------+
| 6 | Bob | Bob receives and reconstructs Enrico from the Policy's public key and Enrico's public key |
+------+-----------+----------------------------------------------------------------------------------------------+
| 7 | Bob | Bob retrieves the original message from Enrico and MessageKit |
+------+-----------+----------------------------------------------------------------------------------------------+
There are two version of the example, one federated example using a local federated network
and another example using the PRE application development tesnet on Goerli: "Lynx".
Install NuCypher
----------------
Acquire the ``nucypher`` application code and install the dependencies:
.. code::
$ git clone https://github.com/nucypher/nucypher.git
...
$ python -m venv nucypher-venv
$ source nucypher-venv/bin/activate
(nucypher-venv)$ cd nucypher
(nucypher-venv)$ pip install -e .
Federated Demo
--------------
First run the local federated network:
.. code::
python ../run_demo_ursula_fleet.py
Then run the demo:
.. code::
python finnegans-wake-demo-federated.py
Testnet Demo
------------
First, configure the demo. Be sure tat alice's address has some Goerli ETH.
.. code::
export DEMO_ETH_PROVIDER_URI=<GOERLI RPC ENDPOINT>
export DEMO_ALICE_ETH_ADDRESS=<ETH ADDRESS>
export DEMO_SIGNER_URI=keystore://<PATH TO KEYSTORE>
Then run the demo:
.. code::
python finnegans-wake-demo-testnet.py

125
docs/source/demos/heartbeat_demo.rst
View File

@ -1,125 +0,0 @@
Heartbeat Demo
====================
.. image:: ../.static/img/heart_monitor.svg
:target: ../.static/img/heart_monitor.svg
Overview
--------
Alicia has a Heart Monitor device that measures her heart rate and outputs this data in encrypted form.
Since Alicia knows that she may want to share this data in the future, she uses NuCypher to create
a *policy public key* for her Heart Monitor to use, so she can read and delegate access to the encrypted
data as she sees fit.
The Heart Monitor uses this public key to produce a file with some amount of encrypted heart rate measurements.
This file is uploaded to a storage layer (e.g., IPFS, S3, or whatever you choose).
At some future point, she wants to share this information with other people, such as her Doctor.
Once she obtains her Doctor's public keys, she can create a policy with PRE nodes to grant access to him.
After this, her Doctor can read the file with encrypted data (which was uploaded by the Heart Monitor) and
request a re-encrypted ciphertext for each measurement, which can be opened with the Doctor's private key.
This simple example showcases many interesting and distinctive aspects of NuCypher:
- Alicia can create policy public keys **before knowing** the potential consumers.
- Alicia, or anyone knowing the policy public key (e.g., the Heart Monitor),
can produce encrypted data that belongs to the policy.
Again, this can happen **before granting access** to any consumer.
- As a consequence of the previous point, the Heart Monitor is completely
unaware of the recipients. In its mind, it's producing data **for Alicia**.
- Alicia never interacts with the Doctor: she only needs the Doctor's public keys.
- Alicia only interacts with a network of PRE nodes for granting access to the Doctor.
After this, she can even disappear from the face of the Earth.
- The Doctor never interacts with Alicia or the Heart Monitor:
he only needs the encrypted data and some policy metadata.
The NuCypher Characters
-----------------------
The actors in this example can be mapped naturally to :doc:`Characters </api/nucypher.characters>` in the NuCypher narrative:
- Since Alicia is the only one capable of granting access,
she retains full control over the data encrypted for her.
As such, she can be considered as the **data owner** or the **policy authority**.
This corresponds to the :class:`~nucypher.characters.lawful.Alice` character.
- The Heart Monitor, or any other data sources that **encrypt data** on Alicia's behalf,
is portrayed by the :class:`~nucypher.characters.lawful.Enrico` character.
- PRE Nodes are called :class:`~nucypher.characters.lawful.Ursula` in our terminology.
They receive the access policy from Alice and stand ready to
re-encrypt data in exchange for payment in fees and token rewards.
In a way, they **enforce the access policy** created by Alicia.
- The Doctor acts as a **data recipient**, and only can decrypt Alicia's data
if she grants access to him.
This is modelled by the :class:`~nucypher.characters.lawful.Bob` character.
Install NuCypher
----------------
Acquire the ``nucypher`` application code and install the dependencies:
.. code::
$ git clone https://github.com/nucypher/nucypher.git
...
$ python -m venv nucypher-venv
$ source nucypher-venv/bin/activate
(nucypher-venv)$ cd nucypher
(nucypher-venv)$ pip install -e .
Run the Demo
------------
Assuming you already have ``nucypher`` installed with the ``demos`` extra,
running the Heartbeat demo involves running a local fleet of federated Ursulas in the ``examples/`` directory,
and executing the ``alicia.py`` and ``doctor.py`` scripts contained in the ``examples/heartbeat_demo`` directory.
First, run the local fleet of federated Ursulas in a separate terminal:
.. code::
(nucypher)$ python examples/run_demo_ursula_fleet.py
This provides a network of 12 local federated Ursulas.
Next, from the ``examples/heartbeat_demo`` directory, run ``alicia.py``:
.. code::
(nucypher)$ python alicia.py
This will create a temporal directory called ``alicia-files``
that contains the data for making Alicia persistent (i.e., her private keys).
Apart from that, it will also generate data and keys for the demo.
What's left is running the ``doctor.py`` script:
.. code::
(nucypher)$ python doctor.py
This script will read the data generated in the previous step and retrieve
re-encrypted ciphertexts by means of the network of PRE nodes.
The result is printed in the console:
.. code::
Creating the Doctor ...
Doctor = ⇀Maroon Snowman DarkSlateGray Bishop↽ (0xA36bcd5c5Cfa0C1119ea5E53621720a0C1a610F5)
The Doctor joins policy for label 'heart-data-❤️-e917d959'
----------------------❤︎ (82 BPM) Retrieval time: 3537.06 ms
---------------------❤︎ (81 BPM) Retrieval time: 2654.51 ms
-------------------------❤︎ (85 BPM) Retrieval time: 1513.32 ms
----------------------------❤︎ (88 BPM) Retrieval time: 1552.66 ms
-----------------------❤︎ (83 BPM) Retrieval time: 1720.66 ms
---------------------❤︎ (81 BPM) Retrieval time: 1485.25 ms
---------------------❤︎ (81 BPM) Retrieval time: 1459.16 ms
---------------------❤︎ (81 BPM) Retrieval time: 1520.30 ms
----------------❤︎ (76 BPM) Retrieval time: 1479.54 ms
----------------❤︎ (76 BPM) Retrieval time: 1464.17 ms
---------------------❤︎ (81 BPM) Retrieval time: 1483.04 ms
----------------❤︎ (76 BPM) Retrieval time: 1687.72 ms
---------------❤︎ (75 BPM) Retrieval time: 1563.65 ms

2
newsfragments/2897.doc.rst Normal file
View File

@ -0,0 +1,2 @@
Updated examples and demos for usage on polygon/mainnet.