ronin-support 0.5.0.rc2 → 0.5.0

data/ChangeLog.md

@@ -1,4 +1,4 @@
-### 0.5.0 / 2012-05-28
+### 0.5.0 / 2012-06-16
 
 * Added {Float#pack}.
 * Added {Regexp::WORD}.

data/Gemfile

@@ -13,6 +13,7 @@ group :development do
   gem 'ripl-multi_line',    '~> 0.2'
   gem 'ripl-auto_indent',   '~> 0.1'
   gem 'ripl-color_result',  '~> 0.3'
+  gem 'rspec',              '~> 2.8'
 
   gem 'kramdown',           '~> 0.12'
 end

data/README.md

@@ -1,8 +1,8 @@
 # Ronin Support
 
-* [Source](http://github.com/ronin-ruby/ronin-support)
-* [Issues](http://github.com/ronin-ruby/ronin-support/issues)
-* [Documentation](http://rubydoc.info/gems/ronin-support/frames)
+* [Source](https://github.com/ronin-ruby/ronin-support)
+* [Issues](https://github.com/ronin-ruby/ronin-support/issues)
+* [Documentation](http://ronin-ruby.github.com/docs/ronin-support/frames)
 * [Mailing List](http://groups.google.com/group/ronin-ruby)
 * [irc.freenode.net #ronin](http://webchat.freenode.net/?channels=ronin&uio=Mj10cnVldd)
 
@@ -31,6 +31,7 @@ or payloads over many common Source-Code-Management (SCM) systems.
     * DNS
     * TCP
     * UDP
+    * SSL
     * SMTP / ESMTP
     * POP3
     * Imap
@@ -43,6 +44,7 @@ or payloads over many common Source-Code-Management (SCM) systems.
   * Handling exceptions.
 * Provides Modules/Classes for:
   * Paths
+  * Fuzzing
   * Wordlists
   * Erb Templates
   * UI:
@@ -57,17 +59,17 @@ please see [Everyday Ronin](http://ronin-ruby.github.com/guides/everyday_ronin.h
 ## Requirements
 
 * [Ruby](http://www.ruby-lang.org/) >= 1.8.7
-* [chars](http://github.com/postmodern/chars#readme)
+* [chars](https://github.com/postmodern/chars#readme)
   ~> 0.2
-* [hexdump](http://github.com/postmodern/hexdump#readme)
+* [hexdump](https://github.com/postmodern/hexdump#readme)
   ~> 0.1
-* [combinatorics](http://github.com/postmodern/combinatorics#readme)
+* [combinatorics](https://github.com/postmodern/combinatorics#readme)
   ~> 0.4
-* [uri-query_params](http://github.com/postmodern/uri-query_params#readme)
+* [uri-query_params](https://github.com/postmodern/uri-query_params#readme)
   ~> 0.6
-* [data_paths](http://github.com/postmodern/data_paths#readme)
+* [data_paths](https://github.com/postmodern/data_paths#readme)
   ~> 0.3
-* [parameters](http://github.com/postmodern/parameters#readme)
+* [parameters](https://github.com/postmodern/parameters#readme)
   ~> 0.4
 
 ## Install

data/gemspec.yml

@@ -7,7 +7,7 @@ description:
 license: LGPL-3
 authors: Postmodern
 email: postmodern.mod3@gmail.com
-homepage: http://github.com/ronin-ruby/ronin-support
+homepage: http://ronin-ruby.github.com/
 has_yard: true
 
 required_ruby_version: ">= 1.8.7"

data/lib/ronin/binary/struct.rb

@@ -26,6 +26,8 @@ module Ronin
     #
     # Generic Binary Struct class.
     #
+    # ## Example
+    #
     #     class Packet < Binary::Struct
     #
     #       endian :network

data/lib/ronin/binary/template.rb

@@ -326,6 +326,13 @@ module Ronin
         @template = self.class.compile(@fields,options)
       end
 
+      #
+      # @see #initialize
+      #
+      def self.[](*fields)
+        new(fields)
+      end
+
       #
       # Translates the type of the field.
       #

data/lib/ronin/extensions/file.rb

@@ -44,7 +44,7 @@ class File
   # @api public
   #
   def File.each_line(path)
-    return enum_for(:each_line,path) unless block_given?
+    return enum_for(__method__,path) unless block_given?
 
     File.open(path) do |file|
       file.each_line { |line| yield line.chomp }
@@ -79,7 +79,7 @@ class File
   # @api public
   #
   def File.each_row(path,separator=/\s+/)
-    return enum_for(:each_row,path,separator) unless block_given?
+    return enum_for(__method__,path,separator) unless block_given?
 
     File.each_line(path) { |line| yield line.split(separator) }
   end

data/lib/ronin/extensions/ip_addr.rb

@@ -63,7 +63,7 @@ class IPAddr
   # @api public
   #
   def IPAddr.extract(text,version=nil,&block)
-    return enum_for(:extract,text,version).to_a unless block_given?
+    return enum_for(__method__,text,version).to_a unless block_given?
 
     regexp = case version
              when :ipv4, :v4, 4
@@ -122,7 +122,7 @@ class IPAddr
       return IPAddr.new(cidr_or_glob).each(&block)
     end
 
-    return enum_for(:each,cidr_or_glob) unless block
+    return enum_for(__method__,cidr_or_glob) unless block
 
     if cidr_or_glob.include?('::')
       separator = '::'
@@ -208,7 +208,7 @@ class IPAddr
   # @api public
   #
   def each
-    return enum_for(:each) unless block_given?
+    return enum_for(__method__) unless block_given?
 
     family_mask = MASKS[@family]
 

data/lib/ronin/extensions/string.rb

@@ -46,7 +46,7 @@ class String
   # @api public
   #
   def each_substring(min=1,&block)
-    return enum_for(:each_substring,min) unless block
+    return enum_for(__method__,min) unless block
 
     (0..(length - min)).each do |i|
       ((i + min)..length).each do |j|
@@ -92,7 +92,7 @@ class String
   # @api public
   #
   def each_unique_substring(min=1,&block)
-    return enum_for(:each_unique_substring,min) unless block
+    return enum_for(__method__,min) unless block
 
     unique_strings = {}
 

data/lib/ronin/formatting/extensions/binary/integer.rb

@@ -60,7 +60,7 @@ class Integer
     buffer = []
 
     case endian
-    when :little, :net
+    when :little
       mask  = 0xff
       shift = 0
 
@@ -70,7 +70,7 @@ class Integer
         mask <<= 8
         shift += 8
       end
-    when :big
+    when :big, :net
       shift = ((length - 1) * 8)
       mask  = (0xff << shift)
 

data/lib/ronin/formatting/extensions/binary/string.rb

@@ -25,9 +25,8 @@ require 'ronin/binary/template'
 
 begin
   require 'zlib'
-rescue Gem::LoadError => e
-  raise(e)
 rescue ::LoadError
+  $stderr.puts "WARNING: Ruby was not compiled with zlib support"
 end
 
 class String

data/lib/ronin/fuzzing/extensions/string.rb

@@ -92,7 +92,7 @@ class String
   #
   # Repeats the String.
   #
-  # @param [Enumerable, Integer] lengths
+  # @param [Enumerable<Integer>, Integer] lengths
   #   The number of times to repeat the String.
   #
   # @yield [repeated]
@@ -141,7 +141,7 @@ class String
   #
   # Incrementally fuzzes the String.
   #
-  # @param [Hash{Regexp,String => #each}] substitutions
+  # @param [Hash{Regexp,String,Symbol => Enumerable,Symbol}] substitutions
   #   Patterns and their substitutions.
   #
   # @yield [fuzz]
@@ -163,6 +163,9 @@ class String
   #     p str
   #   end
   #
+  # @example Replace a {Regexp::UNIX_PATH} with {Ronin::Fuzzing#format_strings}:
+  #   "GET /downloads/".fuzz(:unix_path => :format_string)
+  #
   # @since 0.3.0
   #
   # @api public
@@ -174,7 +177,7 @@ class String
   #
   # Permutes over every possible mutation of the String.
   #
-  # @param [Hash{Regexp,String,Symbol => Symbol,Enumerable}] mutations
+  # @param [Hash{Regexp,String,Symbol => Enumerable,Symbol}] mutations
   #   The patterns and substitutions to mutate the String with.
   #
   # @yield [mutant]

data/lib/ronin/fuzzing/fuzzer.rb

@@ -40,7 +40,7 @@ module Ronin
       #
       # Initializes a new Fuzzer.
       #
-      # @param [Hash{Regexp,String => #each}] rules
+      # @param [Hash{Regexp,String,Symbol => Enumerable,Symbol}] rules
       #   Patterns and their substitutions.
       #
       def initialize(rules)

data/lib/ronin/network.rb

@@ -20,6 +20,7 @@
 require 'ronin/network/dns'
 require 'ronin/network/tcp'
 require 'ronin/network/udp'
+require 'ronin/network/ssl'
 require 'ronin/network/unix'
 require 'ronin/network/smtp'
 require 'ronin/network/esmtp'

data/lib/ronin/network/extensions.rb

@@ -20,6 +20,7 @@
 require 'ronin/network/extensions/dns'
 require 'ronin/network/extensions/tcp'
 require 'ronin/network/extensions/udp'
+require 'ronin/network/extensions/ssl'
 require 'ronin/network/extensions/smtp'
 require 'ronin/network/extensions/esmtp'
 require 'ronin/network/extensions/pop3'

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

@@ -27,6 +27,7 @@ require 'net/http'
 begin
   require 'net/https'
 rescue ::LoadError
+  $stderr.puts "WARNING: could not load 'net/https'"
 end
 
 module Ronin

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

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

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

@@ -107,7 +107,7 @@ module Ronin
         #
         # @example
         #   tcp_connect do |socket|
-        #     socket.write("GET /\n\n")
+        #     socket.write("GET / HTTP/1.1\n\r\n\r")
         #
         #     puts socket.readlines
         #     socket.close

data/lib/ronin/network/ssl.rb

@@ -22,6 +22,7 @@ require 'ronin/network/tcp'
 begin
   require 'openssl'
 rescue ::LoadError
+  $stderr.puts "WARNING: Ruby was not compiled with OpenSSL support"
 end
 
 module Ronin
@@ -99,6 +100,8 @@ module Ronin
       # @example
       #   socket = ssl_connect('twitter.com',443)
       #
+      # @see http://rubydoc.info/stdlib/openssl/OpenSSL/SSL/SSLSocket
+      #
       # @api public
       #
       def ssl_connect(host,port,options={})
@@ -165,11 +168,13 @@ module Ronin
       #
       # @example
       #   ssl_session('twitter.com',443) do |sock|
-      #     sock.write("GET /\n\n")
+      #     sock.write("GET / HTTP/1.1\n\r\n\r")
       #
       #     sock.each_line { |line| puts line }
       #   end
       #
+      # @see http://rubydoc.info/stdlib/openssl/OpenSSL/SSL/SSLSocket
+      #
       # @api public
       #
       def ssl_session(host,port,options={},&block)

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

@@ -27,6 +27,46 @@ module Ronin
       #
       # The TCP Proxy allows for inspecting and manipulating TCP protocols.
       #
+      # ## Example
+      # 
+      #     require 'ronin/network/tcp/proxy'
+      #     require 'hexdump'
+      #
+      #     Ronin::Network::TCP::Proxy.start(:port => 1337, :server => ['www.wired.com', 80]) do |proxy|
+      #       address = lambda { |socket|
+      #         addrinfo = socket.peeraddr
+      #
+      #        "#{addrinfo[3]}:#{addrinfo[1]}"
+      #       }
+      #       hex = Hexdump::Dumper.new
+      #
+      #       proxy.on_client_data do |client,server,data|
+      #         puts "#{address[client]} -> #{proxy}"
+      #         hex.dump(data)
+      #       end
+      #
+      #       proxy.on_client_connect do |client|
+      #         puts "#{address[client]} -> #{proxy} [connected]"
+      #       end
+      #
+      #       proxy.on_client_disconnect do |client,server|
+      #         puts "#{address[client]} <- #{proxy} [disconnected]"
+      #       end
+      #
+      #       proxy.on_server_data do |client,server,data|
+      #         puts "#{address[client]} <- #{proxy}"
+      #         hex.dump(data)
+      #       end
+      #
+      #       proxy.on_server_connect do |client,server|
+      #         puts "#{address[client]} <- #{proxy} [connected]"
+      #       end
+      #
+      #       proxy.on_server_disconnect do |client,server|
+      #         puts "#{address[client]} <- #{proxy} [disconnected]"
+      #       end
+      #     end
+      #
       # ## Callbacks
       #
       # In addition to the events supported by the {Network::Proxy Proxy}

data/lib/ronin/network/udp/proxy.rb

@@ -24,6 +24,28 @@ require 'socket'
 module Ronin
   module Network
     module UDP
+      #
+      # The UDP Proxy allows for inspecting and manipulating UDP protocols.
+      #
+      # ## Example
+      #
+      #     require 'ronin/network/udp/proxy'
+      #     require 'hexdump'
+      #
+      #     Ronin::Network::UDP::Proxy.start(:port => 1337, :server => ['4.2.2.1', 53]) do |proxy|
+      #       hex = Hexdump::Dumper.new
+      #
+      #       proxy.on_client_data do |(client,(host,port)),server,data|
+      #         puts "#{host}:#{port} -> #{proxy}"
+      #         hex.dump(data)
+      #       end
+      #
+      #       proxy.on_server_data do |(client,(host,port)),server,data|
+      #         puts "#{host}:#{port} <- #{proxy}"
+      #         hex.dump(data)
+      #       end
+      #
+      #    end
       #
       # @since 0.5.0
       #
@@ -51,13 +73,13 @@ module Ronin
           readable, writtable, errors = IO.select(sockets,nil,sockets)
 
           (errors & server_connections).each do |server_socket|
-            client_socket = client_for(server_socket)
+            client_socket = client_connection_for(server_socket)
 
             close_connection(client_socket,server_socket)
           end
 
           (readable & server_connections).each do |server_socket|
-            client_socket  = client_for(server_socket)
+            client_socket  = client_connection_for(server_socket)
             data, addrinfo = recv(server_socket)
 
             server_data(client_socket,server_socket,data)
@@ -115,7 +137,7 @@ module Ronin
 
             socket.recvfrom(@buffer_size)
           when UDPSocket
-            socket.recv(@buffer_size)
+            connection.recvfrom(@buffer_size)
           end
         end
 

data/lib/ronin/support/support.rb

@@ -29,6 +29,7 @@ module Ronin
     include Network::DNS
     include Network::TCP
     include Network::UDP
+    include Network::SSL
     include Network::UNIX
     include Network::SMTP
     include Network::ESMTP

data/lib/ronin/support/version.rb

@@ -20,6 +20,6 @@
 module Ronin
   module Support
     # ronin-support version
-    VERSION = '0.5.0.rc2'
+    VERSION = '0.5.0'
   end
 end

data/lib/ronin/ui/output/helpers.rb

@@ -71,7 +71,7 @@ module Ronin
         #
         # Prints one or more messages.
         #
-        # @param [Array] messages
+        # @param [Array] arguments
         #   The messages to print.
         #
         # @example
@@ -81,11 +81,29 @@ module Ronin
         #
         # @api public
         #
-        def puts(*messages)
-          unless messages.empty?
-            messages.each { |message| write("#{message}#{$/}") }
-          else
+        def puts(*arguments)
+          if arguments.empty?
             write($/)
+            return nil
+          end
+
+          arguments.each do |argument|
+            if argument.kind_of?(Array)
+              argument.each { |element| puts(element) }
+            else
+              str = case argument
+                    when nil
+                      if RUBY_VERSION > '1.9'
+                        ''
+                      else
+                        'nil'
+                      end
+                    else
+                      argument.to_s
+                    end
+
+              write("#{str}#{$/}")
+            end
           end
 
           return nil
@@ -97,7 +115,7 @@ module Ronin
         # @param [String] format
         #   The format string.
         #
-        # @param [Array] data
+        # @param [Array] arguments
         #   The data to format.
         #
         # @return [nil]
@@ -106,8 +124,8 @@ module Ronin
         #
         # @api public
         #
-        def printf(format,*data)
-          write(format % data)
+        def printf(format,*arguments)
+          write(format % arguments)
           return nil
         end
 

data/lib/ronin/ui/output/output.rb

@@ -32,7 +32,7 @@ module Ronin
                 :quiet
               end
 
-      @handler = if STDOUT.tty?
+      @handler = if $stdout.tty?
                    Terminal::Color
                  else
                    Terminal::Raw

data/lib/ronin/wordlist.rb

@@ -195,7 +195,7 @@ module Ronin
     # @api public
     #
     def each_word(&block)
-      return enum_for(:each_word) unless block
+      return enum_for(__method__) unless block
 
       if @path
         File.open(@path) do |file|
@@ -223,7 +223,7 @@ module Ronin
     # @api public
     #
     def each(&block)
-      return enum_for(:each) unless block
+      return enum_for(__method__) unless block
 
       mutator = unless @mutations.empty?
                   Fuzzing::Mutator.new(@mutations)

data/spec/network/tcp/tcp_spec.rb

@@ -77,12 +77,14 @@ describe Network::TCP do
       let(:data) { "HELO ronin\n" }
       let(:local_port) { 1024 + rand(65535 - 1024) }
 
+      let(:expected_response) { "250 mx.google.com at your service\r\n" }
+
       it "should connect and then send data" do
         socket   = subject.tcp_connect_and_send(data,host,port)
         banner   = socket.readline
         response = socket.readline
 
-        response.start_with?('250').should be_true
+        response.should == expected_response
 
         socket.close
        end
@@ -104,7 +106,7 @@ describe Network::TCP do
           response = socket.readline
         end
 
-        response.start_with?('250').should be_true
+        response.should == expected_response
 
         socket.close
       end
@@ -136,21 +138,22 @@ describe Network::TCP do
     end
 
     describe "#tcp_banner" do
-      let(:host) { 'smtp.gmail.com' }
-      let(:port) { 25 }
-
+      let(:host)       { 'smtp.gmail.com' }
+      let(:port)       { 25 }
       let(:local_port) { 1024 + rand(65535 - 1024) }
 
-      it "should read the service banner" do
+      let(:expected_banner) { /^220 mx\.google\.com ESMTP/ }
+
+      it "should return the read service banner" do
         banner = subject.tcp_banner(host,port)
 
-        banner.start_with?('220').should be_true
+        banner.should =~ expected_banner
       end
 
       it "should bind to a local host and port" do
         banner = subject.tcp_banner(host,port,nil,local_port)
 
-        banner.start_with?('220').should be_true
+        banner.should =~ expected_banner
       end
 
       it "should yield the banner" do
@@ -160,7 +163,7 @@ describe Network::TCP do
           banner = yielded_banner
         end
 
-        banner.start_with?('220').should be_true
+        banner.should =~ expected_banner
       end
     end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ronin-support
 version: !ruby/object:Gem::Version
-  version: 0.5.0.rc2
-  prerelease: 6
+  version: 0.5.0
+  prerelease: 
 platform: ruby
 authors:
 - Postmodern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-10 00:00:00.000000000 Z
+date: 2012-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chars
@@ -392,7 +392,7 @@ files:
 - spec/ui/output_spec.rb
 - spec/ui/shell_spec.rb
 - spec/wordlist_spec.rb
-homepage: http://github.com/ronin-ruby/ronin-support
+homepage: http://ronin-ruby.github.com/
 licenses:
 - LGPL-3
 post_install_message: