brightbox-cli 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29533e756026749e72115155385719115451994b
-  data.tar.gz: b603ce0f0d7806cce0d5026305ba1dbeeb646e5f
+  metadata.gz: bf43e59f5f1a48d1640ab74aa4b0a10405704b44
+  data.tar.gz: ddccb12e250a6b96e087f38c9bfb9bc30f8ac9eb
 SHA512:
-  metadata.gz: 0ac0ab798b0c7d52e2bbf19289c199e69adc93eea542ea044e1cbb6fc5f143f036da11fe1dd3b469bca7bdb9ba3c5a785989e315823a300e5a1dd5735935dc68
-  data.tar.gz: 6b026cb3b891744bb34fec64ca7241b4ad1ecfd640ef34d90f57d7e02fd421ca3cfd0e69c5411aeb7f07817fd3fa673916472555e778f8aeb4cf055cab798c4c
+  metadata.gz: 7b3ea4869fcd217e4f8ea3e0418e5bac03607d7be2579f136f4babb6b3d3e00e7fe63511b5e36f447e3c20e4b0291e08b45d497f301040cdfe861261fe5a625c
+  data.tar.gz: 998d29050504582fd18e37acb3f0ea885559ae77f2fcb72bd763ecb37d870ea694a0602df42fadf8be948db2ea1d2f906ca915df4cf8658ef8f3e630845cca7f

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### v1.5.0 / 2015-02-13
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v1.4.3...v1.5.0)
+
+Enhancements:
+
+* Add support for GPG stored user passwords.
+
 ### v1.4.3 / 2015-02-12
 [Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v1.4.2...v1.4.3)
 

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    brightbox-cli (1.4.3)
+    brightbox-cli (1.5.0)
       fog-brightbox (~> 0.7, >= 0.7.1)
       fog-core (~> 1.25)
       gli (~> 2.9)
       highline (~> 1.6)
       hirb (~> 0.6)
-      i18n
+      i18n (~> 0.6.0)
       mime-types (~> 1.25)
       multi_json
 
@@ -17,12 +17,12 @@ GEM
     builder (3.2.2)
     coderay (1.0.9)
     diff-lcs (1.2.5)
-    excon (0.42.1)
+    excon (0.44.2)
     fog-brightbox (0.7.1)
       fog-core (~> 1.22)
       fog-json
       inflecto (~> 0.0.2)
-    fog-core (1.27.2)
+    fog-core (1.28.0)
       builder
       excon (~> 0.38)
       formatador (~> 0.2)
@@ -34,8 +34,8 @@ GEM
     formatador (0.2.5)
     gli (2.12.2)
     highline (1.6.21)
-    hirb (0.7.2)
-    i18n (0.7.0)
+    hirb (0.7.3)
+    i18n (0.6.11)
     inflecto (0.0.2)
     metaclass (0.0.1)
     method_source (0.8.1)
@@ -45,7 +45,7 @@ GEM
     multi_json (1.10.1)
     net-scp (1.2.1)
       net-ssh (>= 2.6.5)
-    net-ssh (2.9.1)
+    net-ssh (2.9.2)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)

data/README

@@ -51,6 +51,50 @@ To browse available resources use the resource name as the command:
 
 Command structure may be subject to change.
 
+=== Using GPG to secure passwords
+
+If you use an OAuth application to access your accounts
+(https://www.brightbox.com/docs/guides/manager/oauth-applications/) then you
+frequently need to renter your password.
+
+From v1.5.0 you can store your password locally encrypted by GPG (https://www.gnupg.org/)
+which will decrypt the password when needed. This will prompt for your GPG key
+if not available to the GPG agent using your OS's configured pinentry program.
+
+You need to have setup GPG with your own keys and have configured the pinentry
+to prompt you when the key is locked.
+
+The password file is named after your configuration's alias:
+
+    $ brightbox config
+     alias                 client_id  secret           api_url                         auth_url
+    ------------------------------------------------------------------------------------------------------------------
+     *main                 app-12345  xxxxxxxxxxxxxxx  https://api.gb1.brightbox.com   https://api.gb1.brightbox.com
+    ------------------------------------------------------------------------------------------------------------------
+
+The alias here is `main`. To prepare the password run this command:
+
+    $ gpg --encrypt --recipient gpg@example.com > ~/.brightbox/main.password.gpg
+    (type your password)<RETURN>
+    <CTRL+D>
+    # Test it with...
+    $ gpg --decrypt ~/.brightbox/main.password.gpg
+    password!2015
+    $ brightbox accounts
+    INFO: client_id: app-12345 (main)
+    INFO: Decrypting /home/user/.brightbox/main.password.gpg to obtain password
+    gpg: encrypted with 2048-bit RSA key, ID ABCDE890, created 2015-01-01
+          "Jason Null <gpg@example.com>"
+    Your API credentials have been updated, please re-run your command.
+
+Now when making commands you should only have to unlock your keyring to avoid
+typing your password.
+
+If you are prompted to enter your password still then the file may be named
+incorrectly or there may be an issue with your GPG configuration.
+
+To remove the password delete the `~/.brightbox/main.password.gpg` file.
+
 == Usage guides
 
 * http://docs.brightbox.com/reference/cli

data/README.rdoc

@@ -51,6 +51,50 @@ To browse available resources use the resource name as the command:
 
 Command structure may be subject to change.
 
+=== Using GPG to secure passwords
+
+If you use an OAuth application to access your accounts
+(https://www.brightbox.com/docs/guides/manager/oauth-applications/) then you
+frequently need to renter your password.
+
+From v1.5.0 you can store your password locally encrypted by GPG (https://www.gnupg.org/)
+which will decrypt the password when needed. This will prompt for your GPG key
+if not available to the GPG agent using your OS's configured pinentry program.
+
+You need to have setup GPG with your own keys and have configured the pinentry
+to prompt you when the key is locked.
+
+The password file is named after your configuration's alias:
+
+    $ brightbox config
+     alias                 client_id  secret           api_url                         auth_url
+    ------------------------------------------------------------------------------------------------------------------
+     *main                 app-12345  xxxxxxxxxxxxxxx  https://api.gb1.brightbox.com   https://api.gb1.brightbox.com
+    ------------------------------------------------------------------------------------------------------------------
+
+The alias here is `main`. To prepare the password run this command:
+
+    $ gpg --encrypt --recipient gpg@example.com > ~/.brightbox/main.password.gpg
+    (type your password)<RETURN>
+    <CTRL+D>
+    # Test it with...
+    $ gpg --decrypt ~/.brightbox/main.password.gpg
+    password!2015
+    $ brightbox accounts
+    INFO: client_id: app-12345 (main)
+    INFO: Decrypting /home/user/.brightbox/main.password.gpg to obtain password
+    gpg: encrypted with 2048-bit RSA key, ID ABCDE890, created 2015-01-01
+          "Jason Null <gpg@example.com>"
+    Your API credentials have been updated, please re-run your command.
+
+Now when making commands you should only have to unlock your keyring to avoid
+typing your password.
+
+If you are prompted to enter your password still then the file may be named
+incorrectly or there may be an issue with your GPG configuration.
+
+To remove the password delete the `~/.brightbox/main.password.gpg` file.
+
 == Usage guides
 
 * http://docs.brightbox.com/reference/cli

data/brightbox-cli.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency "fog-brightbox", "~> 0.7", ">= 0.7.1"
   s.add_dependency "fog-core", "~> 1.25"
   s.add_dependency "gli", "~> 2.9"
-  s.add_dependency "i18n"
+  s.add_dependency "i18n", "~> 0.6.0"
   s.add_dependency "mime-types", "~> 1.25"
   s.add_dependency "multi_json"
   s.add_dependency "highline", "~> 1.6"

data/lib/brightbox-cli/config.rb

@@ -12,6 +12,7 @@ module Brightbox
     require 'ini'
     include Brightbox::Logging
     include Brightbox::Config::Cache
+    include Brightbox::Config::GpgEncryptedPasswords
     include Brightbox::Config::AuthenticationTokens
     include Brightbox::Config::Accounts
     include Brightbox::Config::Clients

data/lib/brightbox-cli/config/authentication_tokens.rb

@@ -189,6 +189,7 @@ module Brightbox
       def update_tokens_with_user_credentials(password = nil)
         user_application = Brightbox::Config::UserApplication.new(selected_config, client_name)
 
+        password = gpg_password unless password
         password = prompt_for_password unless password
 
         # FIXME: options are required to work

data/lib/brightbox-cli/config/gpg_encrypted_passwords.rb

@@ -0,0 +1,39 @@
+module Brightbox
+  module Config
+    module GpgEncryptedPasswords
+      attr_accessor :gpg_password
+
+      def gpg_encrypted_password_filename
+        file_name = "#{client_name}.password.gpg"
+        @gpg_encrypted_password_filename ||= File.join(config_directory, file_name)
+      end
+
+      # Return the password from gpg if it's possible
+      def gpg_password
+        if defined?(@gpg_password) && !@gpg_password.nil?
+          return @gpg_password
+        end
+        if File.exist?(gpg_encrypted_password_filename)
+          @gpg_password = gpg_decrypt_password
+        else
+          @gpg_password = nil
+        end
+      end
+
+      private
+
+      # Use gpg to decrypt the password
+      def gpg_decrypt_password
+        info "INFO: Decrypting #{gpg_encrypted_password_filename} to obtain password"
+        begin
+          IO::popen(["gpg", "--decrypt", gpg_encrypted_password_filename], "r") do |io|
+            io.read.chomp
+          end
+        rescue Errno::ENOENT
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/brightbox-cli/version.rb

@@ -1,3 +1,3 @@
 module Brightbox
-  VERSION = "1.4.3" unless defined?(Brightbox::VERSION)
+  VERSION = "1.5.0" unless defined?(Brightbox::VERSION)
 end

data/lib/brightbox_cli.rb

@@ -65,6 +65,7 @@ require_relative 'brightbox-cli/tables'
 require_relative "brightbox-cli/logging"
 require_relative "brightbox-cli/api"
 require_relative "brightbox-cli/config/cache"
+require_relative "brightbox-cli/config/gpg_encrypted_passwords"
 require_relative "brightbox-cli/config/authentication_tokens"
 require_relative "brightbox-cli/config/accounts"
 require_relative "brightbox-cli/config/clients"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brightbox-cli
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - John Leach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-brightbox
@@ -62,16 +62,16 @@ dependencies:
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -341,6 +341,7 @@ files:
 - lib/brightbox-cli/config/cache.rb
 - lib/brightbox-cli/config/clients.rb
 - lib/brightbox-cli/config/dirty.rb
+- lib/brightbox-cli/config/gpg_encrypted_passwords.rb
 - lib/brightbox-cli/config/section_name_deduplicator.rb
 - lib/brightbox-cli/config/sections.rb
 - lib/brightbox-cli/config/to_fog.rb