metasploit_data_models 0.14.2 → 0.14.3

data/app/models/mdm/module/detail.rb

@@ -167,9 +167,10 @@ class Mdm::Module::Detail < ActiveRecord::Base
   #   @return [String]
 
   # @!attribute [rw] stance
-  #   Whether the module is active or passive.
+  #   Whether the module is active or passive.  `nil` if the {#mtype module type} does not
+  #   {#supports_stance? support stances}.
   #
-  #   @return ['active', 'passive']
+  #   @return ['active', 'passive', nil]
 
   #
   # Validations
@@ -193,6 +194,7 @@ class Mdm::Module::Detail < ActiveRecord::Base
   validates :refname, :presence => true
   validates :stance,
             :inclusion => {
+                :if => :supports_stance?,
                 :in => STANCES
             }
 
@@ -276,5 +278,22 @@ class Mdm::Module::Detail < ActiveRecord::Base
     self.targets.build(:index => index, :name => name).save
   end
 
+  # Returns whether this module supports a {#stance}.  Only modules with {#mtype} `'auxiliary'` and `'exploit'` support
+  # a non-nil {#stance}.
+  #
+  # @return [true] if {#mtype} is `'auxiliary'` or `'exploit'`
+  # @return [false] otherwise
+  # @see https://github.com/rapid7/metasploit-framework/blob/a6070f8584ad9e48918b18c7e765d85f549cb7fd/lib/msf/core/db_manager.rb#L423
+  # @see https://github.com/rapid7/metasploit-framework/blob/a6070f8584ad9e48918b18c7e765d85f549cb7fd/lib/msf/core/db_manager.rb#L436
+  def supports_stance?
+    supports_stance = false
+
+    if ['auxiliary', 'exploit'].include? mtype
+      supports_stance = true
+    end
+
+    supports_stance
+  end
+
   ActiveSupport.run_load_hooks(:mdm_module_detail, self)
 end

data/lib/metasploit_data_models/version.rb

@@ -4,5 +4,5 @@ module MetasploitDataModels
   # metasploit-framework/data/sql/migrate to db/migrate in this project, not all models have specs that verify the
   # migrations (with have_db_column and have_db_index) and certain models may not be shared between metasploit-framework
   # and pro, so models may be removed in the future.  Because of the unstable API the version should remain below 1.0.0
-  VERSION = '0.14.2'
+  VERSION = '0.14.3'
 end

data/spec/app/models/mdm/module/detail_spec.rb

@@ -1,8 +1,16 @@
 require 'spec_helper'
 
 describe Mdm::Module::Detail do
-  subject(:module_detail) do
-    FactoryGirl.build(:mdm_module_detail)
+  subject(:detail) do
+    FactoryGirl.build(
+        :mdm_module_detail,
+        :mtype => mtype,
+        :stance => stance
+    )
+  end
+
+  let(:mtype) do
+    FactoryGirl.generate :mdm_module_detail_mtype
   end
 
   let(:ranks) do
@@ -17,6 +25,10 @@ describe Mdm::Module::Detail do
     ]
   end
 
+  let(:stance) do
+    FactoryGirl.generate :mdm_module_detail_stance
+  end
+
   let(:stances) do
     [
         'aggressive',
@@ -109,7 +121,7 @@ describe Mdm::Module::Detail do
       it { should have_db_column(:rank).of_type(:integer) }
       it { should have_db_column(:ready).of_type(:boolean) }
       it { should have_db_column(:refname).of_type(:text) }
-      it { should have_db_column(:stance).of_type(:string) }
+      it { should have_db_column(:stance).of_type(:string).with_options(:null => true) }
     end
 
     context 'indices' do
@@ -127,6 +139,34 @@ describe Mdm::Module::Detail do
       end
 
       it { should be_valid }
+
+      context 'stance' do
+        subject(:mdm_module_detail) do
+          FactoryGirl.build(:mdm_module_detail, :mtype => mtype)
+        end
+
+        context 'with supports_stance?' do
+          let(:mtype) do
+            'exploit'
+          end
+
+          it { should be_valid }
+
+          its(:stance) { should_not be_nil }
+          its(:supports_stance?) { should be_true }
+        end
+
+        context 'without supports_stance?' do
+          let(:mtype) do
+            'post'
+          end
+
+          it { should be_valid }
+
+          its(:stance) { should be_nil }
+          its(:supports_stance?) { should be_false }
+        end
+      end
     end
   end
 
@@ -142,17 +182,28 @@ describe Mdm::Module::Detail do
     end
 
     it { should validate_presence_of(:refname) }
-    it { should ensure_inclusion_of(:stance).in_array(stances) }
+
+    context 'stance' do
+      context 'mtype' do
+        it_should_behave_like 'Mdm::Module::Detail supports stance with mtype', 'auxiliary'
+        it_should_behave_like 'Mdm::Module::Detail supports stance with mtype', 'exploit'
+
+        it_should_behave_like 'Mdm::Module::Detail does not support stance with mtype', 'encoder'
+        it_should_behave_like 'Mdm::Module::Detail does not support stance with mtype', 'nop'
+        it_should_behave_like 'Mdm::Module::Detail does not support stance with mtype', 'payload'
+        it_should_behave_like 'Mdm::Module::Detail does not support stance with mtype', 'post'
+      end
+    end
   end
 
   context 'with saved' do
     before(:each) do
-      module_detail.save!
+      detail.save!
     end
 
     context '#add_action' do
       def add_action
-        module_detail.add_action(name)
+        detail.add_action(name)
       end
 
       let(:name) do
@@ -162,14 +213,14 @@ describe Mdm::Module::Detail do
       it 'should add an Mdm::Action under the Mdm::ModuleDetail' do
         expect {
           add_action
-        }.to change(module_detail.actions, :length).by(1)
+        }.to change(detail.actions, :length).by(1)
       end
 
       context 'new Mdm::Action' do
         subject(:module_action) do
           add_action
 
-          module_detail.actions.last
+          detail.actions.last
         end
 
         it { should be_valid }
@@ -180,7 +231,7 @@ describe Mdm::Module::Detail do
 
     context '#add_arch' do
       def add_arch
-        module_detail.add_arch(name)
+        detail.add_arch(name)
       end
 
       let(:name) do
@@ -190,14 +241,14 @@ describe Mdm::Module::Detail do
       it 'should add an Mdm::ModuleArch under the Mdm::ModuleDetail' do
         expect {
           add_arch
-        }.to change(module_detail.archs, :length).by(1)
+        }.to change(detail.archs, :length).by(1)
       end
 
       context 'new Mdm::ModuleArch' do
         subject(:module_arch) do
           add_arch
 
-          module_detail.archs.last
+          detail.archs.last
         end
 
         it { should be_valid }
@@ -213,7 +264,7 @@ describe Mdm::Module::Detail do
 
       context 'with email' do
         def add_author
-          module_detail.add_author(name, email)
+          detail.add_author(name, email)
         end
 
         let(:email) do
@@ -223,14 +274,14 @@ describe Mdm::Module::Detail do
         it 'should add an Mdm::ModuleAuthor under the Mdm::ModuleDetail' do
           expect {
             add_author
-          }.to change(module_detail.authors, :length).by(1)
+          }.to change(detail.authors, :length).by(1)
         end
 
         context 'new Mdm::ModuleAuthor' do
           subject(:module_author) do
             add_author
 
-            module_detail.authors.last
+            detail.authors.last
           end
 
           it { should be_valid }
@@ -242,20 +293,20 @@ describe Mdm::Module::Detail do
 
       context 'without email' do
         def add_author
-          module_detail.add_author(name)
+          detail.add_author(name)
         end
 
         it 'should add an Mdm::ModuleAuthor under the Mdm::ModuleDetail' do
           expect {
             add_author
-          }.to change(module_detail.authors, :length).by(1)
+          }.to change(detail.authors, :length).by(1)
         end
 
         context 'new Mdm::ModuleAuthor' do
           subject(:module_author) do
             add_author
 
-            module_detail.authors.last
+            detail.authors.last
           end
 
           it { should be_valid }
@@ -268,7 +319,7 @@ describe Mdm::Module::Detail do
 
     context '#add_mixin' do
       def add_mixin
-        module_detail.add_mixin(name)
+        detail.add_mixin(name)
       end
 
       let(:name) do
@@ -278,14 +329,14 @@ describe Mdm::Module::Detail do
       it 'should add an Mdm::ModuleMixin under the Mdm::ModuleDetail' do
         expect {
           add_mixin
-        }.to change(module_detail.mixins, :length).by(1)
+        }.to change(detail.mixins, :length).by(1)
       end
 
       context 'new Mdm::ModuleMixin' do
         subject do
           add_mixin
 
-          module_detail.mixins.last
+          detail.mixins.last
         end
 
         it { should be_valid }
@@ -295,7 +346,7 @@ describe Mdm::Module::Detail do
 
     context '#add_platform' do
       def add_platform
-        module_detail.add_platform(name)
+        detail.add_platform(name)
       end
 
       let(:name) do
@@ -305,14 +356,14 @@ describe Mdm::Module::Detail do
       it 'should add an Mdm::ModulePlatform under the Mdm::ModuleDetail' do
         expect {
           add_platform
-        }.to change(module_detail.platforms, :length).by(1)
+        }.to change(detail.platforms, :length).by(1)
       end
 
       context 'new Mdm::ModulePlatform' do
         subject(:module_platform) do
           add_platform
 
-          module_detail.platforms.last
+          detail.platforms.last
         end
 
         it { should be_valid }
@@ -322,7 +373,7 @@ describe Mdm::Module::Detail do
 
     context '#add_ref' do
       def add_ref
-        module_detail.add_ref(name)
+        detail.add_ref(name)
       end
 
       let(:name) do
@@ -332,14 +383,14 @@ describe Mdm::Module::Detail do
       it 'should add an Mdm::ModuleRef under the Mdm::ModuleDetail' do
         expect {
           add_ref
-        }.to change(module_detail.refs, :length).by(1)
+        }.to change(detail.refs, :length).by(1)
       end
 
       context 'new Mdm::ModuleRef' do
         subject(:module_ref) do
           add_ref
 
-          module_detail.refs.last
+          detail.refs.last
         end
 
         it { should be_valid }
@@ -349,7 +400,7 @@ describe Mdm::Module::Detail do
 
     context '#add_target' do
       def add_target
-        module_detail.add_target(index, name)
+        detail.add_target(index, name)
       end
 
       let(:index) do
@@ -363,14 +414,14 @@ describe Mdm::Module::Detail do
       it 'should add an Mdm::ModuleTarget under the Mdm::ModuleDetail' do
         expect {
           add_target
-        }.to change(module_detail.targets, :length).by(1)
+        }.to change(detail.targets, :length).by(1)
       end
 
       context 'new Mdm::ModuleTarget' do
         subject(:module_target) do
           add_target
 
-          module_detail.targets.last
+          detail.targets.last
         end
 
         it { should be_valid }

data/spec/factories/mdm/module/details.rb

@@ -17,7 +17,14 @@ FactoryGirl.define do
     rank { generate :mdm_module_detail_rank }
     refname { generate :mdm_module_detail_refname }
     fullname { "#{mtype}/#{refname}" }
-    stance { generate :mdm_module_detail_stance }
+
+    stance {
+      if supports_stance?
+        generate :mdm_module_detail_stance
+      else
+        nil
+      end
+    }
 
     file {
       type_directory = Mdm::Module::Detail::DIRECTORY_BY_TYPE[mtype]

data/spec/support/shared/examples/mdm/module/detail/does_not_support_stance_with_mtype.rb

@@ -0,0 +1,20 @@
+shared_examples_for 'Mdm::Module::Detail does not support stance with mtype' do |mtype|
+  context "with #{mtype.inspect}" do
+    # define as a let so that lets from outer context can access option to set detail.
+    let(:mtype) do
+      mtype
+    end
+
+    it 'should return false for supports_stance?' do
+      detail.supports_stance?.should be_false
+    end
+
+    context 'with nil stance' do
+      let(:stance) do
+        nil
+      end
+
+      it { should be_valid }
+    end
+  end
+end

data/spec/support/shared/examples/mdm/module/detail/supports_stance_with_mtype.rb

@@ -0,0 +1,36 @@
+shared_examples_for 'Mdm::Module::Detail supports stance with mtype' do |mtype|
+  context "with #{mtype.inspect}" do
+    # define as a let so that lets from outer context can access option to set detail.
+    let(:mtype) do
+      mtype
+    end
+
+    it 'should return true for supports_stance?' do
+      detail.supports_stance?.should be_true
+    end
+
+    context 'with nil stance' do
+      let(:stance) do
+        nil
+      end
+
+      it { should be_invalid }
+    end
+
+    context "with 'aggresive' stance" do
+      let(:stance) do
+        'aggressive'
+      end
+
+      it { should be_valid }
+    end
+
+    context "with 'passive' stance" do
+      let(:stance) do
+        'passive'
+      end
+
+      it { should be_valid }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metasploit_data_models
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.14.3
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -380,6 +380,8 @@ files:
 - spec/factories/mdm/workspaces.rb
 - spec/lib/base64_serializer_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared/examples/mdm/module/detail/does_not_support_stance_with_mtype.rb
+- spec/support/shared/examples/mdm/module/detail/supports_stance_with_mtype.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -394,7 +396,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3797340516484019629
+      hash: -614166004821636482
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -403,7 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3797340516484019629
+      hash: -614166004821636482
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -481,4 +483,6 @@ test_files:
 - spec/factories/mdm/workspaces.rb
 - spec/lib/base64_serializer_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared/examples/mdm/module/detail/does_not_support_stance_with_mtype.rb
+- spec/support/shared/examples/mdm/module/detail/supports_stance_with_mtype.rb
 has_rdoc: