Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.84 KB

README.md

File metadata and controls

40 lines (30 loc) · 1.84 KB
Raw

Scatter Embed Checker

This script allows anyone to help make sure that Scatter Embed servers have verified files based on production branches of the project.

ScatterEmbed servers have a directory of hashes (you can see a JSON dir listing here https://embed.get-scatter.com/hashes) The root has a list of files which matches the files specified in the hashes directory. Each hash file contains a hash and a signature delimited by a pipe. For instance:

498fc0454a9f7066f4bf9bb004492357f33f62d1408c4da47cd55b8f61481090|SIG_K1_JuM6Hwnq7DTNWq1xs4fes3QGqzLxcbR9NQ4eKuKVtCSqcDmkbGGtNRXYg3BoUhSEm5coJYSNAN2DQCTcQqhv8i6Z7YiZsa

The hash is a sha256 of the entire file contents, and the signature is that hash signed with a known public key that is hard coded into Scatter wallet clients.

Checking process

  • Pull github tree and create an object of locally computed {filename:hash}
  • Check hash and signature against <server>/hashes/<filename>.hash
  • Pull file from <server>/<filename>, compute hash, and check against locally computed hash.

If all the above checks succeed for each file on the server, then the server is verified. If at any point a file fails a hash or signature check this script will notify our API as well as throw an error and exit.

Caveat: During a rolling upgrade, you might get false positives on failures. This happens when the production branch of ScatterEmbed diverges from the live set of servers being hosted through the load balancer. Once the tags change on the load balancer, the hashes will match again.

Install

  • git clone https://github.com/GetScatter/EmbedChecker.git
  • cd EmbedChecker
  • yarn or npm install
  • copy .env.example to .env

You can add a GitHub API key into the .env file if you are having issues with GitHub rejecting file tree fetches.

Run script

  • yarn start or npm start