yopass 1.1.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e9a6c2a4561259f563d42908ea873ee9973d7f3
-  data.tar.gz: b62837a06bf2d3d7ecbcccd9a19ba18375054754
+  metadata.gz: 6f8d26d2cb03549b70d5acdc9ce6acd7b6db3c9a
+  data.tar.gz: b095963eb8be973a7829a65838739b34e266c68b
 SHA512:
-  metadata.gz: cb5c72008630dd778ff72c14bfcf12ca03b8669312f4558744f19f5e91e61a1088a693a6c7c80d22cee1334a0bd16df25b7b27bbd9806dff6f6ae0e40f121bcc
-  data.tar.gz: 5184c9de38f5b2aabe94dcfb319cb2ba424fa55cd74b8e993d72c0148f3ce7c69390082c831bc57d945a456e3ab9200960aaf1389e8424967c739b361cd7b647
+  metadata.gz: 2b6f02e6ddf3fab9fd67d5cf39f784f7d59e735bbf2224832fc991f1cf0e9aa2eb769676d48ce6420b0da2c75c23ab5110d75eff4838077c8b20e4f20a47454e
+  data.tar.gz: b87e77bf5afe05a3a189f85a0d133298849086fb8a03f8e730a568fcfc41a572b52226293a32be61450d63d431c85e61bb99325f722fd8aefc128669c15afab7

data/.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   # Metadata
   s.name        = 'yopass'
-  s.version     = '1.1.5'
+  s.version     = '2.0.0'
   s.author      = 'Johan Haals'
   s.email       = ['jhaals@spotify.com']
   s.homepage    = 'https://github.com/jhaals/yopass'

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Yopass changelog
 
+### 2.0.0
+
+* Rename `http_base_url` to base_url
+* Move configuration settings to environment variables
+* Use thin as webserver
+* Bump rspec version
+
 ### 1.1.5
 * Ability to configure secret_max_length in yopass.yaml
 

data/Dockerfile

@@ -0,0 +1,16 @@
+FROM ubuntu
+MAINTAINER Johan Haals <johan.haals@gmail.com>
+
+RUN apt-get update
+RUN apt-get install -y git libsasl2-dev build-essential ruby ruby-dev memcached
+
+RUN gem install foreman --no-rdoc --no-ri
+RUN gem install bundler --no-rdoc --no-ri
+RUN gem install god --no-rdoc --no-ri
+
+RUN git clone https://github.com/jhaals/yopass /yopass
+RUN cd /yopass && bundle install
+
+EXPOSE 4567
+# Ensure that both yopass and memcached is up and running
+CMD ["god", "-c", "/yopass/yopass.god", "-D"]

data/Gemfile

@@ -1,8 +1,10 @@
 source 'https://rubygems.org'
 
-gem 'sinatra', '~> 1.4.4'
-gem 'encryptor', '~> 1.3.0'
-gem 'memcached', '~> 1.7.2'
+gem 'sinatra'
+gem 'encryptor'
+gem 'memcached'
+gem 'thin'
+
 gem 'yopass', :path => '.'
 
 group :dev do

data/Gemfile.lock

@@ -10,25 +10,31 @@ GEM
   remote: https://rubygems.org/
   specs:
     backports (3.6.0)
+    daemons (1.1.9)
     diff-lcs (1.2.5)
     encryptor (1.3.0)
+    eventmachine (1.0.3)
     memcached (1.7.2)
-    multi_json (1.9.2)
+    multi_json (1.10.1)
     rack (1.5.2)
-    rack-protection (1.5.2)
+    rack-protection (1.5.3)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (10.2.2)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    sinatra (1.4.4)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    sinatra (1.4.5)
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
@@ -39,16 +45,21 @@ GEM
       rack-test
       sinatra (~> 1.4.0)
       tilt (~> 1.3)
+    thin (1.6.2)
+      daemons (>= 1.0.9)
+      eventmachine (>= 1.0.0)
+      rack (>= 1.0.0)
     tilt (1.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  encryptor (~> 1.3.0)
-  memcached (~> 1.7.2)
+  encryptor
+  memcached
   rake
   rspec
-  sinatra (~> 1.4.4)
+  sinatra
   sinatra-contrib
+  thin
   yopass!

data/Procfile

@@ -1 +1 @@
-web: bundle exec ruby lib/yopass.rb -p $PORT
+web: bundle exec rackup config.ru -p 4567 -s thin -o 0.0.0.0

data/README.md

@@ -1,31 +1,40 @@
 # YoPass - Share Secrets Securely
 [![Build Status](https://travis-ci.org/JHaals/yopass.png?branch=master)](https://travis-ci.org/JHaals/yopass)
 
-YoPass is a website that store secrets encrypted(AES 256) in memory(memcached) for a fixed period of time.
-Secrets can then be shared more securely over channels such as IRC and Email. The decryption password for the secret can be sent over SMS to improve security.
+YoPass is a website for sharing secrets in a quick and secure manner.
+This project is created to minimize the amount of passwords floating around in ticket management systems, IRC logs and emails. YoPass generates a one-time URL with an expiration date so you don't have to worry about passwords being visible forever
 
 * AES-256 encryption
 * Secrets can only be viewed once
 * No secrets are written to disk
-* No accounts and user management required
+* No account or user management required
 * Secrets self destruct after X hours
+* Decryption key can be sent over SMS
 
 #### Workflow
-    * Generate secret
+    * Generate secret/password
     * Paste into the yopass website
-    * Receive URL with or without decryption key(can be sent over sms)
-    * Share with the intended person.
-    * Secret is automatically removed when it's viewed by your friend
-    * feel safe
+    * Receive URL with or without the decryption key(can be transfered over other channel such as SMS)
+    * Share with the intended person
+    * Secret is automatically removed once viewed
+    * Feel safe
 
-### Installation
+### Installation / Configuration
+YoPass Docker container available [here](https://hub.docker.com/u/jhaals/yopass)
+
+Otherwise:
 
     gem install yopass
 
 * install and start memcached
-* edit yopass.yaml and move it to /etc
+* edit `conf/yopass.yaml` and move it to desired location (don't forge to specify that path in the YOPASS_CONFIG environment variable)
 * done!
 
+Most settings can be configured with environment variables.
+
+    YOPASS_CONFIG='/path/to/yopass.yaml'
+    YOPASS_BASE_URL='https://yopass.mydomain.com'
+    YOPASS_MEMCACHED_URL='memcached_address'
 
 ### SMS providers
 

data/conf/yopass.yaml

@@ -1,5 +1,5 @@
 memcached_url: 'localhost:11211'
-http_base_url: 'http://127.0.0.1:4567'
+base_url: 'http://127.0.0.1:4567'
 secret_max_length: 100000
 send_sms: false
 

data/config.ru

@@ -0,0 +1,2 @@
+require 'yopass'
+run Yopass

data/lib/yopass.rb

@@ -10,17 +10,15 @@ class Yopass < Sinatra::Base
   configure :development do
     require 'sinatra/reloader'
     register Sinatra::Reloader
-    set :config, YAML.load_file('conf/yopass.yaml')
-  end
-  configure :test do
-    set :config, YAML.load_file('conf/yopass.yaml')
-  end
-  configure :production do
-    set :config, YAML.load_file('/etc/yopass.yaml')
   end
+
   configure do
+    config = ENV['YOPASS_CONFIG'] || 'conf/yopass.yaml'
+    cfg = YAML.load_file(config)
+    set :config, cfg
+    set :base_url, ENV['YOPASS_BASE_URL'] || cfg['base_url']
     set :public_folder, File.dirname(__FILE__) + '/static'
-    set :cache, Memcached.new(settings.config['memcached_url'])
+    set :mc, Memcached.new(ENV['YOPASS_MEMCACHED_URL'] || cfg['memcached_url'])
   end
 
   get '/' do
@@ -56,7 +54,7 @@ class Yopass < Sinatra::Base
 
     # store secret in memcached
     begin
-      settings.cache.set key, data, lifetime_options[lifetime]
+      settings.mc.set key, data, lifetime_options[lifetime]
     rescue Memcached::ServerIsMarkedDead
       return "Can't contact memcached"
     end
@@ -72,13 +70,13 @@ class Yopass < Sinatra::Base
         # TODO verification
         sms.send(mobile_number, password)
         return erb :secret_url, :locals => {
-          :url => URI.join(settings.config['http_base_url'], "get?k=#{key}"),
+          :url => URI.join(settings.base_url, "get?k=#{key}"),
           :key_sent_to_mobile => true }
       end
     end
 
     erb :secret_url, :locals => {
-      :url => URI.join(settings.config['http_base_url'],"get?k=#{key}&p=#{password}"),
+      :url => URI.join(settings.base_url,"get?k=#{key}&p=#{password}"),
       :key_sent_to_mobile => false }
   end
 
@@ -93,7 +91,7 @@ class Yopass < Sinatra::Base
     headers 'Expires' => '0'
 
     begin
-      result = settings.cache.get params[:k]
+      result = settings.mc.get params[:k]
     rescue Memcached::NotFound
       return erb :'404'
     end
@@ -104,7 +102,7 @@ class Yopass < Sinatra::Base
     rescue OpenSSL::Cipher::CipherError
       return 'Invalid decryption key'
     end
-    settings.cache.delete params[:k]
+    settings.mc.delete params[:k]
     result
   end
 

data/yopass.god

@@ -0,0 +1,11 @@
+God.watch do |w|
+  w.name = "yopass"
+  w.start = "foreman start -d /yopass"
+  w.keepalive
+end
+
+God.watch do |w|
+  w.name = "memcached"
+  w.start = "memcached -u root"
+  w.keepalive
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yopass
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Johan Haals
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: encryptor
@@ -59,11 +59,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .buildpacks
 - .gemspec
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -72,6 +72,7 @@ files:
 - Rakefile
 - conf/config.ru
 - conf/yopass.yaml
+- config.ru
 - lib/static/js/jquery.address.js
 - lib/static/js/jquery.js
 - lib/static/packaged/css/font.css
@@ -117,6 +118,7 @@ files:
 - spec/sms_provder_spec.rb
 - spec/spec_helper.rb
 - spec/yopass_spec.rb
+- yopass.god
 homepage: https://github.com/jhaals/yopass
 licenses:
 - Apache 2.0
@@ -138,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Secure sharing for secrets and passwords
@@ -146,4 +148,3 @@ test_files:
 - spec/bulksms_spec.rb
 - spec/sms_provder_spec.rb
 - spec/yopass_spec.rb
-has_rdoc: 

data/.buildpacks

@@ -1,2 +0,0 @@
-https://github.com/bjacobel/heroku-buildpack-libsasl.git
-https://github.com/heroku/heroku-buildpack-ruby.git