metasploit_data_models 0.18.1 → 0.19.0

data/spec/lib/metasploit_data_models/match/parent_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe MetasploitDataModels::Match::Parent do
+  let(:including_class) {
+    described_class = self.described_class
+
+    Class.new {
+      include described_class
+    }
+  }
+
+  let(:including_class_instance) {
+    including_class.new
+  }
+
+  context 'match_child_names' do
+    subject(:match_child_names) {
+      including_class.match_child_names
+    }
+
+    context 'default' do
+      it { should == [] }
+    end
+  end
+
+  context '#match_child' do
+    subject(:match_child) {
+      including_class_instance.match_child(formatted_value)
+    }
+
+    #
+    # lets
+    #
+
+    let(:number_child_class) {
+      Class.new(Metasploit::Model::Base) do
+        extend MetasploitDataModels::Match::Child
+
+        attr_accessor :value
+      end
+    }
+
+    let(:range_child_class) {
+      Class.new(Metasploit::Model::Base) do
+        extend MetasploitDataModels::Match::Child
+
+        attr_accessor :value
+      end
+    }
+
+    #
+    # Callbacks
+    #
+
+    before(:each) do
+      stub_const('NumberChild', number_child_class)
+      stub_const('NumberChild::REGEXP', /\d+/)
+
+      stub_const('RangeChild', range_child_class)
+      stub_const('RangeChild::REGEXP', /\d+-\d+/)
+
+      including_class.class_eval do
+        match_children_named %w{NumberChild RangeChild}
+      end
+    end
+
+    context 'with matching child class' do
+      let(:formatted_value) {
+        '1-10'
+      }
+
+      it 'returns instance of matching child class' do
+        expect(match_child).to be_a RangeChild
+      end
+    end
+
+    context 'without matching child class' do
+      let(:formatted_value) {
+        'a-b'
+      }
+
+      it 'calls match on all child classes' do
+        expect(NumberChild).to receive(:match).with(formatted_value)
+        expect(RangeChild).to receive(:match).with(formatted_value)
+
+        match_child
+      end
+
+      it { should be_nil }
+    end
+  end
+
+  context 'match_children' do
+    subject(:match_children) {
+      including_class.match_children
+    }
+
+    context 'default' do
+      it { should == [] }
+    end
+
+    context 'with class names' do
+      #
+      # lets
+      #
+
+      let(:child_class_names) {
+        [
+            'ChildOne',
+            'ChildTwo'
+        ]
+      }
+
+      let(:child_classes) {
+        child_class_names.map { |child_class_name|
+          child_class = Class.new
+
+          stub_const(child_class_name, child_class)
+
+          child_class
+        }
+      }
+
+      #
+      # Callbacks
+      #
+
+      before(:each) do
+        including_class.match_children_named child_classes.map(&:name)
+      end
+
+      it 'includes child Classes' do
+        expect(match_children).to match_array(child_classes)
+      end
+    end
+  end
+
+  context 'match_children_named' do
+    subject(:match_children_named) {
+      including_class.match_children_named child_class_names
+    }
+
+    let(:child_class_names) {
+      Array.new(2) { |i|
+        "ChildClass#{i}"
+      }
+    }
+
+    it 'sets match_child_names' do
+      match_children_named
+
+      expect(including_class.match_child_names).to eq(child_class_names)
+    end
+  end
+end

data/spec/support/matchers/match_regex_exactly.rb

@@ -0,0 +1,28 @@
+# Checks that the string matches the
+RSpec::Matchers.define :match_string_exactly do |string|
+  failure_message_for_should do |regexp|
+    match = regexp.match(string)
+
+    failure_message = "expected #{regexp} to match #{string}"
+
+    if match
+      failure_message << ', but'
+
+      unless match.pre_match.empty?
+        failure_message << " pre-match is #{match.pre_match}"
+      end
+
+      unless match.post_match.empty?
+        failure_message << " post-match is #{match.post_match}"
+      end
+    end
+
+    failure_message
+  end
+
+  match do |regexp|
+    match = regexp.match(string)
+
+    match && match.pre_match.empty? && match.post_match.empty?
+  end
+end

data/spec/support/shared/contexts/rex/text.rb

@@ -0,0 +1,15 @@
+shared_context 'Rex::Text' do
+  before(:each) do
+    rex_text = Module.new do
+      def self.ascii_safe_hex(str, whitespace=false)
+        if whitespace
+          str.gsub(/([\x00-\x20\x80-\xFF])/n){ |x| "\\x%.2x" % x.unpack("C*")[0] }
+        else
+          str.gsub(/([\x00-\x08\x0b\x0c\x0e-\x1f\x80-\xFF])/n){ |x| "\\x%.2x" % x.unpack("C*")[0]}
+        end
+      end
+    end
+
+    stub_const('Rex::Text', rex_text)
+  end
+end

data/spec/support/shared/examples/metasploit_data_models/search/operation/ipaddress/match.rb

@@ -0,0 +1,109 @@
+shared_examples_for 'MetasploitDataModels::Search::Operation::IPAddress::*.match' do |options={}|
+  options.assert_valid_keys(4, 6)
+
+  subject(:match) {
+    described_class.match(formatted_value)
+  }
+
+  #
+  # Shared Examples
+  #
+
+  shared_examples_for 'match' do |boolean|
+    if boolean
+      it { should be_a described_class }
+
+      it 'does not set #operator' do
+        expect(match.operator).to be_nil
+      end
+
+      it 'sets #value' do
+        expect(match.value).not_to be_nil
+      end
+    else
+      it { should be_nil }
+    end
+  end
+
+  context 'with IPv4' do
+    ipv4 = options.fetch(4, [])
+    ipv4 = Set.new Array.wrap(ipv4)
+
+    key_set = Set.new([:cidr, :nmap, :range, :single])
+
+    unless key_set.superset?(ipv4)
+      unknown_keys = ipv4 - key_set
+
+      raise ArgumentError, "keys (#{unknown_keys.sort.to_sentence}) not in known keys (#{key_set.sort.to_sentence})"
+    end
+
+    context 'with CIDR' do
+      let(:formatted_value) {
+        '1.2.3.4/24'
+      }
+
+      it_should_behave_like 'match', ipv4.include?(:cidr)
+    end
+
+    context 'with NMAP' do
+      let(:formatted_value) {
+        '1-2,4.5,6-7.8-9,10-11.12,13'
+      }
+
+      it_should_behave_like 'match', ipv4.include?(:nmap)
+    end
+
+    context 'with range' do
+      let(:formatted_value) {
+        '1.2.3.4-5.6.7.8'
+      }
+
+      it_should_behave_like 'match', ipv4.include?(:range)
+    end
+
+    context 'with single' do
+      let(:formatted_value) {
+        '1.2.3.4'
+      }
+
+      it_should_behave_like 'match', ipv4.include?(:single)
+    end
+  end
+
+  context 'with IPv6' do
+    ipv6 = options.fetch(6, [])
+    ipv6 = Set.new Array.wrap(ipv6)
+
+    key_set = Set.new([:cidr, :range, :single])
+
+    unless key_set.superset?(ipv6)
+      unknown_keys = ipv6 - key_set
+
+      raise ArgumentError, "keys (#{unknown_keys.sort.to_sentence}) not in known keys (#{key_set.sort.to_sentence})"
+    end
+
+    context 'with CIDR' do
+      let(:formatted_value) {
+        '1:2:3:4:5:6:7:8/48'
+      }
+
+      it_should_behave_like 'match', ipv6.include?(:cidr)
+    end
+
+    context 'with range' do
+      let(:formatted_value) {
+        '1:2:3:4:5:6:7:8-9:10:11:12:13:14:15:16'
+      }
+
+      it_should_behave_like 'match', ipv6.include?(:range)
+    end
+
+    context 'with single' do
+      let(:formatted_value) {
+        '1:2:3:4:5:6:7:8'
+      }
+
+      it_should_behave_like 'match', ipv6.include?(:single)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metasploit_data_models
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Samuel Huckins
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -31,16 +31,16 @@ dependencies:
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - <
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - <
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7.4
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -235,9 +235,19 @@ files:
 - app/models/mdm/wmap_request.rb
 - app/models/mdm/wmap_target.rb
 - app/models/mdm/workspace.rb
+- app/models/metasploit_data_models/ip_address/v4/cidr.rb
+- app/models/metasploit_data_models/ip_address/v4/nmap.rb
+- app/models/metasploit_data_models/ip_address/v4/range.rb
+- app/models/metasploit_data_models/ip_address/v4/segment/nmap/list.rb
+- app/models/metasploit_data_models/ip_address/v4/segment/nmap/range.rb
+- app/models/metasploit_data_models/ip_address/v4/segment/single.rb
+- app/models/metasploit_data_models/ip_address/v4/segmented.rb
+- app/models/metasploit_data_models/ip_address/v4/single.rb
+- app/models/metasploit_data_models/search/operation/ip_address.rb
 - app/models/metasploit_data_models/search/operation/port/number.rb
 - app/models/metasploit_data_models/search/operation/port/range.rb
 - app/models/metasploit_data_models/search/operation/range.rb
+- app/models/metasploit_data_models/search/operator/ip_address.rb
 - app/models/metasploit_data_models/search/operator/multitext.rb
 - app/models/metasploit_data_models/search/operator/port/list.rb
 - app/models/metasploit_data_models/search/visitor/attribute.rb
@@ -367,6 +377,11 @@ files:
 - lib/metasploit_data_models/base64_serializer.rb
 - lib/metasploit_data_models/change_required_columns_to_null_false.rb
 - lib/metasploit_data_models/engine.rb
+- lib/metasploit_data_models/ip_address.rb
+- lib/metasploit_data_models/ip_address/cidr.rb
+- lib/metasploit_data_models/ip_address/range.rb
+- lib/metasploit_data_models/match/child.rb
+- lib/metasploit_data_models/match/parent.rb
 - lib/metasploit_data_models/search.rb
 - lib/metasploit_data_models/search/visitor.rb
 - lib/metasploit_data_models/serialized_prefs.rb
@@ -421,9 +436,19 @@ files:
 - spec/app/models/mdm/wmap_request_spec.rb
 - spec/app/models/mdm/wmap_target_spec.rb
 - spec/app/models/mdm/workspace_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/cidr_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/nmap_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/range_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/segment/nmap/list_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/segment/nmap/range_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/segment/segmented_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/segment/single_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/single_spec.rb
+- spec/app/models/metasploit_data_models/search/operation/ip_address_spec.rb
 - spec/app/models/metasploit_data_models/search/operation/port/number_spec.rb
 - spec/app/models/metasploit_data_models/search/operation/port/range_spec.rb
 - spec/app/models/metasploit_data_models/search/operation/range_spec.rb
+- spec/app/models/metasploit_data_models/search/operator/ip_address_spec.rb
 - spec/app/models/metasploit_data_models/search/operator/multitext_spec.rb
 - spec/app/models/metasploit_data_models/search/operator/port/list_spec.rb
 - spec/app/models/metasploit_data_models/search/visitor/attribute_spec.rb
@@ -459,7 +484,7 @@ files:
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/routes.rb
-- spec/dummy/db/schema.rb
+- spec/dummy/db/structure.sql
 - spec/dummy/lib/assets/.gitkeep
 - spec/dummy/log/.gitkeep
 - spec/dummy/public/404.html
@@ -515,10 +540,17 @@ files:
 - spec/factories/mdm/web_vulns.rb
 - spec/factories/mdm/workspaces.rb
 - spec/lib/base64_serializer_spec.rb
+- spec/lib/metasploit_data_models/ip_address/cidr_spec.rb
+- spec/lib/metasploit_data_models/ip_address/range_spec.rb
+- spec/lib/metasploit_data_models/match/child_spec.rb
+- spec/lib/metasploit_data_models/match/parent_spec.rb
 - spec/lib/metasploit_data_models/version_spec.rb
 - spec/spec_helper.rb
+- spec/support/matchers/match_regex_exactly.rb
+- spec/support/shared/contexts/rex/text.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
+- spec/support/shared/examples/metasploit_data_models/search/operation/ipaddress/match.rb
 - spec/support/shared/examples/metasploit_data_models/search/visitor/includes/visit/with_children.rb
 - spec/support/shared/examples/metasploit_data_models/search/visitor/includes/visit/with_metasploit_model_search_operation_base.rb
 - spec/support/shared/examples/metasploit_data_models/search/visitor/relation/visit/matching_record.rb
@@ -545,7 +577,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Database code for MSF and Metasploit Pro
@@ -597,9 +629,19 @@ test_files:
 - spec/app/models/mdm/wmap_request_spec.rb
 - spec/app/models/mdm/wmap_target_spec.rb
 - spec/app/models/mdm/workspace_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/cidr_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/nmap_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/range_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/segment/nmap/list_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/segment/nmap/range_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/segment/segmented_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/segment/single_spec.rb
+- spec/app/models/metasploit_data_models/ip_address/v4/single_spec.rb
+- spec/app/models/metasploit_data_models/search/operation/ip_address_spec.rb
 - spec/app/models/metasploit_data_models/search/operation/port/number_spec.rb
 - spec/app/models/metasploit_data_models/search/operation/port/range_spec.rb
 - spec/app/models/metasploit_data_models/search/operation/range_spec.rb
+- spec/app/models/metasploit_data_models/search/operator/ip_address_spec.rb
 - spec/app/models/metasploit_data_models/search/operator/multitext_spec.rb
 - spec/app/models/metasploit_data_models/search/operator/port/list_spec.rb
 - spec/app/models/metasploit_data_models/search/visitor/attribute_spec.rb
@@ -635,7 +677,7 @@ test_files:
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/routes.rb
-- spec/dummy/db/schema.rb
+- spec/dummy/db/structure.sql
 - spec/dummy/lib/assets/.gitkeep
 - spec/dummy/log/.gitkeep
 - spec/dummy/public/404.html
@@ -691,10 +733,17 @@ test_files:
 - spec/factories/mdm/web_vulns.rb
 - spec/factories/mdm/workspaces.rb
 - spec/lib/base64_serializer_spec.rb
+- spec/lib/metasploit_data_models/ip_address/cidr_spec.rb
+- spec/lib/metasploit_data_models/ip_address/range_spec.rb
+- spec/lib/metasploit_data_models/match/child_spec.rb
+- spec/lib/metasploit_data_models/match/parent_spec.rb
 - spec/lib/metasploit_data_models/version_spec.rb
 - spec/spec_helper.rb
+- spec/support/matchers/match_regex_exactly.rb
+- spec/support/shared/contexts/rex/text.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
+- spec/support/shared/examples/metasploit_data_models/search/operation/ipaddress/match.rb
 - spec/support/shared/examples/metasploit_data_models/search/visitor/includes/visit/with_children.rb
 - spec/support/shared/examples/metasploit_data_models/search/visitor/includes/visit/with_metasploit_model_search_operation_base.rb
 - spec/support/shared/examples/metasploit_data_models/search/visitor/relation/visit/matching_record.rb