dark-crystal-secrets HTTP API

m4gpi commented 5 years ago

I've been corresponding with folk about making our code more interoperable and enabling our secret verification to be accessible by other applications. We could do with a HTTP API for /lib/secrets-wrapper. For the wrapper in its current form, we can open up the following end-points (and there are likely more we could add over time as we extend the functionality of Dark Crystal):

POST /v1/secret/share
POST /v1/secret/combine
POST /v1/shard/verify
POST /v2/secret/share
POST /v2/secret/verify
POST /v2/secret/combine
POST /v2/shard/verify

Here's an example of how one could use this API and what response we'd send back...

// /v1/secret/share

var params = {
  secret: "X marks the spot",
  quorum: 3,
  shards: 5
}

request('http://localhost:8187/v1/secret/share', params, (err, response) => {
  // returns a JSON response object with the shards as the response body
  console.log(response)
  // {
  //   code: 200,
  //   body: [
  //     '8014743d37c565db0dce12e4994ebfe444a',
  //     '8024cf89c0f40debaae0684c5dacf3e581c',
  //     '8030bbb4f7316830a73e7cc8c2124af1c21',
  //     '804b708b9e5172c52624f6ad67d9368d7e5',
  //     '805f04b6a994171e2bfae229f8678f993d8' 
  //   ]
  // 
})

In addition, we could open up verifying secrets (which currently does exist but is closed off within the v2 wrapper (its a local function).

This would be brilliant as it would expose our secrets wrapper to any and all other languages. It can then be deployed as a component of another application (we could package into a container), rather than us having to port into other languages.

m4gpi commented 5 years ago

Core components required to build this:

Extract secrets-wrapper into a new package called dark-crystal-secrets
Require that package into scuttle-dark-crystal
Bump scuttle-dark-crystal version
Create new repository called dark-crystal-secrets-api
Write tests for the API end-points
Create a HTTP server and open up the end-points
Integrate with the relevant functions from dark-crystal-secrets and format JSON responses.
Ensure effective error handling and clear responses
Clear documentation on how and when to use the API

Nice to haves:

Wrap in a Docker container
Make port and domain configurable
Add /v1/auth and /v2/auth handshake endpoints for passing ephemeral keys and ensure two-way encrypted responses

gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

This issue now has a funding of 1000.0 DAI (1000.0 USD @ $1.0/DAI) attached to it as part of the Ethereum Foundation fund.

If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
- Want to chip in? Add your own contribution here.
- Questions? Checkout Gitcoin Help or the Gitcoin Slack
- $42,057.32 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work has been started.

These users each claimed they can complete the work by 3 weeks ago. Please review their action plans below:

1) devonwesley has applied to start work _(Funders only: approve worker | reject worker)_.

Going to submit ./secret-wrapper as an npm package called dark-crystal-secrets
Use the express framework for the API endpoints.
Use 'express-validator' to validate and sanitize endpoint data.
Write Test for endpoints using "supertest"
Create endpoints using dark-crystal-secrets functions with the formatted JSON response.
Use Swagger for the Docs.
Potentially use a node js container from Docker hub.
For the auth endpoints ill use SSL

Learn more on the Gitcoin Issue Details page.

2) hadasz has applied to start work _(Funders only: approve worker | reject worker)_.

The first things I will do to complete this are: -Check out current code -Make a plan for API -Write the API

(I am very familiar with shamirs secret sharing algorithm as I wrote a react-native library for it. https://github.com/ConsenSys/react-native-sssa

Learn more on the Gitcoin Issue Details page.

3) zyfrank has applied to start work _(Funders only: approve worker | reject worker)_.

really a great tool for web3, I'm familiar with some context of your product, want to take this

Learn more on the Gitcoin Issue Details page.

4) siteriaitaliana has applied to start work _(Funders only: approve worker | reject worker)_.

learn about the project
build the API using TDD/BDD approach

Learn more on the Gitcoin Issue Details page.

5) pierrickgt has applied to start work _(Funders only: approve worker | reject worker)_.

I can setup an express server and build an api to interact with the functions available in the lib.

Learn more on the Gitcoin Issue Details page.

6) kgibb8 has been approved to start work.

Create a new npm package called dark-crystal-secrets, port over lib/secrets-wrapper, edit permissions to include the DC team
TDD a JSON API using express called dark-crystal-secrets-api
Tests using tape / tape-plus and tap-spec
Sanitise requests to the API
Dockerise the application

Learn more on the Gitcoin Issue Details page.

spm32 commented 5 years ago

Hey @KGibb8 you're good to go :)

m4gpi commented 5 years ago

Great @ceresstation, thanks! Work has begun!

https://github.com/blockades/dark-crystal-secrets https://github.com/blockades/dark-crystal-secrets-api

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

m4gpi commented 5 years ago

Work underway robo @gitcoinbot

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

m4gpi commented 5 years ago

Yes robo...

m4gpi commented 5 years ago

[x] Extract secrets-wrapper into a new package called dark-crystal-secrets
[x] Require that package into scuttle-dark-crystal
[x] Bump scuttle-dark-crystal version
[x] Create new repository called dark-crystal-secrets-api
[x] Write tests for the API end-points
[x] Create a HTTP server and open up the end-points
[x] Integrate with the relevant functions from dark-crystal-secrets and format JSON responses.
[x] Ensure effective error handling and clear responses
[x] Clear explanation of when to use the API
[x] Docker and docker-compose
[x] Swagger API documentation
[x] Make port and domain configurable
[x] new tests for verify function in dark-crystal-secrets
[x] documentation for dark-crystal-secrets

https://github.com/blockades/dark-crystal-secrets-api/

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

m4gpi commented 5 years ago

This issue is completed @gitcoinbot @ceresstation

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 5 years ago

@kgibb8 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] reminder (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work for 1000.0 DAI (1000.0 USD @ $1.0/DAI) has been submitted by:

@ceresstation please take a look at the submitted work:

PR by @KGibb8
PR by @KGibb8
PR by @KGibb8

Learn more on the Gitcoin Issue Details page
Want to chip in? Add your own contribution here.
Questions? Checkout Gitcoin Help or the Gitcoin Slack
$56,884.77 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

The funding of 1000.0 DAI (1000.0 USD @ $1.0/DAI) attached to this issue has been approved & issued to @KGibb8.

Learn more on the Gitcoin Issue Details page
Questions? Checkout Gitcoin Help or the Gitcoin Slack
$56,384.73 more funded OSS Work available on the Gitcoin Issue Explorer

blockades / scuttle-dark-crystal

dark-crystal-secrets HTTP API #45