ronin 1.4.1 → 1.5.0.rc1

data/lib/ronin/ui/cli/commands/help.rb

@@ -19,6 +19,7 @@
 
 require 'ronin/ui/cli/command'
 require 'ronin/ui/cli/cli'
+require 'ronin/installation'
 
 module Ronin
   module UI
@@ -47,7 +48,7 @@ module Ronin
 
           summary 'Displays the list of available commands or prints information on a specific command'
 
-          argument :command, :type        => Symbol,
+          argument :command, :type        => String,
                              :description => 'The command to display'
 
           #
@@ -55,11 +56,23 @@ module Ronin
           #
           def execute
             if command?
-              begin
-                CLI.command(@command).start(['--help'])
-              rescue UnknownCommand
-                print_error "unknown command: #{@command}"
+              unless CLI.commands.include?(command)
+                print_error "Unknown command: #{command.dump}"
+                return false
               end
+
+              man_page = "ronin-#{command.tr(':','-')}.1"
+
+              Installation.paths.each do |path|
+                man_path = File.join(path,'man',man_page)
+
+                if File.file?(man_path)
+                  return system('man',man_path)
+                end
+              end
+
+              print_error "No man-page for the command: #{@command}"
+              return false
             else
               print_array CLI.commands, :title => 'Available commands'
             end

data/lib/ronin/ui/cli/commands/hosts.rb

@@ -56,33 +56,40 @@ module Ronin
 
           summary 'Manages HostNames'
 
-          query_option :with_ips, :type  => Array,
-                                  :flag  => '-I',
-                                  :usage => 'IP [...]'
-
-          query_option :with_ports, :type  => Array[Integer],
-                                    :flag  => '-p',
-                                    :usage => 'PORT [...]'
-
-          query_option :domain, :type  => String,
-                                :flag  => '-D',
-                                :usage => 'DOMAIN'
-
-          query_option :tld, :type  => String,
-                             :flag  => '-T',
-                             :usage => 'TLD'
-
-          option :list, :type    => true,
-                        :default => true,
-                        :flag    => '-l'
-
-          option :lookup, :type  => String,
-                          :flag  => '-L',
-                          :usage => 'IP'
-
-          option :import, :type  => String,
-                          :flag  => '-i',
-                          :usage => 'FILE'
+          query_option :with_ips, :type        => Array,
+                                  :flag        => '-I',
+                                  :usage       => 'IP [...]',
+                                  :description => 'Searches for the associated IP(s)'
+
+          query_option :with_ports, :type        => Array[Integer],
+                                    :flag        => '-p',
+                                    :usage       => 'PORT [...]',
+                                    :description => 'Searches for the associated PORT(s)'
+
+          query_option :domain, :type        => String,
+                                :flag        => '-D',
+                                :usage       => 'DOMAIN',
+                                :description => 'Searches for the associated parent DOMAIN'
+
+          query_option :tld, :type        => String,
+                             :flag        => '-T',
+                             :usage       => 'TLD',
+                             :description => 'Searches for the associated TLD'
+
+          option :list, :type        => true,
+                        :default     => true,
+                        :flag        => '-l',
+                        :description => 'Lists the HostNames'
+
+          option :lookup, :type        => String,
+                          :flag        => '-L',
+                          :usage       => 'IP',
+                          :description => 'Looks up HostNames for the IP'
+
+          option :import, :type        => String,
+                          :flag        => '-i',
+                          :usage       => 'FILE',
+                          :description => 'Imports HostNames from the FILE'
 
           #
           # Queries the {HostName} model.

data/lib/ronin/ui/cli/commands/install.rb

@@ -46,19 +46,36 @@ module Ronin
         # ## Arguments
         #
         #      URI                              The URI of the Repository
+        #
+        # ## Examples
+        #
+        #      ronin install git://github.com/user/repo.git
+        #      ronin install --git git@example.com:/home/secret/repo
         # 
         class Install < Command
 
           summary 'Installs Ronin Repositories'
 
-          option :rsync, :type => true
-          option :svn,   :type => true
-          option :hg,    :type => true
-          option :git,   :type => true
+          option :rsync, :type        => true,
+                         :description => 'Install via rsync'
+
+          option :svn, :type        => true,
+                       :description => 'Install via SubVersion (SVN)'
+
+          option :hg, :type        => true,
+                      :description => 'Install via Mercurial (Hg)'
+
+          option :git, :type        => true,
+                       :description => 'Install via Git'
 
           argument :uri, :type        => String,
                          :description => 'The URI of the Repository'
 
+          examples [
+            "ronin install git://github.com/user/repo.git",
+            "ronin install --git git@example.com:/home/secret/repo"
+          ]
+
           #
           # Sets up the install command.
           #

data/lib/ronin/ui/cli/commands/ips.rb

@@ -58,32 +58,43 @@ module Ronin
 
           summary 'Manages IPAddresses'
 
-          query_option :v4, :type => true, :flag => '-4'
-          query_option :v6, :type => true, :flag => '-6'
-
-          query_option :with_ports, :type  => Array[Integer],
-                                    :flag  => '-p',
-                                    :usage => 'PORT [...]'
-
-          query_option :with_macs, :type  => Array,
-                                   :flag  => '-M',
-                                   :usage => 'MAC [...]'
-
-          query_option :with_hosts, :type  => Array,
-                                    :flag  => '-H',
-                                    :usage => 'HOST [...]'
-
-          option :list, :type    => true,
-                        :default => true,
-                        :aliases => '-l'
-
-          option :lookup, :type  => String,
-                          :flag  => '-L',
-                          :usage => 'HOST'
+          query_option :v4, :type => true,
+                            :flag => '-4',
+                            :description => 'Searches for IPv4 addresses'
+
+          query_option :v6, :type => true,
+                            :flag => '-6',
+                            :description => 'Searches for IPv6 addresses'
+
+          query_option :with_ports, :type        => Array[Integer],
+                                    :flag        => '-p',
+                                    :usage       => 'PORT [...]',
+                                    :description => 'Searches for the associated PORT(s)'
+
+          query_option :with_macs, :type        => Array,
+                                   :flag        => '-M',
+                                   :usage       => 'MAC [...]',
+                                   :description => 'Searches for the associated MAC address(es)'
+
+          query_option :with_hosts, :type        => Array,
+                                    :flag        => '-H',
+                                    :usage       => 'HOST [...]',
+                                    :description => 'Searches for the associated HOST(s)'
+
+          option :list, :type        => true,
+                        :default     => true,
+                        :flag        => '-l',
+                        :description => 'Lists the IP addresses'
+
+          option :lookup, :type        => String,
+                          :flag        => '-L',
+                          :usage       => 'HOST',
+                          :description => 'Looks up the IP addresses for the HOST'
 
           option :import, :type  => String,
                           :flag  => '-i',
-                          :usage => 'FILE'
+                          :usage => 'FILE',
+                          :description => 'Imports IP addresses from the FILE'
 
           #
           # Queries the {IPAddress} model.

data/lib/ronin/ui/cli/commands/net/proxy.rb

@@ -0,0 +1,403 @@
+#
+# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin.
+#
+# Ronin 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 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/ui/cli/command'
+require 'ronin/network/tcp/proxy'
+require 'ronin/network/udp/proxy'
+
+require 'hexdump/dumper'
+
+module Ronin
+  module UI
+    module CLI
+      module Commands
+        module Net
+          #
+          # Starts a TCP/UDP intercept proxy.
+          #
+          # ## Usage
+          #
+          #     ronin net:proxy [options]
+          #
+          # ## Options
+          #
+          #     -v, --[no-]verbose               Enable verbose output.
+          #     -q, --[no-]quiet                 Disable verbose output.
+          #         --[no-]silent                Silence all output.
+          #         --[no-]color                 Enables color output.
+          #                                      Default: true
+          #     -t, --[no-]tcp                   TCP Proxy.
+          #                                      Default: true
+          #     -u, --[no-]udp                   UDP Proxy.
+          #     -x, --[no-]hexdump               Enable hexdump output.
+          #     -H, --host [HOST]                Host to listen on.
+          #                                      Default: "0.0.0.0"
+          #     -p, --port [PORT]                Port to listen on.
+          #     -s, --server [HOST[:PORT]]       Server to forward connections to.
+          #     -r, --rewrite [/REGEXP/:STRING] Rewrite rules.
+          #         --rewrite-client [/REGEXP/:STRING]
+          #                                      Client rewrite rules.
+          #         --rewrite-server [/REGEXP/:STRING]
+          #                                      Server rewrite rules.
+          #     -i, --ignore [/REGEXP/ [...]]    Ignore rules.
+          #         --ignore-client [/REGEXP/ [...]]
+          #                                      Client ignore rules.
+          #         --ignore-server [/REGEXP/ [...]]
+          #                                      Server ignore rules.
+          #     -C, --close [/REGEXP/ [...]]     Close rules.
+          #         --close-client [/REGEXP/ [...]]
+          #                                      Client close rules.
+          #         --close-server [/REGEXP/ [...]]
+          #                                      Server close rules.
+          #     -R, --reset [/REGEXP/ [...]]     Reset rules.
+          #         --reset-client [/REGEXP/ [...]]
+          #                                      Client reset rules.
+          #         --reset-server [/REGEXP/ [...]]
+          #                                      Server reset rules.
+          #
+          # @since 1.5.0
+          # 
+          class Proxy < Command
+
+            summary 'Starts a TCP/UDP intercept proxy'
+
+            option :tcp, :type        => true,
+                         :default     => true,
+                         :flag        => '-t',
+                         :description => 'TCP Proxy'
+
+            option :udp, :type        => true,
+                         :flag        => '-u',
+                         :description => 'UDP Proxy'
+
+            option :hexdump, :type        => true,
+                             :flag        => '-x',
+                             :description => 'Enable hexdump output'
+
+            option :host, :type        => String,
+                          :default     => Network::Proxy::DEFAULT_HOST,
+                          :flag        => '-H',
+                          :usage       => 'HOST',
+                          :description => 'Host to listen on'
+
+            option :port, :type        => Integer,
+                          :flag        => '-p',
+                          :usage       => 'PORT',
+                          :description => 'Port to listen on'
+
+            option :server, :type        => String,
+                            :flag        => '-s',
+                            :usage       => 'HOST[:PORT]',
+                            :description => 'Server to forward connections to'
+
+            option :rewrite, :type        => Hash[Regexp => String],
+                             :flag        => '-r',
+                             :usage       => '/REGEXP/:STRING',
+                             :description => 'Rewrite rules'
+
+            option :rewrite_client, :type        => Hash[Regexp => String],
+                                    :usage       => '/REGEXP/:STRING',
+                                    :description => 'Client rewrite rules'
+
+            option :rewrite_server, :type        => Hash[Regexp => String],
+                                    :usage       => '/REGEXP/:STRING',
+                                    :description => 'Server rewrite rules'
+
+            option :ignore, :type        => Set[Regexp],
+                            :flag        => '-i',
+                            :usage       => '/REGEXP/ [...]',
+                            :description => 'Ignore rules'
+
+            option :ignore_client, :type        => Set[Regexp],
+                                   :usage       => '/REGEXP/ [...]',
+                                   :description => 'Client ignore rules'
+
+            option :ignore_server, :type        => Set[String],
+                                   :usage       => '/REGEXP/ [...]',
+                                   :description => 'Server ignore rules'
+
+            option :close, :type        => Set[Regexp],
+                           :flag        => '-C',
+                           :usage       => '/REGEXP/ [...]',
+                           :description => 'Close rules'
+
+            option :close_client, :type        => Set[Regexp],
+                                  :usage       => '/REGEXP/ [...]',
+                                  :description => 'Client close rules'
+
+            option :close_server, :type        => Set[Regexp],
+                                  :usage       => '/REGEXP/ [...]',
+                                  :description => 'Server close rules'
+
+            option :reset, :type        => Set[Regexp],
+                           :flag        => '-R',
+                           :usage       => '/REGEXP/ [...]',
+                           :description => 'Reset rules'
+
+            option :reset_client, :type        => Set[Regexp],
+                                  :usage       => '/REGEXP/ [...]',
+                                  :description => 'Client reset rules'
+
+            option :reset_server, :type        => Set[Regexp],
+                                  :usage       => '/REGEXP/ [...]',
+                                  :description => 'Server reset rules'
+
+            #
+            # Sets up the proxy command.
+            #
+            def setup
+              super
+
+              unless server?
+                print_error "Must specify the SERVER argument"
+                exit -1
+              end
+
+              @server_host, @server_port = server.split(':',2)
+              @server_port = if @server_port
+                               @server_port.to_i
+                             end
+
+              if hexdump?
+                @hexdumper = Hexdump::Dumper.new
+              end
+            end
+
+            #
+            # Executes the proxy command.
+            #
+            def execute
+              @proxy = proxy_class.new(
+                :port   => @port,
+                :host   => @host,
+                :server => [@server_host, @server_port]
+              )
+
+              if tcp?
+                @proxy.on_client_connect do |client|
+                  print_outgoing client, '[connecting]'
+                end
+
+                @proxy.on_client_disconnect do |client,server|
+                  print_outgoing client, '[disconnecting]'
+                end
+
+                @proxy.on_server_connect do |client,server|
+                  print_incoming client, '[connected]'
+                end
+
+                @proxy.on_server_disconnect do |client,server|
+                  print_incoming client, '[disconnected]'
+                end
+              end
+
+              if @reset_client
+                @reset_client.each do |pattern|
+                  @proxy.on_client_data do |client,server,data|
+                    @proxy.reset! if data =~ pattern
+                  end
+                end
+              end
+
+              if @close_client
+                @close_client.each do |pattern|
+                  @proxy.on_client_data do |client,server,data|
+                    @proxy.close! if data =~ pattern
+                  end
+                end
+              end
+
+              if @ignore_client
+                @ignore_client.each do |pattern|
+                  @proxy.on_client_data do |client,server,data|
+                    @proxy.ignore! if data =~ pattern
+                  end
+                end
+              end
+
+              if @rewrite_client
+                @rewrite_client.each do |pattern,replace|
+                  @proxy.on_client_data do |client,server,data|
+                    data.gsub!(pattern,replace)
+                  end
+                end
+              end
+
+              if @reset_server
+                @reset_server.each do |pattern|
+                  @proxy.on_server_data do |client,server,data|
+                    @proxy.reset! if data =~ pattern
+                  end
+                end
+              end
+
+              if @close_server
+                @close_server.each do |pattern|
+                  @proxy.on_server_data do |client,server,data|
+                    @proxy.close! if data =~ pattern
+                  end
+                end
+              end
+
+              if @ignore_server
+                @ignore_server.each do |pattern|
+                  @proxy.on_server_data do |client,server,data|
+                    @proxy.ignore! if data =~ pattern
+                  end
+                end
+              end
+
+              if @rewrite_server
+                @rewrite_server.each do |pattern,replace|
+                  @proxy.on_server_data do |client,server,data|
+                    data.gsub!(pattern,replace)
+                  end
+                end
+              end
+
+              if @reset
+                @reset.each do |pattern|
+                  @proxy.on_data do |client,server,data|
+                    @proxy.reset! if data =~ pattern
+                  end
+                end
+              end
+
+              if @close
+                @close.each do |pattern|
+                  @proxy.on_data do |client,server,data|
+                    @proxy.close! if data =~ pattern
+                  end
+                end
+              end
+
+              if @ignore
+                @ignore.each do |pattern|
+                  @proxy.on_data do |client,server,data|
+                    @proxy.ignore! if data =~ pattern
+                  end
+                end
+              end
+
+              if @rewrite
+                @rewrite.each do |pattern,replace|
+                  @proxy.on_data do |client,server,data|
+                    data.gsub!(pattern,replace)
+                  end
+                end
+              end
+
+              @proxy.on_client_data do |client,server,data|
+                print_outgoing client
+                print_data data
+              end
+
+              @proxy.on_server_data do |client,server,data|
+                print_incoming client
+                print_data data
+              end
+
+              @proxy.start
+            end
+
+            protected
+
+            #
+            # Determines the Proxy class based on the `--tcp` or `--udp`
+            # options.
+            #
+            # @return [Network::TCP::Proxy, Network::UDP::Proxy]
+            #   The proxy class.
+            #
+            def proxy_class
+              if udp?
+                Network::UDP::Proxy
+              elsif tcp?
+                Network::TCP::Proxy
+              end
+            end
+
+            #
+            # Returns the address for the connection.
+            #
+            # @param [(UDPSocket,(host, port)), TCPSocket, UDPSocket] connection
+            #   The connection.
+            #
+            # @return [String]
+            #   The address of the connection.
+            #
+            def address(connection)
+              case connection
+              when Array
+                socket, (host, port) = connection
+
+                "#{host}:#{port}"
+              when TCPSocket, UDPSocket
+                addrinfo = connection.peeraddr
+
+                "#{addrinfo[3]}:#{addrinfo[1]}"
+              end
+            end
+
+            #
+            # Prints a connection header for an incoming event.
+            #
+            # @param [(UDPSocket,(host, port)), TCPSocket, UDPSocket] client
+            #   The client.
+            #
+            # @param [String] event
+            #   The optional name of the event.
+            #
+            def print_incoming(client,event=nil)
+              print_info "#{address(client)} <- #{@proxy} #{event}"
+            end
+
+            #
+            # Prints a connection header for an outgoing event.
+            #
+            # @param [(UDPSocket,(host, port)), TCPSocket, UDPSocket] client
+            #   The client.
+            #
+            # @param [String] type
+            #   The optional name of the event.
+            #
+            def print_outgoing(client,type=nil)
+              print_info "#{address(client)} -> #{@proxy} #{type}"
+            end
+
+            #
+            # Prints data from a message.
+            #
+            # @param [String] data
+            #   The data from a message.
+            #
+            def print_data(data)
+              if hexdump?
+                @hexdumper.dump(data)
+              else
+                puts data
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end