Skip to content

Latest commit

 

History

History
119 lines (85 loc) · 3.96 KB

README.md

File metadata and controls

119 lines (85 loc) · 3.96 KB
Raw

Safe Secrets - safe(r) and easy way to transfer passwords.

The primary use-case is sharing sensitive data by making the information self-destructed, accessible only once and protected by easy-to-share PIN code. I just needed a simple and better alternative to the most popular way of passing passwords, which is why this project was created. Doing this by email always made me concerned about the usual "security" of sending user and password info in two different emails - which is just a joke.

Usage

It runs on safesecret.info for real. Feel free to use it if you are crazy enough to trust me, or just run your own from prepared docker image. And of course, you can build from sources as well.

Create a Safesecret link to your message by entering 3 things:

  • Content of your secret message
  • Expiration time of your secret message
  • Secret PIN

This will give you a link which you can send by email, chat or share by using any other means. As soon as yout recipient opens the link they will be asked for the secret PIN and see your secret message. The PIN is (typically) numeric and easy to pass by a voice call or text message. Each link can be opened only once and the number of attempts to enter a wrong PIN is limited to 3 times by default.

ScreenShot

How safe is this thing?

  • It doesn't keep your original message or PIN anywhere, but encrypts your message with PIN (hashed as well)
  • It doesn't keep any sensitive info in any logs
  • It doesn't keep anything on a disk in any form (in case of default engine)
  • As soon as a message is read or expired it will be deleted and destroyed permanently
  • In order to steal your message, bad guys would need access to your link as well as PIN code

Feel free to suggest any other ways to make the process safer.

Installation

  1. Download docker-compose.yml
  2. Adjust your local docker-compose.yml with:
    • TZ - your local time zone
    • SIGN_KEY - something long and random
    • MAX_EXPIRE - maximum expiration period in secs, default 86400 (24h)
    • PIN_SIZE - default 5
    • PIN_ATTEMPTS - default 3
  3. Setup SSL:
    • The system can make valid certificates for you automatically. Just set:
    • In case you have your own certificates, copy them to etc/ssl and define:
      • SSL_CERT - SSL certificate (file name, not path)
      • SSL_KEY - SSL key (file name, not path)
  4. Run the system with docker-compose up -d. This will download a prepared image from docker hub and start all components.
  5. if you want to build it from sources - docker-compose build will do it, and then docker-compose up -d.

See docker-compose.yml for more details

API

Secrets provides trivial REST to save and load messages.

Save message

POST /v1/message, body - {"message":"some top secret info", "exp": 120, "pin": "12345"}

  • exp expire in N seconds
  • pin fixed-size pin code
    $ http POST https://safesecret.info/api/v1/message pin=12345 message=testtest-12345678 exp:=1000

    HTTP/1.1 201 Created

    {
     "exp": "2016-06-25T13:33:45.11847278-05:00",
     "key": "f1acfe04-277f-4016-518d-16c312ab84b5"
    }

Load message

GET /v1/message/:key/:pin

    $ http GET https://safesecret.info/api/v1/message/6ceab760-3059-4a52-5670-649509b128fc/12345

    HTTP/1.1 200 OK

    {
     "key": "6ceab760-3059-4a52-5670-649509b128fc",
     "message": "testtest-12345678"
    }

ping

GET /v1/ping

    $ http https://safesecret.info/api/v1/ping

    HTTP/1.1 200 OK

    pong

Get params

GET /v1/params

    $ http https://safesecret.info/api/v1/params

    HTTP/1.1 200 OK

    {
        "max_exp_sec": 86400,
        "max_pin_attempts": 3,
        "pin_size": 5
    }