hushnote

A small application written in Node/Express on the server and vanilla javascript on the client. It allows you to send encrypted one-time-use messages to someone via unique URL's that are generated on the server - once someone views the note, the note is destroyed.

There is also a public API that you can use if you would like to integrate it into your own applications.

Public URL: https://hushnote.herokuapp.com

API Endpoints

POST /api/create/

Headers: Content/Type = application/json
Body: {"note": "this is a test message"}
------------------------------------------
Success Response:
{
  "url": "https://hushnote.herokuapp.com/read/40312d32/160586e0",
  "error": null
}

GET /api/read/:key/:pass

Success Response:
{
  "note": "this is a test message",
  "message": "Note has been destroyed."
}

Note Not Found Response:
{
  "note": null,
  "message": "Could not find note, perhaps it has already been destroyed?"
}

Incorrect Pass Response:
{
  "note": null,
  "message": "Incorrect URL parameters. Note has been destroyed."
}

Spinning up your own instance

1. Check out the project by cloning it git clone https://github.com/joshterrill/hushnote and then cd hushnote/

2. Install dependencies by typing npm install

3. Rename the .env.example file to be .env by typing mv .env.example .env

4. Add your mongodb URL, secret passphrase, and other required variables to the .env file

5. In order for the server-side encryption and decryption to work correctly, an IV needs to be generated. This is a 16-character string that looks something like this: f8b43da1eb3cc7c5 which is the example that was put inside of the .env.example file. If you would like to generate your own, you can do so by running: node generate-iv.js

6. Type npm start to run