ronin-support 0.5.2 → 1.0.0.beta1

data/lib/ronin/support/network/udp/proxy.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support 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-support 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-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/network/proxy'
+
+require 'socket'
+
+module Ronin
+  module Support
+    module Network
+      module UDP
+        #
+        # The UDP Proxy allows for inspecting and manipulating UDP protocols.
+        #
+        # ## Example
+        #
+        #     require 'ronin/support/network/udp/proxy'
+        #     require 'hexdump'
+        #
+        #     Ronin::Support::Network::UDP::Proxy.start(:port => 1337, :server => ['4.2.2.1', 53]) do |proxy|
+        #       hex = Hexdump::Hexdump.new
+        #
+        #       proxy.on_client_data do |(client,(host,port)),server,data|
+        #         puts "#{host}:#{port} -> #{proxy}"
+        #         hex.dump(data)
+        #       end
+        #
+        #       proxy.on_server_data do |(client,(host,port)),server,data|
+        #         puts "#{host}:#{port} <- #{proxy}"
+        #         hex.dump(data)
+        #       end
+        #     
+        #     end
+        #
+        # @since 0.5.0
+        #
+        class Proxy < Network::Proxy
+
+          #
+          # Opens the UDP Proxy.
+          #
+          # @api public
+          #
+          def open
+            @socket = UDPSocket.new
+            @socket.bind(@host,@port)
+          end
+
+          #
+          # Polls the connections for data/errors and the proxy socket for
+          # new client connections.
+          #
+          # @api public
+          #
+          def poll
+            sockets = [@socket] + server_connections
+
+            readable, writtable, errors = IO.select(sockets,nil,sockets)
+
+            (errors & server_connections).each do |server_socket|
+              client_socket = client_connection_for(server_socket)
+
+              close_connection(client_socket,server_socket)
+            end
+
+            (readable & server_connections).each do |server_socket|
+              client_socket  = client_connection_for(server_socket)
+              data, addrinfo = recv(server_socket)
+
+              server_data(client_socket,server_socket,data)
+            end
+
+            if readable.include?(@socket)
+              data, addrinfo = recv(@socket)
+
+              client_socket = [@socket, [addrinfo[3], addrinfo[1]]]
+              server_socket = (@connections[client_socket] ||= open_server_connection)
+
+              client_data(client_socket,server_socket,data)
+            end
+          end
+
+          #
+          # Sends data to a connection.
+          #
+          # @param [UDPSocket, (UDPSocket, (String, Integer))] connection
+          #   The connection from the proxy to the server, or the proxy socket
+          #   and host/port of the client.
+          #
+          # @param [String] data
+          #   The data to be sent.
+          #
+          # @api public
+          #
+          def send(connection,data)
+            case connection
+            when Array
+              socket, (host, port) = connection
+
+              socket.send(data,0,host,port)
+            when UDPSocket
+              connection.send(data,0)
+            end
+          end
+
+          #
+          # Receives data from a connection.
+          #
+          # @param [UDPSocket, (UDPSocket, (String, Integer))] connection
+          #   The connection from the proxy to the server, or the proxy socket
+          #   and the address of a client.
+          #
+          # @return [String, (String, Array)]
+          #   The data received.
+          #
+          # @api public
+          #
+          def recv(connection)
+            case connection
+            when Array
+              socket, (host, port) = connection
+
+              socket.recvfrom(@buffer_size)
+            when UDPSocket
+              connection.recvfrom(@buffer_size)
+            end
+          end
+
+          protected
+
+          #
+          # Creates a new connection from the proxy to the server.
+          #
+          # @return [UDPSocket]
+          #   The new UDPSocket to the server.
+          #
+          def open_server_connection
+            socket = UDPSocket.new
+            socket.connect(@server_host,@server_port)
+
+            return socket
+          end
+
+          #
+          # Closes a connection from the client to the proxy.
+          #
+          # @param [(UDPSocket, (String, Integer))] connection
+          #   The UDP Proxy socket and the host/port of the client.
+          #
+          # @note no-op
+          #
+          def close_client_connection(connection)
+            # no-op
+          end
+
+          #
+          # Closes the connection from the proxy to the server.
+          #
+          # @param [UDPSocket] connection
+          #   The UDPSocket from the proxy to the server.
+          #
+          def close_server_connection(connection)
+            connection.close
+          end
+
+          #
+          # Closes the UDP proxy socket.
+          #
+          def close_proxy
+            @socket.close
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/network/udp.rb

@@ -0,0 +1,435 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support 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-support 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-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/network/udp/proxy'
+require 'ronin/support/network/dns/idn'
+
+require 'socket'
+require 'timeout'
+
+module Ronin
+  module Support
+    module Network
+      #
+      # @since 1.0.0
+      #
+      module UDP
+        #
+        # 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 [Integer] timeout (5)
+        #   The maximum time to attempt connecting.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {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.
+        #
+        # @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?('4.2.2.1',53)
+        #   # => true
+        #
+        # @example Using a timeout:
+        #   UDP.open?('example.com',1111, timeout: 5)
+        #   # => nil
+        #
+        # @api public
+        #
+        # @since 0.5.0
+        #
+        def self.open?(host,port, timeout: 5, **kwargs)
+          begin
+            Timeout.timeout(timeout) do
+              connect(host,port,**kwargs) do |socket|
+                # send an empty UDP packet, just like nmap
+                socket.syswrite('')
+
+                # send an empty UDP packet again, to elicit an
+                # Errno::ECONNREFUSED
+                socket.syswrite('')
+              end
+            end
+
+            return true
+          rescue Timeout::Error
+            return nil
+          rescue SocketError, SystemCallError
+            return false
+          end
+        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('8.8.8.8',53)
+        #   # => #<UDPSocket:fd 5, AF_INET, 192.168.122.165, 48313>
+        #
+        # @example
+        #   UDP.connect('8.8.8.8',53) do |socket|
+        #     # ...
+        #   end
+        #
+        # @see https://rubydoc.info/stdlib/socket/UDPSocket
+        #
+        # @api public
+        #
+        def self.connect(host,port, bind_host: nil, bind_port: nil)
+          host = DNS::IDN.to_ascii(host)
+          port = port.to_i
+
+          socket = UDPSocket.new
+
+          if bind_host || bind_port
+            socket.bind(bind_host.to_s,bind_port.to_i)
+          end
+
+          socket.connect(host,port)
+
+          if block_given?
+            yield socket
+            socket.close
+          else
+            return socket
+          end
+        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 [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {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.
+        #
+        # @yieldparam [UDPsocket] socket
+        #   The newly created UDPSocket object.
+        #
+        # @return [UDPSocket]
+        #   The newly created UDPSocket object.
+        #
+        # @api public
+        #
+        def self.connect_and_send(data,host,port,**kwargs)
+          socket = connect(host,port,**kwargs)
+          socket.write(data)
+
+          yield socket if block_given?
+          return socket
+        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 [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {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.
+        #
+        # @return [true]
+        #   The data was successfully sent.
+        #
+        # @example
+        #   buffer = "GET /" + ('A' * 4096) + "\n\r"
+        #   UDP.send(buffer,'victim.com',80)
+        #   # => true
+        #
+        # @api public
+        #
+        # @since 0.4.0
+        #
+        def self.send(data,host,port,**kwargs)
+          connect(host,port,**kwargs) do |socket|
+            socket.write(data)
+          end
+
+          return true
+        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 [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {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 [banner]
+        #   If a block is given, it will be passed the grabbed banner.
+        #
+        # @yieldparam [String] banner
+        #   The grabbed banner.
+        #
+        # @return [String]
+        #   The grabbed banner.
+        #
+        # @api public
+        #
+        def self.banner(host,port,**kwargs)
+          banner = nil
+
+          connect(host,port,**kwargs) do |socket|
+            banner = socket.readline
+          end
+
+          yield banner if block_given?
+          return banner
+        end
+
+        #
+        # Creates a new UDPServer listening on a given host and port.
+        #
+        # @param [Integer, nil] port
+        #   The local port to listen on.
+        #
+        # @param [String, nil] host
+        #   The host to bind to.
+        #
+        # @return [UDPServer]
+        #   The new UDP server.
+        #
+        # @example
+        #   server = UDP.server(port: 1337)
+        #
+        # @see https://rubydoc.info/stdlib/socket/UDPSocket
+        #
+        # @api public
+        #
+        def self.server(port: nil, host: nil)
+          server = UDPSocket.new
+          server.bind(host.to_s,port.to_i)
+
+          yield server if block_given?
+          return server
+        end
+
+        #
+        # Creates a new temporary UDPServer listening on a given host and
+        # port.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional arguments for {server}.
+        #
+        # @option kwargs [Integer, nil] :port
+        #   The local port to bind to.
+        #
+        # @option kwargs [String, nil] :host
+        #   The host to bind to.
+        #
+        # @yield [server]
+        #   The block which will be called after the server has been created.
+        #   After the block has finished, the server will be closed.
+        #
+        # @yieldparam [UDPServer] server
+        #   The newly created UDP server.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   UDP.server_session(port: 1337) do |server|
+        #     data, sender = server.recvfrom(1024)
+        #   end
+        #
+        # @api public
+        #
+        def self.server_session(**kwargs,&block)
+          server = server(**kwargs,&block)
+          server.close()
+          return nil
+        end
+
+        #
+        # Creates a new UDPServer listening on a given host and port,
+        # accepting messages from clients in a loop.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional arguments for {server}.
+        #
+        # @option kwargs [Integer, nil] :port
+        #   The local port to bind to.
+        #
+        # @option kwargs [String, nil] :host
+        #   The host to bind to.
+        #
+        # @yield [server, (client_host, client_port), mesg]
+        #   The given block will be passed the client host/port and the
+        #   received message.
+        #
+        # @yieldparam [UDPServer] server
+        #   The UDPServer.
+        #
+        # @yieldparam [String] client_host
+        #   The source host of the message.
+        #
+        # @yieldparam [Integer] client_port
+        #   The source port of the message.
+        #
+        # @yieldparam [String] mesg
+        #   The received message.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   UDP.server_loop(port: 1337) do |server,(host,port),mesg|
+        #     server.send('hello',host,port)
+        #   end
+        #
+        # @api public
+        #
+        # @since 0.5.0
+        #
+        def self.server_loop(**kwargs)
+          server_session(**kwargs) do |server|
+            loop do
+              mesg, addrinfo = server.recvfrom(4096)
+
+              yield server, [addrinfo[3], addrinfo[1]], mesg if block_given?
+            end
+          end
+        end
+
+        #
+        # Creates a new UDPServer listening on a given host and port,
+        # accepts only one message from a client.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional arguments for {server}.
+        #
+        # @option kwargs [Integer, nil] :port
+        #   The local port to bind to.
+        #
+        # @option kwargs [String, nil] :host
+        #   The host to bind to.
+        #
+        # @yield [server, (client_host, client_port), mesg]
+        #   The given block will be passed the client host/port and the
+        #   received message.
+        #
+        # @yieldparam [UDPServer] server
+        #   The UDPServer.
+        #
+        # @yieldparam [String] client_host
+        #   The source host of the message.
+        #
+        # @yieldparam [Integer] client_port
+        #   The source port of the message.
+        #
+        # @yieldparam [String] mesg
+        #   The received message.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   UDP.recv(port: 1337) do |server,(host,port),mesg|
+        #     server.send('hello',host,port)
+        #   end
+        #
+        # @api public
+        #
+        # @since 0.5.0
+        #
+        def self.recv(**kwargs)
+          server_session(**kwargs) do |server|
+            mesg, addrinfo = server.recvfrom(4096)
+
+            yield server, [addrinfo[3], addrinfo[1]], mesg if block_given?
+          end
+        end
+      end
+    end
+  end
+end