ronin 0.2.4 → 0.3.0

data/lib/ronin/network/helpers/imap.rb

@@ -0,0 +1,115 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/network/helpers/helper'
+require 'ronin/network/imap'
+
+module Ronin
+  module Network
+    module Helpers
+      module IMAP
+        include Helper
+
+        protected
+
+        #
+        # Creates a connection to the IMAP server. The +@host+, +@port+,
+        # +@imap_auth+, +@imap_user+ and +@imap_password+ instance
+        # variables will also be used to make the connection.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [Integer] :port (IMAP.default_port)
+        #   The port the IMAP server is running on.
+        #
+        # @option options [String] :certs
+        #   The path to the file containing CA certs of the server.
+        #
+        # @option options [Symbol] :auth
+        #   The type of authentication to perform when connecting to the
+        #   server. May be either +:login+ or +:cram_md5+.
+        #
+        # @option options [String] :user
+        #   The user to authenticate as when connecting to the server.
+        #
+        # @option options [String] :password
+        #   The password to authenticate with when connecting to the
+        #   server.
+        #
+        # @option options [Boolean]
+        #   Indicates wether or not to use SSL when connecting to the
+        #   server.
+        #
+        # @since 0.3.0
+        #
+        def imap_connect(options={},&block)
+          require_variable :host
+
+          options[:port] ||= @port
+          options[:auth] ||= @imap_auth
+          options[:user] ||= @imap_user
+          options[:password] ||= @imap_password
+
+          if @port
+            print_info "Connecting to #{@host}:#{@port} ..."
+          else
+            print_info "Connecting to #{@host} ..."
+          end
+
+          return ::Net.imap_connect(@host,options,&block)
+        end
+
+        #
+        # Starts a session with the IMAP server. The +@host+, +@port+,
+        # +@imap_auth+, +@imap_user+ and +@imap_password+ instance
+        # variables will also be used to make the connection.
+        #
+        # @yield [session]
+        #   If a _block_ is given, it will be passed the newly created
+        #   IMAP session. After the _block_ has returned, the session will
+        #   be closed.
+        #
+        # @yieldparam [Net::IMAP] session
+        #   The newly created IMAP session object.
+        #
+        # @see imap_connect
+        # @since 0.3.0
+        #
+        def imap_session(options={},&block)
+          imap_connect(options) do |sess|
+            block.call(sess) if block
+
+            print_info "Logging out ..."
+
+            sess.close
+            sess.logout
+
+            if @port
+              print_info "Disconnecting from #{@host}:#{@port}"
+            else
+              print_info "Disconnecting from #{@host}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/network/helpers/pop3.rb

@@ -0,0 +1,110 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/network/helpers/helper'
+require 'ronin/network/pop3'
+
+module Ronin
+  module Network
+    module Helpers
+      module POP3
+        include Helper
+
+        protected
+
+        #
+        # Creates a connection to the POP3 server. The +@host+, +@port+,
+        # +@pop3_user+ and +@pop3_password+ instance variables will also
+        # be used to connect to the server.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [Integer] :port (Ronin::Network::POP3.default_port)
+        #   The port the POP3 server is running on.
+        #
+        # @option options [String] :user
+        #   The user to authenticate with when connecting to the POP3
+        #   server.
+        #
+        # @option options [String] :password
+        #   The password to authenticate with when connecting to the POP3
+        #   server.
+        #
+        # @yield [session]
+        #   If a _block_ is given, it will be passed the newly created
+        #   POP3 session.
+        #
+        # @yieldparam [Net::POP3] session
+        #   The newly created POP3 session.
+        #
+        # @return [Net::POP3]
+        #   The newly created POP3 session.
+        #
+        # @since 0.3.0
+        #
+        def pop3_connect(options={},&block)
+          require_variable :host
+
+          options[:port] ||= @port
+          options[:user] ||= @pop3_user
+          options[:password] ||= @pop3_password
+
+          if @port
+            print_info "Connecting to #{@host}:#{@port} ..."
+          else
+            print_info "Connecting to #{@host} ..."
+          end
+
+          return ::Net.pop3_connect(@host,options,&block)
+        end
+
+        #
+        # Starts a session with the POP3 server. The +@host+, +@port+,
+        # +@pop3_user+ and +@pop3_password+ instance variables will
+        # also be used to connect to the server.
+        #
+        # @yield [session]
+        #   If a _block_ is given, it will be passed the newly created
+        #   POP3 session. After the _block_ has returned, the session
+        #   will be closed.
+        #
+        # @yieldparam [Net::POP3] session
+        #   The newly created POP3 session.
+        #
+        # @see pop3_connect
+        # @since 0.3.0
+        #
+        def pop3_session(options={},&block)
+          pop3_connect(options) do |sess|
+            block.call(sess) if block
+            sess.finish
+
+            if @port
+              print_info "Disconnecting to #{@host}:#{@port}"
+            else
+              print_info "Disconnecting to #{@host}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/network/helpers/smtp.rb

@@ -0,0 +1,123 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/network/helpers/helper'
+require 'ronin/network/smtp'
+
+module Ronin
+  module Network
+    module Helpers
+      module SMTP
+        include Helper
+
+        protected
+
+        #
+        # @see Ronin::Network::SMTP.message
+        #
+        # @since 0.3.0
+        #
+        def smtp_message(options={},&block)
+          Network::SMTP.message(options,&block)
+        end
+
+        #
+        # Creates a connection to the SMTP server. The +@host+, +@port+,
+        # +@smtp_login+, +@smtp_user+ and +@smtp_password+ instance
+        # variables will also be used to connect to the server.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [Integer] :port (Ronin::Network::SMTP.default_port)
+        #   The port to connect to.
+        #
+        # @option options [String] :helo
+        #   The HELO domain.
+        #
+        # @option options [Symbol] :auth
+        #   The type of authentication to use. Can be either +:login+,
+        #   +:plain+ or +:cram_md5+.
+        #
+        # @option options [String] :user
+        #   The user-name to authenticate with.
+        #
+        # @option options [String] :password
+        #   The password to authenticate with.
+        #
+        # @yield [session]
+        #   If a block is given, it will be passed an SMTP session object.
+        #
+        # @yieldparam [Net::SMTP] session
+        #   The SMTP session.
+        #
+        # @return [Net::SMTP]
+        #   The SMTP session.
+        #
+        # @since 0.3.0
+        #
+        def smtp_connect(options={},&block)
+          require_variable :host
+
+          options[:port] ||= @port
+          options[:login] ||= @smtp_login
+          options[:user] ||= @smtp_user
+          options[:password] ||= @smtp_password
+
+          if @port
+            print_info "Connecting to #{@host}:#{@port} ..."
+          else
+            print_info "Connecting to #{@host} ..."
+          end
+
+          return ::Net.smtp_connect(@host,options,&block)
+        end
+
+        #
+        # Starts a session with the SMTP server. The +@host+, +@port+,
+        # +@smtp_login+, +@smtp_user+ and +@smtp_password+ instance
+        # variables will also be used to connect to the server.
+        #
+        # @yield [session]
+        #   If a block is given, it will be passed an SMTP session object.
+        #   After the block has returned, the session will be closed.
+        #
+        # @yieldparam [Net::SMTP] session
+        #   The SMTP session.
+        #
+        # @see smtp_connect
+        # @since 0.3.0
+        #
+        def smtp_session(options={},&block)
+          smtp_connect(options) do |sess|
+            block.call(sess) if block
+            sess.close
+
+            if @port
+              print_info "Disconnecting to #{@host}:#{@port}"
+            else
+              print_info "Disconnecting to #{@host}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,309 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/network/helpers/helper'
+require 'ronin/network/tcp'
+
+module Ronin
+  module Network
+    module Helpers
+      module TCP
+        include Helper
+
+        protected
+
+        #
+        # Opens a TCP connection to the host and port specified by the
+        # +@host+ and +@port+ instance variables. If the +@local_host+ and
+        # +@local_port+ instance variables are set, they will be used for
+        # the local host and port of the TCP connection.
+        #
+        # @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.
+        #
+        # @example
+        #   tcp_connect # => TCPSocket
+        #
+        # @example
+        #   tcp_connect do |sock|
+        #     sock.write("GET /\n\n")
+        #     puts sock.readlines
+        #     sock.close
+        #   end
+        #
+        # @since 0.3.0
+        #
+        def tcp_connect(&block)
+          require_variable :host
+          require_variable :port
+
+          print_info "Connecting to #{@host}:#{@port} ..."
+
+          return ::Net.tcp_connect(@host,@port,@local_host,@local_port,&block)
+        end
+
+        #
+        # Connects to the host and port specified by the +@host+ and +@port+
+        # instance variables, then sends the specified _data_.
+        #
+        # @param [String] data
+        #   The data to send through the connection.
+        #
+        # @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.
+        #
+        # @since 0.3.0
+        #
+        def tcp_connect_and_send(data,&block)
+          require_variable :host
+          require_variable :port
+
+          print_info "Connecting to #{@host}:#{@port} ..."
+          print_debug "Sending data: #{data.inspect}"
+
+          return ::Net.tcp_connect_and_send(data,@host,@port,@local_host,@local_port,&block)
+        end
+
+        #
+        # Creates a TCP session to the host and port specified by the
+        # +@host+ and +@port+ instance variables.
+        #
+        # @yield [socket]
+        #   If a block is given, it will be passed the newly created socket.
+        #   After the block has returned, the socket will be closed.
+        #
+        # @yieldparam [TCPsocket] socket
+        #   The newly created TCPSocket object.
+        #
+        # @since 0.3.0
+        #
+        def tcp_session(&block)
+          require_variable :host
+          require_variable :port
+
+          print_info "Connecting to #{@host}:#{@port} ..."
+
+          Net.tcp_session(@host,@port,@local_host,@local_port,&block)
+
+          print_info "Disconnected from #{@host}:#{@port}"
+          return nil
+        end
+
+        #
+        # Connects to the host and port specified by the +@host+ and +@port+
+        # instance variables, reads the banner then closes the connection.
+        #
+        # @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
+        #   # => "220 mx.google.com ESMTP c20sm3096959rvf.1"
+        #
+        # @since 0.3.0
+        #
+        def tcp_banner(&block)
+          require_variable :host
+          require_variable :port
+
+          print_debug "Grabbing banner from #{@host}:#{@port}"
+
+          return ::Net.tcp_banner(@host,@port,@local_host,@local_port,&block)
+        end
+
+        #
+        # Connects to the host and port specified by the +@host+ and +@port+
+        # instance variables, sends the specified _data_ and then closes the
+        # connection.
+        #
+        # @return [true]
+        #   The data was successfully sent.
+        #
+        # @example
+        #   buffer = "GET /" + ('A' * 4096) + "\n\r"
+        #   Net.tcp_send(buffer)
+        #   # => true
+        #
+        # @since 0.3.0
+        #
+        def tcp_send(data)
+          require_variable :host
+          require_variable :port
+
+          print_info "Connecting to #{@host}:#{@port} ..."
+          print_debug "Sending data: #{data.inspect}"
+
+          ::Net.tcp_send(data,@host,@port,@local_host,@local_port)
+
+          print_info "Disconnected from #{@host}:#{@port}"
+          return true
+        end
+
+        #
+        # Creates a new TCPServer object listening on the +@server_host+
+        # and +@server_port+ instance variables.
+        #
+        # @yield [server]
+        #   The given block will be passed the newly created server.
+        #
+        # @yieldparam [TCPServer] server
+        #   The newly created server.
+        #
+        # @return [TCPServer]
+        #   The newly created server.
+        #
+        # @example
+        #   tcp_server
+        #
+        # @since 0.3.0
+        #
+        def tcp_server(&block)
+          require_variable :server_port
+
+          if @server_host
+            print_info "Listening on #{@server_host}:#{@server_port} ..."
+          else
+            print_info "Listening on #{@server_port} ..."
+          end
+
+          return ::Net.tcp_server(@server_port,@server_host,&block)
+        end
+
+        #
+        # Creates a new TCPServer object listening on the +@server_host+
+        # and +@server_port+ instance variables, passing it to the given
+        # _block_ then closing the server.
+        #
+        # @yield [server]
+        #   The given block will be passed the newly created server.
+        #   When the block has finished, the server will be closed.
+        #
+        # @yieldparam [TCPServer] server
+        #   The newly created server.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   tcp_server_session do |server|
+        #     client1 = server.accept
+        #     client2 = server.accept
+        #
+        #     client2.write(server.read_line)
+        #
+        #     client1.close
+        #     client2.close
+        #   end
+        #
+        # @since 0.3.0
+        #
+        def tcp_server_session(&block)
+          require_variable :server_port
+
+          if @server_host
+            print_info "Listening on #{@server_host}:#{@server_port} ..."
+          else
+            print_info "Listening on #{@server_port} ..."
+          end
+
+          ::Net.tcp_server_session(&block)
+
+          if @server_host
+            print_info "Closed #{@server_host}:#{@server_port}"
+          else
+            print_info "Closed #{@server_port}"
+          end
+
+          return nil
+        end
+
+        #
+        # Creates a new TCPServer object listening on +@server_host+
+        # and +@server_port+ instance variables, accepts one client passing
+        # it to the given _block_, then closes both the newly connected
+        # client and the server.
+        #
+        # @yield [client]
+        #   The given block will be passed the newly connected client.
+        #   When the block has finished, the newly connected client and
+        #   the server will be closed.
+        #
+        # @yieldparam [TCPSocket] client
+        #   The newly connected client.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   tcp_single_server do |client|
+        #     client.puts 'lol'
+        #   end
+        #
+        # @since 0.3.0
+        #
+        def tcp_single_server(&block)
+          require_variable :server_port
+
+          if @server_host
+            print_info "Listening on #{@server_host}:#{@server_port} ..."
+          else
+            print_info "Listening on #{@server_port} ..."
+          end
+
+          ::Net.tcp_single_server do |client|
+            client_addr = client.peeraddr
+            client_host = (client_addr[2] || client_addr[3])
+            client_port = client_addr[1]
+
+            print_info "Client connected #{client_host}:#{client_port}"
+
+            block.call(client) if block
+
+            print_info "Disconnecting client #{client_host}:#{client_port}"
+          end
+
+          if @server_host
+            print_info "Closed #{@server_host}:#{@server_port}"
+          else
+            print_info "Closed #{@server_port}"
+          end
+
+          return nil
+        end
+      end
+    end
+  end
+end