wg-metasploit_data_models 4.1.4.01 → 4.1.4.02

data/lib/metasploit_data_models/match/parent.rb

@@ -0,0 +1,103 @@
+# Uses classes that extend {MetasploitDataModels::Match::Child}
+#
+# @example Add match_child to class.
+#   class Parent
+#     include MetasploitDataModels::Match::Parent
+#
+#     match_children_named %w{FirstChild SecondChild}
+#   end
+module MetasploitDataModels::Match::Parent
+  extend ActiveSupport::Concern
+
+  # @example Declaring children classes
+  #   class FirstChild < Metasploit::Model::Base
+  #     extend MetasploitDataModels::Match::Child
+  #
+  #     #
+  #     # CONSTANTS
+  #     #
+  #
+  #     # Matches a range.
+  #     MATCH_REGEXP = /\A\d+-\d+\z/
+  #
+  #     #
+  #     # Attributes
+  #     #
+  #
+  #     # @!attribute value
+  #     #   The range
+  #     #
+  #     attr_accessor :value
+  #   end
+  #
+  #   class SecondChild < Metasploit::Model::Base
+  #     extend MetasploitDataModels::Match::Child
+  #
+  #     #
+  #     # CONSTANTS
+  #     #
+  #
+  #     # Matches a range.
+  #     MATCH_REGEXP = /\A\d+\z/
+  #
+  #     #
+  #     # Attributes
+  #     #
+  #
+  #     # @!attribute value
+  #     #   The range
+  #     #
+  #     attr_accessor :value
+  #   end
+  #
+  #   class Parent
+  #     include MetasploitDataModels::Match::Parent
+  #
+  #     match_children_named %w{FirstChild SecondChild}
+  #   end
+  module ClassMethods
+    # `Class#name` for classes that extend {MetasploitDataModels::Match::Child} and should be tested using `match`.
+    #
+    # @return [Array<String>]
+    def match_child_names
+      @match_child_names ||= []
+    end
+
+    # `Class`es on which to call `match` in {MetasploitDataModels::Match::Parent#match_child}
+    #
+    # @return [Array<String>]
+    def match_children
+      @match_children ||= match_child_names.map(&:constantize)
+    end
+
+    # @note `Class`es named `class_names`
+    # Register the given `class_names` as `Class#name`s for children classes for
+    # {MetasploitDataModels::Match::Parent#match_child}.
+    #
+    # @return [Array<String>] class_names`
+    def match_children_named(class_names)
+      @match_child_names = class_names
+    end
+  end
+
+  #
+  # Instance Methods
+  #
+
+  # @param formatted_value [#to_s] A formatted value for the child's `#value`.
+  # @return [Object] instance of the first of {ClassMethods#match_children} that matches the `formatted_value`.
+  # @return [nil] if no {ClassMethods#match_children} matches the `formatted_value`.
+  def match_child(formatted_value)
+    child = nil
+
+    self.class.match_children.each do |child_class|
+      child = child_class.match(formatted_value)
+
+      if child
+        break
+      end
+    end
+
+    child
+  end
+end

data/lib/metasploit_data_models/match.rb

@@ -0,0 +1,8 @@
+# Namespace for {MetasploitDataModels::Match::Parent#match_child dispatching} to
+# {MetasploitDataModels::Match::Child#match children based on if their Regexp matches}.
+module MetasploitDataModels::Match
+  extend ActiveSupport::Autoload
+
+  autoload :Child
+  autoload :Parent
+end

data/lib/metasploit_data_models/search/operation/port.rb

@@ -0,0 +1,9 @@
+# Search operation on IP port formats: either
+# {MetasploitDataModels::Search::Operation::Port::Number an individual port number} or
+# {MetasploitDataModels::Search::Operation::Port::Range a hyphenated range of port numbers}.
+module MetasploitDataModels::Search::Operation::Port
+  extend ActiveSupport::Autoload
+
+  autoload :Number
+  autoload :Range
+end

data/lib/metasploit_data_models/search/operation.rb

@@ -0,0 +1,9 @@
+# Search operations ({MetasploitDataModels::Search::Operator operator}:operand) on {Mdm} and {MetasploitDataModels}
+# models.
+module MetasploitDataModels::Search::Operation
+  extend ActiveSupport::Autoload
+
+  autoload :IPAddress
+  autoload :Port
+  autoload :Range
+end

data/lib/metasploit_data_models/search/operator/port.rb

@@ -0,0 +1,6 @@
+# Namespace for search operator for ports.
+module MetasploitDataModels::Search::Operator::Port
+  extend ActiveSupport::Autoload
+
+  autoload :List
+end

data/lib/metasploit_data_models/search/operator.rb

@@ -0,0 +1,8 @@
+# Namespace for search operators for {MetasploitDataModels}.
+module MetasploitDataModels::Search::Operator
+  extend ActiveSupport::Autoload
+
+  autoload :IPAddress
+  autoload :Multitext
+  autoload :Port
+end

data/lib/metasploit_data_models/search/visitor.rb

@@ -0,0 +1,11 @@
+# Namespace for all visitors of `Metasploit::Model::Search::Query` that help search {Mdm} models.
+module MetasploitDataModels::Search::Visitor
+  extend ActiveSupport::Autoload
+
+  autoload :Attribute
+  autoload :Includes
+  autoload :Joins
+  autoload :Method
+  autoload :Relation
+  autoload :Where
+end

data/lib/metasploit_data_models/search.rb

@@ -0,0 +1,8 @@
+# Namespace that deals with search {Mdm} models.
+module MetasploitDataModels::Search
+  extend ActiveSupport::Autoload
+
+  autoload :Operation
+  autoload :Operator
+  autoload :Visitor
+end

data/lib/metasploit_data_models/serialized_prefs.rb

@@ -0,0 +1,27 @@
+# Allows attributes to be extracted and written to key of serialized `Hash` `prefs`.
+module MetasploitDataModels::SerializedPrefs
+  # Setup each arg in `args` as the name of an attribute embedded in the `prefs` `Hash`.  Defines `#<arg>` and
+  # `#<arg>=(value)` methods like standard `attr_accessor`.
+  #
+  # @param args [Array<Symbol>] The names of the attributes to store in the `prefs` `Hash`.
+  # @return [void]
+  def serialized_prefs_attr_accessor(*args)
+    args.each do |method_name|
+
+      method_declarations = <<-RUBY
+          def #{method_name}
+            return if not self.prefs
+            self.prefs[:#{method_name}]
+          end
+
+          def #{method_name}=(value)
+            temp = self.prefs || {}
+            temp[:#{method_name}] = value
+            self.prefs = temp
+          end
+      RUBY
+
+      class_eval method_declarations, __FILE__, __LINE__
+    end
+  end
+end

data/lib/metasploit_data_models/version.rb

@@ -0,0 +1,13 @@
+module MetasploitDataModels
+  # VERSION is managed by GemRelease
+  VERSION = '4.1.4.02'
+
+  # @return [String]
+  #
+  # returns the VERSION
+  #
+
+  def self.version
+    VERSION
+  end
+end

data/lib/metasploit_data_models.rb

@@ -0,0 +1,56 @@
+#
+# Core
+#
+require 'shellwords'
+# So that Mdm::WebPage#cookie can support serializing a WEBrick::Cookie
+require 'webrick'
+
+#
+# Gems
+#
+# gems must load explicitly any gem declared in gemspec
+# @see https://github.com/bundler/bundler/issues/2018#issuecomment-6819359
+#
+#
+require 'active_record'
+require 'active_support'
+require 'active_support/all'
+require 'metasploit/concern'
+require 'metasploit/model'
+require 'arel-helpers'
+
+#
+# Project
+#
+
+require 'metasploit_data_models/version'
+
+autoload :Mdm, 'mdm'
+
+# Core database models for metasploit-framework.
+module MetasploitDataModels
+  extend ActiveSupport::Autoload
+
+  autoload :AutomaticExploitation
+  autoload :Base64Serializer
+  autoload :ChangeRequiredColumnsToNullFalse
+  autoload :IPAddress
+  autoload :Match
+  autoload :ModuleRun
+  autoload :Search
+  autoload :SerializedPrefs
+
+  # The root directory of `metasploit_data_models` gem in both development and gem installs.
+  #
+  # @return [Pathname]
+  def self.root
+    unless instance_variable_defined? :@root
+      lib_pathname = Pathname.new(__FILE__).dirname
+
+      @root = lib_pathname.parent
+    end
+
+    @root
+  end
+end
+

data/metasploit_data_models.gemspec

@@ -0,0 +1,65 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'metasploit_data_models/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'wg-metasploit_data_models'
+  s.version     = MetasploitDataModels::VERSION
+  s.authors     = ['Metasploit Hackers']
+  s.email       = ['msfdev@metasploit.com']
+  s.homepage    = ""
+  s.summary     = %q{Database code for MSF and Metasploit Pro}
+  s.description = %q{Implements minimal ActiveRecord models and database helper code used in both the Metasploit Framework (MSF) and Metasploit commercial editions.}
+
+  s.files         = `git ls-files`.split("\n").reject { |file|
+    file =~ /^bin/
+  }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = %w{app/models app/validators lib}
+
+  s.required_ruby_version = '>= 2.4'
+
+  # ---- Dependencies ----
+  # documentation
+  s.add_development_dependency 'metasploit-yard'
+  s.add_development_dependency 'yard-activerecord'
+  # embed ERDs on index, namespace Module and Class<ApplicationRecord> pages
+  s.add_development_dependency 'yard-metasploit-erd'
+
+  s.add_development_dependency 'rake'
+
+  s.add_development_dependency 'yard'
+  # debugging
+  s.add_development_dependency 'pry'
+
+
+  s.add_runtime_dependency 'activerecord', '~>5.2.2'
+  s.add_runtime_dependency 'activesupport', '~>5.2.2'
+  s.add_runtime_dependency 'metasploit-concern'
+  s.add_runtime_dependency 'metasploit-model', '>=3.1'
+  s.add_runtime_dependency 'railties', '~>5.2.2'
+  s.add_runtime_dependency 'webrick'
+
+  # os fingerprinting
+  s.add_runtime_dependency 'recog', '~> 2.0'
+
+  # arel-helpers: Useful tools to help construct database queries with ActiveRecord and Arel.
+  s.add_runtime_dependency 'arel-helpers'
+
+  if RUBY_PLATFORM =~ /java/
+    # markdown formatting for yard
+    s.add_development_dependency 'kramdown'
+
+    s.add_runtime_dependency 'jdbc-postgres'
+    s.add_runtime_dependency 'activerecord-jdbcpostgresql-adapter'
+
+    s.platform = Gem::Platform::JAVA
+  else
+    # markdown formatting for yard
+    s.add_development_dependency 'redcarpet'
+
+    s.add_runtime_dependency 'pg'
+
+    s.platform = Gem::Platform::RUBY
+  end
+end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/metasploit_data_models/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/app/models/mdm/api_key_spec.rb

@@ -0,0 +1,3 @@
+RSpec.describe Mdm::ApiKey, type: :model do
+  it_should_behave_like 'Metasploit::Concern.run'
+end

data/spec/app/models/mdm/client_spec.rb

@@ -0,0 +1,43 @@
+RSpec.describe Mdm::Client, type: :model do
+
+  it_should_behave_like 'Metasploit::Concern.run'
+
+  context 'associations' do
+    it { is_expected.to belong_to(:host).class_name('Mdm::Host') }
+  end
+
+  context '#destroy' do
+    it 'should successfully destroy the object' do
+      client = FactoryBot.create(:mdm_client, :ua_string => 'user-agent')
+      expect {
+        client.destroy
+      }.to_not raise_error
+      expect {
+        client.reload
+      }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  context 'factory' do
+    it 'should be valid' do
+      client = FactoryBot.build(:mdm_client)
+      expect(client).to be_valid
+    end
+  end
+
+  context 'database' do
+    context 'columns' do
+      it { is_expected.to have_db_column(:host_id).of_type(:integer)}
+      it { is_expected.to have_db_column(:ua_string).of_type(:string).with_options(:null => false) }
+      it { is_expected.to have_db_column(:ua_name).of_type(:string) }
+      it { is_expected.to have_db_column(:ua_ver).of_type(:string) }
+    end
+
+    context 'timestamps' do
+      it { is_expected.to have_db_column(:created_at).of_type(:datetime) }
+      it { is_expected.to have_db_column(:updated_at).of_type(:datetime) }
+    end
+
+  end
+
+end