cased-ruby 0.4.1 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f91759262adc1b192cc5305bb9f84448b888bcb258c7c297f9494b0bba71b55c
-  data.tar.gz: ce78dd8209246e35dd4ed0fb76f15870b074352b29cf73f01eba426352176572
+  metadata.gz: a98d48b740d571c68ad950fe60ecd5af5126fa9567b80030c50bc9cf3f7428c3
+  data.tar.gz: b1fdbda8126943f5421176269d42d60144425790c22d57179abe6cf892e99cb6
 SHA512:
-  metadata.gz: f13376f04cc1d8dc3c8d93ffcc0403e073d9819ec71f1344f9cb0801b596ab21e31646c89ba02c3a5577dc1afd65ee6a2f24e779eb1e45c9d59ef49b9754fcf3
-  data.tar.gz: 8a13f691413981290dfda15d90d6576fdf04723dbc4ede2872d7e9cd476488182bda4a8fdf05eec6f2680490c342fddb1d9aaf0a1f0c32be7739e284c231a01e
+  metadata.gz: b519bd5dac037cc8ae8c5e795f44d658f44f44ad879e0456e1368dd18378323e5e9f4c8c8ea2e23a12958c4acc7c4c78a0b18afc95a57b6b78be8fe535bbfb0a
+  data.tar.gz: 9ce3b66f202ea6b431ae70d28cc4c22327eb4c5b25ac100a320a733964d91c08b139ecc75fbf4a5932f3603cc796983b9a9de39d68a80c54c80ada772bc7f3c3

data/.github/workflows/ruby.yml

@@ -28,19 +28,3 @@ jobs:
       - name: Run Tests
         run: |
           bundle exec rake test
-
-      - name: Generate yard documentation
-        run: |
-          bundle exec yard
-
-      - name: Upload test coverage report
-        uses: actions/upload-artifact@v2
-        with:
-          name: coverage
-          path: coverage/**/*
-
-      - name: Upload generated yard documentation
-        uses: actions/upload-artifact@v2
-        with:
-          name: yard
-          path: doc/**/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cased-ruby (0.4.1)
+    cased-ruby (0.4.6)
       activesupport (~> 6)
       dotpath (= 0.1.0)
       faraday (~> 1.0)
@@ -14,7 +14,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -38,7 +38,7 @@ GEM
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     json (2.5.1)

data/README.md

@@ -9,6 +9,7 @@ A Cased client for Ruby applications in your organization to control and monitor
 - [Usage](#usage)
   - [Cased CLI](#cased-cli)
     - [Starting an approval workflow](#starting-an-approval-workflow)
+    - [Attaching metadata to all CLI requests](#attaching-metadata-to-all-cli-requests)
   - [Audit trails](#audit-trails)
     - [Publishing events to Cased](#publishing-events-to-cased)
     - [Retrieving events from a Cased audit trail](#retrieving-events-from-a-cased-audit-trail)
@@ -85,6 +86,17 @@ Cased.configure do |config|
 
   # CASED_HTTP_READ_TIMEOUT=10
   config.http_read_timeout = 10
+
+  # Attach metadata to all CLI requests. This metadata will appear in Cased and
+  # any notification source such as email or Slack.
+  #
+  # You are limited to 20 properties and cannot be a nested dictionary. Metadata
+  # specified in the CLI request overrides any configured globally.
+  config.cli.metadata = {
+    rails_env: ENV['RAILS_ENV'],
+    heroku_application: ENV['HEROKU_APP_NAME'],
+    git_commit: ENV['GIT_COMMIT'],
+  }
 end
 ```
 
@@ -135,7 +147,8 @@ end
 
 authentication = Cased::CLI::Authentication.new
 identity = Cased::CLI::Identity.new
-authentication.token = identity.identify
+token, ip_address = identity.identify
+authentication.token = token
 
 session = Cased::CLI::Session.new(
   authentication: authentication,
@@ -180,6 +193,27 @@ You no longer need to handle obtaining the user token or asking for a reason up
 front, `Cased::CLI::InteractiveSession` will prompt the user for any reason
 being required as necessary.
 
+#### Attaching metadata to all CLI requests
+
+While you can customize the metadata included for each CLI request, it may prove
+useful to specify metadata globally that will be included with each CLI request.
+Some useful information to include may be the current Rails environment, Heroku
+application, Git commit deployed, and more.
+
+Metadata is limited to 20 properties and cannot be a nested dictionary.
+
+```ruby
+Cased.configure do |config|
+  config.cli.metadata = {
+    rails_env: ENV['RAILS_ENV'],
+    heroku_application: ENV['HEROKU_APP_NAME'],
+    git_commit: ENV['GIT_COMMIT'],
+  }
+end
+```
+
+Note: Metadata specified in the CLI request overrides any configured globally.
+
 ### Audit trails
 
 #### Publishing events to Cased

data/lib/cased/cli/config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Cased
+  module CLI
+    class Config
+      # @example
+      #   Cased.configure do |config|
+      #     config.cli.metadata = {
+      #       rails_env: ENV['RAILS_ENV'],
+      #       heroku_application: ENV['HEROKU_APP_NAME'],
+      #       git_commit: ENV['GIT_COMMIT'],
+      #     }
+      #   end
+      attr_accessor :metadata
+
+      def initialize
+        @metadata = {}
+      end
+    end
+  end
+end

data/lib/cased/cli/identity.rb

@@ -23,15 +23,20 @@ module Cased
       def poll(poll_url)
         count = 0
         user_id = nil
+        ip_address = nil
 
         while user_id.nil?
           count += 1
           response = Cased.clients.cli.get(poll_url)
-          user_id = response.body.dig('user', 'id')
-          sleep 1 if user_id.nil?
+          if response.success?
+            user_id = response.body.dig('user', 'id')
+            ip_address = response.body.fetch('ip_address')
+          else
+            sleep 1
+          end
         end
 
-        user_id
+        [user_id, ip_address]
       end
     end
   end

data/lib/cased/cli/interactive_session.rb

@@ -30,8 +30,31 @@ module Cased
       end
 
       def create
+        signal_handler = Signal.trap('SIGINT') do
+          if session.requested?
+            Cased::CLI::Log.log 'Exiting and canceling request…'
+            session.cancel
+            exit 0
+          elsif signal_handler.respond_to?(:call)
+            # We need to call the original handler if we exit this interactive
+            # session successfully
+            signal_handler.call
+          else
+            raise Interrupt
+          end
+        end
+
         if session.create
           handle_state(session.state)
+        elsif session.reauthenticate?
+          Cased::CLI::Log.log "You must re-authenticate with Cased due to recent changes to this application's settings."
+
+          identity = Cased::CLI::Identity.new
+          token, ip_address = identity.identify
+          session.authentication.token = token
+          session.forwarded_ip_address = ip_address
+
+          create
         elsif session.unauthorized?
           if session.authentication.exists?
             Cased::CLI::Log.log "Existing credentials at #{session.authentication.credentials_path} are not valid."
@@ -40,7 +63,9 @@ module Cased
           end
 
           identity = Cased::CLI::Identity.new
-          session.authentication.token = identity.identify
+          token, ip_address = identity.identify
+          session.authentication.token = token
+          session.forwarded_ip_address = ip_address
 
           create
         elsif session.reason_required?
@@ -57,26 +82,40 @@ module Cased
 
       def reason_prompt
         print Cased::CLI::Log.string 'Please enter a reason for access: '
-        session.reason = gets.chomp
+        session.reason = STDIN.gets.chomp
       end
 
       def wait_for_approval
+        sleep 1
         session.refresh && handle_state(session.state)
       end
 
+      def waiting_for_approval_message
+        return if defined?(@waiting_for_approval_message_displayed)
+
+        motd = session.guard_application.dig('settings', 'message_of_the_day')
+        waiting_message = motd.blank? ? 'Approval request sent…' : motd
+        Cased::CLI::Log.log "#{waiting_message} (id: #{session.id})"
+        @waiting_for_approval_message_displayed = true
+      end
+
       def handle_state(state)
         case state
         when 'approved'
           Cased::CLI::Log.log 'CLI session has been approved'
           session.record
         when 'requested'
+          waiting_for_approval_message
           wait_for_approval
         when 'denied'
           Cased::CLI::Log.log 'CLI session has been denied'
+          exit 1
         when 'timed_out'
           Cased::CLI::Log.log 'CLI session has timed out'
+          exit 1
         when 'canceled'
           Cased::CLI::Log.log 'CLI session has been canceled'
+          exit 0
         end
       end
     end

data/lib/cased/cli/log.rb

@@ -13,6 +13,8 @@ module Cased
 
       def self.log(text)
         puts string(text)
+      ensure
+        STDOUT.flush
       end
 
       def self.color(text, color, bold = false)

data/lib/cased/cli/session.rb

@@ -86,9 +86,17 @@ module Cased
       # @return [String, nil]
       attr_accessor :reason
 
+      # Public: The forwarded IP V4 or IP V6 address of the user that initiated
+      # the CLI session.
+      #
+      # @example
+      #   session.forwarded_ip_address #=> "1.1.1.1"
+      # @return [String, nil]
+      attr_accessor :forwarded_ip_address
+
       # Public: The client's IP V4 or IP V6 address that initiated the CLI session.
       # @example
-      #   session.reason #=> "1.1.1.1"
+      #   session.ip_address #=> "1.1.1.1"
       # @return [String, nil]
       attr_reader :ip_address
 
@@ -120,7 +128,7 @@ module Cased
         @authentication = authentication || Cased::CLI::Authentication.new
         @reason = reason
         @command = command || [$PROGRAM_NAME, *ARGV].join(' ')
-        @metadata = metadata
+        @metadata = Cased.config.cli.metadata.merge(metadata)
         @requester = {}
         @responder = {}
         @guard_application = {}
@@ -144,6 +152,7 @@ module Cased
         @command = session.fetch('command')
         @metadata = session.fetch('metadata')
         @reason = session.fetch('reason')
+        @forwarded_ip_address = session.fetch('forwarded_ip_address')
         @ip_address = session.fetch('ip_address')
         @requester = session.fetch('requester')
         @responded_at = session['responded_at']
@@ -175,7 +184,7 @@ module Cased
         return false unless api_url
 
         response = Cased.clients.cli.get(api_url, user_token: authentication.token)
-        self.session = response.body if response.success?
+        self.session = response.body
       end
 
       def error?
@@ -194,6 +203,10 @@ module Cased
         error == :unauthorized
       end
 
+      def reauthenticate?
+        error == :reauthenticate
+      end
+
       def record_output?
         guard_application.dig('settings', 'record_output') || false
       end
@@ -222,6 +235,7 @@ module Cased
 
         response = Cased.clients.cli.post('cli/sessions',
           user_token: authentication.token,
+          forwarded_ip_address: forwarded_ip_address,
           reason: reason,
           metadata: metadata,
           command: command)
@@ -233,6 +247,8 @@ module Cased
             @error = :reason_required
           when 'unauthorized'
             @error = :unauthorized
+          when 'reauthenticate'
+            @error = :reauthenticate
           else
             @error = true
             return false
@@ -244,7 +260,7 @@ module Cased
 
       def cancel
         response = Cased.clients.cli.post("#{api_url}/cancel", user_token: authentication.token)
-        self.session = response.body if response.success?
+        self.session = response.body
 
         canceled?
       end

data/lib/cased/config.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'cased/cli/config'
+
 module Cased
   class Config
     # The amount of time in seconds to allow the HTTP client to open a
@@ -149,6 +151,16 @@ module Cased
     #   end
     attr_writer :silence
 
+    # @example
+    #   Cased.configure do |config|
+    #     config.cli.metadata = {
+    #       rails_env: ENV['RAILS_ENV'],
+    #       heroku_application: ENV['HEROKU_APP_NAME'],
+    #       git_commit: ENV['GIT_COMMIT'],
+    #     }
+    #   end
+    attr_reader :cli
+
     def initialize
       @http_read_timeout = ENV.fetch('CASED_HTTP_READ_TIMEOUT', 10).to_i
       @http_open_timeout = ENV.fetch('CASED_HTTP_OPEN_TIMEOUT', 5).to_i
@@ -172,6 +184,7 @@ module Cased
           hash[normalized_key] = api_key if api_key
         end
       end
+      @cli = Cased::CLI::Config.new
     end
 
     # Policy keys are used to query for events from audit trails.

data/lib/cased/http/client.rb

@@ -20,8 +20,6 @@ module Cased
 
           conn.options.timeout = Cased.config.http_read_timeout
           conn.options.open_timeout = Cased.config.http_open_timeout
-
-          conn.adapter :net_http_persistent
         end
       end
 

data/lib/cased/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cased
-  VERSION = '0.4.1'
+  VERSION = '0.4.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cased-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.6
 platform: ruby
 authors:
 - Garrett Bjerkhoel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -305,6 +305,7 @@ files:
 - lib/cased/cli/asciinema/file.rb
 - lib/cased/cli/asciinema/writer.rb
 - lib/cased/cli/authentication.rb
+- lib/cased/cli/config.rb
 - lib/cased/cli/identity.rb
 - lib/cased/cli/interactive_session.rb
 - lib/cased/cli/log.rb
@@ -343,7 +344,7 @@ files:
 - lib/cased/sensitive/string.rb
 - lib/cased/test_helper.rb
 - lib/cased/version.rb
-- vendor/cache/activesupport-6.1.3.gem
+- vendor/cache/activesupport-6.1.3.1.gem
 - vendor/cache/addressable-2.7.0.gem
 - vendor/cache/ast-2.4.0.gem
 - vendor/cache/byebug-11.0.1.gem
@@ -356,7 +357,7 @@ files:
 - vendor/cache/faraday-net_http-1.0.1.gem
 - vendor/cache/faraday_middleware-1.0.0.gem
 - vendor/cache/hashdiff-1.0.1.gem
-- vendor/cache/i18n-1.8.9.gem
+- vendor/cache/i18n-1.8.10.gem
 - vendor/cache/jaro_winkler-1.5.4.gem
 - vendor/cache/json-2.5.1.gem
 - vendor/cache/jwt-2.2.2.gem