brightbox-cli 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5c03039c9263c4872064938223b825be9550d1c08e2a77d438b68f1fd7b42cc
-  data.tar.gz: 85f994952c28133cf8ad08c70d16228b165373f94a90916a0a83fe365e14672d
+  metadata.gz: 881d758fc2932375edc56797f613f757a7f83729087cf2335a44736f4554fe1d
+  data.tar.gz: cfb933331637277089d47a0feccf9456e18b45f0a248aa27f233c52f24ba2f61
 SHA512:
-  metadata.gz: 013e062376468560718cfbf25c2e2221db7e0808bcadc6413b6cbf5532b966917de0e2c40d2ffd1a859f8fd78267c28b86166e5638d2869cfe22e9c315bd8a4b
-  data.tar.gz: f81c26c3a3705e6caa3399e1598e4c8ad399f175a0be4d26c2383ccfab8a8cfc75c2ebde0135aa9cee2f4cd220df2119a4d3a880b4c585b3dfc113384cfe57e6
+  metadata.gz: a7b28703cc70a953b900f0caabaf036ff78c1e914810fcba9523b7f8b44ae5c7d148ee09f08d073d71449b587024f7d64ead1f88a659c3a2d2a52c502134d23a
+  data.tar.gz: ea62fcbe6b909e8b7cb8744da7acacd50c75bcb0c109fada221ef135ff1c1ac0d88dc01d8975ef3a8068c75e86956ce244ab88abc641e2dc3d79ed474502e59d

data/.github/workflows/ruby.yml

@@ -20,7 +20,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ["2.4", "2.5", "2.6", "2.7"]
+        ruby: ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "3.0"]
 
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+### v3.3.0 / 2021-09-17
+
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v3.2.0...v3.3.0)
+
+Changes:
+
+* Update `fog-brightbox` to v1.4.0` (allowing Ruby 3.0 support)
+* Added support for getting 2FA from helper
+* Added missing `sql snapshot` fields
+* Infrastructure changes to test on more versions of Ruby
+* Added GitHub actions support for CI testing.
+* Removed Travis CI support.
+
+Bug fixes:
+
+* Updates `crack` gem to switch from `safe_yaml` to `rexml`
+* Bump addressable from 2.3.8 to 2.8.0. (fixing ReDoS vulnerability)
+* Bump rexml from 3.2.4 to 3.2.5 (fixing round-trip vulnerability bugs)
+
 ### v3.2.0 / 2020-11-26
 
 [Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v3.1.0...v3.2.0)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brightbox-cli (3.2.0)
+    brightbox-cli (3.3.0)
       dry-inflector (< 0.2)
       fog-brightbox (>= 1.3.0)
       fog-core (< 2.0)
@@ -15,15 +15,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.8)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     builder (3.2.4)
     coderay (1.0.9)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.3)
     dry-inflector (0.1.2)
-    excon (0.78.0)
-    fog-brightbox (1.3.0)
+    excon (0.79.0)
+    fog-brightbox (1.4.0)
       dry-inflector
       fog-core (>= 1.45, < 3.0)
       fog-json
@@ -52,7 +53,9 @@ GEM
     pry-remote (0.1.8)
       pry (~> 0.9)
       slop (~> 3.0)
+    public_suffix (2.0.5)
     rake (12.3.3)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -66,7 +69,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    safe_yaml (1.0.4)
     slop (3.4.5)
     vcr (2.5.0)
     webmock (1.21.0)

data/README

@@ -9,17 +9,6 @@ You can sign up at https://manage.brightbox.com
 
 {<img src="https://travis-ci.org/brightbox/brightbox-cli.png?branch=master" alt="Build Status" />}[https://travis-ci.org/brightbox/brightbox-cli]
 
-== UPGRADE NOTES
-
-Version 1.0.0 adds a new top level `brightbox` command for the suite.
-
-This may clash with our `brightbox` (brightbox-deployment) gem which, before
-version 2.4.0, used `brightbox` as the name for it's binary. Please ensure you
-update your `brightbox` gem to avoid using the wrong command.
-
-We have included backwards compatible binaries for all the older CLI commands
-(brightbox-accounts, brightbox-servers etc...) but recommend getting used to the
-new form.
 
 == Installation instructions
 
@@ -36,7 +25,11 @@ For a list of available commands use:
 
    $ brightbox help
 
-To add client (account based) credentials use:
+To login with your user credentials use:
+
+   $ brightbox login john@example.com
+
+To instead add api client (account-specific) credentials use:
 
    $ brightbox config client_add cli-2igtb theclientsecret
    Using config file /home/ubuntu/.brightbox/config
@@ -49,7 +42,14 @@ To browse available resources use the resource name as the command:
    $ brightbox images
    ... List of images
 
-Command structure may be subject to change.
+=== Two factor authentication ===
+
+If you've enabled two factor authentication for your user, you can enable it in
+your config and the CLI will prompt for a two factor pin when needed:
+
+    [john@example.com]
+    username = john@example.com
+    two_factor = true
 
 === Integrating with a password manager
 
@@ -64,6 +64,13 @@ appropriate section:
     username = john@example.com
     password_helper_command = pass john-example-com-brightbox
 
+You can also specify a separate helper command to retrive two factor pins:
+
+    [john@example.com]
+    username = john@example.com
+    password_helper_command = pass john-example-com-brightbox
+    two_factor_helper_command = get-two-factor-pin john-example-com-brightbox
+
 === Using GPG to secure passwords
 
 If you use an OAuth application to access your accounts
@@ -108,6 +115,20 @@ incorrectly or there may be an issue with your GPG configuration.
 
 To remove the password delete the `~/.brightbox/main.password.gpg` file.
 
+=== Integrating with a password manager
+
+You can retrieve your passwords from an external password manager by specifying
+a password helper command. This command will be executed any time your password
+is required and its output used as your password.
+
+Configure the command in your config file (usually ~/.brightbox/config) in the
+appropriate section:
+
+    [john@example.com]
+    username = john@example.com
+    password_helper_command = pass john-example-com-brightbox
+
+
 == Usage guides
 
 * http://docs.brightbox.com/reference/cli
@@ -130,6 +151,18 @@ in the path, just specify the full path to it:
 
     complete -C /full/path/to/bin/_brightbox-bash-completer -o filenames brightbox
 
+== UPGRADE NOTES
+
+Version 1.0.0 adds a new top level `brightbox` command for the suite.
+
+This may clash with our `brightbox` (brightbox-deployment) gem which, before
+version 2.4.0, used `brightbox` as the name for it's binary. Please ensure you
+update your `brightbox` gem to avoid using the wrong command.
+
+We have included backwards compatible binaries for all the older CLI commands
+(brightbox-accounts, brightbox-servers etc...) but recommend getting used to the
+new form.
+
 == Testing
 
 You should be able to run the specs and features with the following steps:

data/lib/brightbox-cli/commands/sql/snapshots_show.rb

@@ -21,8 +21,13 @@ module Brightbox
               :name,
               :description,
               :status,
+              :database_engine,
+              :database_version,
               :locked,
-              :created_on
+              :created_on,
+              :created_at,
+              :size,
+              :source
             ]
           )
           render_table(servers, table_opts)

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

@@ -17,7 +17,10 @@ module Brightbox
       end
 
       def two_factor_pin
-        @two_factor_pin ||= prompt_for_two_factor_pin if two_factor_enabled
+        if two_factor_enabled
+          @two_factor_pin ||= Brightbox.config.two_factor_helper_password
+          @two_factor_pin ||= prompt_for_two_factor_pin
+        end
       end
 
       def prompt_for_two_factor_pin

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

@@ -0,0 +1,38 @@
+module Brightbox
+  module Config
+    module TwoFactorHelper
+      attr_accessor :two_factor_helper_password
+
+      def two_factor_helper_command
+        return config[client_name]["two_factor_helper_command"] unless client_name.nil?
+      end
+
+      # Return the two_factor code from the helper if it's possible
+      def two_factor_helper_password
+        if defined?(@two_factor_helper_password) && !@two_factor_helper_password.nil?
+          return @two_factor_helper_password
+        end
+
+        if two_factor_helper_command
+          @two_factor_helper_password = two_factor_helper_call
+        else
+          @two_factor_helper_password = nil
+        end
+      end
+
+      private
+
+      def two_factor_helper_call
+        info "INFO: Calling two factor helper to obtain two factor"
+        begin
+          cmd = two_factor_helper_command.split(/\s+/)
+          IO.popen(cmd, "r") do |io|
+            io.readline.chomp
+          end
+        rescue Errno::ENOENT
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/brightbox-cli/config.rb

@@ -15,6 +15,7 @@ module Brightbox
     include Brightbox::Config::GpgEncryptedPasswords
     include Brightbox::Config::PasswordHelper
     include Brightbox::Config::TwoFactorAuth
+    include Brightbox::Config::TwoFactorHelper
     include Brightbox::Config::AuthenticationTokens
     include Brightbox::Config::Accounts
     include Brightbox::Config::Clients

data/lib/brightbox-cli/database_snapshot.rb

@@ -23,7 +23,7 @@ module Brightbox
     end
 
     def self.default_field_order
-      [:id, :status, :created_on, :name]
+      [:id, :status, :created_on, :size, :name]
     end
 
     def to_row

data/lib/brightbox-cli/version.rb

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

data/lib/brightbox_cli.rb

@@ -73,6 +73,7 @@ require_relative "brightbox-cli/config/cache"
 require_relative "brightbox-cli/config/gpg_encrypted_passwords"
 require_relative "brightbox-cli/config/password_helper"
 require_relative "brightbox-cli/config/two_factor_auth"
+require_relative "brightbox-cli/config/two_factor_helper"
 require_relative "brightbox-cli/config/authentication_tokens"
 require_relative "brightbox-cli/config/accounts"
 require_relative "brightbox-cli/config/clients"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brightbox-cli
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - John Leach
@@ -243,7 +243,6 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -373,6 +372,7 @@ files:
 - lib/brightbox-cli/config/sections.rb
 - lib/brightbox-cli/config/to_fog.rb
 - lib/brightbox-cli/config/two_factor_auth.rb
+- lib/brightbox-cli/config/two_factor_helper.rb
 - lib/brightbox-cli/config/user_application.rb
 - lib/brightbox-cli/connection_manager.rb
 - lib/brightbox-cli/database_server.rb

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-sudo: false
-
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3