metasploit-model 0.24.1.pre.semantic.pre.versioning.pre.2.pre.0

data/spec/factories/metasploit/model/module/architectures.rb

@@ -0,0 +1,15 @@
+FactoryGirl.define do
+  module_architectures_module_types = Metasploit::Model::Module::Instance.module_types_that_allow(:module_architectures)
+  targets_module_types = Metasploit::Model::Module::Instance.module_types_that_allow(:targets)
+
+  # have to remove target supporting types so that target architectures won't interfere with module architectures
+  metasploit_model_module_architecture_module_types = module_architectures_module_types - targets_module_types
+
+  sequence :metasploit_model_module_architecture_module_type, metasploit_model_module_architecture_module_types.cycle
+
+  trait :metasploit_model_module_architecture do
+    ignore do
+      module_type { generate :metasploit_model_module_architecture_module_type }
+    end
+  end
+end

data/spec/factories/metasploit/model/module/classes.rb

@@ -0,0 +1,47 @@
+FactoryGirl.define do
+  sequence :metasploit_model_module_class_payload_type, Metasploit::Model::Module::Class::PAYLOAD_TYPES.cycle
+
+  trait :metasploit_model_module_class do
+    #
+    # Attributes
+    #
+
+    # Don't set full_name: before_validation will derive it from {Metasploit::Model::Module::Class#module_type} and
+    # {Metasploit::Model::Module::Class::reference_name}.
+
+    ignore do
+      # derives from associations in instance, so don't set on instance
+      module_type { generate :metasploit_model_module_type }
+
+      # depends on module_type
+      # ignored because model attribute will derived from reference_name, this factory attribute is used to generate
+      # the correct reference_name.
+      payload_type {
+        # module_type is factory attribute, not model attribute
+        if module_type == Metasploit::Model::Module::Type::PAYLOAD
+          generate :metasploit_model_module_class_payload_type
+        else
+          nil
+        end
+      }
+
+      #
+      # Callback helpers
+      #
+
+      before_write_template {
+        ->(module_class, evaluator) {}
+      }
+      write_template {
+        ->(module_class, evaluator) {
+          Metasploit::Model::Module::Class::Spec::Template.write(module_class: module_class)
+        }
+      }
+    end
+
+    after(:build) do |module_class, evaluator|
+      instance_exec(evaluator, evaluator, &evaluator.before_write_template)
+      instance_exec(evaluator, evaluator, &evaluator.write_template)
+    end
+  end
+end

data/spec/factories/metasploit/model/module/handlers.rb

@@ -0,0 +1,3 @@
+FactoryGirl.define do
+  sequence :metasploit_model_module_handler_type, Metasploit::Model::Module::Handler::TYPES.cycle
+end

data/spec/factories/metasploit/model/module/instances.rb

@@ -0,0 +1,83 @@
+FactoryGirl.define do
+  sequence :metasploit_model_module_instance_description do |n|
+    "Module Description #{n}"
+  end
+
+  sequence :metasploit_model_module_instance_disclosed_on do |n|
+    Date.today - n
+  end
+
+  sequence :metasploit_model_module_instance_license do |n|
+    "Module License #{n}"
+  end
+
+  sequence :metasploit_model_module_instance_name do |n|
+    "Module Name #{n}"
+  end
+
+  sequence :metasploit_model_module_instance_privileged, Metasploit::Model::Module::Instance::PRIVILEGES.cycle
+
+  total_architectures = Metasploit::Model::Architecture::ABBREVIATIONS.length
+  total_platforms = Metasploit::Model::Platform.fully_qualified_name_set.length
+  # chosen so that there is at least 1 element even if 0 is allowed so that factories always test that the associated
+  # records are handled.
+  minimum_with_elements = 1
+  # arbitrarily chosen maximum when there are a bounded total of the associated records.  Most chosen because 3 will
+  # test that there is no 1 or 2 special casing make it work.
+  arbitrary_maximum = 3
+  arbitrary_supported_length = ->{
+    Random.rand(minimum_with_elements .. arbitrary_maximum)
+  }
+
+  trait :metasploit_model_module_instance do
+    ignore do
+      actions_length(&arbitrary_supported_length)
+
+      # this length is only used if supports?(:module_architectures) is true.  It can be set to 0 when
+      # supports?(:module_architectures) is true to make the after(:build) skip building the module architectures automatically.
+      module_architectures_length {
+        Random.rand(minimum_with_elements .. total_architectures)
+      }
+
+      module_authors_length(&arbitrary_supported_length)
+
+      # this length is only used if supports?(:module_platforms) is true.  It can be set to 0 when
+      # supports?(:module_platforms) is true to make the after(:build) skip building the module platforms automatically.
+      module_platforms_length {
+        Random.rand(minimum_with_elements .. total_platforms)
+      }
+
+      module_references_length(&arbitrary_supported_length)
+      targets_length(&arbitrary_supported_length)
+
+      #
+      # Callback helpers
+      #
+
+      # Can't use the after(:build) system because in Mdm, the associations need to be set before writing the template
+      before_write_template {
+        ->(module_instance, _evaluator){}
+      }
+      write_template {
+        ->(module_instance, _evaluator) {
+          Metasploit::Model::Module::Instance::Spec::Template.write(module_instance: module_instance)
+        }
+      }
+    end
+
+    #
+    # Attributes
+    #
+
+    description { generate :metasploit_model_module_instance_description }
+    disclosed_on { generate :metasploit_model_module_instance_disclosed_on }
+    license { generate :metasploit_model_module_instance_license }
+    name { generate :metasploit_model_module_instance_name }
+    privileged { generate :metasploit_model_module_instance_privileged }
+
+    after(:build) do |module_instance, evaluator|
+      instance_exec(module_instance, evaluator, &evaluator.before_write_template)
+      instance_exec(module_instance, evaluator, &evaluator.write_template)
+    end
+  end
+end

data/spec/factories/metasploit/model/module/paths.rb

@@ -0,0 +1,51 @@
+FactoryGirl.define do
+  sequence :metasploit_model_module_path_gem do |n|
+    "metasploit_model_module_path_gem#{n}"
+  end
+
+  sequence :metasploit_model_module_path_name do |n|
+    "metasploit_model_module_path_name#{n}"
+  end
+
+  sequence :metasploit_model_module_path_real_path do |n|
+    pathname = Metasploit::Model::Spec.temporary_pathname.join(
+        'metasploit',
+        'model',
+        'module',
+        'path',
+        'real',
+        'path',
+        n.to_s
+    )
+    Metasploit::Model::Spec::PathnameCollision.check!(pathname)
+    pathname.mkpath
+
+    pathname.to_path
+  end
+
+  sequence :metasploit_model_module_path_directory_real_path do |n|
+    pathname = Metasploit::Model::Spec.temporary_pathname.join(
+        'metasploit',
+        'model',
+        'module',
+        'path',
+        'directory',
+        'real',
+        'path',
+        n.to_s
+    )
+    Metasploit::Model::Spec::PathnameCollision.check!(pathname)
+    pathname.mkpath
+
+    pathname.to_path
+  end
+
+  trait :unnamed_metasploit_model_module_path do
+    real_path { generate :metasploit_model_module_path_real_path }
+  end
+
+  trait :named_metasploit_model_module_path do
+    gem { generate :metasploit_model_module_path_gem }
+    name { generate :metasploit_model_module_path_name }
+  end
+end

data/spec/factories/metasploit/model/module/platforms.rb

@@ -0,0 +1,15 @@
+FactoryGirl.define do
+  module_platforms_module_types = Metasploit::Model::Module::Instance.module_types_that_allow(:module_platforms)
+  targets_module_types = Metasploit::Model::Module::Instance.module_types_that_allow(:targets)
+
+  # have to remove target supporting types so that target platforms won't interfere with module platforms
+  metasploit_model_module_platform_module_types = module_platforms_module_types - targets_module_types
+
+  sequence :metasploit_model_module_platform_module_type, metasploit_model_module_platform_module_types.cycle
+
+  trait :metasploit_model_module_platform do
+    ignore do
+      module_type { generate :metasploit_model_module_platform_module_type }
+    end
+  end
+end

data/spec/factories/metasploit/model/module/ranks.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  number_by_name = Metasploit::Model::Module::Rank::NUMBER_BY_NAME
+
+  names = number_by_name.keys
+  sequence :metasploit_model_module_rank_name, names.cycle
+
+  numbers = number_by_name.values
+  sequence :metasploit_model_module_rank_number, numbers.cycle
+end

data/spec/factories/metasploit/model/module/references.rb

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  module_references_module_types = Metasploit::Model::Module::Instance.module_types_that_allow(:module_references)
+
+  sequence :metasploit_model_module_reference_module_type, module_references_module_types.cycle
+
+  trait :metasploit_model_module_reference do
+    ignore do
+      module_type { generate :metasploit_model_module_reference_module_type }
+    end
+  end
+end

data/spec/factories/metasploit/model/module/stances.rb

@@ -0,0 +1,3 @@
+FactoryGirl.define do
+  sequence :metasploit_model_module_stance, Metasploit::Model::Module::Stance::ALL.cycle
+end

data/spec/factories/metasploit/model/module/targets.rb

@@ -0,0 +1,22 @@
+FactoryGirl.define do
+  total_architectures = Metasploit::Model::Architecture::ABBREVIATIONS.length
+  total_platforms = Metasploit::Model::Platform.fully_qualified_name_set.length
+  targets_module_types = Metasploit::Model::Module::Instance.module_types_that_allow(:targets)
+
+  sequence :metasploit_model_module_target_module_type, targets_module_types.cycle
+
+  sequence :metasploit_model_module_target_name do |n|
+    "Metasploit::Model::Module::Target#name #{n}"
+  end
+
+  trait :metasploit_model_module_target do
+    ignore do
+      module_type { generate :metasploit_model_module_target_module_type }
+
+      target_architectures_length { Random.rand(1 .. total_architectures) }
+      target_platforms_length { Random.rand(1 .. total_platforms) }
+    end
+
+    name { generate :metasploit_model_module_target_name }
+  end
+end

data/spec/factories/metasploit/model/module/types.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  sequence :metasploit_model_module_type, Metasploit::Model::Module::Type::ALL.cycle
+
+  sequence :metasploit_model_non_payload_module_type, Metasploit::Model::Module::Type::NON_PAYLOAD.cycle
+end

data/spec/factories/metasploit/model/references.rb

@@ -0,0 +1,88 @@
+FactoryGirl.define do
+  #
+  #
+  # Metasploit::Model::Reference#designation sequences
+  #
+  #
+
+  sequence :metasploit_model_reference_designation do |n|
+    n.to_s
+  end
+
+  #
+  # Metasploit::Model::Authority-specific Metasploit::Model::Reference#designation sequences
+  #
+
+  sequence :metasploit_model_reference_bid_designation do |n|
+    n.to_s
+  end
+
+  sequence :metasploit_model_reference_cve_designation do |n|
+    number = n % 10000
+    year = n / 10000
+
+    "%04d-%04d" % [year, number]
+  end
+
+  sequence :metasploit_model_reference_msb_designation do |n|
+    number = n % 1000
+    year = n / 1000
+
+    "MS%02d-%03d" % [year, number]
+  end
+
+  sequence :metasploit_model_reference_osvdb_designation do |n|
+    n.to_s
+  end
+
+  sequence :metasploit_model_reference_pmasa_designation do |n|
+    number = n / 100
+    year = n / 100
+
+    "#{year}-#{number}"
+  end
+
+  sequence :metasploit_model_reference_secunia_designation do |n|
+    n.to_s
+  end
+
+  sequence :metasploit_model_reference_us_cert_vu_designation do |n|
+    n.to_s
+  end
+
+  sequence :metasploit_model_reference_waraxe_designation do |n|
+    # numbers don't rollover on the year like other authorities
+    year = n
+    number = n
+
+    "%d-SA#%d" % [year, number]
+  end
+
+  sequence :metasploit_model_reference_zdi_designation do |n|
+    year, number = n.divmod(1000)
+
+    "%02d-%03d" % [year, number]
+  end
+
+  sequence :metasploit_model_reference_url do |n|
+    "http://example.com/metasploit/model/reference/#{n}"
+  end
+
+  trait :metasploit_model_reference do
+    #
+    # Attributes
+    #
+
+    designation { generate :metasploit_model_reference_designation }
+    url { generate :metasploit_model_reference_url }
+  end
+
+  trait :obsolete_metasploit_model_reference do
+    url nil
+  end
+
+  trait :url_metasploit_model_reference do
+    authority nil
+    designation nil
+  end
+end

data/spec/factories/metasploit/model/search/operator/associations.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  sequence :metasploit_model_search_operator_association_association do |n|
+    "metasploit_model_search_operator_association_association#{n}".to_sym
+  end
+end

data/spec/factories/metasploit/model/search/operator/attributes.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  sequence :metasploit_model_search_operator_attribute_attribute do |n|
+    "metasploit_model_search_operator_attribute_attribute#{n}".to_sym
+  end
+
+  sequence :metasploit_model_search_operator_attribute_type, Metasploit::Model::Search::Operator::Attribute::TYPES.cycle
+end

data/spec/factories/metasploit/model/search/operator/bases.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  sequence :metasploit_model_search_operator_base_name do |n|
+    "metasploit_model_search_operator_base_name#{n}".to_sym
+  end
+end

data/spec/lib/metasploit/model/architecture_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Metasploit::Model::Architecture do
+  it_should_behave_like 'Metasploit::Model::Architecture',
+                        namespace_name: 'Dummy' do
+    let(:seed) do
+      Dummy::Architecture.with_abbreviation(abbreviation)
+    end
+  end
+
+  context 'sequences' do
+    context 'metasploit_model_architecture_abbreviation' do
+      subject(:metasploit_model_architecture_abbreviation) do
+        FactoryGirl.generate :metasploit_model_architecture_abbreviation
+      end
+
+      it 'should be an element of Metasploit::Model::Architecture::ABBREVIATIONS' do
+        Metasploit::Model::Architecture::ABBREVIATIONS.should include(metasploit_model_architecture_abbreviation)
+      end
+    end
+
+    context 'metasploit_model_architecture_bits' do
+      subject(:metasploit_model_architecture_bits) do
+        FactoryGirl.generate :metasploit_model_architecture_bits
+      end
+
+      it 'should be an element of Metasploit::Model::Architecture::BITS' do
+        Metasploit::Model::Architecture::BITS.should include(metasploit_model_architecture_bits)
+      end
+    end
+
+    context 'metasploit_model_architecture_endianness' do
+      subject(:metasploit_model_architecture_endianness) do
+        FactoryGirl.generate :metasploit_model_architecture_endianness
+      end
+
+      it 'should be an element of Metasploit::Model::Architecture::ENDIANNESSES' do
+        Metasploit::Model::Architecture::ENDIANNESSES.should include(metasploit_model_architecture_endianness)
+      end
+    end
+
+    context 'metasploit_model_architecture_family' do
+      subject(:metasploit_model_architecture_family) do
+        FactoryGirl.generate :metasploit_model_architecture_family
+      end
+
+      it 'should be an element of Metasploit::Model::Architecture::FAMILIES' do
+        Metasploit::Model::Architecture::FAMILIES.should include(metasploit_model_architecture_family)
+      end
+    end
+  end
+end