gpgenv 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a766f9fb2e19f31afb07dccee60a02b2a5223e56
-  data.tar.gz: e8491b464059bd169ec725760f64f80cad1f119c
+  metadata.gz: 18ffeb8806fa8cf718542dcf4df7580c00fe2bda
+  data.tar.gz: 63135d2cdbc03f735a96e37c944f6d6902816685
 SHA512:
-  metadata.gz: 3dfc1f23d9ad0d63f0402ca33d3ef69485cbe714f302443fa20aa3b6c0fd28982b53b33fad6eef9b1f6147948343ad2dc2647aa4bb795492507e32196919e031
-  data.tar.gz: d1cb7b8b2665462d61a4f72bc4e32fbaa637051780a3f1af497b7b718ad0779432844488ee29ba96f4fbe17bb996f320170cbb8fb10d328414eb6da1a1ebe50c
+  metadata.gz: 21589ca5e2e14842a39144100bb474ff54359a6f4f5d7cdd2de356be452c3adc915a6af6750264e590a610c7caacb4c952c36f436e5189ea07e8cbeaa666ae7a
+  data.tar.gz: e5a7e462444ee4f5eed8db030d547fa1285330f013aba67986a02dfb2cd68c70f24639f8ea097e028b4ce8c9b762f85b8d388f4d7a67f07eca563a52d414ccee

data/README.md

@@ -5,30 +5,6 @@ Gpgenv is similar to [envdir](http://cr.yp.to/daemontools/envdir.html), but it l
 files. This is very useful if you want to store sensitive credentials on your machine, but you want to 
 keep them encrypted. 
 
-Please note that this is *not meant to run services*, despite its similarity to 
-envdir: When you use it, you will be required to enter the passphrase to decrypt the gpg files. Robots and
-automated processes should not have this passphrase (otherwise, why encrypt at all?). The primary use case for this is to stop *you, personally*,
-from storing unencrypted, sensitive credentials on disk (like in your .netrc file, your ~/.aws/credentials file, etc), but to still make it
-easy for you to actually use these sensitive credentials.
-
-Also note that gpgenv will ask you to decrypt files *repeatedly* unless you have `gpg-agent` configured, which will make it borderline unusable.
-
-Gpgenv plays very nicely with [pass](http://www.passwordstore.org/). For example:
-
-```bash
-# Set up a shortcut to your passwordstore home directory
-export GPGENV_HOME=$HOME/.password-store/env
-
-# Insert your oauth token into your password store:
-pass insert env/myservice/OAUTH_TOKEN
-
-# Use gpgenv to spawn a bash session:
-gpgenv myservice bash
-
-# From the new bash session, use your oauth token to hit the service:
-curl https://$user:$OAUTH_TOKEN@myservice.com/get_some_data
-```
-
 ## Why?
 As an admin, I am guilty of occasionally storing sensitive credentials on disk. Personal experience leads me to believe that this is
 extremely common. Your .netrc file probably contains all sorts of sensitive data, and even if you use a gpg-encrypted .netrc file, many tools
@@ -42,16 +18,32 @@ on my own machine. I hope that you find it useful as well, and you use it to sto
 
 ## Usage
 
-### Spawn a child process
+### Setup
+```bash
+# You might want to add this to your profile.
+export GPGENV_KEY_ID=<key-id-to-use-to-encrypt-stuff>
+```
+
+### Create or update files in a .gpgenv directory
+
+Gpgenv can create a .gpgenv directory without you ever needing to store plaintext 
+files permanently on disk. Simply run `gpgedit` to either create a new .gpgenv 
+directory, or edit the keys and values in an existing one.
+
+Alternatively, if you have a .env file and you'd like to switch to gpgenv, run
+`dotenv2gpg`. You can switch back by running `gpg2dotenv`, if you choose.
+
+### Run a process
 Gpgenv can spawn a child process that inherits environment variables like so:
 ```bash
-gpgenv /some/dir /some/other/dir "process_to_run argument1 argument2"
+gpgenv "process_to_run argument1 argument2"
 ```
 
 ### Export environment variables
 Gpgenv can export environment variables in your current shell session, like so:
 ```bash
-eval `gpgshell /some/dir /some/other/dir`
+cd /dir/that/has/a/.gpgenv/subdirectory
+eval `gpgshell`
 ```
 
 ## Contributing

data/lib/gpgenv/edit_command.rb

@@ -8,7 +8,7 @@ module Gpgenv
   class EditCommand < Clamp::Command
 
     def execute
-      env = Gpgenv.read_files
+      env = Hash[Gpgenv.read_files.map{|k,v| [ k, to_editable(v) ] }]
       Tempfile.open('.env', ENV.fetch('TMPDIR', '/tmp')) do |f|
         env.each do |k,v|
           f.write("#{k}=#{v}\n")
@@ -26,10 +26,32 @@ module Gpgenv
           i = line.index('=')
           key = line[0..i-1]
           value = line[i+1..-1]
-          Gpgenv.set(key, value)
+          Gpgenv.set(key, from_editable(value))
         end
       end
     end
 
+    private
+
+    # Convert string to editable string. If it is a multiline string,
+    # enclose it in quotes and replace newlines with \n.
+    def to_editable(str)
+      if str =~ /\n/
+        "#{str.gsub(/\n/, '\n')}"
+      else 
+        str
+      end
+    end
+
+    # Convert from editable back to the format to write to the file.
+    # Replace literal \n with newines, strip quotes.
+    def from_editable(str)
+      if str =~ /\\n/
+        str.gsub(/\\n/, "\n")
+      else
+        str
+      end
+    end
+
   end
 end

data/lib/gpgenv/version.rb

@@ -1,3 +1,3 @@
 module Gpgenv
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gpgenv
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Michael Shea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp