You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@milagro.apache.org by ki...@apache.org on 2019/08/23 16:04:32 UTC
[incubator-milagro-dta] branch initial-dta created (now f9ceb90)
This is an automated email from the ASF dual-hosted git repository.
kittohoward pushed a change to branch initial-dta
in repository https://gitbox.apache.org/repos/asf/incubator-milagro-dta.git.
at f9ceb90 updates README.md
This branch includes the following new commits:
new f9ceb90 updates README.md
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[incubator-milagro-dta] 01/01: updates README.md
Posted by ki...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
kittohoward pushed a commit to branch initial-dta
in repository https://gitbox.apache.org/repos/asf/incubator-milagro-dta.git
commit f9ceb90dfe2bc06046e8bf2e6dc8c404f5a453f1
Author: howardkitto <ki...@gmail.com>
AuthorDate: Fri Aug 23 17:04:17 2019 +0100
updates README.md
---
README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++----------------
go.sum | 4 ++++
2 files changed, 57 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index 6541f92..0a5cbec 100644
--- a/README.md
+++ b/README.md
@@ -2,43 +2,79 @@
---
[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
-Milagro Custody DTA creates an ecosystem in which service providers can issue and protect secrets. When a node is connected to the network it is able to discover service providers who are able to offer secure long term storage of highly sensitive digital assets. It is written in Go and uses REST services based on the GoKit microservices framework: https://gokit.io/
+Milagro Custody D-TA is a colaborative key management server
+Milagro D-TA facilitates secure and auditable communication between people who to use key pairs (Beneficiaries) and service providers who can keep the secret keys safe (Custodians). It is written in Go and uses REST services based on the GoKit microservices framework: https://gokit.io/, it uses IPFS to create a shared immutable log of transactions and relies on Milagro-Crypto-C for it's crypto.
+## Plugins
+Milagro D-TA provides a basic set of services for creating identities for actors in the system, and passing encrypted communication between them but it assumes that different service providers will have their own "special sauce" for securely storing public keys, so the vanilla services can be extended using a plugin framework. Two basic plugins are included in this release to give you an idea of how this can be done.
+1. *BitcoinPlugin* Will generate a Bitcoin address and reveal the corresponding secret key
+2. *SafeGuardSecret* Enables the principal to use a public key to encrypt a string and decrypt it again
-## Linux / MacOS
+## Instalation
+To see Milagro D-TA in action clone this repo and run the build script. This has currently been tested on Ubuntu (we'll make a mac version shortly)
-Click here to down load the binary
+```
+git clone https://github.com/apache/incubator-milagro-dta.git
+
+cd incubator-milagro-dta
-To build the code
+./build_static.sh
+```
-Clone it and run
+Alternatively you can run Milagro D-TA in a docker container
```
-$ ./build.sh
+git clone https://github.com/apache/incubator-milagro-dta.git
+
+cd incubator-milagro-dta
+
+docker build -t mydta .
```
-## Developer Notes
+## Running Test
+
+```
+./cmd/servicetester/fulltest.sh
+```
+
+## Documentation
+
+You can find documentation for Milagro D-TA in the main [Milagro docs site](https://milagro.apache.org/)
+
+Which includes a quick start guide that will show you how to get Milagro D-TA to "do stuff"
+
+
+## Contributing
+
+ Key pairs are becoming key to our online lives, and keeping secret keys safe is a growing industry, we hope to create an ecosystem of custodial service providers who colabroate to make the Internet a safer place for everyone. We are keen to get contributions and feedback from anyone in this space. This is a brand new project so our development processes are still being figured out, but if you have a suggestion, question or wish to make a contribution go ahead raise an issue and someone [...]
+
+## License
+
+Apache License 2.0]
+
+## Credits
+
+Design and Concept... [Brian Spector](https://github.com/spector-in-london)
+Core Algorithm and Services... [Chris Morris](https://github.com/fluidjax)
+Framework and Refactoring... [Stanislav Mihaylov](https://github.com/smihaylov)
+Crypto Genius... [Kealan McCusker](https://github.com/kealan)
+Keeper of "The Apache Way"... [John McCane-Whitney](https://github.com/johnmcw)
+Prototype and Cat Herding... [Howard Kitto](https://github.com/howardkitto)
+
+
+
+
-You need to install protobufs
-If you change the portobufs definition run
-$ protoc -I=. --go_out=. ./docs.proto
-To add a new endpoint to the goKit Microservices framework
-1. First define the contract in milagro/pkg/milagroservice/proto.go
-Add structs for http transport
-Add responses to milagro/swagger/swagger.config,yaml
-2. Add and endpoint definition
-milagro/pkg/milagroendpoints/endpoints.go
-3. Create a handler factory
diff --git a/go.sum b/go.sum
index 306d48a..521c6f5 100644
--- a/go.sum
+++ b/go.sum
@@ -86,9 +86,11 @@ github.com/go-check/check v0.0.0-20180628173108-788fd7840127 h1:0gkP6mzaMqkmpcJY
github.com/go-check/check v0.0.0-20180628173108-788fd7840127/go.mod h1:9ES+weclKsC9YodN5RgxqK/VD9HM9JsCSh7rNhMZE98=
github.com/go-critic/go-critic v0.0.0-20181204210945-c3db6069acc5/go.mod h1:Jc75BZJv2dNy7opKH6bF29VveDQHfGZ6Asn/3phBesg=
github.com/go-critic/go-critic v0.0.0-20181204210945-ee9bf5809ead/go.mod h1:3MzXZKJdeXqdU9cj+rvZdNiN7SZ8V9OjybF8loZDmHU=
+github.com/go-kit/kit v0.8.0 h1:Wz+5lgoB0kkuqLEc6NVmwRknTKP6dTGbSqvhZtBI/j0=
github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
github.com/go-lintpack/lintpack v0.5.2/go.mod h1:NwZuYi2nUHho8XEIZ6SIxihrnPoqBTDqfpXvXAN0sXM=
github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE=
+github.com/go-logfmt/logfmt v0.4.0 h1:MP4Eh7ZCb31lleYCFuwm0oe4/YGak+5l1vA2NOE80nA=
github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk=
github.com/go-ole/go-ole v1.2.1/go.mod h1:7FAglXiTm7HKlQRDeOQ6ZNUHidzCWXuZWq/1dTyBNF8=
github.com/go-playground/locales v0.12.1 h1:2FITxuFt/xuCNP1Acdhv62OzaCiviiE4kotfhkmOqEc=
@@ -496,6 +498,7 @@ github.com/mattn/go-isatty v0.0.7 h1:UvyT9uN+3r7yLEYSlJsbQGdsaB/a0DlgWP3pql6iwOc
github.com/mattn/go-isatty v0.0.7/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
github.com/mattn/goveralls v0.0.2/go.mod h1:8d1ZMHsd7fW6IRPKQh46F2WRpyib5/X4FOpevwGNQEw=
+github.com/matttproud/golang_protobuf_extensions v1.0.1 h1:4hp9jkHxhMHkqkrB3Ix0jegS5sx/RkqARlsWZ6pIwiU=
github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE=
github.com/miekg/dns v1.1.4/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg=
@@ -560,6 +563,7 @@ github.com/pborman/uuid v1.2.0/go.mod h1:X/NO0urCmaxf9VXbdlT7C2Yzkj2IKimNn4k+gtP
github.com/pelletier/go-toml v1.1.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=