settings_reader-vault_resolver 0.4.2 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a9aaa9ade4b4a390d408f4b29bed51bcf1c85c8345cb9434497bd565bd302a2
-  data.tar.gz: '0955dde971303ab6899e9beae5e9b276ef7209b9f9cf3e4769c875a2245619bf'
+  metadata.gz: 5135f50633e103f09f6f30bf956295fc9290a6b75dfd7864e0296ecc9f467f35
+  data.tar.gz: d80b42374412c4053538af7e2ba9a984f0f53219fed76aa440a1a35494167b33
 SHA512:
-  metadata.gz: 69a39ecbcf836c8116531c35b5ed9ea386595182aae4b7afb947d85709071a7dde75763759145e12c031eaff9ee8f85c13dcf55b1e08f2c763813bcb67dd9e2b
-  data.tar.gz: 6732daeeec4a32a63b218926d96974aec750c41abc3097f2ef9cfad58fa7c46626d2df434c147f28a7d7178682d2c3938324c53d5f0e30a5835a85f3fb3e7f8b
+  metadata.gz: 57f47f6d9d9cbea621fa523560129021ceb70c5c9b4175f34f367387bfc76992cae6f5761fb11d36a04bf3111ff156b2ea7c4d7c69703b0256be14e51c973849
+  data.tar.gz: 9789a9fe5ac8bfebb040eae0998d977806daaed20b05a35655d77cf8615aeab6f1023e933ff59c71dd3ce79061f8675f09e8da97d079c02b1b1d95377905e536

data/.circleci/config.yml

@@ -0,0 +1,114 @@
+
+version: 2.1
+
+orbs:
+  ci: matic/orb-common@0.2
+  ruby: circleci/ruby@1.8.0
+
+jobs:
+
+  rspec-test:
+    resource_class: small
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
+        environment:
+          COVERAGE: true
+          CODECOV_TOKEN: a0c859b6-dfb7-4d9f-9933-2dd945cdd960
+          VAULT_ADDR: 'http://127.0.0.1:8200'
+          VAULT_TOKEN: 'vault_root_token'
+      - image: vault
+        environment:
+          VAULT_DEV_ROOT_TOKEN_ID: vault_root_token
+          SKIP_SETCAP: true
+      - image: postgres:14.1-alpine
+        environment:
+          POSTGRES_DB: 'app_db'
+          POSTGRES_USER: 'vault_root'
+          POSTGRES_PASSWORD: 'root_password'
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Set up vault
+          command: sh local/vault/setup.sh
+      - run:
+          name: Run RSpec Tests
+          command: bundle exec rspec
+      - store_test_results:
+          path: reports/rspec
+      - store_artifacts:
+          path: reports/rspec
+      - ci/slack-stage-message
+
+  rubocop:
+    resource_class: small
+    docker:
+      - image: cimg/ruby:2.5
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run rubocop
+          command: bundle exec rubocop --parallel
+
+  release:
+    parameters:
+      tag:
+        type: string
+        default: "default-tag"
+    docker:
+      - image: cimg/ruby:2.7.5
+    environment:
+      RELEASE_TAG: << parameters.tag >>
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Set up credentials
+          command: |
+              mkdir -p $HOME/.gem
+              touch $HOME/.gem/credentials
+              chmod 0600 $HOME/.gem/credentials
+              printf -- "---\n:rubygems_api_key: $RUBYGEMS_API_KEY\n" > $HOME/.gem/credentials
+      - run:
+          name: Set version
+          command: sed -i "s/[[:digit:]].[[:digit:]].[[:digit:]]/${RELEASE_TAG}/g" $(find . -name "version.rb")
+      - run:
+          name: Build gem
+          command: gem build *.gemspec
+      - run:
+          name: Push gem
+          command: gem push *.gem
+
+workflows:
+
+  settings_reader-vault_resolver.build-pull-request:
+    when:
+      not:
+        equal: [ main, << pipeline.git.branch >> ]
+    jobs:
+
+      - rspec-test:
+          context: global
+          matrix:
+            parameters:
+              ruby-version: [ '2.5', '2.6', '2.7', '3.0' ]
+
+      - rubocop:
+          name: Rubocop
+          context: global
+
+  settings_reader-vault_resolver.release:
+    jobs:
+
+      - release:
+          tag: << pipeline.git.tag >>
+          context: gem-publishing
+          filters:
+            branches:
+              ignore: /.*/
+            tags:
+              only: /\d\.\d\.\d/ # It should be [digin dot digit dot digit] format

data/.github/workflows/linters.yml

@@ -9,19 +9,6 @@ on:
     - cron: '30 0 * * 1'
 
 jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.5
-          bundler-cache: true
-      - name: Run rubocop
-        run: bundle exec rubocop --parallel
 
   code-ql:
     name: Analyze

data/.github/workflows/main.yml

@@ -10,64 +10,6 @@ on:
     types: [published]
 
 jobs:
-  build:
-    env:
-      COVERAGE: true
-      CODECOV_TOKEN: a0c859b6-dfb7-4d9f-9933-2dd945cdd960
-      VAULT_ADDR: 'http://127.0.0.1:8200'
-      VAULT_TOKEN: 'vault_root_token'
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby: [ '2.5.x', '2.6.x', '2.7.x', '3.0.x' ]
-    services:
-      vault:
-        image: vault
-        ports:
-          - "8200:8200"
-        env:
-          VAULT_DEV_ROOT_TOKEN_ID: vault_root_token
-          SKIP_SETCAP: true
-      db:
-        image: postgres:14.1-alpine
-        ports:
-          - "5432:5432"
-        env:
-          POSTGRES_USER: 'vault_root'
-          POSTGRES_PASSWORD: 'root_password'
-          POSTGRES_DB: 'app_db'
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v1
-      - name: Cache dependencies
-        uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: ${{ runner.OS }}-ruby-${{ matrix.ruby }}
-          restore-keys: ${{ runner.OS }}-
-
-      - name: Set up Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Set up Bundler
-        run: gem install bundler:2.1.4
-      - name: Set up Dependencies
-        run: bundle install --path vendor/bundle
-      - name: Set up Vault
-        run: sh local/vault/setup.sh
-
-      - name: Run specs
-        env:
-          COVERAGE: true
-        run: bundle exec rspec
-
-      - name: Upload coverage
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-        run: bash <(curl -s https://codecov.io/bash)
 
   release:
     runs-on: ubuntu-latest

data/README.md

@@ -33,7 +33,8 @@ AppSettings = SettingsReader.load do |config|
   # Configure vault resolver
   SettingsReader::VaultResolver.configure do |vault_resolver_config|
     vault_resolver_config.logger = Rails.logger
-    # ... VaultResolver configurations
+    vault_resolver_config.vault_initializer = -> { authenticate_vault }
+    # ... other VaultResolver configurations
   end
   
   # Add vault resolver as one of resolvers

data/docker-compose.yml

@@ -7,7 +7,7 @@ services:
       - "8200:8200"
     environment:
       VAULT_DEV_ROOT_TOKEN_ID: 'vault_root_token'
-      SKIP_SETCAP: true
+      SKIP_SETCAP: 'true'
   db:
     image: postgres:14.1-alpine
     ports:
@@ -26,5 +26,5 @@ services:
     environment:
       VAULT_ADDR: 'http://vault:8200'
       VAULT_TOKEN: 'vault_root_token'
-      SKIP_SETCAP: true
+      SKIP_SETCAP: 'true'
     command: sh /etc/vault/setup.sh

data/lib/settings_reader/vault_resolver/address.rb

@@ -26,6 +26,10 @@ module SettingsReader
         URI.decode_www_form(@uri.query || '').to_h
       end
 
+      def no_cache?
+        options['no_cache'] == 'true'
+      end
+
       def to_s
         @uri.to_s
       end

data/lib/settings_reader/vault_resolver/cache.rb

@@ -23,7 +23,7 @@ module SettingsReader
       end
 
       def fetch(address, &block)
-        if (exiting_entry = retrieve(address))
+        if !address.no_cache? && (exiting_entry = retrieve(address))
           exiting_entry
         else
           new_entry = block.call(address)

data/lib/settings_reader/vault_resolver/configuration.rb

@@ -30,14 +30,19 @@ module SettingsReader
       # Default: empty proc
       attr_accessor :lease_renew_error_listener
 
+      # Block to be executed for initialization and authorization
+      # Default: empty proc
+      attr_accessor :vault_initializer
+
       def initialize
         @logger = Logger.new($stdout, level: Logger::ERROR)
         @retrieval_retries = 2
         @lease_refresh_interval = 60
         @lease_renew_delay = 300
         @lease_renew_retries = 4
-        @lease_renew_error_listener = proc {}
-        @lease_renew_success_listener = proc {}
+        @lease_renew_error_listener = -> {}
+        @lease_renew_success_listener = -> {}
+        @vault_initializer = -> {}
       end
 
       def setup_lease_refresher(cache, previous_task = nil)

data/lib/settings_reader/vault_resolver/engines/abstract.rb

@@ -16,7 +16,7 @@ module SettingsReader
         end
 
         def get(address)
-          return unless (vault_secret = get_secret_with_retries(address))
+          return unless (vault_secret = get_and_retry_auth(address))
 
           wrap_secret(address, vault_secret)
         rescue Vault::VaultError => e
@@ -26,7 +26,7 @@ module SettingsReader
         def renew(entry)
           return unless entry.leased?
 
-          new_secret = renew_lease_with_retries(entry)
+          new_secret = renew_and_retry_auth(entry)
           entry.update_renewed(new_secret)
           true
         rescue Vault::VaultError => e
@@ -35,13 +35,31 @@ module SettingsReader
 
         protected
 
-        def get_secret_with_retries(address)
+        def get_and_retry_auth(address)
+          get_and_retry_connection(address)
+        rescue Vault::HTTPError => e # if not authenticated, let's reauthenticate and try once more
+          raise unless auth_error?(e)
+
+          config.vault_initializer.call
+          get_and_retry_connection(address)
+        end
+
+        def get_and_retry_connection(address)
           Vault.with_retries(Vault::HTTPConnectionError, attempts: config.retrieval_retries) do
             get_secret(address)
           end
         end
 
-        def renew_lease_with_retries(address)
+        def renew_and_retry_auth(address)
+          renew_and_retry_connection(address)
+        rescue Vault::HTTPError => e # if not authenticated, let's reauthenticate and try once more
+          raise unless auth_error?(e)
+
+          config.vault_initializer.call
+          renew_and_retry_connection(address)
+        end
+
+        def renew_and_retry_connection(address)
           Vault.with_retries(Vault::HTTPConnectionError, attempts: config.lease_renew_retries) do
             renew_lease(address)
           end
@@ -58,6 +76,10 @@ module SettingsReader
         def wrap_secret(address, secret)
           SettingsReader::VaultResolver::Entry.new(address, secret)
         end
+
+        def auth_error?(error)
+          error.code == 403 || error.message =~ /token mac for token_version.*is incorrect/
+        end
       end
     end
   end

data/lib/settings_reader/vault_resolver/engines/auth.rb

@@ -12,6 +12,16 @@ module SettingsReader
 
         protected
 
+        # Auth backend should not retry auth errors as it causing infinite recursion
+        def get_and_retry_auth(address)
+          get_and_retry_connection(address)
+        end
+
+        # Auth backend should not retry auth errors as it causing infinite recursion
+        def renew_and_retry_auth(address)
+          renew_and_retry_connection(address)
+        end
+
         def get_secret(address)
           return k8s_auth(address) if address.path == K8S_AUTH
 

data/lib/settings_reader/vault_resolver/helpers/vault_authentication.rb

@@ -8,8 +8,9 @@ module SettingsReader
         FAKE_RESOLVER_PATH = 'vault/authentication'.freeze
 
         def authenticate_via_k8s(role, route: nil, service_token_path: nil)
-          params = URI.encode_www_form({ role: role, route: route, service_token_path: service_token_path }.compact)
-          resolver.resolve("vault://auth/kubernetes/login?#{params}#client_token", FAKE_RESOLVER_PATH)
+          params = { role: role, route: route, service_token_path: service_token_path, no_cache: true }
+          url_params = URI.encode_www_form(params.compact)
+          resolver.resolve("vault://auth/kubernetes/login?#{url_params}#client_token", FAKE_RESOLVER_PATH)
         end
 
         private

data/lib/settings_reader/vault_resolver/version.rb

@@ -1,5 +1,5 @@
 module SettingsReader
   module VaultResolver
-    VERSION = '0.4.2'.freeze
+    VERSION = '0.4.4'.freeze
   end
 end

data/lib/settings_reader/vault_resolver.rb

@@ -28,6 +28,7 @@ module SettingsReader
     def self.configure(&block)
       @configuration = SettingsReader::VaultResolver::Configuration.new
       block&.call(@configuration)
+      @configuration.vault_initializer.call
       @refresher_timer_task = @configuration.setup_lease_refresher(cache, refresher_timer_task)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settings_reader-vault_resolver
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.4
 platform: ruby
 authors:
 - Volodymyr Mykhailyk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -62,6 +62,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".github/workflows/linters.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Settings Reader plugin to resolve values using in Hashicorp Vault