You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@milagro.apache.org by ki...@apache.org on 2019/07/01 10:21:44 UTC

[incubator-milagro] branch dta/overview updated: describe indentity document

This is an automated email from the ASF dual-hosted git repository.

kittohoward pushed a commit to branch dta/overview
in repository https://gitbox.apache.org/repos/asf/incubator-milagro.git


The following commit(s) were added to refs/heads/dta/overview by this push:
     new acbd1ef  describe indentity document
acbd1ef is described below

commit acbd1effaf163d47e23a6133c12d5f18465edfe7
Author: howardkitto <ki...@gmail.com>
AuthorDate: Mon Jul 1 11:21:24 2019 +0100

    describe indentity document
---
 docs/d-ta-overview.md                    |   4 ++--
 docs/dta-details/encrypted-envelope.md   |   7 +++++++
 docs/dta-details/identity-documents.md   |   8 ++++++--
 docs/dta-details/why-ipfs.md             |   8 +++++++-
 website/sidebars.json                    |   1 +
 website/static/img/dta/RC1-Ecosystem.png | Bin 86849 -> 86861 bytes
 6 files changed, 23 insertions(+), 5 deletions(-)

diff --git a/docs/d-ta-overview.md b/docs/d-ta-overview.md
index 2373ae8..1f5a852 100644
--- a/docs/d-ta-overview.md
+++ b/docs/d-ta-overview.md
@@ -22,10 +22,10 @@ Milagro DTA provides a secure, distributed method of communication between benef
 
 1. How can actors in the system be identified and trusted?
 
-    **Answer:** Identity Documents
+    **Answer:** [Identity Documents](dta-details/identity-documents.md)
 2. How can records of interactions between actors in the system be trusted and verified?
 
-    **Answer:** Encrypted Envelopes via IPFS
+    **Answer:** [Encrypted Envelopes](dta-details/encrypted-envelope.md) via [IPFS](dta-details/why-ipfs.md)
 3. How can conditions for revealing or using secrets be specified? 
 
     **Answer:** Redemption Policies
diff --git a/docs/dta-details/encrypted-envelope.md b/docs/dta-details/encrypted-envelope.md
new file mode 100644
index 0000000..758db63
--- /dev/null
+++ b/docs/dta-details/encrypted-envelope.md
@@ -0,0 +1,7 @@
+---
+id: encrypted-envelope
+title: Encrypted Envelope
+sidebar_label: Encrypted Envelope
+---
+
+Protobuf, encryption s-mime etc...
\ No newline at end of file
diff --git a/docs/dta-details/identity-documents.md b/docs/dta-details/identity-documents.md
index bcbdbdb..472b172 100644
--- a/docs/dta-details/identity-documents.md
+++ b/docs/dta-details/identity-documents.md
@@ -9,7 +9,7 @@ In order to create an identity document Milagro DTA provides the following endpo
 
 [POST: /identity](http://localhost:3000/swagger/index.html#/identity/createIdentity)
 
-The document contains public keys for signing and key encapsulation. The Milagro DTA communication protocol uses protbufs for serialisation, the defitnition of an identity document is:
+An Identity Document contains public keys for signing and key encapsulation. The defitnition of an identity document is:
 ```
 message IDDocument {
     string AuthenticationReference  = 2 ;
@@ -20,8 +20,12 @@ message IDDocument {
     string Username                 = 7 ;
     int64 Timestamp                 = 8;
 }
+
 ```
-Authentication reference refers to Milagro's out of the box oAuth integration
+
+* Note: The Milagro DTA communication protocol uses [protobufs](https://developers.google.com/protocol-buffers/) for serialisation
+
+* `AuthenticationReference` refers to Milagro's out of the box [oAuth integration](authentication.md)
 
 The node that is used to create an identity document will store the seed and secret keys associated with the Identity. In RC1 these are store as a JSON file in the key value store:
 
diff --git a/docs/dta-details/why-ipfs.md b/docs/dta-details/why-ipfs.md
index abd5d74..9e5f752 100644
--- a/docs/dta-details/why-ipfs.md
+++ b/docs/dta-details/why-ipfs.md
@@ -4,4 +4,10 @@ title: Why IPFS?
 sidebar_label: Why IPFS?
 ---
 
-Milagro DTA aims to provide and auditable record of all interactions between actors in the system. Whenever a secret is created or redeemed an imutable, secure and attributrable record is kep. It is vital that all the actors in the system can refer to an agreed record of these transactions incase of dispute or inresponse to requests from third parties such as law enforcement or audit / compl
\ No newline at end of file
+Milagro DTA aims to provide and auditable record of all interactions between actors in the system. It is vital that all the actors in the system can refer to an agreed record of these transactions in case of dispute or in response to requests from third parties such as law enforcement, audit or compliance.  Milagro creates immutable, secure and attributable records of every interaction that occurs in the lifecycle of the actors and their dealings with secrets. We do this using the Inter  [...]
+
+IPFS is a globally distributed peer-to-peer file system - think GitHub meets BitTorrent. When a file is written (SET) into your local IPFS node a hash of the document is returned, you can then GET the document using that address. If somebody else who is running an IPFS tries to GET the same hash address the file will be pulled from your node to theirs. If the document is changed in way the hash will change. In this way a immutability and peer-to-peer consensus is achieved.
+
+:::Note: We appreciate feedback regarding this approach
+If more complex multi-party consensus is required we could implement something like [Paxos](https://understandingpaxos.wordpress.com/), [Raft](https://raft.github.io/), [Tendermint](https://tendermint.com/)
+
diff --git a/website/sidebars.json b/website/sidebars.json
index 9dc0b2d..efde24d 100644
--- a/website/sidebars.json
+++ b/website/sidebars.json
@@ -20,6 +20,7 @@
         "type":"subcategory",
         "label":"DTA Details",
         "ids":[ "dta-details/identity-documents",
+                "dta-details/encrypted-envelope",
                 "dta-details/why-ipfs",
                 "dta-details/authentication"]
       },
diff --git a/website/static/img/dta/RC1-Ecosystem.png b/website/static/img/dta/RC1-Ecosystem.png
index 59bf721..33826c0 100644
Binary files a/website/static/img/dta/RC1-Ecosystem.png and b/website/static/img/dta/RC1-Ecosystem.png differ