hiera-eyaml-gpg 0.1 → 0.2

data/README.md

@@ -14,3 +14,59 @@ keys. This means that each team member can hold their own private key and so can
 Equally, each puppet master can have their own key if desired and when you need to rotate 
 keys for either users or puppet masters, re-encrypting your files and changing the key everywhere
 does not need to be done in lockstep.
+
+Requirements
+------------
+
+You'll need a working GPG setup with your own keypair and a public keyring containing any other
+keys that you want to work
+
+To get started, install the hiera-eyaml-gpg gem.
+
+    $ gem install hiera-eyaml-gpg
+
+If you haven't already installed it, this requires and will install the hiera-eyaml gem, which you
+should probably acquint yourself with at https://github.com/TomPoulton/hiera-eyaml.
+
+Note that in order to install the gpgme gem you'll need to have the ruby development package installed
+for your distribution.
+
+How to use
+----------
+
+### Encrypting and editing encrypted data
+
+Once installed you can create encrypted hiera-eyaml blocks that are encrypted using GPG.
+
+    $ eyaml -n gpg -e -s "A secret string to encrypt" --gpg-recipients bob@example.com,hiera@example.com
+
+If you do not have a web of trust (i.e. you normally use --always-trust for gpg signing) then you'll need 
+to use the `--gpg-always-trust` option on the command line.
+
+It gets pretty dull to keep on remembering which recipients you should use, so you can put them in a file
+and specify that instead.
+
+    $ eyaml -n gpg -e -s "A secret string to encrypt" --gpg-recipients-file hiera-eyaml-gpg.recipients
+
+In fact, when editing a file on disk and neither of the --gpg-recipient options are provided it will
+automatically look for a `hiera-eyaml-gpg.recipients` file in the same directory as the file being edited 
+(or any parent in the tree). The first file discovered will be used allowing different parts of a hiera 
+tree to have different recipients if so desired.
+
+Use `eyaml --help` for more details or look at the hiera-eyaml docs.
+
+### Configuring hiera
+
+Assuming you have a working `hiera` and `hiera-eyaml` then the only option you need to add is to
+configure `:gpg_gnupghome:` in your hiera.yaml (under the `:eyaml:` section). This should be the
+directory that contains the keyring etc for the user that can to decrypt the hiera data. Please note
+that the private GPG key must not have a passphrase.
+
+Authors
+-------
+
+ - Simon Hildrew - Initial code
+ - Geoff Meakins - Created hiera-eyaml plugin framework that made this possible
+
+### Contributors
+ - Walt Javins - Bug fixes

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

@@ -27,10 +27,18 @@ class Hiera
                              :type => :string }
           }
 
+          @@passphrase_cache = Hash.new
+
           def self.passfunc(hook, uid_hint, passphrase_info, prev_was_bad, fd)
             begin
                 system('stty -echo')
-                passphrase = ask("Enter passphrase for #{uid_hint}: ") { |q| q.echo = '*' }
+
+                unless @@passphrase_cache.has_key?(uid_hint)
+                  @@passphrase_cache[uid_hint] = ask("Enter passphrase for #{uid_hint}: ") { |q| q.echo = '' }
+                  $stderr.puts
+                end
+                passphrase = @@passphrase_cache[uid_hint]
+
                 io = IO.for_fd(fd, 'w')
                 io.puts(passphrase)
                 io.flush
@@ -38,7 +46,6 @@ class Hiera
                 (0 ... $_.length).each do |i| $_[i] = ?0 end if $_
                   system('stty echo')
               end
-              $stderr.puts
           end
 
           def self.find_recipients
@@ -52,7 +59,7 @@ class Hiera
                 debug("Using --recipients-file option")
                 Pathname.new(recipient_file_option)
               else
-                debug("Searching for any hiera-eyaml-gpg.recipents files in path")
+                debug("Searching for any hiera-eyaml-gpg.recipients files in path")
                 # if we are editing a file, look for a hiera-eyaml-gpg.recipients file
                 filename = case Eyaml::Options[:source]
                 when :file
@@ -146,6 +153,7 @@ class Hiera
               txt.read
             else
               warn("No usable keys found in #{ENV['GNUPGHOME']}. Check :gpgpghome value in hiera.yaml is correct")
+              raise ArgumentError, "No usable keys found in #{ENV['GNUPGHOME']}. Check :gpgpghome value in hiera.yaml is correct"
             end
           end
 
@@ -158,4 +166,4 @@ class Hiera
       end
     end
   end
-end
+end

data/lib/hiera/backend/eyaml/encryptors/gpg/version.rb

@@ -3,7 +3,7 @@ class Hiera
     module Eyaml
       module Encryptors
         module Gpg
-          VERSION = "0.1"
+          VERSION = "0.2"
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hiera-eyaml-gpg
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiera-eyaml