dradis-plugins 4.7.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a55255c245e1ce6009d032fab79a582b05e760af0942ae7893ee7bb42af99dc
-  data.tar.gz: 350e48e4f5c7021339e0d542d7d9776bafaf44f78e23b3feae5e7f8e8d8e6d4f
+  metadata.gz: 76e20a999e5f8a6309b837043fc488dc8d7f8f6bafae273482f9f1027078aa04
+  data.tar.gz: aa7c0068193b07f847ea8f0ddb6b7a8f2fb4705922ebb3da01df2859837fe4f7
 SHA512:
-  metadata.gz: 91ee0fb58cc17d416a403dd60b9eeae6c106f16fdc4badeda6816f171f5154da7443b0c0b9d96964bf06d32a1f7b41f94db5e7d5c15f7bf3cb4c6ee0a773b643
-  data.tar.gz: 04af89b9742efb8803f8e8d9c934aea5fa9b38c0fa7dcf16fe0f1d23a270167ef1f2c2e46af93d9e00c47c20618467e07b862b03fb4765e799d45dbcbec8ed8b
+  metadata.gz: efcd0183333ddf9271c3ecca1a7c4793bb864c7e6172d46bc1f335e543ecbbfcedc640953230d976c5ba9e052df2988a5077921f78a61f95e6fa188782f44357
+  data.tar.gz: 0c73436e1dd6d733a37fe4ccf10519f0d710137eab88eb6170fc44756d993c142372751e7f41dbc3ca5798ae6c2494d6d1829e9ba5d68cd4b1ed341fa7c92467

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+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
+
 v4.7.0 (February 2023)
   - No changes
 

data/app/controllers/dradis/plugins/export/base_controller.rb

@@ -2,15 +2,18 @@ module Dradis
   module Plugins
     module Export
       class BaseController < Rails.application.config.dradis.base_export_controller_class_name.to_s.constantize
+        before_action :validate_scope
 
         protected
 
-        # Protected: allows export plugins to access the options sent from the
-        # framework via the session object (see Export#create).
-        #
-        # Returns a Hash with indifferent access.
-        def export_options
-          @export_options ||= session[:export_manager].with_indifferent_access
+        def export_params
+          params.permit(:project_id, :scope, :template)
+        end
+
+        def validate_scope
+          unless Dradis::Plugins::ContentService::Base::VALID_SCOPES.include?(params[:scope])
+            raise 'Something fishy is going on...'
+          end
         end
       end
     end

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', '~> 1.6'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  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/base.rb

@@ -10,6 +10,8 @@ require 'dradis/plugins/content_service/properties'
 
 module Dradis::Plugins::ContentService
   class Base
+    VALID_SCOPES = %w[all published].freeze
+
     include Core
 
     include Boards

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

@@ -3,23 +3,34 @@ module Dradis::Plugins::ContentService
     extend ActiveSupport::Concern
 
     def all_content_blocks
-      project.content_blocks
+      case scope
+      when :all
+        project.content_blocks
+      when :published
+        project.content_blocks.published
+      else
+        raise 'Unsupported scope!'
+      end
     end
 
     def create_content_block(args={})
       block_group    = args.fetch(:block_group, default_content_block_group)
       content        = args.fetch(:content, default_content_block_content)
+      state          = args.fetch(:state, :published)
       user_id        = args.fetch(:user_id)
 
       content_block = ContentBlock.new(
         content: content,
         block_group: block_group,
         project_id: project.id,
+        state: state,
         user_id: user_id
       )
 
       if content_block.valid?
         content_block.save
+
+        return content_block
       else
         try_rescue_from_length_validation(
           model: content_block,

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

@@ -3,7 +3,7 @@ module Dradis::Plugins::ContentService
     extend ActiveSupport::Concern
 
     included do
-      attr_accessor :logger, :plugin, :project
+      attr_accessor :logger, :plugin, :project, :scope
     end
 
     # ----------------------------------------------------------- Initializer
@@ -12,9 +12,11 @@ module Dradis::Plugins::ContentService
     # @option plugin [Class] the 'wrapper' module of a plugin, e.g.
     #     Dradis::Plugins::Nessus
     def initialize(args={})
-      @logger  = args.fetch(:logger, Rails.logger)
-      @plugin  = args.fetch(:plugin)
+      @logger = args.fetch(:logger, Rails.logger)
+      @plugin = args.fetch(:plugin)
       @project = args[:project]
+      @scope = args.fetch(:scope, :published)
+      @state = args[:state]
     end
 
     private

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

@@ -3,7 +3,17 @@ module Dradis::Plugins::ContentService
     extend ActiveSupport::Concern
 
     def all_issues
-      project.issues.where(category_id: default_issue_category.id)
+      issues =
+        case scope
+        when :all
+          project.issues
+        when :published
+          project.issues.published
+        else
+          raise 'Unsupported scope!'
+        end
+
+      issues.where(category_id: default_issue_category.id)
     end
 
     def create_issue(args={})
@@ -11,6 +21,7 @@ module Dradis::Plugins::ContentService
       # NOTE that ID is the unique issue identifier assigned by the plugin,
       # and is not to be confused with the Issue#id primary key
       id   = args.fetch(:id, default_issue_id)
+      state = args.fetch(:state, @state)
 
       # Bail if we already have this issue in the cache
       uuid      = [plugin::Engine::plugin_name, id]
@@ -25,9 +36,10 @@ module Dradis::Plugins::ContentService
       text << plugin_details
 
       issue = Issue.new(text: text) do |i|
-        i.author   = default_author
-        i.node     = project.issue_library
+        i.author = default_author
+        i.node = project.issue_library
         i.category = default_issue_category
+        i.state = state
       end
 
       if issue.valid?
@@ -64,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/export/base.rb

@@ -5,7 +5,7 @@ module Dradis
   module Plugins
     module Export
       class Base
-        attr_accessor :content_service, :logger, :options, :plugin, :project
+        attr_accessor :content_service, :logger, :options, :plugin, :project, :scope
 
         def initialize(args={})
           # Save everything just in case the implementing class needs any of it.
@@ -15,6 +15,7 @@ module Dradis
           @logger  = args.fetch(:logger, Rails.logger)
           @plugin  = args[:plugin] || default_plugin
           @project = args.key?(:project_id) ? Project.find(args[:project_id]) : nil
+          @scope = args.fetch(:scope, :published).to_sym
 
           @content_service = args.fetch(:content_service, default_content_service)
 
@@ -34,7 +35,8 @@ module Dradis
           @content ||= Dradis::Plugins::ContentService::Base.new(
             logger: logger,
             plugin: plugin,
-            project: project
+            project: project,
+            scope: scope
           )
         end
 

data/lib/dradis/plugins/gem_version.rb

@@ -7,7 +7,7 @@ module Dradis
 
     module VERSION
       MAJOR = 4
-      MINOR = 7
+      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/thor_helper.rb

@@ -9,7 +9,7 @@ module Dradis
       end
 
       def task_options
-        @task_options ||= { logger: logger }
+        @task_options ||= { logger: logger, state: :published }
       end
 
       def logger

data/lib/dradis/plugins/upload/importer.rb

@@ -12,6 +12,7 @@ module Dradis
           :options,
           :plugin,
           :project,
+          :state,
           :template_service
         )
 
@@ -22,10 +23,11 @@ module Dradis
         def initialize(args={})
           @options = args
 
-          @logger  = args.fetch(:logger, Rails.logger)
-          @plugin  = args[:plugin] || default_plugin
-          @project = args.key?(:project_id) ? Project.find(args[:project_id]) : nil
           @default_user_id = args[:default_user_id] || -1
+          @logger = args.fetch(:logger, Rails.logger)
+          @plugin = args[:plugin] || default_plugin
+          @project = args.key?(:project_id) ? Project.find(args[:project_id]) : nil
+          @state = args.fetch(:state, :published)
 
           @content_service  = args.fetch(:content_service, default_content_service)
           @template_service = args.fetch(:template_service, default_template_service)
@@ -46,7 +48,8 @@ module Dradis
           @content ||= Dradis::Plugins::ContentService::Base.new(
             logger: logger,
             plugin: plugin,
-            project: project
+            project: project,
+            state: state
           )
         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/content_service/content_blocks_spec.rb

@@ -0,0 +1,29 @@
+require 'rails_helper'
+
+# To run, execute from Dradis Pro main app folder:
+#   bin/rspec [dradis-plugins path]/spec/lib/dradis/plugins/content_service/content_blocks_spec.rb
+
+describe 'Content Block content service' do
+  let(:plugin) { Dradis::Plugins::Nessus }
+  let(:plugin_id) { '111' }
+  let(:project) { create(:project) }
+  let(:service) do
+    Dradis::Plugins::ContentService::Base.new(
+      plugin: plugin,
+      logger: Rails.logger,
+      project: project
+    )
+  end
+
+  describe '#all_content_blocks' do
+    before do
+      @draft_content = create_list(:content_block, 10, project: project, state: :draft)
+      @review_content = create_list(:content_block, 10, project: project, state: :ready_for_review)
+      @published_content = create_list(:content_block, 10, project: project, state: :published)
+    end
+
+    it 'returns only the published content blocks' do
+      expect(service.all_content_blocks.to_a).to match_array(@published_content)
+    end
+  end
+end

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

@@ -1,11 +1,11 @@
 require 'rails_helper'
 
-# These specs are coming from engines/dradispro-rules/spec/content_service_spec.rb
 # To run, execute from Dradis main app folder:
 #   bin/rspec [dradis-plugins path]/spec/lib/dradis/plugins/content_service/issues_spec.rb
 
-describe Dradis::Plugins::ContentService::Base do
-  let(:plugin)  { Dradis::Plugins::Nessus }
+describe 'Issues content service' do
+  let(:plugin) { Dradis::Plugins::Nessus }
+  let(:plugin_id) { '111' }
   let(:project) { create(:project) }
   let(:service) do
     Dradis::Plugins::ContentService::Base.new(
@@ -17,47 +17,39 @@ describe Dradis::Plugins::ContentService::Base do
 
   describe 'Issues' do
     let(:create_issue) do
-      service.create_issue_without_callback(id: plugin_id)
+      service.create_issue(text: "#[Title]#\nTest Issue\n", id: plugin_id, state: :ready_for_review)
     end
 
-    # Remember: even though we're calling create_issue_without_callback,
-    # that method will still call issue_cache_with_callback internally.
-    # So when we store an issue in the issue_cache/finding_cache below,
-    # it's being stored within an instance of FindingCache, which
-    # automatically wraps Issues in Findings.
-
     describe 'when the issue already exists in the cache' do
-      let(:existing_issue) { create(:issue, text: cached_issue_text) }
-      before { cache.store(existing_issue) }
-
-      it "doesn't create a new issue" do
-        expect{create_issue}.not_to change{Issue.count}
+      before do
+        issue = create(:issue, text: "#[Title]#\nTest Issue\n", id: plugin_id)
+        service.issue_cache.store("nessus-#{plugin_id}", issue)
       end
 
-      it 'returns the cached issue encapsulated in a finding' do
-        finding = create_issue
-        expect(finding).to be_a(Finding)
-        expect(finding).to eq Finding.from_issue(existing_issue)
+      it 'does not create a new issue' do
+        expect { create_issue }.not_to change { Issue.count }
       end
     end
 
     describe "when the issue doesn't already exist in the cache" do
       it "creates a new Issue containing 'plugin' and 'plugin_id'" do
         new_issue = nil
-        expect{new_issue = create_issue}.to change{Issue.count}.by(1)
-        expect(new_issue.body).to match(/#\[plugin\]#\n*#{plugin_name}/)
-        expect(new_issue.body).to match(/#\[plugin_id\]#\n*#{plugin_id}/)
+        plugin_name = "#{plugin}::Engine".constantize.plugin_name
+        expect { new_issue = create_issue }.to change { Issue.count }.by(1)
+        expect(new_issue.text).to match(/#\[plugin\]#\n*#{plugin_name}/)
+        expect(new_issue.text).to match(/#\[plugin_id\]#\n*#{plugin_id}/)
       end
+    end
 
-      it 'returns the new Issue encapsulated in a Finding' do
-        finding = create_issue
-        expect(finding).to be_a(Finding)
-        expect(finding).to eq Finding.from_issue(Issue.last)
+    describe '#all_issues' do
+      before do
+        @draft_issues = create_list(:issue, 10, project: project, state: :draft)
+        @review_issues = create_list(:issue, 10, project: project, state: :ready_for_review)
+        @published_issues = create_list(:issue, 10, project: project, state: :published)
       end
 
-      it 'adds the new Finding to the cache' do
-        finding = create_issue
-        expect(cache[cache_key]).to eq finding
+      it 'returns only the published issues' do
+        expect(service.all_issues.to_a).to match_array(@published_issues)
       end
     end
   end

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,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: dradis-plugins
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Daniel Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        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
@@ -106,7 +108,9 @@ files:
 - spec/engine_spec.rb
 - spec/internal/log/test.log
 - 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
@@ -136,6 +140,8 @@ test_files:
 - spec/engine_spec.rb
 - spec/internal/log/test.log
 - 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