No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
backend separate database for different environments Jul 18, 2018
frontend update packages Jul 2, 2018
.gitignore commit gitignores May 22, 2018
LICENSE updating readme, licence, misc May 10, 2018
README.md add implementation guide Jul 25, 2018

README.md

Client-Side Raindrop UI - Web

This UI demo is an example implementation of the Client-Side Raindrop Authentication protocol. For a walkthrough of this process, see our implementation guide.

Initial Setup

  • Download the testing Hydro mobile app: after requesting an applicationId through the Hydrogen Platform developer portal, you will be given a Testflight link to download a version of the app compatible with the Sandbox environment. The live Hydro mobile app on the app store will not be compatible with your Sandbox development. When you have finished developing your integration in Sandbox, you will need to request and be given Production keys, at which point you can roll the product out to your users who will be using the public-facing Hydro mobile app on the App Store.

  • Initialize the example backend: visit the backend/ folder for setup instructions.

  • Initialize the example frontend: visit the frontend/ folder for setup instructions.

Note: If you restart your backend without refreshing the frontend, it's possible for some session variables to get out of sync. Not to fear, simply refreshing the frontend should fix any issues!

Terms

Once your demo is live, you can begin testing out the system! It will be helpful to define some key terms:

  • Backend: A privileged server running code. It can receive and send data to/from the frontend. The two communicate via the backend's internal API.
  • Database: The database, only accessible to code running on the backend, must store, at minimum, 3 columns: internalUsername, hydroID, confirmed. This codifies the following relationship: users of your site can link their account (identified by internalUsername, a unique identifier) with their hydroID (a unique identifier from the Hydro mobile app). When users first enter their hydroID, confirmed must be set to false, and should only be set to true after a user successfully signs a message (i.e. after you successfully call the verifySignature endpoint of the Hydro API).
  • Blockchain: Client Raindrop relies on information being stored in the blockchain. The Hydro API manages all interactions with the blockchain so you don't have to!
  • Frontend: The frontend is your client-facing website. Users must be able to opt in to Client Raindrop by providing their hydroID. They then should be prompted to verify this link via a first-time signature verification. Once the link is confirmed, users should be required to sign a message for every login/transaction/etc. that you wish to protect with Client Raindrop.
  • Raindrop SDK: A Javascript wrapper for making calls to the Hydro API. Abstracts away from many of the trivialities of making API calls.
  • Hydro API: The API that powers Client-Side Raindrop. The backend makes calls to the Hydro API, authenticated with your secret credentials.

Copyright & License

Copyright 2018 The Hydrogen Technology Corporation under the MIT License.