ronin-support 0.5.1 → 1.0.0.beta1

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

@@ -0,0 +1,443 @@
+# 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/tcp/proxy'
+require 'ronin/support/network/dns/idn'
+
+require 'socket'
+require 'timeout'
+
+module Ronin
+  module Support
+    module Network
+      #
+      # @since 1.0.0
+      #
+      module TCP
+        #
+        # Tests whether a remote TCP 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 TCP port is open.
+        #   If the connection was not accepted, `nil` will be returned.
+        #
+        # @example
+        #   open?('example.com',80)
+        #   # => true
+        #
+        # @example Using a timeout:
+        #   TCP.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
+              socket = connect(host,port,**kwargs)
+              socket.close
+            end
+
+            return true
+          rescue Timeout::Error
+            return nil
+          rescue SocketError, SystemCallError
+            return false
+          end
+        end
+
+        #
+        # Creates a new TCP socket 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 [TCPsocket] socket
+        #   The newly created TCP socket.
+        #
+        # @return [TCPSocket, nil]
+        #   The newly created TCPSocket object. If a block is given a `nil`
+        #   will be returned.
+        #
+        # @example
+        #   TCP.connect('www.example.com',80)
+        #   # => #<TCPSocket:fd 5, AF_INET, 192.168.122.165, 40364>
+        #
+        # @example
+        #   TCP.connect('www.wired.com',80) do |socket|
+        #     socket.write("GET /\n\n")
+        #
+        #     puts socket.readlines
+        #   end
+        #
+        # @see https://rubydoc.info/stdlib/socket/TCPSocket
+        #
+        # @api public
+        #
+        def self.connect(host,port, bind_host: nil, bind_port: nil)
+          host = DNS::IDN.to_ascii(host)
+          port = port.to_i
+
+          socket = if bind_host || bind_port
+                     TCPSocket.new(host,port,bind_host.to_s,bind_port.to_i)
+                   else
+                     TCPSocket.new(host,port)
+                   end
+
+          if block_given?
+            yield socket
+            socket.close
+          else
+            return socket
+          end
+        end
+
+        #
+        # Creates a new TCPSocket object, connected to a given host and port.
+        # The given data will then be written to the newly created TCPSocket.
+        #
+        # @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 [TCPSocket] socket
+        #   The newly created TCPSocket object.
+        #
+        # @return [TCPSocket]
+        #   The newly created TCPSocket 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
+
+        #
+        # 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] :bind_host
+        #   The local host to bind to.
+        #
+        # @option kwargs [Integer] :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.
+        #
+        # @example
+        #   TCP.banner('pop.gmail.com',25)
+        #   # => "220 mx.google.com ESMTP c20sm3096959rvf.1"
+        #
+        # @api public
+        #
+        def self.banner(host,port,**kwargs)
+          banner = nil
+
+          connect(host,port,**kwargs) do |socket|
+            banner = socket.readline.strip
+          end
+
+          yield banner if block_given?
+          return banner
+        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] :bind_host
+        #   The local host to bind to.
+        #
+        # @option kwargs [Integer] :bind_port
+        #   The local port to bind to.
+        #
+        # @return [true]
+        #   The data was successfully sent.
+        #
+        # @example
+        #   buffer = "GET /" + ('A' * 4096) + "\n\r"
+        #   TCP.send(buffer,'victim.com',80)
+        #   # => true
+        #
+        # @api public
+        #
+        def self.send(data,host,port,**kwargs)
+          connect(host,port,**kwargs) do |socket|
+            socket.write(data)
+          end
+
+          return true
+        end
+
+        #
+        # Creates a new TCPServer 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.
+        #
+        # @param [Integer] backlog
+        #   The maximum backlog of pending connections.
+        #
+        # @yield [server]
+        #   The block which will be called after the server has been created.
+        #
+        # @yieldparam [TCPServer] server
+        #   The newly created TCP server.
+        #
+        # @return [TCPServer]
+        #   The new TCP server.
+        #
+        # @example
+        #   server = TCP.server(port: 1337)
+        #
+        # @see https://rubydoc.info/stdlib/socket/TCPServer
+        #
+        # @api public
+        #
+        def self.server(port: 0, host: nil, backlog: 5)
+          server = if host
+                     TCPServer.new(host.to_s,port.to_i)
+                   else
+                     TCPServer.new(port.to_i)
+                   end
+          server.listen(backlog)
+
+          yield server if block_given?
+          return server
+        end
+
+        #
+        # Creates a new temporary TCPServer listening on a host and port.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {server}.
+        #
+        # @option kwargs [Integer, nil] :port (0)
+        #   The local port to bind to.
+        #
+        # @option kwargs [String, nil] :host
+        #   The host to bind to.
+        #
+        # @option kwargs [Integer] :backlog (5)
+        #   The maximum backlog of pending connections.
+        #
+        # @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 [TCPServer] server
+        #   The newly created TCP server.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   TCP.server_session(port: 1337) do |server|
+        #     client1 = server.accept
+        #     client2 = server.accept
+        #
+        #     client2.write(server.read_line)
+        #
+        #     client1.close
+        #     client2.close
+        #   end
+        #
+        # @api public
+        #
+        def self.server_session(**kwargs,&block)
+          server = server(**kwargs,&block)
+          server.close()
+          return nil
+        end
+
+        #
+        # Creates a new TCPServer listening on a given host and port,
+        # accepting clients in a loop.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {server}.
+        #
+        # @option kwargs [Integer, nil] :port (0)
+        #   The local port to bind to.
+        #
+        # @option kwargs [String, nil] :host
+        #   The host to bind to.
+        #
+        # @option kwargs [Integer] :backlog (5)
+        #   The maximum backlog of pending connections.
+        #
+        # @yield [client]
+        #   The given block will be passed the newly connected client.
+        #   After the block has finished, the client will be closed.
+        #
+        # @yieldparam [TCPSocket] client
+        #   A newly connected client.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   TCP.server_loop(port: 1337) do |client|
+        #     client.puts 'lol'
+        #   end
+        #
+        # @api public
+        #
+        # @since 0.5.0
+        #
+        def self.server_loop(**kwargs)
+          server_session(**kwargs) do |server|
+            loop do
+              client = server.accept
+
+              yield client if block_given?
+              client.close
+            end
+          end
+        end
+
+        #
+        # Creates a new TCPServer listening on a given host and port,
+        # accepts only one client and then stops listening.
+        #
+        # @param [Integer] backlog
+        #   The maximum backlog of pending connections.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword 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 [client]
+        #   The given block will be passed the newly connected client.
+        #   After the block has finished, both the client and the server
+        #   will be closed.
+        #
+        # @yieldparam [TCPSocket] client
+        #   The newly connected client.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   TCP.accept(port: 1337) do |client|
+        #     client.puts 'lol'
+        #   end
+        #
+        # @api public
+        #
+        # @since 0.5.0
+        #
+        def self.accept(backlog: 1, **kwargs)
+          server_session(backlog: backlog, **kwargs) do |server|
+            client = server.accept
+
+            yield client if block_given?
+            client.close
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/network/telnet/mixin.rb

@@ -0,0 +1,150 @@
+# 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/telnet'
+require 'ronin/support/network/dns/idn'
+
+module Ronin
+  module Support
+    module Network
+      #
+      # Provides helper methods for communicating with Telnet services.
+      #
+      # @deprecated Will be removed in 1.0.0.
+      #
+      module Telnet
+        #
+        # Provides helper methods for using the Telnet protocol.
+        #
+        module Mixin
+          #
+          # Creates a new Telnet connection.
+          #
+          # @param [String] host
+          #   The host to connect to.
+          #
+          # @param [Integer] port
+          #   The port to connect to.
+          #
+          # @param [Boolean] binmode
+          #   Indicates that newline substitution shall not be performed.
+          #
+          # @param [String, nil] output_log
+          #   The name of the file to write connection status messages and all
+          #   received traffic to.
+          #
+          # @param [String, nil] dump_log
+          #   Similar to the `:output_log` option, but connection output is also
+          #   written in hexdump format.
+          #
+          # @param [Regexp] prompt
+          #   A regular expression matching the host command-line prompt
+          #   sequence, used to determine when a command has finished.
+          #
+          # @param [Boolean] telnet
+          #   Indicates that the connection shall behave as a telnet connection.
+          #
+          # @param [Boolean] plain
+          #   Indicates that the connection shall behave as a normal TCP
+          #   connection.
+          #
+          # @param [Integer] timeout
+          #   The number of seconds to wait before timing out both the initial
+          #   attempt to connect to host, and all attempts to read data from the
+          #   host.
+          #
+          # @param [Integer] wait_time
+          #   The amount of time to wait after seeing what looks like a prompt.
+          #
+          # @param [Net::Telnet, IO, nil] proxy
+          #   A proxy object to used instead of opening a direct connection to
+          #   the host.
+          #
+          # @param [String, nil] user
+          #   The user to login as.
+          #
+          # @param [String, nil] password
+          #   The password to login with.
+          #
+          # @yield [telnet]
+          #   If a block is given, it will be passed the newly created Telnet
+          #   session.
+          #
+          # @yieldparam [Net::Telnet] telnet
+          #   The newly created Telnet session.
+          #
+          # @return [Net::Telnet]
+          #   The Telnet session
+          #
+          # @example
+          #   telnet_connect('towel.blinkenlights.nl')
+          #   # => #<Net::Telnet: ...>
+          #
+          # @example
+          #   telnet_connect('towel.blinkenlights.nl') do |movie|
+          #     movie.each_line { |line| puts line }
+          #   end
+          #
+          # @api public
+          #
+          def telnet_connect(host, # connection options
+                             proxy:     Telnet.proxy,
+                             port:      Telnet::DEFAULT_PORT,
+                             binmode:   false,
+                             wait_time: 0,
+                             prompt:    Telnet::DEFAULT_PROMPT,
+                             timeout:   Telnet.default_timeout,
+                             telnet:    nil,
+                             plain:     nil,
+                             # authentication options
+                             user:     nil,
+                             password: nil,
+                             # log options
+                             output_log: nil,
+                             dump_log:   nil)
+            host = DNS::IDN.to_ascii(host)
+
+            telnet_options = {
+              'Host'       => host,
+              'Port'       => port,
+              'Binmode'    => binmode,
+              'Waittime'   => wait_time,
+              'Prompt'     => prompt,
+              'Timeout'    => timeout
+            }
+
+            telnet_options['Telnetmode'] = true       if (telnet && !plain)
+            telnet_options['Output_log'] = output_log if output_log
+            telnet_options['Dump_log']   = dump_log   if dump_log
+            telnet_options['Proxy']      = proxy      if proxy
+
+            telnet = Net::Telnet.new(telnet_options)
+            telnet.login(user,password) if user
+
+            if block_given?
+              yield telnet
+              telnet.close
+            else
+              return telnet
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# 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/>.
+#
+
+begin
+  require 'net/telnet'
+rescue LoadError => error
+  warn "ronin/network/telnet requires the net-telnet gem be installed."
+  raise(error)
+end
+
+module Ronin
+  module Support
+    module Network
+      #
+      # Provides helper methods for communicating with Telnet services.
+      #
+      # @deprecated Will be removed in 1.0.0.
+      #
+      module Telnet
+        # Default telnet port
+        DEFAULT_PORT = 23
+
+        # The default prompt regular expression
+        DEFAULT_PROMPT = /[$%#>] \z/n
+
+        # The default timeout
+        DEFAULT_TIMEOUT = 10
+
+        #
+        # @return [Integer]
+        #   The default Ronin Telnet timeout.
+        #
+        # @api public
+        #
+        def self.default_timeout
+          @default_timeout ||= DEFAULT_TIMEOUT
+        end
+
+        #
+        # Sets the default Ronin Telnet timeout.
+        #
+        # @param [Integer] timeout
+        #   The new default Ronin Telnet timeout.
+        #
+        # @api public
+        #
+        def self.default_timeout=(timeout)
+          @default_timeout = timeout
+        end
+
+        #
+        # @return [Telnet, IO, nil]
+        #   The Ronin Telnet proxy.
+        #
+        # @api public
+        #
+        def self.proxy
+          @proxy ||= nil
+        end
+
+        #
+        # Sets the Ronin Telnet proxy.
+        #
+        # @param [Telnet, IO, nil] new_proxy
+        #   The new Ronin Telnet proxy.
+        #
+        # @api public
+        #
+        def self.proxy=(new_proxy)
+          @proxy = new_proxy
+        end
+      end
+    end
+  end
+end