arver 0.1.0 → 0.1.2

data/CHANGELOG.textile

@@ -1,3 +1,8 @@
+=== 0.1.2 2012-05-01
+
+* Fixed bug in password dialog
+* Added an --init action
+
 === 0.1.0 2012-04-30
 
 * Fixed documentation

data/README.textile

@@ -48,6 +48,7 @@ The following ruby gems are required for arver:
 * gpgme 2
 * activesupport 2
 * escape
+* highline
 
 For development you will need the following additional gems:
 

data/lib/arver.rb

@@ -1,6 +1,6 @@
-%w{ singleton yaml fileutils active_support gpgme escape openssl}.each {|f| require f }
+%w{ singleton yaml fileutils active_support highline/import gpgme escape openssl}.each {|f| require f }
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
  
-%w{ gpg_key_manager luks_wrapper action create_action list_action gc_action adduser_action deluser_action info_action close_action open_action target_list command_wrapper ssh_command_wrapper log_levels io_logger log string bootstrap local_config config test_config_loader node_with_script_hooks partition_hierarchy_node host hostgroup tree partition test_partition key_generator key_saver keystore runtime_config key_info_action}.each {|f| require "arver/#{f}" }
+%w{ gpg_key_manager luks_wrapper action initial_config_action create_action list_action gc_action adduser_action deluser_action info_action close_action open_action target_list command_wrapper ssh_command_wrapper log_levels io_logger log string bootstrap local_config config test_config_loader node_with_script_hooks partition_hierarchy_node host hostgroup tree partition test_partition key_generator key_saver keystore runtime_config key_info_action}.each {|f| require "arver/#{f}" }
 

data/lib/arver/bootstrap.rb

@@ -4,6 +4,8 @@ class Arver::Bootstrap
       local = Arver::LocalConfig.instance
       local.config_dir = options[:config_dir] unless options[:config_dir].empty?
       local.username = options[:user] unless options[:user].empty?
+      
+      return true if options[:action] == :init
 
       unless local.username.present?
         Arver::Log.error( "No user defined" )
@@ -14,7 +16,7 @@ class Arver::Bootstrap
       config.load
 
       self.load_runtime_config(options)
-     
+
       unless Arver::Config.instance.exists?(local.username)
         Arver::Log.error( "No such user #{local.username}" )
         return false

data/lib/arver/cli.rb

@@ -73,6 +73,8 @@ module Arver
                 "LUKS info about a target.") { |arg| options[:argument][:target] = arg; options[:action] = :info; }
         opts.on_tail( "-l", "--list-targets",
                 "List targets." ) { options[:action] = :list; }
+        opts.on_tail( "--init",
+                "Setup a sample configuration." ) { options[:action] = :init; }
         
         begin
           opts.parse!(arguments)
@@ -85,18 +87,18 @@ module Arver
         end
         
         if options[:action].nil? || 
-           ( options[:action] != :list && options[:action] != :gc && ! options[:argument][:target] ) ||
+           ( options[:action] != :list && options[:action] != :gc && options[:action] != :init && ! options[:argument][:target] ) ||
            ( ( options[:action] == :adduser || options[:action] == :deluser ) && ! options[:argument][:target] )
           Arver::Log.write opts; return
         end
       end
-      
+
       unless( Arver::Bootstrap.run( options ) )
         return
       end
       
       target_list = TargetList.get_list( options[:argument][:target] )
-      if target_list.empty? && ( options[:action] != :list && options[:action] != :gc )
+      if target_list.empty? && ( options[:action] != :list && options[:action] != :gc && options[:action] != :init )
         Arver::Log.write( "No targets found" )
         return false
       end
@@ -115,6 +117,7 @@ module Arver
         :deluser => Arver::DeluserAction,
         :info => Arver::InfoAction,
         :key_info => Arver::KeyInfoAction,
+        :init => Arver::InitialConfigAction,
       }
 
       action = (actions[ action ]).new( target_list )

data/lib/arver/gpg_key_manager.rb

@@ -11,7 +11,7 @@ module Arver
           return false
         end
         key = key.first
-        if fp.size == 40 && fp != key.fingerprint
+        if fp.size != 8 && fp != key.fingerprint
           return false
         end
         key
@@ -34,7 +34,7 @@ module Arver
           return false
         end
         fp = fp.gsub(" ","")
-        if fp.size != 40
+        if fp.size == 8
           Arver::Log.error( "Please use the full fingerprint to define the gpg key for #{user}. The current config might be ambiguous." )
         end
         

data/lib/arver/initial_config_action.rb

@@ -0,0 +1,44 @@
+module Arver
+  class InitialConfigAction < Action
+    def post_action
+      if LocalConfig.instance.username.empty?
+        Log.warn( "Please choose a username using '-u'" )
+        return
+      end
+      local_config = LocalConfig.instance.path
+      if File.exist?( local_config )
+        Log.warn( "#{local_config} already exists" )
+      else
+        content = { 'username' => LocalConfig.instance.username }
+        f = File.new(local_config, "w")
+        f.write(content.to_yaml)
+        f.close
+      end
+
+      config_path = LocalConfig.instance.config_dir
+
+      if File.exist?( config_path )
+        Log.warn( "#{config_path} already exists" )
+      else
+        Config.instance.users = {
+          LocalConfig.instance.username => {
+            'slot' => "<the next free luks slot>",
+            'gpg'  => "<gpg fingerprint of #{LocalConfig.instance.username}>"
+          }
+        }
+        Config.instance.tree = {
+          'default' => {
+            'sample_machine' => {
+              'address'    => 'foo.bar.com',
+              'post_open'  => 'script-after-opening-the-disks.sh',
+              'a_disk' => {
+                'device' => '/dev/sda'
+              }
+            }
+          }
+        }
+        Config.instance.save
+      end
+    end
+  end
+end

data/lib/arver/version.rb

@@ -1,3 +1,3 @@
 module Arver
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

data/man/arver.5

@@ -109,10 +109,10 @@ To run an action on all possible disks use \fBALL\fR as target\.
 Working with arver is quite simple and straight forward\. Within the next paragraphs you\'ll find a detailed overview on the concept of arver, as well as how to set it up and what the different actions are doing exactly\.
 .
 .SH "Concept"
-To setup arver we only need to define in the corresponding configuration files our (admin\-)users and our disks\.
+To setup arver we only need to define in the corresponding configuration files our (admin\-)users and our disks\. See section \fBBootstrapping a new arverdata directory\fR on how to setup your config\.
 .
 .P
-Arver\'s configuration files are contained in a single directory which contains all the necessary (non\-private) information to manage your disks\. This directory will be referred to as \fBarverdata\fR\. We recommend you to share that directory amongs your group of admins with a distributed version control system such as git\.
+Arver\'s configuration files are contained in a single directory which contains all the necessary (non\-private) information to manage your disks\. This directory will be referred to as \fBarverdata\fR\. We recommend you to share that directory among your group with a distributed version control system such as git\.
 .
 .P
 Eeach admin will be assigned one global LUKS slot\. Arver will use this information to grant or revoke privileges to other users\. See the \fBManaging users\fR section for a detailed descripton of how this is done\.
@@ -133,18 +133,27 @@ keys/public/     <\- contains gpg public keys of the admins (managed by arver)
 .
 .IP "" 0
 .
+.SH "Bootstrapping a new arverdata directory"
+To bootstrap a new \fBarverdata\fR directory just run:
+.
+.P
+arver \-u \fInew_username\fR \-\-init
+.
+.P
+This will create ~/\.arverdata with a sample configuration\. See the next two sections on how to adapt it to your setup:
+.
 .SS "Users"
-The \fBuser\fR config file contains all your admins in the following structure:
+The \fBuser\fR config file contains all your users\. It is very important that all users use exactly the same configuration! It has the following structure:
 .
 .IP "" 4
 .
 .nf
 
-foo1:
-  slot: 0
+me:
+  slot: 1
   gpg: BEAFAFFEBEAFAFFEBEAFAFFEBEAFAFFEBEAFAFFE
-foo2:
-  slot 1
+foo:
+  slot 2
   gpg: AFFEBEAFAFFEBEAFAFFEBEAFAFFEBEAFAFFEBEAF
 .
 .fi
@@ -152,7 +161,16 @@ foo2:
 .IP "" 0
 .
 .P
-\fBfoo1\fR is the identifier of one of your admins\. \fBslot\fR referes to the LUKS slot which is used for this admin\. This has to be a unique number between 0 and 7\. If you\'d like to migrate existing LUKS devices take care to avoid the currently used slot number (usually 0)\. \fBgpg\fR is the gpg\-fingerprint of the public key for \fBfoo1\fR\. We recommend to use a dedicated gpg key just for \fBarver\fR\.
+\fBme\fR is the identifier you selected on \fB\-\-init\fR\. \fBslot\fR referes to the LUKS slot which will be used\. This has to be a unique number between 0 and 7\. If you\'d like to migrate existing LUKS devices take care to avoid the currently used slot number (usually 0)\. \fBgpg\fR is the (40 digit) fingerprint of the gpg\-key\. We recommend to use a dedicated gpg key just for \fBarver\fR\. You can create one with:
+.
+.P
+gpg \-\-gen\-key
+.
+.P
+And you can find out the fingerprint of your key with:
+.
+.P
+gpg \-\-fingerprint \-\-list\-key \fIkey\-id\fR
 .
 .SS "Disks"
 The \fBdisks\fR file contains the following hash tree in yaml notation:
@@ -218,29 +236,6 @@ You can also add script hooks to any host or disk\. Those will be run during the
 .P
 Any other entry within the hosts\-object are actual disks entries of that particular host\. These disks are represented by an identifier and at least a \fBdevice\fR entry pointing to the actual disk path\. So for example the disks on \fBhost1\fR are: \fB/dev/storage/disk1\fR identified by \fBdisk1\fR and \fB/dev/sdb1\fR idetified by \fBdisk2\fR\. The prefix \fB/dev/\fR is alays added to the disk path\.
 .
-.SH "Bootstrapping a new arverdata"
-How do you start and bootstrap a new \fBarverdata\fR, so you can use arver for your storage?
-.
-.P
-First you need to create the basic structure for your \fBarverdata\fR:
-.
-.IP "" 4
-.
-.nf
-
-$ mkdir ~/\.arverdata # the location is configurable\. We use the default one\.
-$ gpg \-\-gen\-key      # create a dedicated gpg key for arver
-$ vi users           # add your user and the key\-id of your new public gpg\-key
-$ vi disks           # add your hostgroups, hosts and disks
-$ echo "\'username\': \'<your_arver_username>\' > ~/\.arver  #set your default user
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Then we can create the encrypted harddisk:
-.
 .SH "Action Create"
 To initially create an arver managed LUKS device you first need to add the device to the disks config\. See above for various examples\. You can create the LUKS device by invoking the following command:
 .

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arver
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2012-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gpgme
-  requirement: &12106580 !ruby/object:Gem::Requirement
+  requirement: &7240120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *12106580
+  version_requirements: *7240120
 - !ruby/object:Gem::Dependency
   name: escape
-  requirement: &12105920 !ruby/object:Gem::Requirement
+  requirement: &7239180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *12105920
+  version_requirements: *7239180
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &12105360 !ruby/object:Gem::Requirement
+  requirement: &7238020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - <
@@ -45,10 +45,21 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *12105360
+  version_requirements: *7238020
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &7236760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *7236760
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &12104740 !ruby/object:Gem::Requirement
+  requirement: &7235620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +67,10 @@ dependencies:
         version: 0.10.2
   type: :development
   prerelease: false
-  version_requirements: *12104740
+  version_requirements: *7235620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &12104120 !ruby/object:Gem::Requirement
+  requirement: &7234840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +78,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *12104120
+  version_requirements: *7234840
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &12103560 !ruby/object:Gem::Requirement
+  requirement: &7233720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,7 +89,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *12103560
+  version_requirements: *7233720
 description: Arver helps you to manage a large amount of crypted devices easily and
   safe amongst a certain amount of members
 email: arver@lists.immerda.ch
@@ -102,6 +113,7 @@ files:
 - lib/arver/host.rb
 - lib/arver/hostgroup.rb
 - lib/arver/info_action.rb
+- lib/arver/initial_config_action.rb
 - lib/arver/io_logger.rb
 - lib/arver/key_generator.rb
 - lib/arver/key_info_action.rb