ronin-recon 0.1.0.rc1

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

@@ -0,0 +1,190 @@
+# 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 a discovered open port.
+      #
+      # @api public
+      #
+      class OpenPort < Value
+
+        # The IP address that the open port listens on.
+        #
+        # @return [String]
+        attr_reader :address
+
+        # The port number.
+        #
+        # @return [Integer]
+        attr_reader :number
+
+        # The optional hostname associated with the address.
+        #
+        # @return [String, nil]
+        attr_reader :host
+
+        # The protocol of the port.
+        #
+        # @return [:tcp, :udp] protocol
+        attr_reader :protocol
+
+        # The optional service information.
+        #
+        # @return [String, nil] service
+        attr_reader :service
+
+        # Indiciates whether the open port uses SSL.
+        #
+        # @return [Boolean]
+        attr_reader :ssl
+
+        #
+        # Initializes the open port.
+        #
+        # @param [String] address
+        #   The IP address for the open port.
+        #
+        # @param [Integer] number
+        #   The port number.
+        #
+        # @param [String, nil] host
+        #   The optional hostname associated with the address.
+        #
+        # @param [:tcp, :udp] protocol
+        #   The protocol of the port.
+        #
+        # @param [String, nil] service
+        #   The optional service information.
+        #
+        # @param [Boolean] ssl
+        #   Indicates that the open port uses SSL/TLS.
+        #
+        def initialize(address,number, host:     nil,
+                                       protocol: :tcp,
+                                       service:  nil,
+                                       ssl:      false)
+          @address  = address
+          @number   = number
+          @host     = host
+          @protocol = protocol
+          @service  = service
+          @ssl      = ssl
+        end
+
+        #
+        # Determines whether the open port uses SSL/TLS.
+        #
+        # @return [Boolean]
+        #
+        def ssl?
+          @ssl
+        end
+
+        #
+        # Compares the value to another value.
+        #
+        # @param [Values::Value] other
+        #
+        # @return [Boolean]
+        #
+        def eql?(other)
+          other.kind_of?(self.class) &&
+            @address  == other.address &&
+            @number   == other.number &&
+            @protocol == other.protocol &&
+            @service  == other.service &&
+            @ssl      == other.ssl
+        end
+
+        #
+        # The "hash" value of the open port.
+        #
+        # @return [Integer]
+        #
+        def hash
+          [self.class, @address, @number, @protocol, @service, @ssl].hash
+        end
+
+        #
+        # Converts the open port into a String.
+        #
+        # @return [String]
+        #   The hot-name/IP and port number.
+        #
+        def to_s
+          "#{@address}:#{@number}"
+        end
+
+        #
+        # Converts the open port into an Integer.
+        #
+        # @return [Integer]
+        #   The port {#number}.
+        #
+        def to_i
+          @number.to_i
+        end
+
+        alias to_int to_i
+
+        #
+        # Coerces the open port value into JSON.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The Ruby Hash that will be converted into JSON.
+        #
+        def as_json
+          hash = {
+            type:     :open_port,
+            address:  @address,
+            protocol: @protocol,
+            number:   @number
+          }
+
+          hash[:service] = @service if @service
+          hash[:ssl]     = @ssl     if @ssl
+
+          return hash
+        end
+
+        #
+        # Returns the type or kind of recon value.
+        #
+        # @return [:open_port]
+        #
+        # @note
+        #   This is used internally to map a recon value class to a printable
+        #   type.
+        #
+        # @api private
+        #
+        def self.value_type
+          :open_port
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,218 @@
+# 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 'uri'
+
+module Ronin
+  module Recon
+    module Values
+      #
+      # Represents a discovered URL.
+      #
+      # @api public
+      #
+      class URL < Value
+
+        # The parsed URI.
+        #
+        # @return [URI::HTTP, URI::HTTPS]
+        attr_reader :uri
+
+        # The HTTP status of the URI.
+        #
+        # @return [Integer, nil]
+        attr_reader :status
+
+        # The HTTP response headers for the URI.
+        #
+        # @return [Hash{String => String}, nil]
+        attr_reader :headers
+
+        # The HTTP response body for the URI.
+        #
+        # @return [String, nil]
+        attr_reader :body
+
+        #
+        # Initializes the URL object.
+        #
+        # @param [URI::HTTP, URI::HTTPS, String] url
+        #
+        # @param [Integer, nil] status
+        #   The optional HTTP status of the URI.
+        #
+        # @param [Hash{String => String}, nil] headers
+        #   The optional HTTP response headers for the URI.
+        #
+        # @param [String, nil] body
+        #   The optional HTTP response body for the URI.
+        #
+        def initialize(url, status: nil, headers: nil, body: nil)
+          @uri = URI(url)
+
+          @status  = status
+          @headers = headers
+          @body    = body
+        end
+
+        #
+        # The scheme of the URL.
+        #
+        # @return [String]
+        #
+        def scheme
+          @uri.scheme
+        end
+
+        #
+        # The URI's user information.
+        #
+        # @return [String, nil]
+        #
+        def userinfo
+          @uri.userinfo
+        end
+
+        #
+        # The URL's host name.
+        #
+        # @return [String]
+        #
+        def host
+          @uri.host
+        end
+
+        #
+        # The URL's port.
+        #
+        # @return [Integer]
+        #
+        def port
+          @uri.port
+        end
+
+        #
+        # The URL's path.
+        #
+        # @return [String]
+        #
+        def path
+          @uri.path
+        end
+
+        #
+        # The URL's query string.
+        #
+        # @return [String, nil]
+        #
+        def query
+          @uri.query
+        end
+
+        #
+        # The URL's query params.
+        #
+        # @return [Hash{String => String}, nil]
+        #
+        def query_params
+          @uri.query_params
+        end
+
+        #
+        # The URL's fragment string.
+        #
+        # @return [String, nil]
+        #
+        def fragment
+          @uri.fragment
+        end
+
+        #
+        # Compares the value to another value.
+        #
+        # @param [Values::Value] other
+        #
+        # @return [Boolean]
+        #
+        def eql?(other)
+          other.kind_of?(self.class) && @uri == other.uri
+        end
+
+        #
+        # The "hash" value of the URL.
+        #
+        # @return [Integer]
+        #   The hash value of {#uri}.
+        #
+        def hash
+          [self.class, @uri].hash
+        end
+
+        alias to_uri uri
+
+        #
+        # Converts the URL object to a String.
+        #
+        # @return [String]
+        #   The URL string.
+        #
+        def to_s
+          @uri.to_s
+        end
+
+        alias to_str to_s
+
+        #
+        # Coerces the URL value into JSON.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The Ruby Hash that will be converted into JSON.
+        #
+        def as_json
+          hash = {type: :url, url: @uri.to_s}
+
+          hash[:status]  = @status  if @status
+          hash[:headers] = @headers if @headers
+          hash[:body]    = @body    if @body
+
+          return hash
+        end
+
+        #
+        # Returns the type or kind of recon value.
+        #
+        # @return [:url]
+        #
+        # @note
+        #   This is used internally to map a recon value class to a printable
+        #   type.
+        #
+        # @api private
+        #
+        def self.value_type
+          :url
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,200 @@
+# 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 'uri'
+
+module Ronin
+  module Recon
+    module Values
+      #
+      # Represents a discovered website (ex: `https://example.com`).
+      #
+      # @api public
+      #
+      class Website < Value
+
+        # Indicates whether the website uses `http://` or `https://`.
+        #
+        # @return [:http, :https]
+        attr_reader :scheme
+
+        # The website's host name.
+        #
+        # @return [String]
+        attr_reader :host
+
+        # The website's port number.
+        #
+        # @return [Integer]
+        attr_reader :port
+
+        #
+        # Initializes the website.
+        #
+        # @param [:http, :https] scheme
+        #   Indicates whether the website uses `http://` or `https://`.
+        #
+        # @param [String] host
+        #   The website's host name.
+        #
+        # @param [Integer] port
+        #   The website's port number.
+        #
+        def initialize(scheme,host,port)
+          @scheme = scheme
+          @host   = host
+          @port   = port
+        end
+
+        #
+        # Initializes a new `http://` website.
+        #
+        # @param [String] host
+        #   The website's host name.
+        #
+        # @param [Integer] port
+        #   The website's port number.
+        #
+        # @return [Website]
+        #   The new website value.
+        #
+        def self.http(host,port=80)
+          new(:http,host,port)
+        end
+
+        #
+        # Initializes a new `https://` website.
+        #
+        # @param [String] host
+        #   The website's host name.
+        #
+        # @param [Integer] port
+        #   The website's port number.
+        #
+        # @return [Website]
+        #   The new website value.
+        #
+        def self.https(host,port=443)
+          new(:https,host,port)
+        end
+
+        #
+        # Parses a URL.
+        #
+        # @param [String] url
+        #   The URL string to parse.
+        #
+        # @return [Website]
+        #   The parsed website object.
+        #
+        def self.parse(url)
+          uri = URI.parse(url)
+
+          Values::Website.new(uri.scheme.to_sym,uri.host,uri.port)
+        end
+
+        #
+        # Compares the value to another value.
+        #
+        # @param [Values::Value] other
+        #
+        # @return [Boolean]
+        #
+        def eql?(other)
+          self.class == other.class &&
+            @scheme == other.scheme &&
+            @host   == other.host &&
+            @port   == other.port
+        end
+
+        #
+        # The "hash" value of the wildcard host name.
+        #
+        # @return [Integer]
+        #   The hash value of {#host} and {#port}.
+        #
+        def hash
+          [self.class, @scheme, @host, @port].hash
+        end
+
+        # Mapping of {#scheme} values to URI classes.
+        #
+        # @api private
+        URI_CLASSES = {
+          https: URI::HTTPS,
+          http:  URI::HTTP
+        }
+
+        #
+        # Converts the website into a URI.
+        #
+        # @return [URI::HTTP, URI::HTTPS]
+        #   The URI object for the website.
+        #
+        def to_uri
+          URI_CLASSES.fetch(@scheme).build(host: @host, port: @port, path: '/')
+        end
+
+        #
+        # Converts the website to a String.
+        #
+        # @return [String]
+        #   The base URL value for the website.
+        #
+        def to_s
+          if ((@scheme == :https) && (@port != 443)) ||
+             ((@scheme == :http)  && (@port != 80))
+            "#{@scheme}://#{@host}:#{@port}"
+          else
+            "#{@scheme}://#{@host}"
+          end
+        end
+
+        #
+        # Coerces the website value into JSON.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The Ruby Hash that will be converted into JSON.
+        #
+        def as_json
+          {type: :website, scheme: @scheme, host: @host, port: @port}
+        end
+
+        #
+        # Returns the type or kind of recon value.
+        #
+        # @return [:website]
+        #
+        # @note
+        #   This is used internally to map a recon value class to a printable
+        #   type.
+        #
+        # @api private
+        #
+        def self.value_type
+          :website
+        end
+
+      end
+    end
+  end
+end