metasploit-model 0.28.0 → 0.29.0

data/lib/metasploit/model/module/target/platform.rb

@@ -1,34 +0,0 @@
-# Model that joins {Metasploit::Model::Platform} and {Metasploit::Model::Module::Target}.
-module Metasploit::Model::Module::Target::Platform
-  extend ActiveModel::Naming
-  extend ActiveSupport::Concern
-
-  include Metasploit::Model::Translation
-
-  included do
-    include ActiveModel::Validations
-
-    #
-    # Validations
-    #
-
-    validates :module_target,
-              presence: true
-    validates :platform,
-              presence: true
-  end
-
-  #
-  # Associations
-  #
-
-  # @!attribute [rw] module_target
-  #   The module target that supports {#platform}.
-  #
-  #   @return [Metasploit::Model::Module::Target]
-
-  # @!attribute [rw] platform
-  #   The platform supported by the {#module_target}.
-  #
-  #   @return [Metasploit::Model::Platform]
-end

data/lib/metasploit/model/module/type.rb

@@ -1,38 +0,0 @@
-# Defines constants for {Metasploit::Model::Module} types as used in {Metasploit::Model::Module::Ancestor}.
-module Metasploit::Model::Module::Type
-  #
-  # CONSTANTS
-  #
-
-  # Symbolizes any module type is allowed.
-  ANY = '_any_'
-  # Auxiliary modules
-  AUX = 'auxiliary'
-  # Encoder modules
-  ENCODER = 'encoder'
-  # Exploit modules
-  EXPLOIT = 'exploit'
-  # No operation modules
-  NOP = 'nop'
-  # Payload modules
-  PAYLOAD = 'payload'
-  # Post-exploitation modules
-  POST = 'post'
-
-  # Array<String> of all supported module types (except {ANY} since that's a symbolic type)
-  ALL = [
-      AUX,
-      ENCODER,
-      EXPLOIT,
-      NOP,
-      PAYLOAD,
-      POST
-  ]
-
-  # Array<String> of all module types that aren't {PAYLOAD} because {PAYLOAD}
-  # {Metasploit::Model::Module::Ancestor#contents} define `Modules` instead of `Classes` and so need to be loaded
-  # differently.
-  NON_PAYLOAD = ALL.reject { |module_type|
-    module_type == PAYLOAD
-  }
-end

data/lib/metasploit/model/platform.rb

@@ -1,246 +0,0 @@
-# Code shared between `Mdm::Platform` and `Metasploit::Framework::Platform`.
-module Metasploit::Model::Platform
-  extend ActiveModel::Naming
-  extend ActiveSupport::Concern
-
-  include Metasploit::Model::Translation
-
-  #
-  # CONSTANTS
-  #
-
-  # Platforms are seeded in a hierarchy with deeper levels refining higher levels, so 'Windows 98 SE' is a
-  # refinement of 'Windows 98', which is a refinement of 'Windows'.
-  SEED_RELATIVE_NAME_TREE = {
-      'AIX' => nil,
-      'Android' => nil,
-      'BSD' => nil,
-      'BSDi' => nil,
-      'Cisco' => nil,
-      'Firefox' => nil,
-      'FreeBSD' => nil,
-      'HPUX' => nil,
-      'IRIX' => nil,
-      'Java' => nil,
-      'Javascript' => nil,
-      'Linux' => nil,
-      'NetBSD' => nil,
-      'Netware' => nil,
-      'NodeJS' => nil,
-      'OpenBSD' => nil,
-      'OSX' => nil,
-      'PHP' => nil,
-      'Python' => nil,
-      'Ruby' => nil,
-      'Solaris' => {
-          '4' => nil,
-          '5' => nil,
-          '6' => nil,
-          '7' => nil,
-          '8' => nil,
-          '9' => nil,
-          '10' => nil
-      },
-      'Windows' => {
-          '95' => nil,
-          '98' => {
-              'FE' => nil,
-              'SE' => nil
-          },
-          'ME' => nil,
-          'NT' => {
-              'SP0' => nil,
-              'SP1' => nil,
-              'SP2' => nil,
-              'SP3' => nil,
-              'SP4' => nil,
-              'SP5' => nil,
-              'SP6' => nil,
-              'SP6a' => nil
-          },
-          '2000' => {
-              'SP0' => nil,
-              'SP1' => nil,
-              'SP2' => nil,
-              'SP3' => nil,
-              'SP4' => nil
-          },
-          'XP' => {
-              'SP0' => nil,
-              'SP1' => nil,
-              'SP2' => nil,
-              'SP3' => nil
-          },
-          '2003' => {
-              'SP0' => nil,
-              'SP1' => nil
-          },
-          'Vista' => {
-              'SP0' => nil,
-              'SP1' => nil
-          },
-          '7' => nil
-      },
-      'UNIX' => nil
-  }
-
-  included do
-    include ActiveModel::MassAssignmentSecurity
-    include ActiveModel::Validations
-    include Metasploit::Model::Derivation
-    include Metasploit::Model::Search
-
-    #
-    # Derivations
-    #
-
-    derives :fully_qualified_name, :validate => true
-
-    #
-    # Mass Assignment Security
-    #
-
-    attr_accessible :relative_name
-
-    #
-    # Search
-    #
-
-    search_attribute :fully_qualified_name,
-                     type: {
-                         set: :string
-                     }
-
-    #
-    # Validation
-    #
-
-    validates :fully_qualified_name,
-              inclusion: {
-                  in: Metasploit::Model::Platform.fully_qualified_name_set
-              }
-    validates :relative_name,
-              presence: true
-  end
-
-  # Adds {#fully_qualified_name_set} to class.
-  module ClassMethods
-    # Set of valid {Metasploit::Model::Platform#fully_qualified_name}.
-    #
-    # @return [Set<String>]
-    def fully_qualified_name_set
-      Metasploit::Model::Platform.fully_qualified_name_set
-    end
-  end
-
-  #
-  # Attributes
-  #
-
-  # @!attribute [rw] fully_qualified_name
-  #   The fully qualified name of this platform, as would be used in the platform list in a metasploit-framework
-  #   module.
-  #
-  #   @return [String]
-
-  # @!attribute [rw] parent
-  #   The parent platform of this platform.  For example, Windows is parent of Windows 98, which is the parent of
-  #   Windows 98 FE.
-  #
-  #   @return [nil] if this is a top-level platform, such as Windows or Linux.
-  #   @return [Metasploit::Model::Platform]
-
-  # @!attribute [rw] relative_name
-  #   The name of this platform relative to the {#fully_qualified_name} of {#parent}.
-  #
-  #   @return [String]
-
-  #
-  # Methods
-  #
-
-  # Derives {#fully_qualified_name} from {#parent}'s {#fully_qualified_name} and this platform's {#relative_name}.
-  #
-  # @return [nil] if {#relative_name} is blank.
-  # @return [String] {#relative_name} if {#parent} is `nil`.
-  # @return [String] '<{#parent} {#relative_name}> <{#relative_name}>' if {#parent} is not `nil`.
-  def derived_fully_qualified_name
-    if relative_name.present?
-      if parent
-        "#{parent.fully_qualified_name} #{relative_name}"
-      else
-        relative_name
-      end
-    end
-  end
-
-  # @note Not defined in `ClassMethods` because consumers should always refer back to {Metasploit::Model::Platform}
-  #   when seeding.
-  #
-  # @param options [Hash{Symbol => Object, Hash}]
-  # @option options [Object] :parent (nil) The parent object to which to attach the children.
-  # @option options [Hash{String => nil,Hash}] :grandchildren_by_child_relative_name
-  #   ({SEED_RELATIVE_NAME_TREE}) Maps {#relative_name} of children under :parent to their children
-  #   (grandchildren of parent).  Grandchildren can be `nil` or another recursive `Hash` of names and their
-  #   descendants.
-  # @yield [attributes] Block should construct child object using attributes.
-  # @yieldparam attributes [Hash{Symbol => Object,String}] Hash containing attributes for child object, include
-  #   :parent for {#parent} and :relative_name for {#relative_name}.
-  # @yieldreturn [Object] child derived from :parent and :relative_name to be used as the parent for
-  #   grandchildren.
-  # @return [void]
-  def self.each_seed_attributes(options={}, &block)
-    options.assert_valid_keys(:parent, :grandchildren_by_child_relative_name)
-
-    parent = options[:parent]
-    grandchildren_by_child_relative_name = options.fetch(
-        :grandchildren_by_child_relative_name,
-        SEED_RELATIVE_NAME_TREE
-    )
-
-    grandchildren_by_child_relative_name.each do |child_relative_name, great_grandchildren_by_grandchild_relative_name|
-      attributes = {
-          parent: parent,
-          relative_name: child_relative_name
-      }
-      child = block.call(attributes)
-
-      if great_grandchildren_by_grandchild_relative_name
-        each_seed_attributes(
-            grandchildren_by_child_relative_name: great_grandchildren_by_grandchild_relative_name,
-            parent: child,
-            &block
-        )
-      end
-    end
-  end
-
-  # List of valid {#fully_qualified_name} derived from {SEED_RELATIVE_NAME_TREE}.
-  #
-  # @return [Array<String>]
-  def self.fully_qualified_name_set
-    unless instance_variable_defined? :@fully_qualified_name_set
-      @fully_qualified_name_set = Set.new
-
-      each_seed_attributes do |attributes|
-        parent = attributes.fetch(:parent)
-        relative_name = attributes.fetch(:relative_name)
-
-        if parent
-          fully_qualified_name = "#{parent} #{relative_name}"
-        else
-          fully_qualified_name = relative_name
-        end
-
-        @fully_qualified_name_set.add fully_qualified_name
-
-        # yieldreturn
-        fully_qualified_name
-      end
-
-      @fully_qualified_name_set.freeze
-    end
-
-    @fully_qualified_name_set
-  end
-end

data/lib/metasploit/model/real_pathname.rb

@@ -1,16 +0,0 @@
-require 'pathname'
-
-# Adds {#real_pathname} to class, which will convert `#real_path` `String` to a `Pathname`.
-module Metasploit::Model::RealPathname
-  # `#real_path` as a `Pathname`.
-  #
-  # @return [Pathname] unless `#real_path` is `nil`.
-  # @return [nil] if `#real_path` is `nil`.
-  def real_pathname
-    if real_path
-      Pathname.new(real_path)
-    else
-      nil
-    end
-  end
-end

data/lib/metasploit/model/reference.rb

@@ -1,104 +0,0 @@
-# Code shared between `Mdm::Reference` and `Metasploit::Framework::Reference`.
-module Metasploit::Model::Reference
-  extend ActiveModel::Naming
-  extend ActiveSupport::Concern
-
-  include Metasploit::Model::Translation
-
-  included do
-    include ActiveModel::MassAssignmentSecurity
-    include ActiveModel::Validations
-    include Metasploit::Model::Derivation
-    include Metasploit::Model::Search
-
-    #
-    # Derivations
-    #
-
-    derives :url, :validate => false
-
-    #
-    # Mass Assignment Security
-    #
-
-    attr_accessible :designation
-    attr_accessible :url
-
-    #
-    # Search Attributes
-    #
-
-    search_attribute :designation, :type => :string
-    search_attribute :url, :type => :string
-
-    #
-    # Validations
-    #
-
-    validates :designation,
-              :presence => {
-                  :if => :authority?
-              },
-              :nil => {
-                  :unless => :authority?
-              }
-    validates :url,
-              :presence => {
-                  :unless => :authority?
-              }
-  end
-
-  #
-  # Associations
-  #
-
-  # @!attribute [rw] authority
-  #   The {Metasploit::Model::Authority authority} that assigned {#designation}.
-  #
-  #   @return [Metasploit::Model::Authority, nil]
-
-  # @!attribute [r] module_instances
-  #   {Metasploit::Model::Module::Instance Modules} that exploit this reference or describe a proof-of-concept (PoC)
-  #   code that the module is based on.
-  #
-  #   @return [Array<Metasploit::Model::Module::Instance>]
-
-  #
-  # Attributes
-  #
-
-  # @!attribute [rw] designation
-  #   A designation (usually a string of numbers and dashes) assigned by {#authority}.
-  #
-  #   @return [String, nil]
-
-  # @!attribute [rw] url
-  #   URL to web page with information about referenced exploit.
-  #
-  #   @return [String, nil]
-
-  #
-  # Instance Methods
-  #
-
-  # Returns whether {#authority} is not `nil`.
-  #
-  # @return [true] unless {#authority} is `nil`.
-  # @return [false] if {#authority} is `nil`.
-  def authority?
-    authority.present?
-  end
-
-  # Derives {#url} based how {#authority} routes {#designation designations} to a URL.
-  #
-  # @return [String, nil]
-  def derived_url
-    derived = nil
-
-    if authority and designation.present?
-      derived = authority.designation_url(designation)
-    end
-
-    derived
-  end
-end

data/spec/app/models/metasploit/model/module/ancestor/spec/template_spec.rb

@@ -1,174 +0,0 @@
-require 'spec_helper'
-
-describe Metasploit::Model::Module::Ancestor::Spec::Template do
-  subject(:template) do
-    described_class.new(
-        module_ancestor: module_ancestor
-    )
-  end
-
-  let(:module_ancestor) do
-    FactoryGirl.build(:dummy_module_ancestor)
-  end
-
-  context 'CONSTANTS' do
-    context 'DEFAULT_SEARCH_PATHNAMES' do
-      subject(:default_search_pathnames) do
-        described_class::DEFAULT_SEARCH_PATHNAMES
-      end
-
-      it "includes 'module/ancestors'" do
-        expect(default_search_pathnames).to include(Pathname.new('module/ancestors'))
-      end
-    end
-
-    context 'DEFAULT_SOURCE_RELATIVE_NAME' do
-      subject(:default_source_relative_name) do
-        described_class::DEFAULT_SOURCE_RELATIVE_NAME
-      end
-
-      it { should == 'base' }
-    end
-  end
-
-  context 'validations' do
-    it { should validate_presence_of :module_ancestor }
-  end
-
-  context '#destination_pathname' do
-    subject(:destination_pathname) do
-      template.destination_pathname
-    end
-
-    context 'with #module_ancestor' do
-      it 'defaults to module_ancestor.real_pathname' do
-        expect(destination_pathname).to eq(module_ancestor.real_pathname)
-      end
-    end
-
-    context 'without #module_ancestor' do
-      let(:module_ancestor) do
-        nil
-      end
-
-      it { should be_nil }
-    end
-  end
-
-  context '#locals' do
-    subject(:locals) do
-      template.locals
-    end
-
-    it { should be_a Hash }
-
-    context '[:metasploit_module_relative_name]' do
-      subject(:metasploit_module_relative_name) do
-        locals[:metasploit_module_relative_name]
-      end
-
-      it 'is #metasploit_module_relative_name' do
-        expect(metasploit_module_relative_name).to eq(template.metasploit_module_relative_name)
-      end
-    end
-
-    context '[:module_ancestor]' do
-      subject(:locals_module_ancestor) do
-        locals[:module_ancestor]
-      end
-
-      it 'is #module_ancestor' do
-        expect(locals_module_ancestor).to eq(template.module_ancestor)
-      end
-    end
-  end
-
-  context '#metasploit_module_relative_name' do
-    subject(:metasploit_module_relative_name) do
-      template.metasploit_module_relative_name
-    end
-
-    it { should be_a String }
-
-    it 'uses FactoryGirl.generate' do
-      # ensure template is memoized so only metasploit_module_relative_name's usage of FactoryGirl is seen
-      template
-
-      expect(FactoryGirl).to receive(:generate).with(:metasploit_model_module_ancestor_metasploit_module_relative_name).and_call_original
-
-      metasploit_module_relative_name
-    end
-  end
-
-  context '#overwrite' do
-    subject(:overwrite) do
-      template.overwrite
-    end
-
-    it { should be_false }
-  end
-
-  context '#search_pathnames' do
-    subject(:search_pathnames) do
-      template.search_pathnames
-    end
-
-    it 'uses DEFAULT_SEARCH_PATHNAMES' do
-      expect(search_pathnames).to match_array(described_class::DEFAULT_SEARCH_PATHNAMES)
-    end
-  end
-
-  context '#source_relative_name' do
-    subject(:source_relative_name) do
-      template.source_relative_name
-    end
-
-    it 'uses DEFAULT_SOURCE_RELATIVE_NAME' do
-      expect(source_relative_name).to eq(described_class::DEFAULT_SOURCE_RELATIVE_NAME)
-    end
-  end
-
-  context 'write' do
-    subject(:write) do
-      described_class.write(attributes)
-    end
-
-    before(:each) do
-      # Since overwrite is false, have to delete the template that the factories make.
-      module_ancestor.real_pathname.delete
-    end
-
-    context 'with valid' do
-      let(:attributes) do
-        {
-            module_ancestor: module_ancestor
-        }
-      end
-
-      it { should be_true }
-
-      it 'writes template' do
-        # memoize attributes so any other writes besides the one under-test are already run.
-        attributes
-
-        described_class.any_instance.should_receive(:write)
-
-        write
-      end
-    end
-
-    context 'without valid' do
-      let(:attributes) do
-        {}
-      end
-
-      it { should be_false }
-
-      it 'does not write template' do
-        described_class.any_instance.should_not_receive(:write)
-
-        write
-      end
-    end
-  end
-end