ronin-support 0.4.1 → 0.5.0.rc1

data/lib/ronin/network/http/http.rb

@@ -27,7 +27,6 @@ require 'net/http'
 begin
   require 'net/https'
 rescue ::LoadError
-  $stderr.puts "WARNING: could not load 'net/https'"
 end
 
 module Ronin
@@ -51,7 +50,7 @@ module Ronin
       #
       # @api public
       #
-      def HTTP.proxy
+      def self.proxy
         @proxy ||= if ENV['HTTP_PROXY']
                      Proxy.parse(ENV['HTTP_PROXY'])
                    else
@@ -74,7 +73,7 @@ module Ronin
       #
       # @api public
       #
-      def HTTP.proxy=(new_proxy)
+      def self.proxy=(new_proxy)
         @proxy = Proxy.create(new_proxy)
       end
 
@@ -86,7 +85,7 @@ module Ronin
       #
       # @api public
       #
-      def HTTP.user_agent
+      def self.user_agent
         @user_agent ||= nil
       end
 
@@ -98,7 +97,7 @@ module Ronin
       #
       # @api public
       #
-      def HTTP.user_agent=(agent)
+      def self.user_agent=(agent)
         @user_agent = agent
       end
 
@@ -113,7 +112,7 @@ module Ronin
       #
       # @api private
       #
-      def HTTP.expand_url(url)
+      def self.expand_url(url)
         new_options = {}
 
         url = case url
@@ -155,7 +154,7 @@ module Ronin
       # @option options [String] :host
       #   The host to connect to.
       #
-      # @option options [String] :port (::Net::HTTP.default_port)
+      # @option options [String] :port (Net::HTTP.default_port)
       #   The port to connect to.
       #
       # @option options [String] :user
@@ -175,7 +174,7 @@ module Ronin
       #
       # @api private
       #
-      def HTTP.expand_options(options={})
+      def self.expand_options(options={})
         new_options = options.dup
 
         new_options[:port] ||= Net::HTTP.default_port
@@ -210,7 +209,7 @@ module Ronin
       #
       # @api private
       #
-      def HTTP.header_name(name)
+      def self.header_name(name)
         words = name.to_s.split(/[\s+_-]/)
 
         words.each { |word| word.capitalize! }
@@ -229,11 +228,11 @@ module Ronin
       #
       # @api private
       #
-      def HTTP.headers(options={})
+      def self.headers(options={})
         headers = {}
 
-        if HTTP.user_agent
-          headers['User-Agent'] = HTTP.user_agent
+        if user_agent
+          headers['User-Agent'] = user_agent
         end
 
         if options
@@ -292,7 +291,7 @@ module Ronin
       #
       # @api private
       #
-      def HTTP.request(options={})
+      def self.request(options={})
         unless options[:method]
           raise(ArgumentError,"the :method option must be specified")
         end
@@ -303,7 +302,7 @@ module Ronin
           raise(UnknownRequest,"unknown HTTP request type #{name.dump}")
         end
 
-        headers = HTTP.headers(options[:headers])
+        headers = headers(options[:headers])
         path    = (options[:path] || '/').to_s
         query   = if options[:query]
                     URI.escape(options[:query])

data/lib/ronin/network/imap.rb

@@ -36,7 +36,7 @@ module Ronin
       #
       # @api public
       #
-      def IMAP.default_port
+      def self.default_port
         @default_port ||= DEFAULT_PORT
       end
 
@@ -48,7 +48,7 @@ module Ronin
       #
       # @api public
       #
-      def IMAP.default_port=(port)
+      def self.default_port=(port)
         @default_port = port
       end
 
@@ -90,19 +90,20 @@ module Ronin
       # @api public
       #
       def imap_connect(host,options={})
-        host = host.to_s
-        port = (options[:port] || IMAP.default_port)
-        certs = options[:certs]
-        auth = options[:auth]
-        user = options[:user]
+        host   = host.to_s
+        port   = (options[:port] || IMAP.default_port)
+        certs  = options[:certs]
+        auth   = options[:auth]
+        user   = options[:user]
         passwd = options[:password]
 
         if options[:ssl]
-          ssl = true
-          ssl_certs = options[:ssl][:certs]
+          ssl        = true
+          ssl_certs  = options[:ssl][:certs]
           ssl_verify = SSL::VERIFY[options[:ssl][:verify]]
         else
-          ssl = false
+          ssl        = false
+          ssl_certs  = nil
           ssl_verify = false
         end
 

data/lib/ronin/network/mixins.rb

@@ -25,4 +25,5 @@ require 'ronin/network/mixins/esmtp'
 require 'ronin/network/mixins/pop3'
 require 'ronin/network/mixins/imap'
 require 'ronin/network/mixins/telnet'
+require 'ronin/network/mixins/ftp'
 require 'ronin/network/mixins/http'

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

@@ -0,0 +1,155 @@
+#
+# Copyright (c) 2006-2012 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 <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/network/mixins/mixin'
+require 'ronin/network/ftp'
+
+module Ronin
+  module Network
+    module Mixins
+      #
+      # Adds FTP convenience methods and connection parameters to a class.
+      #
+      # Defines the following parameters:
+      #
+      # * `host` (`String`) - FTP host.
+      # * `port` (`Integer`) - FTP port.
+      # * `ftp_user` (`String`) - FTP user to login as.
+      # * `ftp_password` (`String`) - FTP password to login with.
+      # * `ftp_account` (`String`) - FTP account information to send.
+      #
+      # @since 0.5.0
+      #
+      module FTP
+        include Mixin, Network::FTP
+
+        # FTP host
+        parameter :host, :type => String,
+                         :description => 'FTP host'
+
+        # FTP port
+        parameter :port, :type => Integer,
+                         :description => 'FTP port'
+
+        # FTP user to login as
+        parameter :ftp_user, :type => String,
+                              :description => 'FTP user to login as'
+
+        # FTP password to login with
+        parameter :ftp_password, :type => String,
+                                  :description => 'FTP password to login with'
+
+        # FTP account information to send
+        parameter :ftp_password, :type => String,
+                                  :description => 'FTP account information'
+
+        protected
+
+        #
+        # Creates a connection to the FTP server. The `host`, `port`,
+        # `ftp_user`, `ftp_password` and `ftp_account` parameters
+        # will also be used to connect to the server.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [Integer] :port (Network::FTP.default_port)
+        #   The port to connect to.
+        #
+        # @option options [String] :user
+        #   The username to authenticate with.
+        #
+        # @option options [String] :password
+        #   The password to authenticate with.
+        #
+        # @option options [String] :account
+        #   The account information to send via the FTP `ACCT` command.
+        #
+        # @yield [session]
+        #   If a block is given, it will be passed an FTP session object.
+        #
+        # @yieldparam [Net::FTP] session
+        #   The FTP session.
+        #
+        # @return [Net::FTP]
+        #   The FTP session.
+        #
+        # @see Network::FTP#ftp_connect
+        #
+        # @api public
+        #
+        def ftp_connect(options={},&block)
+          print_info "Connecting to #{host_port} ..."
+
+          return super(self.host,ftp_merge_options(options),&block)
+        end
+
+        #
+        # Starts a session with the FTP server. The `host`, `port`,
+        # `ftp_login`, `ftp_user` and `ftp_password` parameters
+        # will also be used to connect to the server.
+        #
+        # @yield [session]
+        #   If a block is given, it will be passed an FTP session object.
+        #   After the block has returned, the session will be closed.
+        #
+        # @yieldparam [Net::FTP] session
+        #   The FTP session.
+        #
+        # @see Network::FTP#ftp_session
+        #
+        # @api public
+        #
+        def ftp_session(options={},&block)
+          super(ftp_merge_options(options)) do |sess|
+            yield sess if block_given?
+
+            print_info "Logging out ..."
+          end
+
+          print_info "Disconnected to #{host_port}"
+          return nil
+        end
+
+        private
+
+        #
+        # Merges the FTP parameters into the options for {Network::FTP}
+        # methods.
+        #
+        # @param [Hash] options
+        #   The original options.
+        #
+        # @return [Hash]
+        #   The merged options.
+        #
+        # @api private
+        #   
+        def ftp_merge_options(options={})
+          options[:port]     ||= self.port
+          options[:user]     ||= self.ftp_user
+          options[:password] ||= self.ftp_password
+          options[:account]  ||= self.ftp_account
+
+          return options
+        end
+      end
+    end
+  end
+end

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

@@ -130,7 +130,7 @@ module Ronin
         #
         # @example
         #   ssl_session do |socket|
-        #     socket.write("GET / HTTP/1.1\n\r\n\r")
+        #     socket.write("GET /\n\n")
         #
         #     socket.each_line { |line| puts line }
         #   end

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

@@ -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
@@ -84,7 +107,7 @@ module Ronin
         #
         # @example
         #   tcp_connect do |socket|
-        #     socket.write("GET / HTTP/1.1\n\r\n\r")
+        #     socket.write("GET /\n\n")
         #
         #     puts socket.readlines
         #     socket.close
@@ -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/udp.rb

@@ -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
 
         #