# frozen_string_literal: true
#
# ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
# payload crafting functionality.
#
# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# ronin-exploits 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-exploits 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-exploits.  If not, see <https://www.gnu.org/licenses/>.
#

require 'ronin/support/network/udp/mixin'
require 'ronin/exploits/params/host'
require 'ronin/exploits/params/port'
require 'ronin/exploits/params/bind_host'
require 'ronin/exploits/params/bind_port'

module Ronin
  module Exploits
    module Mixins
      #
      # Adds UDP helper methods for communicating with a remote host.
      #
      # @api public
      #
      # @since 1.0.0
      #
      module RemoteUDP
        include Support::Network::UDP::Mixin

        #
        # Includes {Params::Host}, {Params::Port}, {Params::BindHost}, and
        # {Params::BindPort} into the exploit class that is including
        # {Mixins::RemoteUDP}.
        #
        # @param [Class<Exploit>] exploit
        #   The exploit class that is including {Mixins::RemoteUDP}.
        #
        # @api private
        #
        def self.included(exploit)
          exploit.include Params::Host
          exploit.include Params::Port
          exploit.include Params::BindHost
          exploit.include Params::BindPort
        end

        #
        # Tests whether a remote UDP port is open.
        #
        # @param [String] host
        #   The host to connect to.
        #
        # @param [Integer] port
        #   The port to connect to.
        #
        # @param [Hash{Symbol => Object}] kwargs
        #   Additional keyword arguments for {#udp_connect}.
        #
        # @option kwargs [String, nil] :bind_host
        #   The local host to bind to.
        #
        # @option kwargs [Integer, nil] :bind_port
        #   The local port to bind to.
        #
        # @option kwargs [Integer] :timeout (5)
        #   The maximum time to attempt connecting.
        #
        # @return [Boolean, nil]
        #   Specifies whether the remote UDP port is open.
        #   If no data or ICMP error were received, `nil` will be returned.
        #
        # @example
        #   udp_open?
        #   # => true
        #
        # @example Using a timeout:
        #   udp_open?(timeout: 5)
        #   # => nil
        #
        def udp_open?(host=params[:host],port=params[:port],
                      bind_host: params[:bind_host],
                      bind_port: params[:bind_port],
                      **kwargs)
          if debug?
            print_debug "Testing if #{host}:#{port} is open ..."
          end

          super(host,port, bind_host: bind_host,
                           bind_port: bind_port,
                           **kwargs)
        end

        #
        # Creates a new UDPSocket object connected to a given host and port.
        #
        # @param [String] host
        #   The host to connect to.
        #
        # @param [Integer] port
        #   The port to connect to.
        #
        # @param [String, nil] bind_host
        #   The local host to bind to.
        #
        # @param [Integer, nil] bind_port
        #   The local port to bind to.
        #
        # @yield [socket]
        #   If a block is given, it will be passed the newly created socket.
        #   Once the block returns the socket will be closed.
        #
        # @yieldparam [UDPsocket] socket
        #   The newly created UDP socket.
        #
        # @return [UDPSocket, nil]
        #   The newly created UDP socket object. If a block is given a `nil`
        #   will be returned.
        #
        # @example
        #   udp_connect
        #   # => #<UDPSocket:fd 5, AF_INET, 192.168.122.165, 48313>
        #
        # @example
        #   udp_connect do |socket|
        #     # ...
        #   end
        #
        # @see https://rubydoc.info/stdlib/socket/UDPSocket
        #
        def udp_connect(host=params[:host],port=params[:port],
                        bind_host: params[:bind_host],
                        bind_port: params[:bind_port],
                        &block)
          if debug?
            print_debug "Connecting to #{host}:#{port} ..."
          end

          super(host,port, bind_host: bind_host,
                           bind_port: bind_port,
                           &block)
        end

        #
        # Creates a new UDPSocket object, connected to a given host and port.
        # The given data will then be written to the newly created UDPSocket.
        #
        # @param [String] data
        #   The data to send through the connection.
        #
        # @param [String] host
        #   The host to connect to.
        #
        # @param [Integer] port
        #   The port to connect to.
        #
        # @param [String, nil] bind_host
        #   The local host to bind to.
        #
        # @param [Integer, nil] bind_port
        #   The local port to bind to.
        #
        # @yield [socket]
        #   If a block is given, it will be passed the newly created socket.
        #
        # @yieldparam [UDPsocket] socket
        #   The newly created UDPSocket object.
        #
        # @return [UDPSocket]
        #   The newly created UDPSocket object.
        #
        def udp_connect_and_send(data,host=params[:host],port=params[:port],
                                 bind_host: params[:bind_host],
                                 bind_port: params[:bind_port],
                                 &block)
          if debug?
            print_debug "Connecting to #{host}:#{port} and sending #{data.inspect} ..."
          end

          super(data,host,port, bind_host: bind_host,
                                bind_port: bind_port,
                                &block)
        end

        #
        # Reads the banner from the service running on the given host and
        # port.
        #
        # @param [String] host
        #   The host to connect to.
        #
        # @param [Integer] port
        #   The port to connect to.
        #
        # @param [String, nil] bind_host
        #   The local host to bind to.
        #
        # @param [Integer, nil] bind_port
        #   The local port to bind to.
        #
        # @yield [banner]
        #   If a block is given, it will be passed the grabbed banner.
        #
        # @yieldparam [String] banner
        #   The grabbed banner.
        #
        # @return [String]
        #   The grabbed banner.
        #
        def udp_banner(host=params[:host],port=params[:port], bind_host: params[:bind_host], bind_port: params[:bind_port])
          if debug?
            print_debug "Fetching the banner for #{host}:#{port} ..."
          end

          super(host,port,bind_host: bind_host, bind_port: bind_port)
        end

        #
        # Connects to a specified host and port, sends the given data and then
        # closes the connection.
        #
        # @param [String] data
        #   The data to send through the connection.
        #
        # @param [String] host
        #   The host to connect to.
        #
        # @param [Integer] port
        #   The port to connect to.
        #
        # @param [String, nil] bind_host
        #   The local host to bind to.
        #
        # @param [Integer, nil] bind_port
        #   The local port to bind to.
        #
        # @return [true]
        #   The data was successfully sent.
        #
        # @example
        #   buffer = "GET /" + ('A' * 4096) + "\n\r"
        #   udp_send(buffer)
        #   # => true
        #
        def udp_send(data,host=params[:host],port=params[:port], bind_host: params[:bind_host], bind_port: params[:bind_port])
          if debug?
            print_debug "Sending #{data.inspect} to #{host}:#{port} ..."
          end

          super(data,host,port, bind_host: bind_host, bind_port: bind_port)
        end
      end
    end
  end
end