ronin-support 0.1.0 → 0.2.0.rc1

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

@@ -58,6 +58,8 @@ module Net
   # @return [Net::IMAP]
   #   The newly created IMAP session object.
   #
+  # @api public
+  #
   def Net.imap_connect(host,options={})
     host = host.to_s
     port = (options[:port] || Ronin::Network::IMAP.default_port)
@@ -109,6 +111,8 @@ module Net
   #
   # @see Net.imap_connect
   #
+  # @api public
+  #
   def Net.imap_session(host,options={})
     session = Net.imap_connect(host,options)
 

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

@@ -49,6 +49,8 @@ module Net
   # @return [Net::POP3]
   #   The newly created POP3 session.
   #
+  # @api public
+  #
   def Net.pop3_connect(host,options={})
     host = host.to_s
     port = (options[:port] || Ronin::Network::POP3.default_port)
@@ -79,6 +81,8 @@ module Net
   #
   # @return [nil]
   #
+  # @api public
+  #
   def Net.pop3_session(host,options={})
     session = Net.pop3_connect(host,options)
 

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

@@ -17,16 +17,30 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+require 'ronin/network/smtp/smtp'
 require 'ronin/network/smtp/email'
 
 require 'net/smtp'
 
 module Net
   #
-  # @see Ronin::Network::SMTP.message
+  # Creates a new email message.
+  #
+  # @param [Hash] options
+  #   Additional options for the email.
+  #
+  # @yield [email]
+  #   The given block will be passed the new email.
+  #
+  # @yieldparam [Ronin::Network::SMTP::Email] email
+  #   The new email.
+  #
+  # @see Ronin::Network::SMTP::Email.new
+  #
+  # @api public
   #
   def Net.smtp_message(options={},&block)
-    Ronin::Network::SMTP.message(options,&block)
+    Ronin::Network::SMTP::Email.new(options,&block)
   end
 
   #
@@ -63,6 +77,11 @@ module Net
   # @return [Net::SMTP]
   #   The SMTP session.
   #
+  # @example
+  #   Net.smtp_connect('www.example.com', :user => 'joe')
+  #
+  # @api public
+  #
   def Net.smtp_connect(host,options={})
     host = host.to_s
     port = (options[:port] || Ronin::Network::SMTP.default_port)
@@ -95,8 +114,15 @@ module Net
   # @yieldparam [Net::SMTP] session
   #   The SMTP session.
   #
+  # @example
+  #   Net.smtp_session('www.example.com', :user => 'joe') do |smtp|
+  #     # ...
+  #   end
+  #
   # @see Net.smtp_connect
   #
+  # @api public
+  #
   def Net.smtp_session(host,options={})
     session = Net.smtp_connect(host,options)
 
@@ -105,4 +131,49 @@ module Net
     session.finish
     return nil
   end
+
+  #
+  # @since 0.2.0
+  #
+  # @param [String] host
+  #   The host to connect to.
+  #
+  # @param [Hash] options
+  #   Additional SMTP and Email options.
+  #
+  # @yield [email]
+  #   The given block will be passed the new email to be sent.
+  #
+  # @yieldparam [Ronin::Network::SMTP::Email] email
+  #   The new email to be sent.
+  #
+  # @see Net.smtp_session
+  #
+  # @example
+  #   Net.smtp_send_message 'www.example.com', :to => 'joe@example.com',
+  #                                            :from => 'eve@example.com',
+  #                                            :subject => 'Hello',
+  #                                            :message_id => 'XXXX',
+  #                                            :body => 'Hello'
+  #
+  # @example Using the block.
+  #   Net.smtp_send_message('www.example.com') do |email|
+  #     email.to = 'joe@example.com'
+  #     email.from 'eve@example.com'
+  #     email.subject = 'Hello'
+  #     email.message_id = 'XXXXXXXXXX'
+  #     email.body << 'Hello!'
+  #   end
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def Net.smtp_send_message(host,options={},&block)
+    email = Net.smtp_message(options,&block)
+
+    Net.smtp_session(host,options) do |smtp|
+      smtp.send_message(email.to_s, email.from, email.to)
+    end
+  end
 end

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

@@ -65,6 +65,8 @@ module Net
   # @example
   #   socket = Net.ssl_connect('twitter.com',443)
   #
+  # @api public
+  #
   def Net.ssl_connect(host,port,options={})
     local_host = options[:local_host]
     local_port = options[:local_port]
@@ -134,6 +136,8 @@ module Net
   #     sock.each_line { |line| puts line }
   #   end
   #
+  # @api public
+  #
   def Net.ssl_session(host,port)
     ssl_socket = Net.ssl_connect(host,port)
 

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

@@ -54,6 +54,8 @@ module Net
   #     sock.close
   #   end
   #
+  # @api public
+  #
   def Net.tcp_connect(host,port,local_host=nil,local_port=nil)
     host = host.to_s
     local_host = if local_host
@@ -91,6 +93,8 @@ module Net
   # @yieldparam [TCPsocket] socket
   #   The newly created TCPSocket object.
   #
+  # @api public
+  #
   def Net.tcp_connect_and_send(data,host,port,local_host=nil,local_port=nil)
     sock = Net.tcp_connect(host,port,local_host,local_port)
     sock.write(data)
@@ -124,6 +128,8 @@ module Net
   #
   # @return [nil]
   #
+  # @api public
+  #
   def Net.tcp_session(host,port,local_host=nil,local_port=nil)
     sock = Net.tcp_connect(host,port,local_host,local_port)
 
@@ -161,6 +167,8 @@ module Net
   #   Net.tcp_banner('pop.gmail.com',25)
   #   # => "220 mx.google.com ESMTP c20sm3096959rvf.1"
   #
+  # @api public
+  #
   def Net.tcp_banner(host,port,local_host=nil,local_port=nil)
     banner = nil
 
@@ -199,6 +207,8 @@ module Net
   #   Net.tcp_send(buffer,'victim.com',80)
   #   # => true
   #
+  # @api public
+  #
   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)
@@ -222,6 +232,8 @@ module Net
   # @example
   #   Net.tcp_server(1337)
   #
+  # @api public
+  #
   def Net.tcp_server(port,host='0.0.0.0')
     host = host.to_s
 
@@ -261,6 +273,8 @@ module Net
   #     client2.close
   #   end
   #
+  # @api public
+  #
   def Net.tcp_server_session(port,host='0.0.0.0',&block)
     server = Net.tcp_server(port,host,&block)
     server.close()
@@ -285,6 +299,8 @@ module Net
   #     client.puts 'lol'
   #   end
   #
+  # @api public
+  #
   def Net.tcp_single_server(port,host='0.0.0.0')
     host = host.to_s
 

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

@@ -88,6 +88,8 @@ module Net
   #   Net.telnet_connect('towel.blinkenlights.nl')
   #   # => #<Net::Telnet: ...>
   #
+  # @api public
+  #
   def Net.telnet_connect(host,options={})
     host = host.to_s
     telnet_options = {}
@@ -143,6 +145,8 @@ module Net
   #
   # @see Net.telnet_session
   #
+  # @api public
+  #
   def Net.telnet_session(host,options={})
     session = Net.telnet_connect(host,options)
 

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

@@ -53,6 +53,8 @@ module Net
   #     puts sock.readlines
   #   end
   #
+  # @api public
+  #
   def Net.udp_connect(host,port,local_host=nil,local_port=nil)
     host = host.to_s
     local_host = if local_host
@@ -93,6 +95,8 @@ module Net
   # @return [UDPSocket]
   #   The newly created UDPSocket object.
   #
+  # @api public
+  #
   def Net.udp_connect_and_send(data,host,port,local_host=nil,local_port=nil)
     sock = Net.udp_connect(host,port,local_host,local_port)
     sock.write(data)
@@ -126,6 +130,8 @@ module Net
   #
   # @return [nil]
   #
+  # @api public
+  #
   def Net.udp_session(host,port,local_host=nil,local_port=nil)
     sock = Net.udp_connect(host,port,local_host,local_port)
 
@@ -159,6 +165,8 @@ module Net
   # @return [String]
   #   The grabbed banner.
   #
+  # @api public
+  #
   def Net.udp_banner(host,port,local_host=nil,local_port=nil)
     banner = nil
 
@@ -185,6 +193,8 @@ module Net
   # @example
   #   Net.udp_server(1337)
   #
+  # @api public
+  #
   def Net.udp_server(port,host='0.0.0.0')
     host = host.to_s
     server = UDPServer.new(host,port)
@@ -216,6 +226,8 @@ module Net
   #     data, sender = server.recvfrom(1024)
   #   end
   #
+  # @api public
+  #
   def Net.udp_server_session(port,host='0.0.0.0',&block)
     server = Net.udp_server(port,host,&block)
     server.close()

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

@@ -37,6 +37,8 @@ module Ronin
       # @see Proxy.new
       # @see Proxy.parse
       #
+      # @api public
+      #
       def HTTP.proxy
         @proxy ||= if ENV['HTTP_PROXY']
                      Proxy.parse(ENV['HTTP_PROXY'])
@@ -58,6 +60,8 @@ module Ronin
       #   The given proxy information was not a {Proxy}, `URI::HTTP`,
       #   `Hash` or {String}.
       #
+      # @api public
+      #
       def HTTP.proxy=(new_proxy)
         @proxy = Proxy.create(new_proxy)
       end
@@ -68,6 +72,8 @@ module Ronin
       # @return [String, nil]
       #   The default Ronin HTTP User-Agent.
       #
+      # @api public
+      #
       def HTTP.user_agent
         @user_agent ||= nil
       end
@@ -78,6 +84,8 @@ module Ronin
       # @param [String] agent
       #   The new User-Agent string to use.
       #
+      # @api public
+      #
       def HTTP.user_agent=(agent)
         @user_agent = agent
       end
@@ -85,39 +93,40 @@ module Ronin
       #
       # Expands the URL into options.
       #
-      # @param [URI::HTTP, String, nil] url
+      # @param [URI::HTTP, String] url
       #   The URL to expand.
       #
       # @return [Hash{Symbol => Object}]
       #   The options for the URL.
       #
+      # @api private
+      #
       def HTTP.expand_url(url)
-        new_options = {
-          :port => Net::HTTP.default_port,
-          :path => '/'
-        }
-
-        if url
-          url = case url
-                when URI
-                  url
-                when Hash
-                  URI::HTTP.build(url)
-                else
-                  URI(url.to_s)
-                end
-
-          new_options[:ssl] = {} if url.scheme == 'https'
-
-          new_options[:host] = url.host
-          new_options[:port] = url.port
-
-          new_options[:user] = url.user if url.user
-          new_options[:password] = url.password if url.password
-
-          new_options[:path] = url.path unless url.path.empty?
-          new_options[:path] += "?#{url.query}" if url.query
-        end
+        new_options = {}
+
+        url = case url
+              when URI
+                url
+              when Hash
+                URI::HTTP.build(url)
+              else
+                URI(url.to_s)
+              end
+
+        new_options[:ssl] = {} if url.scheme == 'https'
+
+        new_options[:host] = url.host
+        new_options[:port] = url.port
+
+        new_options[:user] = url.user if url.user
+        new_options[:password] = url.password if url.password
+
+        new_options[:path] = unless url.path.empty?
+                               url.path
+                             else
+                               '/'
+                             end
+        new_options[:path] += "?#{url.query}" if url.query
 
         return new_options
       end
@@ -152,15 +161,21 @@ module Ronin
       # @return [Hash]
       #   The expanded version of options.
       #
+      # @api private
+      #
       def HTTP.expand_options(options={})
         new_options = options.dup
 
+        new_options[:port] ||= Net::HTTP.default_port
+        new_options[:path] ||= '/'
+
         if new_options[:ssl] == true
           new_options[:ssl] = {}
         end
 
-        url = new_options.delete(:url)
-        new_options.merge!(HTTP.expand_url(url))
+        if (url = new_options.delete(:url))
+          new_options.merge!(HTTP.expand_url(url))
+        end
 
         new_options[:proxy] = if new_options.has_key?(:proxy)
                                 HTTP::Proxy.create(new_options[:proxy])
@@ -181,6 +196,8 @@ module Ronin
       # @return [String]
       #   The camel-case HTTP header name.
       #
+      # @api private
+      #
       def HTTP.header_name(name)
         words = name.to_s.split(/[\s+_-]/)
 
@@ -198,6 +215,8 @@ module Ronin
       # @return [Hash]
       #   The camel-cased HTTP headers created from the given options.
       #
+      # @api private
+      #
       def HTTP.headers(options={})
         headers = {}
 
@@ -253,6 +272,8 @@ module Ronin
       #
       # @see HTTP.expand_options
       #
+      # @api private
+      #
       def HTTP.request(options={})
         unless options[:method]
           raise(ArgumentError,"the :method option must be specified")