dradis-plugins 4.8.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cba7a2e144b2d99cb1cb3ed6433424e6e46c0c9b2ac4b92ba44d2d8c18e22a5
-  data.tar.gz: 63fb037763ed258a8286c01a2430b4c61b8c70a3e79f5bf372f468a679c2dcb6
+  metadata.gz: 76e20a999e5f8a6309b837043fc488dc8d7f8f6bafae273482f9f1027078aa04
+  data.tar.gz: aa7c0068193b07f847ea8f0ddb6b7a8f2fb4705922ebb3da01df2859837fe4f7
 SHA512:
-  metadata.gz: aae6bd486e5d39e78c7cef4731476ec3350a3dd73bd4dfac18061fd3dabd2a9d51a7045fd9c64a967c453000794d1d990a67f4d2ecc3bd77dc3b8646cfdd2039
-  data.tar.gz: 861a9ef7afdcc8450f13abde042710e25770c6edd9ed25d860703180a3b280bdcdf0aca4a7a8e780c3e259c529c1c96a21359ecd6c7c7286974365fadad61a5e
+  metadata.gz: efcd0183333ddf9271c3ecca1a7c4793bb864c7e6172d46bc1f335e543ecbbfcedc640953230d976c5ba9e052df2988a5077921f78a61f95e6fa188782f44357
+  data.tar.gz: 0c73436e1dd6d733a37fe4ccf10519f0d710137eab88eb6170fc44756d993c142372751e7f41dbc3ca5798ae6c2494d6d1829e9ba5d68cd4b1ed341fa7c92467

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+v4.9.0 (June 2023)
+  - Fix deduplication of findings
+  - Store engine settings encrypted
+
 v4.8.0 (April 2023)
   - Add support for issue and content block states
 

data/dradis-plugins.gemspec

@@ -20,12 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
 
-  spec.add_development_dependency 'bundler', '>= 2.2.33'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec-rails'
-
-  # By not including Rails as a dependency, we can use the gem with different
-  # versions of Rails (a sure recipe for disaster, I'm sure), which is needed
-  # until we bump Dradis Pro to 4.1.
-  # s.add_dependency 'rails', '~> 4.1.1'
 end

data/lib/dradis/plugins/configurable.rb

@@ -3,14 +3,19 @@ module Dradis::Plugins
     extend ActiveSupport::Concern
 
     module ClassMethods
-      delegate :settings, to: :instance
+      delegate :encrypted_settings, :settings, to: :instance
 
       def settings_namespace
-        @settings_namespace || plugin_name
+        @settings_namespace ||= plugin_name
+      end
+
+      def addon_encrypted_settings(namespace = nil, &block)
+        @settings_namespace = namespace
+        yield self if block_given?
       end
 
       def addon_settings(namespace = nil, &block)
-        @settings_namespace = namespace if namespace
+        @settings_namespace = namespace
         yield self if block_given?
       end
 
@@ -19,8 +24,12 @@ module Dradis::Plugins
       end
     end
 
+    def encrypted_settings
+      @encrypted_settings ||= Dradis::Plugins::Settings.new(self.class.settings_namespace, adapter: :encrypted_configuration)
+    end
+
     def settings
-      @settings ||= Dradis::Plugins::Settings.new(self.class.settings_namespace)
+      @settings ||= Dradis::Plugins::Settings.new(self.class.settings_namespace, adapter: :db)
     end
   end
 end

data/lib/dradis/plugins/content_service/issues.rb

@@ -76,7 +76,7 @@ module Dradis::Plugins::ContentService
     # the issue library cache has been initialized.
     def issue_cache
       @issue_cache ||= begin
-        issues_map = all_issues.map do |issue|
+        issues_map = project.issues.map do |issue|
           cache_key = [
             issue.fields['plugin'],
             issue.fields['plugin_id']

data/lib/dradis/plugins/gem_version.rb

@@ -7,7 +7,7 @@ module Dradis
 
     module VERSION
       MAJOR = 4
-      MINOR = 8
+      MINOR = 9
       TINY  = 0
       PRE   = nil
 

data/lib/dradis/plugins/settings/adapters/db.rb

@@ -0,0 +1,30 @@
+module Dradis::Plugins::Settings::Adapters
+  class Db
+    def initialize(namespace)
+      @namespace = namespace.to_s
+    end
+
+    def delete(key)
+      Configuration.find_by(name: namespaced_key(key)).destroy
+    end
+
+    def exists?(key)
+      Configuration.exists?(name: namespaced_key(key))
+    end
+
+    def read(key)
+      Configuration.find_by(name: namespaced_key(key))&.value
+    end
+
+    def write(key, value)
+      db_setting = Configuration.find_or_create_by(name: namespaced_key(key))
+      db_setting.update_attribute(:value, value)
+    end
+
+    private
+
+    def namespaced_key(key)
+      [@namespace, key.to_s.underscore].join(':')
+    end
+  end
+end

data/lib/dradis/plugins/settings/adapters/encrypted_configuration.rb

@@ -0,0 +1,58 @@
+module Dradis::Plugins::Settings::Adapters
+  class EncryptedConfiguration
+    attr_writer :config_path
+
+    def initialize(namespace)
+      @namespace = namespace
+    end
+
+    def delete(key)
+      if exists?(key)
+        configuration.config[@namespace].delete(key)
+        configuration.write(configuration.config.to_yaml)
+      end
+    end
+
+    def exists?(key)
+      !!configuration.config[@namespace]&.key?(key)
+    end
+
+    def read(key)
+      configuration.config.fetch(@namespace, {}).fetch(key, nil)
+    end
+
+    def write(key, value)
+      configuration.config[@namespace] ||= {}
+      configuration.config[@namespace][key] = value
+      configuration.write(configuration.config.to_yaml)
+    end
+
+    def key_path=(string_or_pathname)
+      @key_path = Pathname.new(string_or_pathname)
+    end
+
+    private
+    def config_path
+      @config_path ||= Rails.root.join('config', 'shared', 'dradis-plugins.yml.enc')
+    end
+
+    def configuration
+      @configuration ||= begin
+          create_key unless key_path.exist?
+
+          ActiveSupport::EncryptedConfiguration.new(
+            config_path: config_path, key_path: key_path,
+            env_key: 'RAILS_MASTER_KEY', raise_if_missing_key: true
+          )
+        end
+    end
+
+    def create_key
+      File.write(key_path, ActiveSupport::EncryptedConfiguration.generate_key)
+    end
+
+    def key_path
+      @key_path ||= Rails.root.join('config', 'shared', 'dradis-plugins.key')
+    end
+  end
+end

data/lib/dradis/plugins/settings.rb

@@ -2,10 +2,11 @@ module Dradis::Plugins
   class Settings
     attr_reader :namespace
 
-    def initialize(namespace)
+    def initialize(namespace, adapter: :db)
       @namespace = namespace
       @dirty_options ||= {}
       @default_options ||= { enabled: true }.with_indifferent_access
+      assign_adapter(adapter)
     end
 
     def respond_to?(name)
@@ -16,14 +17,18 @@ module Dradis::Plugins
       @default_options.except(:enabled).map do |key, value|
         {
           name: key.to_sym,
-          value: value = dirty_or_db_setting_or_default(key.to_sym),
+          value: value = dirty_or_stored_or_default(key.to_sym),
           default: is_default?(key, value)
         }
       end.sort_by{ |o| o[:name] }
     end
 
     def save
-      @dirty_options.reject{ |k, v| v.present? && v == db_setting(k) }.each{ |k, v| write_to_db(k, v) }
+      @dirty_options.reject do |k, v|
+        v.present? && v == read(k)
+      end.each do |k, v|
+        write(k, v)
+      end
     end
 
     def update_settings(opts = {})
@@ -36,7 +41,7 @@ module Dradis::Plugins
     def reset_defaults!
       @dirty_options = {}
       @default_options.each do |key, value|
-        Configuration.where(name: namespaced_key(key)).each(&:destroy)
+        delete(key) if exists?(key)
       end
     end
 
@@ -45,6 +50,8 @@ module Dradis::Plugins
     end
 
     private
+    attr_reader :adapter
+    delegate :delete, :exists?, :read, :write, to: :adapter
 
     # ---------------------------------------------------- Method missing magic
     def method_missing(name, *args, &blk)
@@ -53,39 +60,33 @@ module Dradis::Plugins
       elsif name.to_s =~ /=$/
         @dirty_options[$`.to_sym] = args.first
       elsif @default_options.key?(name)
-        dirty_or_db_setting_or_default(name)
+        dirty_or_stored_or_default(name)
       else
         super
       end
     end
     # --------------------------------------------------- /Method missing magic
 
-    def write_to_db(key, value)
-      db_setting = Configuration.find_or_create_by(name: namespaced_key(key))
-      db_setting.update_attribute(:value, value)
-    end
-
-
-    def db_setting(key)
-      Configuration.where(name: namespaced_key(key)).first.value rescue nil
+    def assign_adapter(name)
+      adapters = { db: Adapters::Db, encrypted_configuration: Adapters::EncryptedConfiguration }
+      if adapters.key?(name)
+        @adapter = adapters[name].new(namespace)
+      else
+        raise ArgumentError
+      end
     end
 
     # This method looks up in the configuration repository DB to see if the
     # user has provided a value for the given setting. If not, the default
     # value is returned.
-    def dirty_or_db_setting_or_default(key)
+    def dirty_or_stored_or_default(key)
       if @dirty_options.key?(key)
         @dirty_options[key]
-      elsif Configuration.exists?(name: namespaced_key(key))
-        db_setting(key)
+      elsif exists?(key)
+        read(key)
       else
         @default_options[key]
       end
     end
-
-    # Builds namespaced key
-    def namespaced_key(key)
-      [self.namespace.to_s, key.to_s.underscore].join(":")
-    end
   end
 end

data/lib/dradis/plugins.rb

@@ -84,6 +84,8 @@ require 'dradis/plugins/upload'
 # Common functionality
 require 'dradis/plugins/configurable'
 require 'dradis/plugins/settings'
+require 'dradis/plugins/settings/adapters/db'
+require 'dradis/plugins/settings/adapters/encrypted_configuration'
 require 'dradis/plugins/templates'
 require 'dradis/plugins/thor'
 require 'dradis/plugins/thor_helper'

data/spec/engine_spec.rb

@@ -13,11 +13,14 @@ describe Dradis::Plugins::Base do
 
   describe '#enabled?' do
     it 'returns default value' do
-      expect(TestEngine.enabled?).to eq(false)
+      expect(TestEngine.enabled?).to eq(true)
     end
   end
   describe '#enable!' do
     it 'sets enabled to true' do
+      TestEngine.settings.enabled = false
+      TestEngine.settings.save
+
       expect { TestEngine.enable! }.to change {
         TestEngine.enabled?
       }.from(false).to(true)
@@ -25,7 +28,9 @@ describe Dradis::Plugins::Base do
   end
   describe '#disable!' do
     it 'sets enabled to false' do
-      TestEngine.enable!
+      TestEngine.settings.enabled = true
+      TestEngine.settings.save
+
       expect { TestEngine.disable! }.to change {
         TestEngine.enabled?
       }.from(true).to(false)

data/spec/lib/dradis/plugins/content_service/boards_spec.rb

@@ -20,7 +20,7 @@ describe Dradis::Plugins::ContentService::Boards do
         node = create(:node, project: project)
         node_board = create(:board, node: node, project: project)
 
-        boards = service.all_boards
+        boards = service.project_boards
 
         expect(boards).to include(board)
         expect(boards).to_not include(node_board)

data/spec/lib/dradis/plugins/settings/adapters/encrypted_configuration_spec.rb

@@ -0,0 +1,112 @@
+#
+# This spec must be run from Dradis root dir.
+#
+# Configuration init from:
+#   https://github.com/rails/rails/blob/main/activesupport/test/encrypted_configuration_test.rb
+#
+require 'rails_helper'
+
+describe Dradis::Plugins::Settings::Adapters::EncryptedConfiguration do
+
+  subject do
+    ec = Dradis::Plugins::Settings::Adapters::EncryptedConfiguration.new(:rspec)
+    ec.config_path = @credentials_config_path
+    ec.key_path = @credentials_key_path
+    ec
+  end
+
+  context 'With an empty config file' do
+    before(:all) do
+      @tmpdir = Dir.mktmpdir('config-')
+      @credentials_config_path = File.join(@tmpdir, 'empty.yml.enc')
+      @credentials_key_path = File.join(@tmpdir, 'empty.key')
+    end
+
+    describe '#delete' do
+      it 'becomes a no-op' do
+        expect { subject.delete(:key) }.to_not raise_error
+      end
+    end
+
+    describe '#exists' do
+      it 'is always false' do
+        expect(subject.exists?(:key)).to be(false)
+        expect(subject.exists?(:key2)).to be(false)
+      end
+    end
+
+    describe '#read' do
+      it 'always returns nil' do
+        expect(subject.read(:key)).to eq(nil)
+        expect(subject.read(:key2)).to eq(nil)
+      end
+    end
+
+    describe '#write' do
+      it 'inits the namespace and stores the setting' do
+        expect { subject.write(:key, :value) }.to_not raise_error
+        expect(File.size(@credentials_config_path)).to_not be(0)
+
+        File.unlink @credentials_config_path
+      end
+    end
+  end
+
+  context 'With a working config file' do
+    DEFAULT_CONFIG = { rspec: { key: :lorem_ipsum, key2: :dolor_sit } }.to_yaml.freeze
+
+    before(:all) do
+      @tmpdir = Dir.mktmpdir('config-')
+      @credentials_config_path = File.join(@tmpdir, 'credentials.yml.enc')
+      @credentials_key_path = File.join(@tmpdir, 'master.key')
+
+      File.write(@credentials_key_path, ActiveSupport::EncryptedConfiguration.generate_key)
+
+      @credentials = ActiveSupport::EncryptedConfiguration.new(
+        config_path: @credentials_config_path, key_path: @credentials_key_path,
+        env_key: 'RAILS_MASTER_KEY', raise_if_missing_key: true
+      )
+
+      @credentials.write(DEFAULT_CONFIG)
+    end
+
+    after(:all) do
+      FileUtils.rm_rf @tmpdir
+    end
+
+    describe '#delete' do
+      it 'removes a value from disk' do
+        subject.delete(:key2)
+
+        @credentials.instance_variable_set('@config', nil)
+        expect(@credentials.config[:rspec].key?(:key)).to be(true)
+        expect(@credentials.config[:rspec].key?(:key2)).to be(false)
+        @credentials.write(DEFAULT_CONFIG)
+      end
+    end
+
+    describe '#exists' do
+      it 'finds an existing value' do
+        expect(subject.exists?(:key)).to be(true)
+      end
+      it 'detects an inexisting value' do
+        expect(subject.exists?(:key3)).to be(false)
+      end
+    end
+
+    describe '#read' do
+      it 'loads an already existing value' do
+        expect(subject.read(:key)).to eq(:lorem_ipsum)
+      end
+    end
+
+    describe '#write' do
+      it 'stores a value on disk' do
+        subject.write(:new_key, :new_value)
+        @credentials.instance_variable_set('@config', nil)
+        expect(@credentials.config[:rspec][:new_key]).to eq(:new_value)
+        @credentials.write(DEFAULT_CONFIG)
+      end
+    end
+  end
+end

data/spec/settings_spec.rb

@@ -19,7 +19,6 @@ describe Dradis::Plugins::Settings do
   end
 
   it "sets and return default values" do
-    expect(TestEngine::settings.enabled).to eq(false)
     expect(TestEngine::settings.host).to eq('localhost')
     expect(TestEngine::settings.port).to eq(80)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dradis-plugins
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Daniel Martin
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.33
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.33
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,8 @@ files:
 - lib/dradis/plugins/import/filters/base.rb
 - lib/dradis/plugins/import/result.rb
 - lib/dradis/plugins/settings.rb
+- lib/dradis/plugins/settings/adapters/db.rb
+- lib/dradis/plugins/settings/adapters/encrypted_configuration.rb
 - lib/dradis/plugins/template_service.rb
 - lib/dradis/plugins/templates.rb
 - lib/dradis/plugins/thor.rb
@@ -108,13 +110,14 @@ files:
 - spec/lib/dradis/plugins/content_service/boards_spec.rb
 - spec/lib/dradis/plugins/content_service/content_blocks_spec.rb
 - spec/lib/dradis/plugins/content_service/issues_spec.rb
+- spec/lib/dradis/plugins/settings/adapters/encrypted_configuration_spec.rb
 - spec/settings_spec.rb
 - spec/spec_helper.rb
 homepage: http://dradisframework.org
 licenses:
 - GPL-2
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -129,8 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Plugin manager for the Dradis Framework project.
 test_files:
@@ -139,5 +142,6 @@ test_files:
 - spec/lib/dradis/plugins/content_service/boards_spec.rb
 - spec/lib/dradis/plugins/content_service/content_blocks_spec.rb
 - spec/lib/dradis/plugins/content_service/issues_spec.rb
+- spec/lib/dradis/plugins/settings/adapters/encrypted_configuration_spec.rb
 - spec/settings_spec.rb
 - spec/spec_helper.rb