-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
see #26
- Loading branch information
Showing
74 changed files
with
1,105 additions
and
163 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
sidebar_position: 2 | ||
title: Tutorial | ||
tags: [quickstart] | ||
--- | ||
|
||
:::Warning | ||
|
||
:construction_worker: This section is under construction | ||
|
||
::: | ||
|
||
## 1. Configure the Privacy Computation Engine | ||
|
||
## 2. Set-up Storage | ||
|
||
## 3. Initiate a Web App | ||
|
||
## 4. Encrypt Data | ||
|
||
## 5. Capture Data | ||
|
||
## 6. Install the Privacy Request Capture Interface | ||
|
||
## 7. Make a Privacy Request | ||
|
||
## 8. Decrypt Data |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: Introduction | ||
sidebar_position: 1 | ||
tags: ["introduction"] | ||
--- | ||
|
||
The blindnet devkit **Privacy Computation Engine** is a service that interpret your rights to hold and treat a particular Data Capture at a particular point of time and calculate a response to [Data Subjects'](/docs/references/lexicon#data-subject) [Privacy Requests](docs/references/lexicon#privacy-request). | ||
|
||
It associates a [Privacy Compiler](./references/high-level-architecture#privacy-compiler) and [Customization API](./references/high-level-architecture#customization-api). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,20 @@ | ||
# How Privacy Computation Engine Works | ||
|
||
## Configuring your Privacy Computation Engine | ||
--- | ||
title: Configuring your Privacy Computation Engine | ||
sidebar_position: 2 | ||
tags: ['guide'] | ||
--- | ||
|
||
You must first configure the Privacy Computation Engine in order to make the most of it. | ||
|
||
It needs to know about: | ||
|
||
- General information about your Organization and its' data processing policies (Equivalent to a RoPA - Record of Processing Activities) | ||
- Mappings of your data structures to [PRIV](https://github.com/blindnet-io/product-management/blob/main/refs/schemas/priv/RFC-PRIV.md) Data Categories | ||
- Few choices you have to make about when to authenticate the user (before or after they make a Privacy Request), and when to deliver automatic responses and when to wait for validation | ||
|
||
To Configure your Privacy Computation Engine prepare the following information: | ||
|
||
<!-- prettier-ignore --> | ||
| Information | Format | Example| | ||
| :----: | :-----: | :--------| | ||
| Name and contact details of your Organization and its representative | `string` | `Blindnet Inc. [email protected] Vuk Janosevic`| | ||
|
@@ -26,12 +32,14 @@ To Configure your Privacy Computation Engine prepare the following information: | |
| A table of data transfers | `Transfer Record` | see bellow | | ||
|
||
Based on this information the Privacy Computation Engine creates a set of **Processing Records** that contain: | ||
|
||
- Identification of the data field in your database. Table/Object and field/property. E.g. `USER`, `e_mail_address` | ||
- A [Privacy Scope](https://github.com/blindnet-io/product-management/blob/main/refs/schemas/priv/RFC-PRIV.md#privacy-scope) e.g. (`CONTACT.EMAIL` x {`COLLECTION`, `STORING`, `USING`} x {`SERVICES`,`COMPLIANCE`}) | ||
- One or more [Legal Bases](https://github.com/blindnet-io/product-management/blob/main/refs/schemas/priv/RFC-PRIV.md#legal-base) e.g. a legal base of type `CONTRACT` | ||
|
||
It is possible to end-up having serval records for one Data Category, e.g. | ||
|
||
<!-- prettier-ignore --> | ||
| Data in database | Privacy Scope | Legal bases | | ||
| :----: | :-----: | :--------| | ||
| table:`USER` field:`name` | `NAME.FIRST-NAME` x {`COLLECTION`, `STORING`, `USING`} x {`SERVICES`,`COMPLIANCE`} | `CONTRACT` | | ||
|
@@ -44,33 +52,20 @@ The same System is sending marketing and advertising e-mail to the user under `L | |
The System only shares the e-mail with partners under `CONSENT` legal base. | ||
|
||
A **Transfer Record** has: | ||
|
||
- One or more data categories being transferred outside of the system e.g. `CONTACT.EMAIL` | ||
- One or more Systems to which transfer is made (their IDs (URLs) and user-readable names) | ||
|
||
Multiple provenance objects can also be provided for the same data category. Consider the following examples: | ||
|
||
<!-- prettier-ignore --> | ||
| Provenance object | `data-category` | `provenance-category` | `system` | | ||
| :----: | :-----: | :-----: | :--------| | ||
| provenance1 | `CONTACT.EMAIL` | `USER.DATA-SUBJECT` | `https://thissystem.com` | | ||
| provenance2 | `CONTACT.EMAIL` | `TRANSFERRED` | `https://linkedin.com` | | ||
| provenance2 | `BEHAVIOR.CONNECTION` | `DERIVED` | `https://thissystem.com` | | ||
| provenance3 | `PROFILING` | `TRANSFERRED` | `https://marketing-data-exchange.com` | | ||
|
||
The records given in the example correspond to the situation of a System that collect the e-mail directly from the user (proveance1), | ||
but also, since the System uses OpenID and allow login through Linkedin, it may gain knowledge of e-mail from Linkedin (provenance2). | ||
The records given in the example correspond to the situation of a System that collect the e-mail directly from the user (proveance1), but also, since the System uses OpenID and allow login through Linkedin, it may gain knowledge of e-mail from Linkedin (provenance2). | ||
The system generates connection data, every time the user connects to it. | ||
It obtains profiling data about the user for a marketing data exchange platform, so that it can better target the user with marketing offers. | ||
|
||
## Using your Privacy Computation Engine | ||
|
||
The Privacy Computation Engine (PCE) processes a timeline of [PRIV Events](https://github.com/blindnet-io/product-management/blob/main/refs/schemas/priv/RFC-PRIV.md#events). | ||
Feed anything that is a PRIV event (e.g. Consent, Legal Base Event, Privacy Request) to your PCE. | ||
The PCE will order them in a timeline. | ||
|
||
<img height="300" src="./img/PCEexplained.gif" /> | ||
|
||
Processing the timeline of PRIV events, the PCE will deliver recommendations of [Privacy Request Responses](https://github.com/blindnet-io/product-management/blob/main/refs/schemas/priv/RFC-PRIV.md#privacy-request-response) | ||
|
||
The PCE decides on the responses to recommend by calculating, at each moment an Eligible Privacy Scope. | ||
The component responsible for translating PRIV events into operations over the Eligible Privacy Scope is called Privacy Compiler. | ||
See [How Privacy Compiler Works](./pc.mdx) to learn more. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: Using your Privacy Computation Engine | ||
sidebar_position: 3 | ||
tags: ['guide'] | ||
--- | ||
|
||
|
||
The Privacy Computation Engine (PCE) processes a timeline of [PRIV Events](https://github.com/blindnet-io/product-management/blob/main/refs/schemas/priv/RFC-PRIV.md#events). | ||
|
||
Feed anything that is a PRIV event (e.g. Consent, Legal Base Event, Privacy Request) to your PCE. | ||
The PCE will order them in a timeline. | ||
|
||
<img height="300" src="/img/how_it_works/PCEexplained.gif" /> | ||
|
||
Processing the timeline of PRIV events, the PCE will deliver recommendations of [Privacy Request Responses](https://github.com/blindnet-io/product-management/blob/main/refs/schemas/priv/RFC-PRIV.md#privacy-request-response) | ||
|
||
The PCE decides on the responses to recommend by calculating, at each moment an Eligible Privacy Scope. | ||
The component responsible for translating PRIV events into operations over the Eligible Privacy Scope is called Privacy Compiler. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Computation", | ||
"position": 3 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
import DocCardList from '@theme/DocCardList'; | ||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; | ||
|
||
# Privacy Computation Engine | ||
|
||
<DocCardList items={useCurrentSidebarCategory().items}/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
title: Introduction | ||
sidebar_position: 1 | ||
tags: ["introduction"] | ||
--- | ||
|
||
The blindnet devkit provides several user interfaces to allow different kinds of users to interact around Privacy Requests and help developers to execute privacy-by-design and privacy UX. | ||
|
||
Those interfaces are delivered as a collection of Web Components and JS libraries called [Privacy Components for the Web](https://github.com/blindnet-io/privacy-components-web). | ||
|
||
This allow you to embed any of this user interfaces independendly in any web page or application. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Installation | ||
sidebar_position: 2 | ||
tags: ["guide"] | ||
--- | ||
|
||
> :construction_worker: This section is under construction |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "User Interfaces", | ||
"position": 4 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
import DocCardList from '@theme/DocCardList'; | ||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; | ||
|
||
# User Interfaces | ||
|
||
<DocCardList items={useCurrentSidebarCategory().items}/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Introduction | ||
sidebar_position: 1 | ||
tags: ["introduction"] | ||
--- | ||
|
||
> :construction_worker: This section is under construction |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Storage", | ||
"position": 5 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
import DocCardList from '@theme/DocCardList'; | ||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; | ||
|
||
# Storage | ||
|
||
<DocCardList items={useCurrentSidebarCategory().items}/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Introduction | ||
sidebar_position: 1 | ||
tags: ["introduction"] | ||
--- | ||
|
||
> :construction_worker: This section is under construction |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Data Capture", | ||
"position": 6 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
import DocCardList from '@theme/DocCardList'; | ||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; | ||
|
||
# Data Capture | ||
|
||
<DocCardList items={useCurrentSidebarCategory().items}/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.