ronin 0.2.4 → 0.3.0

data/lib/ronin/network/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'
@@ -30,14 +27,18 @@ module Ronin
       DEFAULT_PORT = 143
 
       #
-      # Returns the default Ronin IMAP port.
+      # @return [Integer]
+      #   The default Ronin IMAP port.
       #
       def IMAP.default_port
         @@imap_default_port ||= DEFAULT_PORT
       end
 
       #
-      # Sets the default Ronin IMAP port to the specified _port_.
+      # Sets the default Ronin IMAP port.
+      #
+      # @param [Integer] port
+      #   The new default Ronin IMAP port.
       #
       def IMAP.default_port=(port)
         @@imap_default_port = port

data/lib/ronin/network/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'
@@ -30,14 +27,18 @@ module Ronin
       DEFAULT_PORT = 110
 
       #
-      # Returns the default Ronin POP3 port.
+      # @return [Integer]
+      #   The default Ronin POP3 port.
       #
       def POP3.default_port
         @@pop3_default_port ||= DEFAULT_PORT
       end
 
       #
-      # Sets the default Ronin POP3 port to the specified _port_.
+      # Sets the default Ronin POP3 port.
+      #
+      # @param [Integer] port
+      #   The new default Ronin POP3 port.
       #
       def POP3.default_port=(port)
         @@pop3_default_port = port

data/lib/ronin/network/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/smtp/email'

data/lib/ronin/network/smtp/email.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
-#++
 #
 
 module Ronin
@@ -45,20 +42,35 @@ module Ronin
         attr_accessor :body
 
         #
-        # Creates a new Email object with the given _options_. If a _block_
-        # is given, it will be passed the newly created Email object.
+        # Creates a new Email object.
         #
-        # _options_ must contain the following keys:
-        # <tt>:from</tt>:: The address the email is from.
-        # <tt>:to</tt>:: The address that the email should be sent to.
-        # <tt>:subject</tt>:: The subject of the email.
-        # <tt>:message_id</tt>:: 
+        # @param [Hash] options
+        #   Additional options.
         #
-        # _options_ may contain the following keys:
-        # <tt>:date</tt>:: The date the email was sent on. Defaults to
-        #                  <tt>Time.now</tt>.
-        # <tt>:body</tt>:: The body of the email. Can be a String or an
-        #                  Array of Strings.
+        # @option options [String] :from
+        #   The address the email is from.
+        #
+        # @option options [String] :to
+        #   The address that the email should be sent to.
+        #
+        # @option options [String] :subject
+        #   The subject of the email.
+        #
+        # @option options [String] :message_id
+        #   Message-ID of the email.
+        #
+        # @option options [String, Time] :date (Time.now)
+        #   The date the email was sent on.
+        #
+        # @option options [String, Array<String>] :body
+        #   The body of the email.
+        #
+        # @yield [email]
+        #   If a block is given, it will be passed the newly created email
+        #   object.
+        #
+        # @yieldparam [Email] email
+        #   The newly created email object.
         #
         def initialize(options={},&block)
           @from = options[:from]
@@ -78,8 +90,12 @@ module Ronin
         end
 
         #
-        # Formats the email into a SMTP message as described in
-        # http://www.ruby-doc.org/stdlib/libdoc/net/smtp/rdoc/classes/Net/SMTP.html
+        # Formats the email into a SMTP message.
+        #
+        # @return [String]
+        #   Properly formatted SMTP message.
+        #
+        # @see http://www.ruby-doc.org/stdlib/libdoc/net/smtp/rdoc/classes/Net/SMTP.html
         #
         def to_s
           address = lambda { |info|

data/lib/ronin/network/smtp/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/smtp/email'
@@ -30,7 +27,8 @@ module Ronin
       DEFAULT_PORT = 25
 
       #
-      # Returns the default Ronin SMTP port.
+      # @return [Integer]
+      #   The default Ronin SMTP port.
       #
       def SMTP.default_port
         @@smtp_default_port ||= DEFAULT_PORT
@@ -39,13 +37,27 @@ module Ronin
       #
       # Sets the default Ronin SMTP port.
       #
+      # @param [Integer] port
+      #   The new default Ronin SMTP port.
+      #
       def SMTP.default_port=(port)
         @@smtp_default_port = port
       end
 
       #
-      # Returns the String form of an Email object with the given _options_
-      # and _block_.
+      # Creates a properly formatted email.
+      #
+      # @yield [email]
+      #   If a block is given, it will be passed the newly created Email
+      #   object.
+      #
+      # @yieldparam [Ronin::Network::Email::SMTP] email
+      #   The new Email object.
+      #
+      # @return [String]
+      #   Formatted SMTP email.
+      #
+      # @see Ronin::Network::SMTP::Email
       #
       def SMTP.message(options={},&block)
         Email.new(options,&block).to_s

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

data/lib/ronin/network/telnet.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/telnet'
@@ -36,56 +33,72 @@ module Ronin
       DEFAULT_TIMEOUT = 10
 
       #
-      # Returns the default Ronin Telnet port.
+      # @return [Integer]
+      #   The default Ronin Telnet port.
       #
       def Telnet.default_port
         @@telnet_default_port ||= DEFAULT_PORT
       end
 
       #
-      # Sets the default Ronin Telnet port to the specified _port_.
+      # Sets the default Ronin Telnet port.
+      #
+      # @param [Integer] port
+      #   The new default Ronin Telnet port.
       #
       def Telnet.default_port=(port)
         @@telnet_default_port = port
       end
 
       #
-      # Returns the default Ronin Telnet prompt.
+      # @return [Regexp]
+      #   The default Ronin Telnet prompt pattern.
       #
       def Telnet.default_prompt
         @@telnet_default_prompt ||= DEFAULT_PROMPT
       end
 
       #
-      # Sets the default Ronin Telnet prompt to the specified _prompt_.
+      # Sets the default Ronin Telnet prompt pattern.
+      #
+      # @param [Regexp] prompt
+      #   The new default Ronin Telnet prompt pattern.
       #
       def Telnet.default_prompt=(prompt)
         @@telnet_default_prompt = prompt
       end
 
       #
-      # Returns the default Ronin Telnet timeout.
+      # @return [Integer]
+      #   The default Ronin Telnet timeout.
       #
       def Telnet.default_timeout
         @@telnet_default_timeout ||= DEFAULT_TIMEOUT
       end
 
       #
-      # Sets the default Ronin Telnet timeout to the specified _timeout_.
+      # Sets the default Ronin Telnet timeout.
+      #
+      # @param [Integer] timeout
+      #   The new default Ronin Telnet timeout.
       #
       def Telnet.default_timeout=(timeout)
         @@telnet_default_timeout = timeout
       end
 
       #
-      # Returns the Ronin Telnet proxy.
+      # @return [Telnet, IO, nil]
+      #   The Ronin Telnet proxy.
       #
       def Telnet.proxy
         @@telnet_proxy ||= nil
       end
 
       #
-      # Sets the Ronin Telnet proxy to _new_proxy_.
+      # Sets the Ronin Telnet proxy.
+      #
+      # @param [Telnet, IO, nil] new_proxy
+      #   The new Ronin Telnet proxy.
       #
       def Telnet.proxy=(new_proxy)
         @@telnet_proxy = new_proxy

data/lib/ronin/network/udp.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/udp'

data/lib/ronin/os.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/model'
@@ -44,8 +41,12 @@ module Ronin
     validates_present :name
 
     #
-    # Returns the String form of the os.
+    # Converts the os to a String.
     #
+    # @return [String]
+    #   The OS name and version.
+    #
+    # @example
     #   os = OS.new(:name => 'Linux', :version => '2.6.11')
     #   os.to_s # => "Linux 2.6.11"
     #
@@ -58,33 +59,54 @@ module Ronin
     end
 
     #
-    # Defines a new builtin OS of the specified _name_.
+    # Defines a new predefined OS.
+    #
+    # @param [Symbol, String] name
+    #   The method name to define for the builtin OS.
+    #
+    # @param [String] os_name
+    #   The name of the OS.
     #
-    #   OS.define('FreeBSD')
+    # @example
+    #   OS.predefine :freebsd, 'FreeBSD'
     #
-    def OS.define(name)
-      name = name.to_s
-      method_name = name.snake_case
+    def OS.predefine(name,os_name)
+      os_name = os_name.to_s
 
-      meta_def(method_name) do |*arguments|
+      meta_def(name) do |*arguments|
         if (version = arguments.first)
-          OS.first_or_create(:name => name, :version => version.to_s)
+          OS.first_or_create(:name => os_name, :version => version.to_s)
         else
-          OS.new(:name => name)
+          OS.new(:name => os_name)
         end
       end
 
       return nil
     end
 
-    define 'Linux'
-    define 'FreeBSD'
-    define 'OpenBSD'
-    define 'NetBSD'
-    define 'OSX'
-    define 'Solaris'
-    define 'Windows'
-    define 'UNIX'
+    # The Linux OS
+    predefine :linux, 'Linux'
+
+    # The FreeBSD OS
+    predefine :freebsd, 'FreeBSD'
+
+    # The OpenBSD OS
+    predefine :openbsd, 'OpenBSD'
+
+    # The NetBSD OS
+    predefine :netbsd, 'NetBSD'
+
+    # OSX
+    predefine :osx, 'OSX'
+
+    # The Solaris OS
+    predefine :solaris, 'Solaris'
+
+    # The Windows OS
+    predefine :windows, 'Windows'
+
+    # The family UNIX OSes
+    predefine :unix, 'UNIX'
 
   end
 end