donjon 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 940c4424826fe9f8701b29bb26a9af71af4f217c
-  data.tar.gz: c637c714b56d5682b6d0752b6b4cafb44d8c08ad
+  metadata.gz: 13b97b25c7492ea9cd2e839f3782fc514f69951e
+  data.tar.gz: 9dd7c77553f48b0462ae6024752689b8f0743b20
 SHA512:
-  metadata.gz: 0a00ccb3a4016e2886e419000acf945246d4e9f7c08cdd69da88c51d7c609ae0a5740d1c5c58f067236d711b34872e0b010365073381e52f38450376bda8b5d0
-  data.tar.gz: 5811899c6508678844795cc3eee9bc47469a556b289fb17cf48bf4fc200ca21ee5bb0266e7f75644b4f99b1bd2344239a2b03473e6333af321055000e784b281
+  metadata.gz: 7ef534ceda3824fbe3538223ddf4a7d70b9a1661411659df0fb71fc534222f1b4c6508d0948b705712b8d98a3e71f61c1252d85cf96b752c40ca695c90e1533a
+  data.tar.gz: c8da58337bb8b1ad3dccb9030253a6b742eae9ee78576dfdac49d7e74d05212ccc4a58f28ed8c65b8951b44a5eb23b25c72ea7fb0b5ac883d7269b03ce3d199c

data/README.md

@@ -3,10 +3,11 @@
 Donjon is a secure, multi-user store for key-value pairs.
 
 Skip to: [Purpose](#purpose) | [Concepts](#concepts) | [Setting
-up](#installation) | [Usage](#usage)
+up](#installation) | [Usage](#usage) | [Storing QR
+codes](#storing-qr-codes-in-donjon)
 
-![Version](https://badge.fury.io/rb/donjon.svg)
-![Build status](https://travis-ci.org/mezis/donjon.svg?branch=master)
+[![Version](https://badge.fury.io/rb/donjon.svg)](https://rubygems.org/gems/donjon)
+[![Build status](https://travis-ci.org/mezis/donjon.svg?branch=master)](https://travis-ci.org/mezis/donjon)
 
 
 ## Purpose
@@ -81,10 +82,14 @@ Bittorrent Sync.
 
 ### Connecting to an existing vault
 
-Create an (empty) directory where you want the vault to be synced. Tyhis can
-typically be `~/.donjon`.
+**Note**: please follow these steps _in order_.
 
 Download and install [Bittorrent Sync](http://www.bittorrent.com/sync/downloads).
+During install, let the software create a default sync directory (we won't use
+it).
+
+Create an (empty) directory where you want the vault to be synced. This can
+typically be `~/.donjon`.
 
 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
@@ -121,15 +126,62 @@ vault, e.g. on Dropbox).
 
 ```
 Commands:
-  dj config:get KEY...         # Decrypts the value for KEY from the vault
-  dj config:mget [REGEXP]      # Decrypts multiple keys (all readable by default)
-  dj config:set KEY=VALUE ...  # Encrypts KEY and VALUE in the vault
-  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
+  dj config:get KEY...          # Decrypts the value for KEY from the vault
+  dj config:set KEY             # Reads a VALUE from standard input, encrypts KEY and VALUE in the vault
+  dj config:del KEY             # Removes a key-value pair
+  dj config:fset KEY FILE       # Encrypts KEY and the contents of FILE in the vault
+  dj config:mget [REGEXP]       # Decrypts multiple keys (all keys by default)
+  dj config:mset KEY=VALUE ...  # Encrypts KEY and VALUE in the vault
+  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
 ```
 
+
+## Storing QR codes in Donjon
+
+Some service offer two factor authentication, which is a good thing.
+Unfortunately some of those are not multi-user, which means the token for two
+factor authentication also needs to be shared.
+
+This token is usually shared as a QR code for convenience, to be used with
+Google Authenticator or Authy.
+
+You can store it in Donjon as follows:
+
+1. Get the QR code from the service. A screenshot is fine.
+
+2. Install [zbar](http://zbar.sourceforge.net/) (to scan the code) and
+   [qrencode](http://fukuchi.org/works/qrencode/) (to generate a new, compact
+   code)
+
+3. Extract a new QR code:
+
+     ```
+     $ zbarimg --raw -q <file>.png | \
+     tr -d '\n' | \
+     qrencode -m 2 -d 1 -t ASCII | \
+     sed -e "s/ /ESC[7m ESC[0m/g;s/#/ /g" | \
+     tr 'ESC' '\033' | \
+     tee /tmp/qr
+     ```
+
+     (this should output the QR code on your terminal)
+
+4. Store the QR code in Donjon:
+
+    ```
+    $ dj config:fset mykey /tmp/qr
+    ```
+
+5. Test the code has been properly stored:
+
+    ```
+    $ dj config:get mykey
+    ```
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/mezis/donjon/fork )

data/lib/donjon/commands/base.rb

@@ -54,8 +54,6 @@ module Donjon
         end
       end
 
-      private
-
       def _get_password(message)
         say message, :green
         $stdout.write('> ')

data/lib/donjon/commands/config.rb

@@ -3,7 +3,10 @@ require 'donjon/commands/base'
 module Donjon
   module Commands
     Base.class_eval do
-      desc 'config:set KEY=VALUE ...', 'Encrypts KEY and VALUE in the vault'
+      desc 'config:mset KEY=VALUE ...', 'Encrypts KEY and VALUE in the vault'
+      decl 'config:mset'
+
+      desc 'config:set KEY', 'Reads a VALUE from standard input, encrypts KEY and VALUE in the vault'
       decl 'config:set'
 
       desc 'config:fset KEY FILE', 'Encrypts KEY and the contents of FILE in the vault'
@@ -20,13 +23,24 @@ module Donjon
       
       private
       
-      def config_set(*keyvals)
+      def config_mset(*keyvals)
         keyvals.each do |keyval|
           m = /([^=]*)=(.*)/.match(keyval)
+          if m.nil?
+            say "Misformatted key-value pair '#{keyval}'"
+            exit 1
+          end
           key = m[1]
           value = m[2]
           database[key] = value
         end
+        say "Warning: the keys and values you just set may be saved to your shell history", :red
+        say "You can clear your history by running `history -c`."
+      end
+
+      def config_set(key)
+        value = _get_password("Please enter the value for '#{key}'")
+        database[key] = value
       end
 
       def config_fset(key, path)
@@ -45,6 +59,10 @@ module Donjon
           next if regexp && regexp !~ key
           puts "#{key}: #{value}"
         end
+      rescue RegexpError => e
+        say "Misformatted regular expression '#{regexp}'", :red
+        say "(#{e.message})"
+        exit 1
       end
 
       def config_del(key)

data/lib/donjon/version.rb

@@ -1,3 +1,3 @@
 module Donjon
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: donjon
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-01 00:00:00.000000000 Z
+date: 2014-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor