donjon 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71892ce6ba19ef7b519a3d11751725255e44b319
-  data.tar.gz: bc53943944cd25d783cd7d9fc0097782a28a3691
+  metadata.gz: a183f49f2e60ad2ed9aaa0257580a4c7b094cf05
+  data.tar.gz: 1bf7b4ae1bd9907f553d1736c4e4eece9349d938
 SHA512:
-  metadata.gz: 244868a56f1ebd8b885f5b23477c15dc4e3ad3f1090b275df80336bfa07cd9c8e9416938952896efbbea11ff5ffd043ebe30895680f0d608f85a6dc8dda11c66
-  data.tar.gz: d6bb4031a0df5199a5825328961d7fced263a905e97559c54bcdc79becb7c60a9ba0973807c6b84ddb29a1b45ead2e2493e44c537b57c7d27ebc904d571ff95e
+  metadata.gz: c5484887af5dca5d4f1ca498d858253ed91a57a11d222d2aa4fad8bd65771d49f44e171e2c28c30abb24dbe836c011a83e2a55d362b4e07be3f898efb30b1afb
+  data.tar.gz: 0a3a7f7da362f258fa54e6ba81af5030d3b1aa7c7d3351e78937c36fd20f9e33915de5dade5d4688fc6f49157bfa1bbbbcf65275d294a701d4b98f9cf72cd58a

data/README.md

@@ -1,16 +1,109 @@
 # Donjon
 
-TODO: Write a gem description
+Donjon is a secure, multi-user store for key-value pairs.
+
+Skip to: [Purpose](#purpose) | [Concepts](#concepts) | [Setting
+up](#installation) | [Usage](#usage)
+
+## Purpose
+
+We built Donjon to share credentials in a (small) devops team, for services where
+single user accounts don't make sense, e.g.:
+
+- root passwords for databases and servers
+- root credentials for hosting accounts
+- accounts for web services that don't do multi-user/multi-admin
+- Two-factor tokens for single-user web services.
+
+Donjon uses standards for encryption: 2048-bit asymmetric RSA encryption used to
+prime symmetric 256-bit AES CBC encryption with random padding.
+In other words, while the NSA will probably be able to read your data should it
+get its paws on it, it's unlikely Joe Hacker will.
+
+[Online tools](https://lastpass.com) exist that serve the same purpose as Donjon, but simply
+put: they're generally closed source and host the data somewhere we don't
+control. We think the inconvenience of not having a cute toolbar icon for
+passwords is trumped by better security.
+
+## Concepts
+
+A **vault** is a directory managed by Donjon. It contains encrypted key-value
+pairs, and public keys for all allowed users. Each key-value pair lives in its
+own directory. The name of the directory is an obfuscated (hashed) version of
+the key, but it's not encrypted. The directory contains one file per user, each
+containing the key-value pair encrypted with their public key.
+
+**Syncing** the vault between users is left as an exercice to users or
+integrators :)
+One option is to use a shared drive (e.g. using a cloud server and
+[SSHFS](http://en.wikipedia.org/wiki/SSHFS)). We prefer to sync the vault
+directory using [Bittorrent Sync](http://www.bittorrent.com/sync) rather than
+leave a copy of it with third parties. Another option is to use Git as a
+distribution mechanism.
+
 
 ## Installation
 
-Install it as you would any gem:
+The setup is slightly different different for new vaults (first subsection below)
+and connecting to an existing vault (second subsection).
+
+This section assumes the vault is synced between users using Bittorrent Sync.
+
+
+### Creating a new vault
+
+Install Donjon:
+    
+    $ gem install donjon
+
+Run the Donjon configuration:
+
+    $ dj init
+
+Note that while you can re-use an existing private key for Donjon, it must be
+encrypted and be a 2048-bit RSA key.
+
+Add, then read a first key-value pair to confirm encryption is working:
+
+    $ dj config:set TEST=foobar
+    $ dj config:get TEST
+    TEST: foobar
+
+Download, install, and run [Bittorrent Sync](http://www.bittorrent.com/sync/downloads).
+
+Add the vault directory you configured during `dj init` to be synced by
+Bittorrent Sync.
+
+
+### Connecting to an existing vault
+
+Download and install [Bittorrent Sync](http://www.bittorrent.com/sync/downloads).
+
+Ask a peer already using the vault you're interested in to provide you a "one
+time secret" for the shared vault directory. Add this to Bittorrent Sync, and
+wait for syncing to complete.
+
+Install Donjon:
 
     $ gem install donjon
 
-Then run the interactive setup:
+Configure Donjon; when prompted for a vault path, enter the path to the relevant
+synced directory:
+
+    $ dj init
+    
+At this point your public key has been added to the vault, but you can't access
+any data as it hasn't been encrypted for you. Obtain your public key:
+
+    $ dj user:key
+
+and send it over a reasonably secure medium to your peer. They will then run
+
+    $ dj user:add <your-username>
+
+to encrypt all key-value pairs for your user.
 
-    $ dj vault:init
+Test that you can read a particular key, and you're all set!
 
 
 ## Usage
@@ -26,11 +119,12 @@ Commands:
   dj help [COMMAND]            # Describe available commands or one specific command
   dj init                      # Creates a new vault, or connects to an existing vault.
   dj user:add NAME [PATH]      # Adds user and their public key to the vault. Reads from standard input if no path is given.
+  dj user:key                  # Prints your public key
 ```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/donjon/fork )
+1. Fork it ( http://github.com/mezis/donjon/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/donjon/commands/user.rb

@@ -7,6 +7,9 @@ module Donjon
       desc 'user:add NAME [PATH]', 'Adds user and their public key to the vault. Reads from standard input if no path is given.'
       decl 'user:add'
 
+      desc 'user:key', 'Prints your public key'
+      decl 'user:key'
+
       private
       
       def user_add(name, path = nil)
@@ -21,7 +24,7 @@ module Donjon
             key_data << line
           end
         else
-          key_data = Pathname.new(key_path).expand_path.read
+          key_data = Pathname.new(path).expand_path.read
         end
 
         key = OpenSSL::PKey::RSA.new(key_data, '').public_key
@@ -31,6 +34,10 @@ module Donjon
         database.update
         say "Success! #{name} has been added to the vault.", [:green, :bold]
       end
+
+      def user_key
+        puts actor.key.public_key.to_pem 
+      end
     end
   end
 end

data/lib/donjon/version.rb

@@ -1,3 +1,3 @@
 module Donjon
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: donjon
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Julien Letessier