ronin 1.5.1 → 2.0.0.beta1

data/lib/ronin/script/testable.rb

@@ -1,365 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/script/exceptions/test_failed'
-require 'ronin/ui/output/helpers'
-
-module Ronin
-  module Script
-    #
-    # Adds testing methods to an {Script}.
-    #
-    # @since 1.1.0
-    #
-    module Testable
-      include UI::Output::Helpers
-
-      #
-      # Initializes the testable script.
-      #
-      # @param [Hash] attributes
-      #   Additional attributes for the script.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      def initialize(attributes={})
-        super(attributes)
-
-        @test_blocks = []
-      end
-
-      #
-      # Tests that the script is properly configured.
-      #
-      # @return [true]
-      #   The script is built and ready for deployment.
-      #
-      # @see test
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      def test!
-        print_info "Testing #{self.class.short_name} ..."
-
-        @test_blocks.each { |block| block.call() }
-
-        print_info "#{self.class.short_name} tested!"
-        return true
-      end
-
-      protected
-
-      #
-      # Flunks the testing process.
-      #
-      # @param [String] message
-      #   The message on why the testing failed.
-      #
-      # @raise [TestFailed]
-      #   The testing failure message.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def flunk(message)
-        raise(TestFailed,message)
-      end
-
-      #
-      # Registers a given block to be called when the script is tested.
-      #
-      # @yield []
-      #   The given block will be called when the script is being tested.
-      #
-      # @return [Script]
-      #   The script.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def test(&block)
-        @test_blocks << block
-        return self
-      end
-
-      #
-      # Tests whether an expression is true.
-      #
-      # @param [String] message
-      #   The failure message if the expression was not true.
-      #
-      # @yield []
-      #   The given block will contain the expression to evaluate.
-      #
-      # @return [true]
-      #   The expression was true.
-      #
-      # @raise [TestFailed]
-      #   The expression was not true.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def test?(message,&block)
-        test { flunk(message) unless block.call() }
-      end
-
-      #
-      # Tests whether a method has the expected value.
-      #
-      # @param [Symbol] name
-      #   The method to call.
-      #
-      # @param [Object] expected_value
-      #   The expected value.
-      #
-      # @param [String] message
-      #   Optional failure message.
-      #
-      # @return [true]
-      #   The method returned the expected value.
-      #
-      # @raise [TestFailed]
-      #   The method did not return the expected value.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def test_equal(name,expected_value,message=nil)
-        name = name.to_sym
-
-        test do
-          actual_value = self.send(name)
-          message ||= "#{name} (#{actual_value.inspect}) must equal #{expected_value.inspect}"
-
-          flunk(message) unless actual_value == expected_value
-        end
-      end
-
-      #
-      # Tests whether a method does not have the unexpected value.
-      #
-      # @param [Symbol] name
-      #   The method to call.
-      #
-      # @param [Object] unexpected_value
-      #   The unexpected value.
-      #
-      # @param [String] message
-      #   Optional failure message.
-      #
-      # @return [true]
-      #   The method did not return the unexpected value.
-      #
-      # @raise [TestFailed]
-      #   The method did return the unexpected value.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def test_not_equal(name,unexpected_value,message=nil)
-        name = name.to_sym
-
-        test do
-          actual_value = self.send(name)
-          message ||= "#{name} (#{actual_value.inspect}) cannot equal #{unexpected_value.inspect}"
-
-          flunk(message) unless actual_value != unexpected_value
-        end
-      end
-
-      #
-      # Tests whether a method returns a non-`nil` value.
-      #
-      # @param [Symbol] name
-      #   The method to call.
-      #
-      # @param [String] message
-      #   Optional failure message.
-      #
-      # @return [true]
-      #   The method returned a non-`nil` value.
-      #
-      # @raise [TestFailed]
-      #   The method returned `nil`.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def test_set(name,message=nil)
-        name = name.to_sym
-
-        test do
-          actual_value = self.send(name)
-          message ||= "#{name} is not set"
-
-          blank = if actual_value.respond_to?(:empty?)
-                    actual_value.empty?
-                  else
-                    actual_value.nil?
-                  end
-
-          flunk(message) if blank
-        end
-      end
-
-      #
-      # Tests whether a method matches the pattern.
-      #
-      # @param [Symbol] name
-      #   The method to call.
-      #
-      # @param [Regexp, String] pattern
-      #   The pattern to match against.
-      #
-      # @param [String] message
-      #   Optional failure message.
-      #
-      # @return [true]
-      #   The method matched the pattern.
-      #
-      # @raise [TestFailed]
-      #   The method did not match the pattern.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def test_match(name,pattern,message=nil)
-        name = name.to_sym
-
-        test do
-          actual_value = self.send(name)
-          message ||= "#{name} (#{actual_value.inspect}) must match #{pattern.inspect}"
-
-          flunk(message) unless actual_value.match(pattern)
-        end
-      end
-
-      #
-      # Tests whether a method does not matches the pattern.
-      #
-      # @param [Symbol] name
-      #   The method to call.
-      #
-      # @param [Regexp, String] pattern
-      #   The pattern to match against.
-      #
-      # @param [String] message
-      #   Optional failure message.
-      #
-      # @return [true]
-      #   The method matched the pattern.
-      #
-      # @raise [TestFailed]
-      #   The method did not match the pattern.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def test_no_match(name,pattern,message=nil)
-        name = name.to_sym
-
-        test do
-          actual_value = self.send(name)
-          message ||= "#{name} (#{actual_value.inspect}) cannot match #{pattern.inspect}"
-
-          flunk(message) unless !actual_value.match(pattern)
-        end
-      end
-
-      #
-      # Tests a method has a value in the expected values.
-      #
-      # @param [Symbol] name
-      #   The method name.
-      #
-      # @param [#include?]  expected_values
-      #   The expected values.
-      #
-      # @param [String] message
-      #   Optional failure message.
-      #
-      # @return [true]
-      #   The method returned one of the expected values.
-      #
-      # @raise [TestFailed]
-      #   The method did not return one of the expected values.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def test_in(name,expected_values,message=nil)
-        name = name.to_sym
-
-        test do
-          actual_value = self.send(name)
-          message ||= "#{name} (#{actual_value.inspect}) must be one of #{expected_values.inspect}"
-
-          flunk(message) unless expected_values.include?(actual_value)
-        end
-      end
-
-      #
-      # Tests a method does not have a value in the unexpected values.
-      #
-      # @param [Symbol] name
-      #   The method name.
-      #
-      # @param [#include?]  unexpected_values
-      #   The unexpected values.
-      #
-      # @param [String] message
-      #   Optional failure message.
-      #
-      # @return [true]
-      #   The method did not return one of the unexpected values.
-      #
-      # @raise [TestFailed]
-      #   The method did return one of the unexpected values.
-      #
-      # @since 1.1.0
-      #
-      # @api public
-      #
-      def test_not_in(name,unexpected_values,message=nil)
-        name = name.to_sym
-
-        test do
-          actual_value = self.send(name)
-          message ||= "#{name} (#{actual_value.inspect}) cannot be one of #{unexpected_values.inspect}"
-
-          flunk(message) unless !unexpected_values.include?(actual_value)
-        end
-      end
-    end
-  end
-end

data/lib/ronin/script.rb

@@ -1,21 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/script/exceptions'
-require 'ronin/script/script'

data/lib/ronin/service.rb

@@ -1,39 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model'
-require 'ronin/model/has_unique_name'
-
-module Ronin
-  #
-  # Represents a TCP/UDP Service that runs on various common ports.
-  #
-  class Service
-
-    include Model
-    include Model::HasUniqueName
-
-    # Primary key of the service
-    property :id, Serial
-
-    # The open ports running the service
-    has 1..n, :open_ports
-
-  end
-end

data/lib/ronin/service_credential.rb

@@ -1,31 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/credential'
-
-module Ronin
-  #
-  # Represents Credentials used to access a TCP/UDP {Service}.
-  #
-  class ServiceCredential < Credential
-
-    belongs_to :open_port, :required => false
-
-  end
-end

data/lib/ronin/software.rb

@@ -1,55 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model'
-
-module Ronin
-  #
-  # Represents a Software product.
-  #
-  class Software
-
-    include Model
-
-    # Primary key
-    property :id, Serial
-
-    # Name
-    property :name, String, :required => true, :index => true
-
-    # Version
-    property :version, String, :required => true, :index => true
-
-    # The vendor of the software
-    belongs_to :vendor, :required => false
-
-    #
-    # Converts the software to a String.
-    #
-    # @return [String]
-    #   The software vendor, name and version.
-    #
-    # @api public
-    #
-    def to_s
-      [self.vendor, self.name, self.version].compact.join(' ')
-    end
-
-  end
-end

data/lib/ronin/spec/database.rb

@@ -1,56 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/database'
-
-require 'rspec'
-require 'tmpdir'
-
-RSpec.configure do |spec|
-  defaults = {
-    :user     => 'ronin_test',
-    :password => 'ronin_test',
-    :database => 'ronin_test'
-  }
-  adapter  = ENV.fetch('ADAPTER','sqlite3')
-
-  uri = case adapter
-        when 'sqlite3', 'sqlite'
-          path = File.join(Dir.tmpdir,'ronin_database.sqlite3')
-
-          {:adapter  => 'sqlite3', :database => path}
-        else
-          defaults.merge(:adapter => adapter)
-        end
-
-  spec.before(:suite) do
-    # setup the database
-    Ronin::Database.setup(uri)
-
-    # auto-migrate any models defined in the specs
-    DataMapper.finalize.auto_migrate!
-  end
-
-  spec.after(:suite) do
-    case adapter
-    when 'sqlite3', 'sqlite'
-      File.unlink(path)
-    end
-  end
-end

data/lib/ronin/target.rb

@@ -1,66 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model'
-
-require 'dm-timestamps'
-require 'fileutils'
-
-module Ronin
-  #
-  # Represents an {Address} targeted by a {Campaign}.
-  #
-  class Target
-
-    include Model
-
-    # Primary key of the target
-    property :id, Serial
-
-    # The campaign the target belongs to
-    belongs_to :campaign
-
-    # The host being targeted
-    belongs_to :address
-
-    # Defines the `created_at` timestamp
-    timestamps :created_at
-
-    # The organization that is being targeted
-    has 1, :organization, :through => :address
-
-    # Validates the uniqueness of the address and the campaign.
-    validates_uniqueness_of :address, :scope => [:campaign]
-
-    #
-    # Converts the target to a String.
-    #
-    # @return [String]
-    #   The address of the target.
-    #
-    # @since 1.0.0
-    #
-    # @api public
-    #
-    def to_s
-      self.address.to_s
-    end
-
-  end
-end

data/lib/ronin/tcp_port.rb

@@ -1,36 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/port'
-
-module Ronin
-  #
-  # Represents a TCP {Port}.
-  #
-  class TCPPort < Port
-
-    # The protocol used for the port
-    property :protocol, String, :default => 'tcp'
-
-    # The URLs that use the port
-    has 0..n, :urls, :model => 'URL',
-                     :child_key => [:port_id]
-
-  end
-end

data/lib/ronin/udp_port.rb

@@ -1,32 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/port'
-
-module Ronin
-  #
-  # Represents a UDP {Port}.
-  #
-  class UDPPort < Port
-
-    # The protocol used for the port
-    property :protocol, String, :default => 'tcp'
-
-  end
-end