ronin-recon 0.1.0.rc1

data/lib/ronin/recon/values/email_address.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/recon/value'
+
+module Ronin
+  module Recon
+    module Values
+      #
+      # Represents an email address.
+      #
+      # @api public
+      #
+      class EmailAddress < Value
+
+        # The email address.
+        #
+        # @return [String]
+        attr_reader :address
+
+        #
+        # Initializes the email address object.
+        #
+        # @param [String] address
+        #   The email address.
+        #
+        def initialize(address)
+          @address = address
+        end
+
+        #
+        # Compares the value to another value.
+        #
+        # @param [Values::Value] other
+        #   The other value to compare.
+        #
+        # @return [Boolean]
+        #   Indicates whether the other value is a kind of {EmailAddress} and
+        #   has the same address.
+        #
+        def eql?(other)
+          other.kind_of?(self.class) && @address == other.address
+        end
+
+        alias === eql?
+
+        #
+        # The "hash" value for the email address.
+        #
+        # @return [Integer]
+        #   The hash of the {#address}.
+        #
+        def hash
+          [self.class, @address].hash
+        end
+
+        #
+        # Converts the email address object to a String.
+        #
+        # @return [String]
+        #   The email address.
+        #
+        def to_s
+          @address.to_s
+        end
+
+        alias to_str to_s
+
+        #
+        # Coerces the email address value into JSON.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The Ruby Hash that will be converted into JSON.
+        #
+        def as_json
+          {type: :email_address, address: @address}
+        end
+
+        #
+        # Returns the type or kind of recon value.
+        #
+        # @return [:email_address]
+        #
+        # @note
+        #   This is used internally to map a recon value class to a printable
+        #   type.
+        #
+        # @api private
+        #
+        def self.value_type
+          :email_address
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/recon/values/host.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/recon/value'
+require 'ronin/recon/values/ip'
+require 'ronin/recon/values/website'
+require 'ronin/recon/values/url'
+
+module Ronin
+  module Recon
+    module Values
+      #
+      # Represents a host-name (ex: `www.example.com`).
+      #
+      # @api public
+      #
+      class Host < Value
+
+        # The host name.
+        #
+        # @return [String]
+        attr_reader :name
+
+        #
+        # Initializes the host object.
+        #
+        # @param [String] name
+        #   The host name.
+        #
+        def initialize(name)
+          @name = name
+        end
+
+        #
+        # Compares the value to another value.
+        #
+        # @param [Values::Value] other
+        #   The other value to compare.
+        #
+        # @return [Boolean]
+        #   Indicates whether the other value is a kind of {Host} and has the
+        #   same host name.
+        #
+        def eql?(other)
+          self.class == other.class && @name == other.name
+        end
+
+        #
+        # Case equality method used for fuzzy matching.
+        #
+        # @param [Value] other
+        #   The other value to compare.
+        #
+        # @return [Boolean]
+        #   Imdicates whether the other value is either a {Host} and has the
+        #   same host name, or an {IP}, {Website}, {URL} with the same host
+        #   name.
+        #
+        def ===(other)
+          case other
+          when Host
+            @name == other.name
+          when IP, Website, URL
+            @name == other.host
+          else
+            false
+          end
+        end
+
+        #
+        # The "hash" value of the host name.
+        #
+        # @return [Integer]
+        #   The hash of the {#name}.
+        #
+        def hash
+          [self.class, @name].hash
+        end
+
+        #
+        # Converts the IP object to a String.
+        #
+        # @return [String]
+        #   The host name.
+        #
+        def to_s
+          @name.to_s
+        end
+
+        alias to_str to_s
+
+        #
+        # Coerces the host value into JSON.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The Ruby Hash that will be converted into JSON.
+        #
+        def as_json
+          {type: :host, name: @name}
+        end
+
+        #
+        # Returns the type or kind of recon value.
+        #
+        # @return [:host]
+        #
+        # @note
+        #   This is used internally to map a recon value class to a printable
+        #   type.
+        #
+        # @api private
+        #
+        def self.value_type
+          :host
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/recon/values/ip.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/recon/value'
+
+module Ronin
+  module Recon
+    module Values
+      #
+      # Represents an IP address.
+      #
+      # @api public
+      #
+      class IP < Value
+
+        # The IP address.
+        #
+        # @return [String]
+        attr_reader :address
+
+        # The optional parent host name.
+        #
+        # @return [String, nil]
+        attr_reader :host
+
+        #
+        # Initializes the IP object.
+        #
+        # @param [String] address
+        #   The IP address.
+        #
+        # @param [String, nil] host
+        #   The host name for the IP address.
+        #
+        def initialize(address, host: nil)
+          @address = address
+          @host    = host
+        end
+
+        #
+        # Compares the value to another value.
+        #
+        # @param [Values::Value] other
+        #   The other value to compare.
+        #
+        # @return [Boolean]
+        #   Indicates whether the other value is a kind of {IP} and has the
+        #   same address.
+        #
+        def eql?(other)
+          other.kind_of?(self.class) && @address == other.address
+        end
+
+        alias === eql?
+
+        #
+        # The "hash" value for the IP address.
+        #
+        # @return [Integer]
+        #   The hash of the {#address}.
+        #
+        def hash
+          [self.class, @address].hash
+        end
+
+        #
+        # Converts the IP object to a String.
+        #
+        # @return [String]
+        #   The IP address.
+        #
+        def to_s
+          @address.to_s
+        end
+
+        alias to_str to_s
+
+        #
+        # Coerces the IP value into JSON.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The Ruby Hash that will be converted into JSON.
+        #
+        def as_json
+          {type: :ip, address: @address}
+        end
+
+        #
+        # Returns the type or kind of recon value.
+        #
+        # @return [:ip]
+        #
+        # @note
+        #   This is used internally to map a recon value class to a printable
+        #   type.
+        #
+        # @api private
+        #
+        def self.value_type
+          :ip
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/recon/values/ip_range.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/recon/value'
+require 'ronin/recon/values/ip'
+
+require 'ronin/support/network/ip_range'
+
+module Ronin
+  module Recon
+    module Values
+      #
+      # Represents a IP CIDR or glob range.
+      #
+      # @api public
+      #
+      class IPRange < Value
+
+        # The IP range.
+        #
+        # @return [Ronin::Support::Network::IPRange]
+        attr_reader :range
+
+        #
+        # Initializes the IP range object.
+        #
+        # @param [Ronin::Support::Network::IPRange, String] range
+        #   The IP range string.
+        #
+        # @raise [ArgumentError]
+        #   The given range was not an `Ronin::Support::Network::IPRange` or
+        #   `String` object.
+        #
+        def initialize(range)
+          @range = case range
+                   when Support::Network::IPRange
+                     range
+                   when String
+                     Support::Network::IPRange.new(range)
+                   else
+                     raise(ArgumentError,"IP range must be either an IPAddr or String: #{range.inspect}")
+                   end
+        end
+
+        #
+        # Determines if an IP address exists within the IP range.
+        #
+        # @param [Ronin::Support::Network::IPRange, IPAddr, String] ip
+        #   The IP address to test.
+        #
+        # @return [Boolean]
+        #   Indicates whether the IP address exists within the IP range.
+        #
+        def include?(ip)
+          @range.include?(ip)
+        end
+
+        #
+        # Case equality method used for fuzzy matching.
+        #
+        # @param [Value] other
+        #   The other value to compare.
+        #
+        # @return [Boolean]
+        #   Imdicates whether the other value is either another {IPRange} that
+        #   intersects with the IP range, or an {IP} and exists within the IP
+        #   range.
+        #
+        def ===(other)
+          case other
+          when IPRange then @range === other.range
+          when IP      then include?(other.address)
+          else              false
+          end
+        end
+
+        #
+        # Compares the value to another value.
+        #
+        # @param [Values::Value] other
+        #
+        # @return [Boolean]
+        #
+        def eql?(other)
+          other.kind_of?(self.class) && @range == other.range
+        end
+
+        #
+        # The "hash" value of the IP range.
+        #
+        # @return [Integer]
+        #   The hash value of {#range}.
+        #
+        def hash
+          [self.class, @range].hash
+        end
+
+        #
+        # Converts the IP range object to a String.
+        #
+        # @return [String]
+        #   The IP range.
+        #
+        def to_s
+          @range.to_s
+        end
+
+        alias to_str to_s
+
+        #
+        # Coerces the IP range value into JSON.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The Ruby Hash that will be converted into JSON.
+        #
+        def as_json
+          {type: :ip_range, range: @range.to_s}
+        end
+
+        #
+        # Returns the type or kind of recon value.
+        #
+        # @return [:ip_range]
+        #
+        # @note
+        #   This is used internally to map a recon value class to a printable
+        #   type.
+        #
+        # @api private
+        #
+        def self.value_type
+          :ip_range
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/recon/values/mailserver.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/recon/values/host'
+
+module Ronin
+  module Recon
+    module Values
+      #
+      # Represents a discovered mailserver.
+      #
+      # @api public
+      #
+      class Mailserver < Host
+
+        #
+        # Coerces the mailserver value into JSON.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The Ruby Hash that will be converted into JSON.
+        #
+        def as_json
+          {type: :mailserver, name: @name}
+        end
+
+        #
+        # Returns the type or kind of recon value.
+        #
+        # @return [:mailserver]
+        #
+        # @note
+        #   This is used internally to map a recon value class to a printable
+        #   type.
+        #
+        # @api private
+        #
+        def self.value_type
+          :mailserver
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/recon/values/nameserver.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/recon/values/host'
+
+module Ronin
+  module Recon
+    module Values
+      #
+      # Represents a discovered DNS nameserver.
+      #
+      # @api public
+      #
+      class Nameserver < Host
+
+        #
+        # Coerces the nameserver value into JSON.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The Ruby Hash that will be converted into JSON.
+        #
+        def as_json
+          {type: :nameserver, name: @name}
+        end
+
+        #
+        # Returns the type or kind of recon value.
+        #
+        # @return [:nameserver]
+        #
+        # @note
+        #   This is used internally to map a recon value class to a printable
+        #   type.
+        #
+        # @api private
+        #
+        def self.value_type
+          :nameserver
+        end
+
+      end
+    end
+  end
+end