ronin-support 0.4.1 → 0.5.2

data/lib/ronin/network/mixins/imap.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 'ronin/network/mixins/mixin'

data/lib/ronin/network/mixins/mixin.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 'ronin/ui/output/helpers'

data/lib/ronin/network/mixins/pop3.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 'ronin/network/mixins/mixin'

data/lib/ronin/network/mixins/smtp.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 'ronin/network/mixins/mixin'

data/lib/ronin/network/mixins/ssl.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 'ronin/network/mixins/mixin'

data/lib/ronin/network/mixins/tcp.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 'ronin/network/mixins/mixin'
@@ -64,6 +64,29 @@ module Ronin
 
         protected
 
+        #
+        # Tests whether the TCP port, specified by the `host` and `port`
+        # parameters, is open.
+        #
+        # @param [Integer] timeout (5)
+        #   The maximum time to attempt connecting.
+        #
+        # @return [Boolean, nil]
+        #   Specifies whether the remote TCP port is open.
+        #   If the connection was not accepted, `nil` will be returned.
+        #
+        # @see Network::TCP#tcp_open?
+        #
+        # @api public
+        #
+        # @since 0.5.0
+        #
+        def tcp_open?(timeout=nil)
+          print_info "Testing if #{host_port} is open ..."
+
+          super(self.host,self.port,self.local_host,self.local_port,timeout)
+        end
+
         #
         # Opens a TCP connection to the host and port specified by the
         # `host` and `port` parameters. If the `local_host` and
@@ -147,7 +170,7 @@ module Ronin
         def tcp_session(&block)
           print_info "Connecting to #{host_port} ..."
 
-          Net.tcp_session(self.host,self.port,self.local_host,self.local_port,&block)
+          super(self.host,self.port,self.local_host,self.local_port,&block)
 
           print_info "Disconnected from #{host_port}"
           return nil
@@ -189,7 +212,7 @@ module Ronin
         #
         # @example
         #   buffer = "GET /" + ('A' * 4096) + "\n\r"
-        #   Net.tcp_send(buffer)
+        #   tcp_send(buffer)
         #   # => true
         #
         # @see Network::TCP#tcp_send
@@ -287,15 +310,17 @@ module Ronin
         # @return [nil]
         #
         # @example
-        #   tcp_single_server do |client|
+        #   tcp_accept do |client|
         #     client.puts 'lol'
         #   end
         #
-        # @see Network::TCP#tcp_server_single_server
+        # @see Network::TCP#tcp_accept
         #
         # @api public
         #
-        def tcp_single_server(&block)
+        # @since 0.5.0
+        #
+        def tcp_accept(&block)
           print_info "Listening on #{server_host_port} ..."
 
           super(self.server_port,self.server_host) do |client|
@@ -314,6 +339,14 @@ module Ronin
           return nil
         end
 
+        #
+        # @deprecated
+        #   Deprecated as of 0.5.0. Use {#tcp_accept} instead.
+        #
+        def tcp_single_server(&block)
+          tcp_accept(&block)
+        end
+
         private
 
         #

data/lib/ronin/network/mixins/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 'ronin/network/mixins/mixin'

data/lib/ronin/network/mixins/udp.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 'ronin/network/mixins/mixin'
@@ -64,6 +64,27 @@ module Ronin
 
         protected
 
+        #
+        # Tests whether the UDP port, specified by the `host` and `port`
+        # parameters, is open.
+        #
+        # @param [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.
+        #
+        # @api public
+        #
+        # @since 0.5.0
+        #
+        def udp_open?(timeout=nil)
+          print_info "Testing if #{host_port} is open ..."
+
+          super(self.host,self.port,self.local_host,self.local_port,timeout)
+        end
+
         #
         # Opens a UDP connection to the host and port specified by the
         # `host` and `port` parameters. If the `local_host` and
@@ -164,7 +185,7 @@ module Ronin
         #
         # @example
         #   buffer = "GET /" + ('A' * 4096) + "\n\r"
-        #   Net.udp_send(buffer)
+        #   udp_send(buffer)
         #   # => true
         #
         # @see Network::UDP#udp_send
@@ -240,6 +261,105 @@ module Ronin
           return nil
         end
 
+        #
+        # Creates a new UDPServer listening on the `server_host` and
+        # `server_port` parameters, accepting messages from clients in a loop.
+        #
+        # @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 mesg.
+        #
+        # @yieldparam [Integer] client_port
+        #   The source port of the mesg.
+        #
+        # @yieldparam [String] mesg
+        #   The received message.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   udp_server_loop do |server,(host,port),mesg|
+        #     server.send('hello',host,port)
+        #   end
+        #
+        # @see Network::UDP#udp_server_loop
+        #
+        # @api public
+        #
+        # @since 0.5.0
+        #
+        def udp_server_loop(&block)
+          print_info "Listening on #{self.server_host_port} ..."
+
+          super(self.server_port,self.server_host,&block)
+
+          print_info "Closed #{self.server_host_port}"
+          return nil
+        end
+
+        #
+        # Creates a new UDPServer listening on the `server_host` and
+        # `server_port` parameters, accepts only one message from a client.
+        #
+        # @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 mesg.
+        #
+        # @yieldparam [Integer] client_port
+        #   The source port of the mesg.
+        #
+        # @yieldparam [String] mesg
+        #   The received message.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   udp_recv do |server,(host,port),mesg|
+        #     server.send('hello',host,port)
+        #   end
+        #
+        # @see Network::UDP#udp_recv
+        #
+        # @api public
+        #
+        # @since 0.5.0
+        #
+        def udp_recv(&block)
+          print_info "Listening on #{self.server_host_port} ..."
+
+          super(self.server_port,self.server_host) do |server,(host,port),mesg|
+            print_info "Received message from #{host}:#{port}"
+            print_debug mesg
+
+            yield server, [host, port], mesg if block_given?
+          end
+
+          print_info "Closed #{self.server_host_port}"
+          return nil
+        end
+
+        #
+        # @deprecated
+        #   Deprecated as of 0.5.0. Use {#udp_recv} instead.
+        #
+        # @since 0.5.0
+        #
+        def udp_single_server(&block)
+          udp_recv(&block)
+        end
+
         private
 
         #

data/lib/ronin/network/mixins/unix.rb

@@ -0,0 +1,279 @@
+#
+# 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/mixins/mixin'
+require 'ronin/network/unix'
+
+module Ronin
+  module Network
+    module Mixins
+      #
+      # Adds UNIX Socket convenience methods and connection parameters to a
+      # class.
+      #
+      # Defines the following parameters:
+      #
+      # * `path` (`String`) - UNIX Socket path.
+      #
+      # @since 0.5.0
+      #
+      module UNIX
+        include Mixin, Network::UNIX
+
+        # UNIX path
+        parameter :path, :type        => String,
+                         :description => 'UNIX Socket path'
+
+        protected
+
+        #
+        # Connects to a UNIX socket specified by the `path` parameter.
+        #
+        # @yield [socket]
+        #   If a block is given, it will be passed an UNIX socket object.
+        #
+        # @yieldparam [UNIXSocket] socket
+        #   The UNIX socket.
+        #
+        # @return [UNIXSocket]
+        #   The UNIX socket.
+        #
+        # @example
+        #   socket = unix_connect
+        #
+        # @see Network::UNIX#unix_connect
+        #
+        # @api public
+        #
+        def unix_connect(&block)
+          print_info "Connecting to #{self.path} ..."
+
+          super(self.path,&block)
+        end
+
+        #
+        # Creates a new UNIXSocket object, connected to the `path` parameter.
+        # The given data will then be written to the newly created UNIXSocket.
+        #
+        # @param [String] data
+        #   The data to send to the socket.
+        #
+        # @yield [socket]
+        #   If a block is given, it will be passed the newly created socket.
+        #
+        # @yieldparam [UNIXSocket] socket
+        #   The newly created UNIXSocket object.
+        #
+        # @return [UNIXSocket]
+        #   The newly created UNIXSocket object.
+        #
+        # @see Network::UNIX#unix_connect_and_send
+        #
+        # @api public
+        #
+        def unix_connect_and_send(data,&block)
+          print_info "Connecting to #{self.path} ..."
+          print_debug "Sending data: #{data.inspect}"
+
+          return super(data,self.path,&block)
+        end
+
+        #
+        # Creates a UNIX session to the host and port specified by the
+        # `host` and `port` parameters. If the `local_host` and `local_port`
+        # parameters are set, they will be used for the local host and port
+        # of the UNIX connection.
+        #
+        # @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 [UNIXsocket] socket
+        #   The newly created UNIXSocket object.
+        #
+        # @see Network::UNIX#unix_session
+        #
+        # @api public
+        #
+        def unix_session(&block)
+          print_info "Connecting to #{self.path} ..."
+
+          super(self.host,&block)
+
+          print_info "Disconnected from #{self.path}"
+          return nil
+        end
+
+        #
+        # Connects to the UNIX socket, specified by the `path` parameter,
+        # sends the given data and then disconnects.
+        #
+        # @param [String] data
+        #   The data to send to the UNIX socket.
+        #
+        # @return [true]
+        #   The data was successfully sent.
+        #
+        # @example
+        #   buffer = "GET /" + ('A' * 4096) + "\n\r"
+        #   unix_send(buffer)
+        #   # => true
+        #
+        # @see Network::UNIX#unix_send
+        #
+        # @api public
+        #
+        # @since 0.4.0
+        #
+        def unix_send(data)
+          print_info "Connecting to #{self.path} ..."
+          print_debug "Sending data: #{data.inspect}"
+
+          super(data,self.path,&block)
+
+          print_info "Disconnected from #{self.path}"
+          return true
+        end
+
+        #
+        # Opens a UNIX socket, listening on the `path` parameter.
+        #
+        # @yield [server]
+        #   The given block will be passed the newly created server.
+        #
+        # @yieldparam [UNIXServer] server
+        #   The newly created server.
+        #
+        # @return [UNIXServer]
+        #   The newly created server.
+        #
+        # @example
+        #   unix_server
+        #
+        # @see Network::UNIX#unix_server
+        #
+        # @api public
+        #
+        def unix_server(&block)
+          print_info "Listening on #{self.path} ..."
+
+          return super(self.path,&block)
+        end
+
+        #
+        # Opens a UNIX socket temporarily, listening on the `path` parameter.
+        #
+        # @yield [server]
+        #   The given block will be passed the newly created server.
+        #   When the block has finished, the server will be closed.
+        #
+        # @yieldparam [UNIXServer] server
+        #   The newly created server.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   unix_server_session do |server|
+        #     # ...
+        #   end
+        #
+        # @see Network::UNIX#unix_server_session
+        #
+        # @api public
+        #
+        def unix_server_session(&block)
+          print_info "Listening on #{self.path} ..."
+
+          super(self.path,&block)
+
+          print_info "Closed #{self.path}"
+          return nil
+        end
+
+        #
+        # Opens a UNIX socket specified by the `path` parameter,
+        # accepts a connection, then closes the socket.
+        #
+        # @yield [client]
+        #   If a block is given, it will be passed the accepted connection.
+        #
+        # @yieldparam [UNIXSocket] client
+        #   The accepted connection to UNIX socket.
+        #
+        # @example
+        #   unix_accept do |client|
+        #     # ...
+        #   end
+        #
+        # @see Network::UNIX#unix_accept
+        #
+        # @api public
+        #
+        def unix_accept
+          print_info "Listening on #{self.path} ..."
+
+          super(self.path) do |client|
+            print_info "Client connected to #{self.path}"
+
+            yield client if block_given?
+
+            print_info "Client disconnecting from #{self.path} ..."
+          end
+
+          print_info "Closed #{self.path}"
+          return nil
+        end
+
+        #
+        # Opens a UNIX socket specified by the `path` parameter,
+        # accepts connections in a loop.
+        #
+        # @yield [client]
+        #   If a block is given, it will be passed each accepted connection.
+        #
+        # @yieldparam [UNIXSocket] client
+        #   An accepted connection to UNIX socket.
+        #
+        # @example
+        #   unix_server_loop do |client|
+        #     # ...
+        #   end
+        #
+        # @see Network::UNIX#unix_server_loop
+        #
+        # @api public
+        #
+        def unix_server_loop
+          print_info "Listening on #{self.path} ..."
+
+          super(self.path) do |client|
+            print_info "Client connected: #{self.path}"
+
+            yield client if block_given?
+
+            print_info "Client disconnecting: #{self.path} ..."
+          end
+
+          print_info "Closed #{self.path}"
+          return nil
+        end
+      end
+    end
+  end
+end