ronin-rb/ronin-brute

# frozen_string_literal: true
#
# ronin-brute - A micro-framework and tool for bruteforcing credentials.
#
# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
#
# ronin-brute 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-brute 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-brute.  If not, see <https://www.gnu.org/licenses/>.
#

require 'ronin/brute/network_bruteforcer'

require 'ronin/support/network/udp/mixin'

module Ronin
  module Brute
    #
    # Base class for all UDP service bruteforcers.
    #
    class UDPBruteforcer < NetworkBruteforcer

      include Support::Network::UDP::Mixin

      #
      # Creates a new UDPSocket object connected to a given host and port.
      #
      # @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.
      #
      # @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(**kwargs,&block)
        if debug?
          print_debug "Connecting to #{host}:#{port} ..."
        end

        super(host,port,**kwargs,&block)
      end

      alias connect udp_connect

      #
      # Returns the type or kind of bruteforcer.
      #
      # @return [Symbol]
      #
      # @note
      #   This is used internally to map an bruteforcer class to a printable
      #   type.
      #
      # @api private
      #
      def self.bruteforcer_type
        :udp
      end

    end
  end
end