hiera-eyaml 2.0.3 → 2.0.4

data/CHANGES.md

@@ -0,0 +1,16 @@
+Change log for hiera-eyaml
+==========================
+
+2.04
+----
+
+ - Add change log
+ - #118 - Some initial support for spaces in filenames (primarily targeted at windows platforms) (@elyscape)
+ - #114 - Add new config file resolution so that a system wide /etc/eyaml/config.yaml is processed first (@gtmtech)
+ - #112 - Improve debugging options and colorise output (@gtmtech)
+ - #102 - Extension of temp files should be yaml to help editors provide syntax highlighting (@ColinHebert)
+ - #90, #121, #122 - Add preamble in edit mode to make it easier to remember how to edit (@sihil)
+ - #96, #111, #116 - Various updates to docs
+
+2.03
+----

data/README.md

@@ -59,6 +59,10 @@ Setup
 
     $ gem install hiera-eyaml
 
+### Installing hiera-eyaml for the new [puppet-server](https://github.com/puppetlabs/puppet-server)
+
+    $ puppetserver gem install hiera-eyaml
+
 ### Generate keys
 
 The first step is to create a pair of keys:
@@ -234,7 +238,7 @@ Configuration file for eyaml
 
 Default parameters for the eyaml command line tool can be provided by creating a configuration YAML file.
 
-The location of the file defaults to `~/.eyaml/config.yaml` but can be overriden by setting `EYAML_CONFIG` environment variable.
+Config files will be read first from `/etc/eyaml/config.yaml`, then from `~/.eyaml/config.yaml` and finally by anything referenced in the `EYAML_CONFIG` environment variable
 
 The file takes any long form argument that you can provide on the command line. For example, to override the pkcs7 keys:
 ```yaml
@@ -271,9 +275,12 @@ When editing eyaml files, you will see that the unencrypted plaintext is marked
 This is a list of available plugins:
 
  - [hiera-eyaml-gpg](https://github.com/sihil/hiera-eyaml-gpg) - Provide GPG encryption
- - [hiera-eyaml-plaintext](https://github.com/gtmtech/hiera-eyaml-plaintext) - This is a no-op encryption plugin that 
+ - [hiera-eyaml-plaintext](https://github.com/gtmtechltd/hiera-eyaml-plaintext) - This is a no-op encryption plugin that 
    simply base64 encodes the values. It exists as an example plugin to create your own and to do integration tests on 
    hiera-eyaml. **THIS SHOULD NOT BE USED IN PRODUCTION**
+ - [hiera-eyaml-twofac](https://github.com/gtmtechltd/hiera-eyaml-twofac) - PKCS7 keypair + AES256 symmetric password for two-factor encryption
+   Note that this plugin mandates the user enter a password. It is useful for non-automated scenarios, and is not advised to be used
+   in conjunction with puppet, as it requires entry of a password over a terminal.
 
 
 Notes
@@ -322,6 +329,7 @@ You'll need to have a few requirements installed:
   * `aruba` (gem)
   * `cucumber` (gem)
   * `puppet` (gem)
+  * `hiera-eyaml-plaintext` (gem)
 
 
 Authors

data/bin/eyaml

@@ -9,5 +9,18 @@ require 'hiera/backend/eyaml/encryptors/pkcs7'
 Hiera::Backend::Eyaml::Encryptors::Pkcs7.register
 Hiera::Backend::Eyaml::Plugins.find
 
-Hiera::Backend::Eyaml::CLI.parse
-Hiera::Backend::Eyaml::CLI.execute
+begin
+  Hiera::Backend::Eyaml::CLI.parse
+rescue StandardError => e
+  Hiera::Backend::Eyaml::Utils.warn e.message
+  Hiera::Backend::Eyaml::Utils.debug e.backtrace.join("\n")
+  exit 1
+end
+
+begin
+  Hiera::Backend::Eyaml::CLI.execute
+rescue StandardError => e
+  Hiera::Backend::Eyaml::Utils.warn e.message
+  Hiera::Backend::Eyaml::Utils.debug e.backtrace.join("\n")
+  exit 1
+end

data/lib/hiera/backend/eyaml.rb

@@ -2,7 +2,7 @@ class Hiera
   module Backend
     module Eyaml
 
-      VERSION = "2.0.3"
+      VERSION = "2.0.4"
       DESCRIPTION = "Hiera-eyaml is a backend for Hiera which provides OpenSSL encryption/decryption for Hiera properties"
 
       class RecoverableError < StandardError
@@ -45,4 +45,3 @@ class Hiera
     end
   end
 end
-

data/lib/hiera/backend/eyaml/CLI.rb

@@ -34,7 +34,7 @@ class Hiera
 
           options = command_class.validate options
           Eyaml::Options.set options
-          Eyaml::Options.debug
+          Eyaml::Options.trace
 
         end
 
@@ -46,7 +46,7 @@ class Hiera
             puts result unless result.nil?
           rescue Exception => e
             Utils.warn e.message
-            Utils.info e.backtrace.inspect
+            Utils.debug e.backtrace.join("\n")
           end
 
         end

data/lib/hiera/backend/eyaml/encryptor.rb

@@ -59,6 +59,10 @@ class Hiera
             "[eyaml_#{plugin_classname}]:  #{msg}"
           end
 
+          def self.trace msg
+            Utils::trace :from => plugin_classname, :msg => msg
+          end
+
           def self.debug msg
             Utils::debug :from => plugin_classname, :msg => msg
           end

data/lib/hiera/backend/eyaml/encryptors/pkcs7.rb

@@ -94,7 +94,7 @@ class Hiera
 
             Utils.ensure_key_dir_exists public_key
             Utils.write_important_file :filename => public_key, :content => cert.to_pem
-            puts "Keys created OK"
+            Utils.info "Keys created OK"
 
           end
 

data/lib/hiera/backend/eyaml/options.rb

@@ -20,13 +20,17 @@ class Hiera
           end
         end
 
-        def self.debug
-          Utils::debug "Dump of eyaml tool options dict:"
-          Utils::debug "--------------------------------"
+        def self.trace
+          Utils::trace "Dump of eyaml tool options dict:"
+          Utils::trace "--------------------------------"
           @@options.each do |k, v|
-            Utils::debug sprintf "%18s %-18s = %18s %-18s", "(#{k.class.name})", k.to_s, "(#{v.class.name})", v.to_s
+            begin
+              Utils::trace sprintf "%18s %-18s = %18s %-18s", "(#{k.class.name})", k.to_s, "(#{v.class.name})", v.to_s
+            rescue
+              Utils::trace sprintf "%18s %-18s = %18s %-18s", "(#{k.class.name})", k.to_s, "(#{v.class.name})", "<unprintable>" # case where v is binary
+            end
           end
-          Utils::debug "--------------------------------"
+          Utils::trace "--------------------------------"
         end
 
       end

data/lib/hiera/backend/eyaml/subcommand.rb

@@ -22,6 +22,9 @@ class Hiera
            {:name          => :verbose,
               :description => "Be more verbose",
               :short       => 'v'},
+           {:name          => :trace,
+              :description => "Enable trace debug",
+              :short       => 't'},
            {:name          => :quiet,
               :description => "Be less verbose",
               :short       => 'q'},
@@ -31,21 +34,24 @@ class Hiera
           ]
         
         def self.load_config_file
-          config_file=ENV['EYAML_CONFIG'] || "#{ENV['HOME']}/.eyaml/config.yaml"
-          begin
-            config = YAML.load_file(config_file)
-            Utils::info "Loaded config from #{config_file}"
-            config
-          rescue Errno::ENOENT, IndexError
-            {}
+          config = {}
+          [ "/etc/eyaml/config.yaml", "#{ENV['HOME']}/.eyaml/config.yaml", "#{ENV['EYAML_CONFIG']}" ].each do |config_file|
+            begin
+              yaml_contents = YAML.load_file(config_file)
+              Utils::info "Loaded config from #{config_file}"
+              config.merge! yaml_contents
+            rescue 
+              raise StandardError, "Could not open config file \"#{config_file}\" for reading"
+            end if config_file and File.file? config_file
           end
+          config
         end
 
         def self.all_options 
           options = @@global_options.dup
           options += self.options if self.options
           options += Plugins.options
-          # merge in defaults from configuration file
+          # merge in defaults from configuration files
           config_file = self.load_config_file
           options.map!{ | opt| 
             key_name = "#{opt[:name]}"
@@ -106,6 +112,10 @@ class Hiera
             Hiera::Backend::Eyaml.verbosity_level += 1
           end
 
+          if options[:trace]
+            Hiera::Backend::Eyaml.verbosity_level += 2
+          end
+
           if options[:quiet]
             Hiera::Backend::Eyaml.verbosity_level = 0
           end

data/lib/hiera/backend/eyaml/subcommands/edit.rb

@@ -12,7 +12,8 @@ class Hiera
         class Edit < Subcommand
 
           def self.options
-            []
+            [{ :name => :no_preamble,
+               :description => "Don't prefix edit sessions with the informative preamble" }]
           end
 
           def self.description
@@ -23,11 +24,46 @@ class Hiera
             "Usage: eyaml edit [options] <some-eyaml-file>"
           end
 
+          def self.prefix
+            '#|'
+          end
+
+          def self.preamble
+            tags = (["pkcs7"] + Plugins.plugins.collect {|plugin|
+              plugin.name.split("hiera-eyaml-").last
+            }).collect{|name| Encryptor.find(name).tag}
+
+            preamble = <<-eos
+This is eyaml edit mode. This text (lines starting with #{self.prefix} at the top of the
+file) will be removed when you save and exit.
+ - To edit encrypted values, change the content of the DEC(<num>)::PKCS7[]!
+   block#{(tags.size>1) ? " (or #{tags.drop(1).collect {|tag| "DEC(<num>)::#{tag}[]!" }.join(' or ')})." : '.' }
+   WARNING: DO NOT change the number in the parentheses.
+ - To add a new encrypted value copy and paste a new block from the
+   appropriate example below. Note that:
+    * the text to encrypt goes in the square brackets
+    * ensure you include the exclamation mark when you copy and paste
+    * you must not include a number when adding a new block
+   e.g. #{tags.collect {|tag| "DEC::#{tag}[]!" }.join(' -or- ')}
+eos
+
+            preamble.gsub(/^/, "#{self.prefix} ")
+          end
+
           def self.validate options
             Trollop::die "You must specify an eyaml file" if ARGV.empty?
             options[:source] = :eyaml
             options[:eyaml] = ARGV.shift
-            options[:input_data] = File.read options[:eyaml]
+            if File.exists? options[:eyaml]
+              begin
+                options[:input_data] = File.read options[:eyaml]
+              rescue
+                raise StandardError, "Could not open file for reading: #{options[:eyaml]}"
+              end
+            else
+              Utils.info "#{options[:eyaml]} doesn't exist, editing new file"
+              options[:input_data] = "---"
+            end
             options
           end
 
@@ -35,16 +71,19 @@ class Hiera
             encrypted_parser = Parser::ParserFactory.encrypted_parser
             tokens = encrypted_parser.parse Eyaml::Options[:input_data]
             decrypted_input = tokens.each_with_index.to_a.map{|(t,index)| t.to_decrypted :index => index}.join
-            decrypted_file = Utils.write_tempfile decrypted_input
+            decrypted_file_content = Eyaml::Options[:no_preamble] ? decrypted_input : (self.preamble + decrypted_input)
+            decrypted_file = Utils.write_tempfile decrypted_file_content
 
             editor = Utils.find_editor
 
             begin
-              system "#{editor} #{decrypted_file}"
+              system "#{editor} \"#{decrypted_file}\""
               status = $?
 
               raise StandardError, "File was moved by editor" unless File.file? decrypted_file
-              edited_file = File.read decrypted_file
+              raw_edited_file = File.read decrypted_file
+              # strip comments at start of file
+              edited_file = raw_edited_file.split($/,-1).drop_while {|line| line.start_with?(self.prefix)}.join($/)
 
               raise StandardError, "Editor #{editor} has not exited?" unless status.exited?
               raise StandardError, "Editor did not exit successfully (exit code #{status.exitstatus}), aborting" unless status.exitstatus == 0

data/lib/hiera/backend/eyaml/subcommands/version.rb

@@ -19,11 +19,7 @@ class Hiera
           def self.execute
             plugin_versions = {}
 
-            puts <<-EOS
-Version info
-
-hiera-eyaml (core): #{Eyaml::VERSION}
-EOS
+            Eyaml::Utils.info "hiera-eyaml (core): #{Eyaml::VERSION}"
 
             Plugins.plugins.each do |plugin|
               plugin_shortname = plugin.name.split("hiera-eyaml-").last
@@ -32,7 +28,7 @@ EOS
               rescue
                 "unknown (is plugin compatible with eyaml 2.0+ ?)"
               end
-              puts "    hiera-eyaml-#{plugin_shortname} (gem): #{plugin_version}"
+              Eyaml::Utils.info "hiera-eyaml-#{plugin_shortname} (gem): #{plugin_version}"
             end
 
             nil
@@ -44,4 +40,4 @@ EOS
       end
     end
   end
-end
+end

data/lib/hiera/backend/eyaml/utils.rb

@@ -34,6 +34,20 @@ class Hiera
           editor = ENV['EDITOR']
           editor ||= %w{ /usr/bin/sensible-editor /usr/bin/editor /usr/bin/vim /usr/bin/vi }.collect {|e| e if FileTest.executable? e}.compact.first
           raise StandardError, "Editor not found. Please set your EDITOR env variable" if editor.nil?
+          if editor.index(' ')
+            editor = editor.dup if editor.frozen? # values from ENV are frozen
+            editor.gsub!(/([^\\]|^)~/, '\1' + ENV['HOME']) # replace ~ with home unless escaped
+            editor.gsub!(/(^|[^\\])"/, '\1') # remove unescaped quotes during processing
+            editor.gsub!(/\\ /, ' ') # unescape spaces since we quote paths
+            pieces = editor.split(' ')
+            paths = pieces.each_with_index.map {|_,x| pieces[0..x].join(' ')}.reverse # get possible paths, starting with longest
+            extensions = (ENV['PATHEXT'] || '').split(';') # handle Windows executables
+            editorfile = paths.select { |path|
+              FileTest.file?(path) || ! extensions.select {|ext| FileTest.file?(path + ext) }.empty?
+            }.first
+            raise StandardError, "Editor not found. Please set your EDITOR env variable" if editorfile.nil?
+            editor = "\"#{editorfile}\"#{editor[editorfile.size()..-1]}"
+          end
           editor
         end
 
@@ -45,11 +59,12 @@ class Hiera
             num_bytes.times { file.print(byte.chr) }
             file.fsync
           end
+          file.close
           File.delete args[:file]
         end
 
         def self.write_tempfile data_to_write
-          file = Tempfile.open('eyaml_edit')
+          file = Tempfile.open(['eyaml_edit', '.yaml'])
           path = file.path
           file.close!
 
@@ -107,7 +122,7 @@ class Hiera
           root_folder = File.dirname(__FILE__) + "/" + Array.new(num_class_hierarchy_levels).fill("..").join("/")
           class_folder = root_folder + "/" + classdir
           Dir[File.expand_path("#{class_folder}/*.rb")].uniq.each do |file|
-            # puts "Requiring file: #{file}"
+            self.trace "Requiring file: #{file}"
             require file
           end
         end
@@ -134,36 +149,60 @@ class Hiera
           else
             message.merge!({:msg => messageinfo.to_s})
           end
+          message[:prefix] = "[#{message[:from]}]"
+          message[:spacer] = " #{' ' * message[:from].length} "
+          formatted_output = message[:msg].split("\n").each_with_index.map do |line, index|
+            if index == 0
+              "#{message[:prefix]} #{line}"
+            else
+              "#{message[:spacer]} #{line}"
+            end
+          end
+          formatted_output.join "\n"
         end
 
         def self.warn messageinfo
-          message = self.structure_message messageinfo
-          message = "[#{message[:from]}] !!! #{message[:msg]}"
-          if self.hiera?
-            Hiera.warn message
-          else
-            STDERR.puts message
-          end
+          self.print_message({ :message => self.structure_message( messageinfo ), :hiera_loglevel => :warn, :cli_color => :red })
         end
 
         def self.info messageinfo
-          message = self.structure_message messageinfo
-          message = "[#{message[:from]}] #{message[:msg]}"
-          if self.hiera?
-            Hiera.debug message if Eyaml.verbosity_level > 0
-          else
-            STDERR.puts message if Eyaml.verbosity_level > 0
-          end
+          self.print_message({ :message => self.structure_message( messageinfo ), :hiera_loglevel => :debug, :cli_color => :white, :threshold => 0 })
         end
 
         def self.debug messageinfo
-          message = self.structure_message messageinfo
-          message = "[#{message[:from]}] #{message[:msg]}"
+          self.print_message({ :message => self.structure_message( messageinfo ), :hiera_loglevel => :debug, :cli_color => :green, :threshold => 1 })
+        end
+
+        def self.trace messageinfo
+          self.print_message({ :message => self.structure_message( messageinfo ), :hiera_loglevel => :debug, :cli_color => :blue, :threshold => 2 })
+        end
+
+        def self.print_message( args )
+          message        = args[:message] ||= ""
+          hiera_loglevel = args[:hiera_loglevel] ||= :debug
+          cli_color      = args[:cli_color] ||= :blue
+          threshold      = args[:threshold]
+
           if self.hiera?
-            Hiera.debug message if Eyaml.verbosity_level > 1
+            Hiera.send(hiera_loglevel, message) if threshold.nil? or Eyaml.verbosity_level > threshold
           else
-            STDERR.puts message if Eyaml.verbosity_level > 1
+            STDERR.puts self.colorize( message, cli_color ) if threshold.nil? or Eyaml.verbosity_level > threshold
+          end
+        end
+
+        def self.colorize message, color
+          suffix = "\e[0m"
+          prefix = case color
+          when :red
+            "\e[31m"
+          when :green
+            "\e[32m"
+          when :blue
+            "\e[34m"
+          else #:white
+            "\e[0m"
           end
+          "#{prefix}#{message}#{suffix}"
         end
 
       end

data/tools/regem.sh

@@ -6,4 +6,4 @@ echo ${RAKE_OUT}
 VERSION=`echo ${RAKE_OUT} | awk '{print $2}'`
 echo Installing version: ${VERSION} ...
 gem install pkg/hiera-eyaml-${VERSION}.gem
-eyaml -v
+eyaml version

metadata

@@ -1,47 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hiera-eyaml
-version: !ruby/object:Gem::Version 
-  version: 2.0.3
+version: !ruby/object:Gem::Version
+  version: 2.0.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Tom Poulton
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-07-23 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: trollop
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "2.0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: highline
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.6.19
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.19
 description: Hiera backend for decrypting encrypted yaml properties
 email: 
-executables: 
+executables:
 - eyaml
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
+- CHANGES.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -76,30 +87,28 @@ files:
 - sublime_text/eyaml.syntax_definition.json
 - tools/regem.sh
 homepage: http://github.com/TomPoulton/hiera-eyaml
-licenses: 
+licenses:
 - MIT
-metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - &id003 
-    - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id003
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: OpenSSL Encryption backend for Hiera
 test_files: []
-

checksums.yaml

@@ -1,7 +0,0 @@
---- 
-SHA1: 
-  metadata.gz: 3912bf9a2405844f834908a20b1366efda3dd75d
-  data.tar.gz: 5cec508a47fab8d5a4f4ec19808c436dd61d8d6a
-SHA512: 
-  metadata.gz: dc1f52d302216134c15e7880f77c5f3c8aa639f4ac1be73b30fca4ae9e0c76a30a7bf95999cb94313fe7c9c4632853cbafdf08559658d83c94c81a9e6ec72097
-  data.tar.gz: 861f3b3ca88829e533f65ac4a36afc5e674b2217d84855005c913c3577e94f490eeefb70c027daa89d77f8b650f9e9c926b55e4217a87945a0e7bcb4cb71d116