ronin-support 0.4.1 → 0.5.2

data/lib/ronin/network/telnet.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# 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,
+# 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 <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'net/telnet'
@@ -24,6 +24,8 @@ module Ronin
     #
     # Provides helper methods for communicating with Telnet services.
     #
+    # @deprecated Will be removed in 1.0.0.
+    #
     module Telnet
       # Default telnet port
       DEFAULT_PORT = 23
@@ -40,7 +42,7 @@ module Ronin
       #
       # @api public
       #
-      def Telnet.default_port
+      def self.default_port
         @default_port ||= DEFAULT_PORT
       end
 
@@ -52,7 +54,7 @@ module Ronin
       #
       # @api public
       #
-      def Telnet.default_port=(port)
+      def self.default_port=(port)
         @default_port = port
       end
 
@@ -62,7 +64,7 @@ module Ronin
       #
       # @api public
       #
-      def Telnet.default_prompt
+      def self.default_prompt
         @default_prompt ||= DEFAULT_PROMPT
       end
 
@@ -74,7 +76,7 @@ module Ronin
       #
       # @api public
       #
-      def Telnet.default_prompt=(prompt)
+      def self.default_prompt=(prompt)
         @default_prompt = prompt
       end
 
@@ -84,7 +86,7 @@ module Ronin
       #
       # @api public
       #
-      def Telnet.default_timeout
+      def self.default_timeout
         @default_timeout ||= DEFAULT_TIMEOUT
       end
 
@@ -96,7 +98,7 @@ module Ronin
       #
       # @api public
       #
-      def Telnet.default_timeout=(timeout)
+      def self.default_timeout=(timeout)
         @default_timeout = timeout
       end
 
@@ -106,7 +108,7 @@ module Ronin
       #
       # @api public
       #
-      def Telnet.proxy
+      def self.proxy
         @proxy ||= nil
       end
 
@@ -118,7 +120,7 @@ module Ronin
       #
       # @api public
       #
-      def Telnet.proxy=(new_proxy)
+      def self.proxy=(new_proxy)
         @proxy = new_proxy
       end
 
@@ -191,29 +193,33 @@ module Ronin
       # @api public
       #
       def telnet_connect(host,options={})
-        host = host.to_s
-        telnet_options = {}
-
-        telnet_options['Host'] = host
-        telnet_options['Port'] = (options[:port] || Telnet.default_port)
-        telnet_options['Binmode'] = options[:binmode]
-        telnet_options['Output_log'] = options[:output_log]
-        telnet_options['Dump_log'] = options[:dump_log]
-        telnet_options['Prompt'] = (options[:prompt] || Telnet.default_prompt)
+        telnet_options = {
+          'Host'       => host.to_s,
+          'Port'       => (options[:port]      || Telnet.default_port),
+          'Binmode'    => (options[:binmode]   || false),
+          'Waittime'   => (options[:wait_time] || 0),
+          'Prompt'     => (options[:prompt]    || Telnet.default_prompt),
+          'Timeout'    => (options[:timeout]   || Telnet.default_timeout)
+        }
 
         if (options[:telnet] && !options[:plain])
           telnet_options['Telnetmode'] = true
         end
 
-        telnet_options['Timeout'] = (options[:timeout] || Telnet.default_timeout)
-        telnet_options['Waittime'] = options[:wait_time]
-        telnet_options['Proxy'] = (options[:proxy] || Telnet.proxy)
+        if options[:output_log]
+          telnet_options['Output_log'] = options[:output_log]
+        end
+
+        if options[:dump_log]
+          telnet_options['Dump_log'] = options[:dump_log]
+        end
 
-        user = options[:user]
-        passwd = options[:passwd]
+        if (proxy = (options[:proxy] || Telnet.proxy))
+          telnet_options['Proxy'] = proxy
+        end
 
         session = Net::Telnet.new(telnet_options)
-        session.login(user,passwd) if user
+        session.login(options[:user],options[:password]) if options[:user]
 
         yield session if block_given?
         return session

data/lib/ronin/network/udp.rb

@@ -1,285 +1,21 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# 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,
+# 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 <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'socket'
-
-module Ronin
-  module Network
-    #
-    # Provides helper methods for using the UDP protocol.
-    #
-    module UDP
-      #
-      # 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] local_host (nil)
-      #   The local host to bind to.
-      #
-      # @param [Integer] local_port (nil)
-      #   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.
-      #
-      # @example
-      #   udp_connect('www.hackety.org',80)
-      #   # => UDPSocket
-      #
-      # @example
-      #   udp_connect('www.wired.com',80) do |socket|
-      #     puts socket.readlines
-      #   end
-      #
-      # @api public
-      #
-      def udp_connect(host,port,local_host=nil,local_port=0)
-        host       = host.to_s
-        local_host = (local_host || '0.0.0.0').to_s
-
-        socket = UDPSocket.new
-        socket.bind(local_host,local_port) if (local_host && local_port)
-        socket.connect(host,port)
-
-        yield socket if block_given?
-        return socket
-      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] local_host (nil)
-      #   The local host to bind to.
-      #
-      # @param [Integer] local_port (nil)
-      #   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 udp_connect_and_send(data,host,port,local_host=nil,local_port=0)
-        socket = udp_connect(host,port,local_host,local_port)
-        socket.write(data)
-
-        yield socket if block_given?
-        return socket
-      end
-
-      #
-      # Creates a new temporary UDPSocket object, connected to the given host
-      # and port.
-      #
-      # @param [String] host
-      #   The host to connect to.
-      #
-      # @param [Integer] port
-      #   The port to connect to.
-      #
-      # @param [String] local_host (nil)
-      #   The local host to bind to.
-      #
-      # @param [Integer] local_port (nil)
-      #   The local port to bind to.
-      #
-      # @yield [socket]
-      #   If a block is given, it will be passed the newly created socket.
-      #   After the block has returned, the socket will then be closed.
-      #
-      # @yieldparam [UDPsocket] socket
-      #   The newly created UDPSocket object.
-      #
-      # @return [nil]
-      #
-      # @api public
-      #
-      def udp_session(host,port,local_host=nil,local_port=0)
-        socket = udp_connect(host,port,local_host,local_port)
-
-        yield socket if block_given?
-
-        socket.close
-        return nil
-      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] local_host (nil)
-      #   The local host to bind to.
-      #
-      # @param [Integer] local_port (nil)
-      #   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 udp_send(data,host,port,local_host=nil,local_port=0)
-        udp_session(host,port,local_host,local_port) 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 [String] local_host (nil)
-      #   The local host to bind to.
-      #
-      # @param [Integer] local_port (nil)
-      #   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 udp_banner(host,port,local_host=nil,local_port=0)
-        banner = nil
-
-        udp_session(host,port,local_host,local_port) 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] port
-      #   The local port to listen on.
-      #
-      # @param [String] host ('0.0.0.0')
-      #   The host to bind to.
-      #
-      # @return [UDPServer]
-      #   The new UDP server.
-      #
-      # @example
-      #   udp_server(1337)
-      #
-      # @api public
-      #
-      def udp_server(port=0,host=nil)
-        host   = (host || '0.0.0.0').to_s
-        server = UDPSocket.new
-
-        server.bind(host,port)
-
-        yield server if block_given?
-        return server
-      end
-
-      #
-      # Creates a new temporary UDPServer listening on a given host and port.
-      #
-      # @param [Integer] port
-      #   The local port to bind to.
-      #
-      # @param [String] host ('0.0.0.0')
-      #   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(1337) do |server|
-      #     data, sender = server.recvfrom(1024)
-      #   end
-      #
-      # @api public
-      #
-      def udp_server_session(port=0,host=nil,&block)
-        server = udp_server(port,host,&block)
-
-        server.close()
-        return nil
-      end
-    end
-  end
-end
+require 'ronin/network/udp/udp'
+require 'ronin/network/udp/proxy'

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

@@ -0,0 +1,191 @@
+#
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-support.
+#
+# 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/network/proxy'
+
+require 'socket'
+
+module Ronin
+  module Network
+    module UDP
+      #
+      # The UDP Proxy allows for inspecting and manipulating UDP protocols.
+      #
+      # ## Example
+      #
+      #     require 'ronin/network/udp/proxy'
+      #     require 'hexdump'
+      #
+      #     Ronin::Network::UDP::Proxy.start(:port => 1337, :server => ['4.2.2.1', 53]) do |proxy|
+      #       hex = Hexdump::Dumper.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