Skip to content

BarefootCoders/yopass

 
 

Repository files navigation

Yopass-horizontal

Yopass - Share Secrets Securely

Build Status Go Report Card

demo

Yopass is a project for sharing secrets in a quick and secure manner*. The sole purpose of Yopass is to minimize the amount of passwords floating around in ticket management systems, IRC logs and emails. The message is encrypted/decrypted locally in the browser and then sent to yopass without the decryption key which is only visible once to the user during encryption, yopass then returns a one-time URL with specified expiry date.

There is no perfect way of sharing secrets online and there is a trade off in every implementation. Yopass is designed to be as simple and "dumb" as possible without compromising on security. There's no mapping between the generated UUID and the user that submitted the encrypted message. It's always best send all the context except password over another channel.

Demo available here. It's recommended to host your own if you care about security.

  • End-to-End encryption using SJCL
  • Secrets can only be viewed once
  • No accounts or user management required
  • Secrets self destruct after X hours

Installation / Configuration

Here are some deployment options depending on your setup.

Command line flags:

$ yopass -h
      --address string     listen address (default 0.0.0.0)
      --max-length int     max length of encrypted secret (default 10000)
      --memcached string   memcached address (default "localhost:11211")
      --port int           listen port (default 1337)
      --tls-cert string    path to TLS certificate
      --tls-key string     path to TLS key

AWS Lambda

Yopass website is a separate component in this step which can be deployed to netlify for free.

You can run Yopass on AWS Lambda backed by dynamodb

cd deploy/aws-lambda && ./deploy.sh

Docker

Start memcached to store secrets in memory

docker run --name memcached_yopass -d memcached

TLS encryption

docker run -p 1337:1337 -v /local/certs/:/certs \
    --link memcached_yopass:memcache -d jhaals/yopass --memcached=memcache:11211 --tls-key=/certs/tls.key --tls-cert=/certs/tls.crt

Plain(make sure this is restricted to localhost)

docker run -p 1337:1337 --link memcached_yopass:memcache -d jhaals/yopass --memcached=memcache:11211

Kubernetes

kubectl apply -f deploy/yopass-k8.yaml
kubectl port-forward service/yopass 1337:1337

This is meant to get you started, please configure TLS when running yopass for real.

About

Secure sharing for secrets and passwords

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 55.3%
  • Go 33.9%
  • HTML 3.7%
  • Dockerfile 2.9%
  • Shell 2.3%
  • CSS 1.9%