ronin-rb/ronin-recon

# 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_relative '../../worker'

require 'ronin/nmap'

module Ronin
  module Recon
    module Net
      #
      # A recon worker that performs a nmap port scan.
      #
      class PortScan < Worker

        register 'net/port_scan'

        summary 'Scans an IP for open ports'

        description <<~DESC
          Performs a nmap port scan of the given IP and retruns the open
          ports and their services.
        DESC

        accepts IP
        outputs OpenPort
        concurrency 1 # prevents overloading the network interface

        param :ports, String, desc: 'Optional port list to scan'

        #
        # Performs an nmap port scan on the given IP value.
        #
        # @param [Values::IP] ip
        #   The given IP to scan.
        #
        # @yield [new_value]
        #   The discovered open ports will be yielded.
        #
        # @yieldparam [Values::OpenPort] new_value
        #   A discovered open port.
        #
        def process(ip)
          xml = Nmap.scan(ip.address, verbose:      true,
                                      service_scan: true,
                                      ports:        params[:ports])

          address = ip.address
          host    = ip.host || xml.host.to_s

          xml.host.open_ports.each do |open_port|
            number   = open_port.number
            protocol = open_port.protocol
            service  = open_port.service

            yield OpenPort.new(
              address,number, host:     host,
                              protocol: protocol,
                              service:  service && service.name,
                              ssl:      service && service.ssl?
            )
          end
        end

      end
    end
  end
end