ronin 0.2.4 → 0.3.0

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

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/extensions/imap/net'

data/lib/ronin/network/extensions/imap/net.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/imap'
@@ -27,22 +24,39 @@ require 'net/imap'
 
 module Net
   #
-  # Connects to the IMAP server on the specified _host_ with the given
-  # _options_. If a _block_ is given, it will be passed the newly created
-  # Net::Imap object.
-  #
-  # _options_ may contain the following keys:
-  # <tt>:port</tt>:: The port the IMAP server is running on. Defaults to
-  #                  IMAP.default_port.
-  # <tt>:certs</tt>:: The path to the file containing CA certs of the server.
-  # <tt>:auth</tt>:: The type of authentication to perform when connecting
-  #                  to the server. May be either :login, or :cram_md5.
-  # <tt>:user</tt>:: The user to authenticate as when connecting to the
-  #                  server.
-  # <tt>:password</tt>:: The password to authenticate with when connecting
-  #                      to the server.
-  # <tt>:ssl</tt>:: Indicates wether or not to use SSL when connecting to
-  #                 the server.
+  # Creates a connection to the IMAP server.
+  #
+  # @param [String] host
+  #   The host to connect to.
+  #
+  # @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.
+  #
+  # @yield [session]
+  #   If a _block_ is given, it will be passed the newly created IMAP
+  #   session.
+  #
+  # @yieldparam [Net::IMAP] session
+  #   The newly created IMAP session object.
+  #
+  # @return [Net::IMAP]
+  #   The newly created IMAP session object.
   #
   def Net.imap_connect(host,options={},&block)
     port = (options[:port] || Ronin::Net::IMAP.default_port)
@@ -75,9 +89,22 @@ module Net
   end
 
   #
-  # Starts an IMAP session with the IMAP server running on the specified
-  # _host_ with the given _options_. If a _block_ is given, it will be
-  # called before the session is closed.
+  # Starts an IMAP session with the IMAP server.
+  #
+  # @param [String] host
+  #   The host to connect to.
+  #
+  # @param [Hash] options
+  #   Additional options.
+  #
+  # @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 Net.imap_connect
   #
   def Net.imap_session(host,options={},&block)
     Net.imap_connect(host,options) do |sess|

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

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/extensions/pop3/net'

data/lib/ronin/network/extensions/pop3/net.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/pop3'
@@ -27,17 +24,32 @@ require 'net/pop'
 
 module Net
   #
-  # Connects to the POP3 server on the specified _host_ using the given
-  # _options_. If a _block_ is given, it will be passed the newly created
-  # <tt>Net::POP3</tt> object.
+  # Creates a connection to the POP3 server.
   #
-  # _options_ may contain the following keys:
-  # <tt>:port</tt>:: The port the POP3 server is running on. Defaults to
-  #                  <tt>Ronin::Network::POP3.default_port</tt>.
-  # <tt>:user</tt>:: The user to authenticate with when connecting to the
-  #                  POP3 server.
-  # <tt>:password</tt>:: The password to authenticate with when connecting
-  #                      to the POP3 server.
+  # @param [String] host
+  #   The host to connect to.
+  #
+  # @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.
   #
   def Net.pop3_connect(host,options={},&block)
     port = (options[:port] || Ronin::Network::POP3.default_port)
@@ -50,9 +62,20 @@ module Net
   end
 
   #
-  # Starts a session with the POP3 server on the specified _host_ using the
-  # given _options_. If a _block_ is given, it will be passed the newly
-  # created <tt>Net::POP3</tt> object before the connection is closed.
+  # Starts a session with the POP3 server.
+  #
+  # @param [String] host
+  #   The host to connect to.
+  #
+  # @param [Hash] options
+  #   Additional options.
+  #
+  # @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.
   #
   def Net.pop3_session(host,options={},&block)
     Net.pop3_connect(host,options) do |sess|

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

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/extensions/smtp/net'

data/lib/ronin/network/extensions/smtp/net.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/smtp/email'
@@ -27,26 +24,45 @@ require 'net/smtp'
 
 module Net
   #
-  # See <tt>Ronin::Network::SMTP.message</tt>.
+  # @see Ronin::Network::SMTP.message
   #
   def Net.smtp_message(options={},&block)
     Ronin::Network::SMTP.message(options,&block)
   end
 
   #
-  # Connects to the SMTP server on the specified _host_ with the given
-  # _options_. If a _block_ is given it will be passed the newly created
-  # <tt>Net::SMTP</tt> object.
+  # Creates a connection to the SMTP server.
   #
-  # _options_ may contain the following keys:
-  # <tt>:port</tt>:: The port to connect to, defaults to
-  #                  <tt>Ronin::Network::SMTP.default_port</tt>.
-  # <tt>:helo</tt>:: The HELO domain.
-  # <tt>:auth</tt>:: The type of authentication to use. Can be
-  #                  either <tt>:login</tt>, <tt>:plain</tt> or
-  #                  <tt>:cram_md5</tt>.
-  # <tt>:user</tt>:: The user name to authenticate with.
-  # <tt>:password</tt>:: The password to authenticate with.
+  # @param [String] host
+  #   The host to connect to.
+  #
+  # @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.
   #
   def Net.smtp_connect(host,options={},&block)
     port = (options[:port] || Ronin::Network::SMTP.default_port)
@@ -64,10 +80,22 @@ module Net
   end
 
   #
-  # Connects to the SMTP server on the specified _host_ with the given
-  # _options_. If a _block_ is given it will be passed the newly created
-  # <tt>Net::SMTP</tt> object. After the <tt>Net::SMTP</tt> object has been
-  # passed to the _block_ it will be closed.
+  # Starts a session with the SMTP server.
+  #
+  # @param [String] host
+  #   The host to connect to.
+  #
+  # @param [Hash] options
+  #   Additional options.
+  #
+  # @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 Net.smtp_connect
   #
   def Net.smtp_session(host,options={},&block)
     Net.smtp_connect(host,options) do |sess|

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

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/extensions/tcp/net'

data/lib/ronin/network/extensions/tcp/net.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,40 +16,81 @@
 # 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 'socket'
 
 module Net
   #
-  # Creates a new TCPSocket object with the specified _rhost_, _rport_
-  # and the given _lhost_ and _lport_. If _block_ is given, it will be
-  # passed the newly created TCPSocket object.
+  # Creates a new TCPSocket object with the specified _host_, _port_
+  # and the given _local_host_ and _local_port_.
   #
+  # @param [String] host
+  #   The host to connect to.
+  #
+  # @param [Integer] port
+  #   The port to connect to.
+  #
+  # @param [String] local_host
+  #   The local host to bind to.
+  #
+  # @param [Integer] local_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.
+  #
+  # @example
   #   Net.tcp_connect('www.hackety.org',80) # => TCPSocket
   #
+  # @example
   #   Net.tcp_connect('www.wired.com',80) do |sock|
   #     sock.write("GET /\n\n")
   #     puts sock.readlines
   #     sock.close
   #   end
   #
-  def Net.tcp_connect(rhost,rport,lhost=nil,lport=nil,&block)
-    sock = TCPSocket.new(rhost,rport,lhost,lport)
+  def Net.tcp_connect(host,port,local_host=nil,local_port=nil,&block)
+    sock = TCPSocket.new(host,port,local_host,local_port)
     block.call(sock) if block
 
     return sock
   end
 
   #
-  # Creates a new TCPSocket object with the specified _rhost_ 
-  # _rport_, and the given _lhost_ and _lport_. The specified _data_ will
-  # then be written to the newly created TCPSocket. If a _block_ is given
-  # it will be passed the TCPSocket object.
+  # Creates a new TCPSocket object with the specified _host_, _port_, and
+  # the given _local_host_ and _local_port_. The specified _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.
   #
-  def Net.tcp_connect_and_send(data,rhost,rport,lhost=nil,lport=nil,&block)
-    Net.tcp_connect(rhost,rport,lhost,lport) do |sock|
+  # @param [String] local_host
+  #   The local host to bind to.
+  #
+  # @param [Integer] local_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.
+  #
+  def Net.tcp_connect_and_send(data,host,port,local_host=nil,local_port=nil,&block)
+    Net.tcp_connect(host,port,local_host,local_port) do |sock|
       sock.write(data)
 
       block.call(sock) if block
@@ -59,13 +98,32 @@ module Net
   end
 
   #
-  # Creates a new TCPSocket object with the specified _rhost_, _rport_
-  # and the given _lhost_ and _lport_. If _block_ is given, it will be
-  # passed the newly created TCPSocket object. After the TCPSocket object
-  # has been passed to the given _block_ it will be closed.
+  # Creates a new TCPSocket object with the specified _host_, _port_
+  # and the given _local_host_ and _local_port_. If _block_ is given, it
+  # will be passed the newly created TCPSocket object. After the TCPSocket
+  # object has been passed to the given _block_ it will be closed.
+  #
+  # @param [String] host
+  #   The host to connect to.
+  #
+  # @param [Integer] port
+  #   The port to connect to.
+  #
+  # @param [String] local_host
+  #   The local host to bind to.
+  #
+  # @param [Integer] local_port
+  #   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.
   #
-  def Net.tcp_session(rhost,rport,lhost=nil,lport=nil,&block)
-    Net.tcp_connect(rhost,rport,lhost,lport) do |sock|
+  # @yieldparam [TCPsocket] socket
+  #   The newly created TCPSocket object.
+  #
+  def Net.tcp_session(host,port,local_host=nil,local_port=nil,&block)
+    Net.tcp_connect(host,port,local_host,local_port) do |sock|
       block.call(sock) if block
       sock.close
     end
@@ -74,17 +132,39 @@ module Net
   end
 
   #
-  # Connects to the specified _rhost_ and _rport_ with the given _lhost_
-  # and _lport_, reads the banner then closes the connection, returning the
-  # received banner. If a _block_ is given it will be passed the banner.
+  # Connects to the specified _host_ and _port_ with the given
+  # _local_host_ and _local_port_, reads the banner then closes the
+  # connection.
+  #
+  # @param [String] host
+  #   The host to connect to.
+  #
+  # @param [Integer] port
+  #   The port to connect to.
+  #
+  # @param [String] local_host
+  #   The local host to bind to.
+  #
+  # @param [Integer] local_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
   #   Net.tcp_banner('pop.gmail.com',25)
   #   # => "220 mx.google.com ESMTP c20sm3096959rvf.1"
   #
-  def Net.tcp_banner(rhost,rport,lhost=nil,lport=nil,&block)
+  def Net.tcp_banner(host,port,local_host=nil,local_port=nil,&block)
     banner = nil
 
-    Net.tcp_session(rhost,rport,lhost,lport) do |sock|
+    Net.tcp_session(host,port,local_host,local_port) do |sock|
       banner = sock.readline.strip
     end
 
@@ -93,18 +173,141 @@ module Net
   end
 
   #
-  # Connects to the specified _rhost_ and _rport_ with the given _lhost_
-  # and _lport_, sends the specified _data_ and then closes the connection.
-  # Returns +true+ if the _data_ was successfully sent.
+  # Connects to the specified _host_ and _port_ with the given _local_host_
+  # and _local_port_, sends the specified _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
+  #   The local host to bind to.
+  #
+  # @param [Integer] local_port
+  #   The local port to bind to.
+  #
+  # @return [true]
+  #   The data was successfully sent.
+  #
+  # @example
   #   buffer = "GET /" + ('A' * 4096) + "\n\r"
   #   Net.tcp_send(buffer,'victim.com',80)
+  #   # => true
   #
-  def Net.tcp_send(data,rhost,rport,lhost=nil,lport=nil)
-    Net.tcp_session(rhost,rport,lhost,lport) do |sock|
+  def Net.tcp_send(data,host,port,local_host=nil,local_port=nil)
+    Net.tcp_session(host,port,local_host,local_port) do |sock|
       sock.write(data)
     end
 
     return true
   end
+
+  #
+  # Creates a new TCPServer listening on the specified _host_ and _port_.
+  #
+  # @param [Integer] port
+  #   The local port to listen on.
+  #
+  # @param [String] host
+  #   The host to bind to.
+  #
+  # @return [TCPServer]
+  #   The new TCP server.
+  #
+  # @example
+  #   Net.tcp_server(1337)
+  #
+  # @since 0.3.0
+  #
+  def Net.tcp_server(port,host='0.0.0.0',&block)
+    server = TCPServer.new(host,port)
+    server.listen(3)
+
+    block.call(server) if block
+    return server
+  end
+
+  #
+  # Creates a new TCPServer listening on the specified _host_ and _port_,
+  # passing it to the given _block_ and then closing the server.
+  #
+  # @param [Integer] port
+  #   The local port to bind to.
+  #
+  # @param [String] host
+  #   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 [TCPServer] server
+  #   The newly created TCP server.
+  #
+  # @return [nil]
+  #
+  # @example
+  #   Net.tcp_server_session(1337) do |server|
+  #     client1 = server.accept
+  #     client2 = server.accept
+  #
+  #     client2.write(server.read_line)
+  #
+  #     client1.close
+  #     client2.close
+  #   end
+  #
+  # @since 0.3.0
+  #
+  def Net.tcp_server_session(port,host='0.0.0.0',&block)
+    server = Net.tcp_server(port,host,&block)
+    server.close()
+    return nil
+  end
+
+  #
+  # Creates a new TCPServer listening on the specified _host_ and _port_,
+  # then accepts only one client.
+  #
+  # @param [Integer] port
+  #   The local port to listen on.
+  #
+  # @param [String] host
+  #   The host to bind to.
+  #
+  # @yield [client]
+  #   The block which will be passed the newly connected _client_.
+  #   After the block has finished, the _client_ and the server will be
+  #   closed.
+  #
+  # @yieldparam [TCPSocket] client
+  #   The newly connected client.
+  #
+  # @return [nil]
+  #
+  # @example
+  #   Net.tcp_single_server(1337) do |client|
+  #     client.puts 'lol'
+  #   end
+  #
+  # @since 0.3.0
+  #
+  def Net.tcp_single_server(port,host='0.0.0.0',&block)
+    server = TCPServer.new(host,port)
+    server.listen(1)
+
+    client = server.accept
+
+    block.call(client) if block
+
+    client.close
+    server.close
+    return nil
+  end
 end