arachni 1.3.2 → 1.4

data/components/plugins/metrics.rb

@@ -1,5 +1,5 @@
 =begin
-    Copyright 2010-2015 Tasos Laskos <tasos.laskos@arachni-scanner.com>
+    Copyright 2010-2016 Tasos Laskos <tasos.laskos@arachni-scanner.com>
 
     This file is part of the Arachni Framework project and is subject to
     redistribution and commercial restrictions. Please see the Arachni Framework

data/components/plugins/proxy.rb

@@ -1,5 +1,5 @@
 =begin
-    Copyright 2010-2015 Tasos Laskos <tasos.laskos@arachni-scanner.com>
+    Copyright 2010-2016 Tasos Laskos <tasos.laskos@arachni-scanner.com>
 
     This file is part of the Arachni Framework project and is subject to
     redistribution and commercial restrictions. Please see the Arachni Framework
@@ -53,7 +53,7 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
         framework_pause
         print_info 'System paused.'
 
-        print_status "Listening on: http://#{@server[:BindAddress]}:#{@server[:Port]}"
+        print_status "Listening on: #{@server.url}"
 
         print_info "Control panel URL: #{url_for( :panel )}"
         print_info "Shutdown URL:      #{url_for( :shutdown )}"
@@ -61,7 +61,7 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
         print_info
         print_info 'When browsing HTTPS sites, please accept the Arachni SSL certificate' +
             ' or install the CA certificate manually from:'
-        print_info "    #{Arachni::HTTP::ProxyServer::INTERCEPTOR_CA_CERTIFICATE}"
+        print_info "    #{Arachni::HTTP::ProxyServer::SSLInterceptor::CA_CERTIFICATE}"
         print_info
         print_bad '**DO NOT** forget to revoke it after using the proxy, as it' +
             ' can be used by anyone to impersonate 3rd party servers.'
@@ -73,29 +73,21 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
 
         TemplateScope.get.set :params, {}
 
-        Thread.new do
-            @server.start
-        end
+        @server.start_async
 
         wait_while_framework_running
     end
 
     def clean_up
+        return if @cleaned_up
+        @cleaned_up = true
+
         @server.shutdown
 
         @pages.each { |p| framework.push_to_page_queue( p, true ) }
         framework_resume
     end
 
-    def prepare_pages_for_inspection
-        (@pages.select do |p|
-            next if !p.text?
-
-            p.forms.any? || p.links.any? || p.cookies.any? || p.jsons.any? ||
-                p.xmls.any?
-        end).to_a
-    end
-
     def vectors_yaml
         vectors = []
         prepare_pages_for_inspection.each do |page|
@@ -201,9 +193,12 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
         # Avoid propagating the proxy's session cookie to the webapp.
         req.cookies.delete SESSION_TOKEN_COOKIE
 
+        res.code = 200
+
         if url.start_with? url_for( :panel )
             body =  case '/' + res.parsed_url.path.split( '/' )[2..-1].join( '/' )
                         when '/'
+                            TemplateScope.get.set :pages, prepare_pages_for_inspection
                             erb :panel
 
                         when '/vectors.yml'
@@ -214,10 +209,6 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
                                 format:  :yml,
                                 vectors: vectors_yaml
 
-                        when '/inspect'
-                            erb :inspect,
-                                pages: prepare_pages_for_inspection
-
                         when '/help'
                             erb :help
 
@@ -228,8 +219,8 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
                         when '/record/stop'
                             record_stop
                             erb :verify_login_check, verify_fail: false, params: {
-                                'url'     => framework.options.login.check_url,
-                                'pattern' => framework.options.login.check_pattern
+                                'url'     => framework.options.session.check_url,
+                                'pattern' => framework.options.session.check_pattern
                             }
 
                         when '/verify/login_check'
@@ -237,8 +228,8 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
                             if req.method != :post
                                 erb :verify_login_check, verify_fail: false
                             else
-                                framework.options.login.check_url     = params['url']
-                                framework.options.login.check_pattern = params['pattern']
+                                framework.options.session.check_url     = params['url']
+                                framework.options.session.check_pattern = params['pattern']
 
                                 if !session.logged_in?
                                     erb :verify_login_check,
@@ -283,6 +274,10 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
         end
 
         true
+
+    rescue => e
+        ap e
+        ap e.backtrace
     end
 
     def requires_token?( url )
@@ -349,9 +344,31 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
         @pages.map { |p| p.forms.select { |f| f.requires_password? } }.flatten
     end
 
+    def prepare_pages_for_inspection
+        (@pages.map do |p|
+            next if !p.text?
+            p = p.dup
+
+            %w(links forms cookies jsons xmls).each do |type|
+                p.send(
+                    "#{type}=",
+                    p.send(type).reject { |e| e.inputs.empty? }
+                )
+            end
+
+            if !(p.forms.any? || p.links.any? || p.cookies.any? || p.jsons.any? ||
+                p.xmls.any?)
+                next
+            end
+
+            p
+        end).compact
+    end
+
     # Called by the proxy for each response.
     def response_handler( request, response )
-        return response if response.scope.out?
+        return response if response.scope.out? || !response.text? ||
+            response.code == 304
 
         if ignore_responses?
             page = Page.from_data(
@@ -371,15 +388,9 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
         print_info " *  #{page.xmls.size} XML"
 
         @pages << page.dup
-
-        inject_panel response
-    rescue => e
-        ap e
-        ap e.backtrace
     end
 
     def update_forms( page, request, response )
-
         if (json = Arachni::Element::JSON.from_request( response.url, request ))
             page.jsons |= [json]
             return page
@@ -397,17 +408,10 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
             inputs: request_parse_body( request.body.to_s )
         )]
         page
-    end
 
-    def inject_panel( response )
-        if !response.headers.content_type.to_s.start_with?( 'text/html' ) ||
-            !(body_tag = response.body.match( /<(\s*)body(.*)>/i ))
-            return response
-        end
-
-        response.body.gsub!( body_tag.to_s, "#{body_tag}#{panel_iframe}" )
-        response.headers['content-length'] = response.body.size.to_s
-        response
+    rescue => e
+        ap e
+        ap e.backtrace
     end
 
     def panel_iframe
@@ -432,6 +436,9 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
 
     def erb( *args )
         TemplateScope.get.erb( *args )
+    rescue => e
+        ap e
+        ap e.backtrace
     end
 
     def ignore_responses?
@@ -482,23 +489,41 @@ class Arachni::Plugins::Proxy < Arachni::Plugin::Base
 * Supports SSL interception.
 * Authorization via a configurable session token.
 
+**MANAGEMENT**
+
+* [Control panel](http://arachni.proxy/panel)
+* [Shutdown URL](http://arachni.proxy/shutdown)
+
+_The above URLs will only work from a browser configured to use the proxy._
+
+**SSL**
+
+When browsing HTTPS sites, please accept the Arachni SSL certificate or install
+the CA certificate manually from:
+
+    %s
+
+**INFO**
+
 To skip crawling and only audit elements discovered by using the proxy
 set the scope page-limit option to '0'.
 
-**NOTICE**:
+**NOTICE**
+
 The `session_token` will be looked for in a cookie named
 `arachni.proxy.session_token`, so if you choose to use a token to restrict
 access to the proxy and need to pass traffic through the proxy programmatically
 please configure your HTTP client with a cookie named `arachni.proxy.session_token`
 with the value of the 'session_token' option.
 
-**WARNING**:
+**WARNING**
+
 The `session_token` option is not a way to secure usage of this proxy but rather
 a way to restrict usage enough to avoid users unwittingly interfering with each
 others' sessions.
-},
+} % Arachni::HTTP::ProxyServer::SSLInterceptor::CA_CERTIFICATE,
             author:      'Tasos "Zapotek" Laskos <tasos.laskos@arachni-scanner.com>',
-            version:     '0.3.5',
+            version:     '0.4',
             options:     [
                 Options::Port.new( :port,
                     description: 'Port to bind to.',

data/components/plugins/proxy/panel/help.html.erb

@@ -1,8 +1,7 @@
 <% content_for :title, 'Help' %>
 
 <div class="hero-unit">
-    <h1>Fear not,</h1>
-    <h2>help is at hand.</h2>
+    <h1>Fear not, help is at hand.</h1>
 </div>
 
 <div class="alert">
@@ -11,7 +10,6 @@
     the proxy.
 </div>
 
-
 <div class="well">
     <h2>Recording a log-in sequence</h2>
     <div class="alert">
@@ -41,21 +39,6 @@
     </p>
 </div>
 
-<div class="well">
-    <h2>Inspecting discovered pages</h2>
-    <div class="alert alert-info">
-        <strong>Heads up!</strong>
-        The proxy will actually log all sorts of responses, even images and documents,
-        however you won't be presented with these.
-    </div>
-
-    <p>
-        You can review the logged pages along with their elements by clicking the
-        open-eye icon.
-    </p>
-
-</div>
-
 <div class="well">
     <h2>Shutting down and starting the scan</h2>
     <p>

data/components/plugins/proxy/panel/inspect.html.erb

@@ -1,7 +1,8 @@
-<% content_for :title, 'Discovered elements' %>
-
 <div class="hero-unit">
-    <h1><em><%= pages.size %></em> pages with auditable elements thus far</h1>
+    <h1>
+      <em><%= pages.size %></em>
+      pages with auditable elements
+    </h1>
 </div>
 
 <%= render :page_twin_accordion, pages: pages  %>

data/components/plugins/proxy/panel/page_accordion.html.erb

@@ -2,96 +2,131 @@
     <% (pages || []).each.with_index do |page, i| %>
         <div class="accordion-group">
             <div class="accordion-heading">
-                <p class="btn accordion-toggle" data-toggle="collapse"
+                <div class="btn accordion-toggle" data-toggle="collapse"
                    data-parent="#pages-accordion" href="#page<%= page.hash %>">
-                    <%= html_encode page.title %>
-                    -
+
+                    <% if !page.title.to_s.empty? %>
+                      <p>
+                          <%= html_encode page.title %>
+                      </p>
+                    <% end %>
+
+                    <p>
+                      <%= page.dom.url %>
+                    </p>
+
                     <%= page.forms.size %> forms,
                     <%= page.links.size %> links,
                     <%= page.cookies.size %> cookies,
                     <%= page.jsons.size %> JSONs and
                     <%= page.xmls.size %> XMLs.
-
-                    <br/>
-
-                    (<%= page.url %>)
-                </p>
+                </div>
             </div>
+
             <div id="page<%= page.hash %>" class="accordion-body collapse">
                 <div class="accordion-inner">
+
+                  <% if page.forms.any? %>
                     <div class="well forms">
                         <h2>Forms</h2>
                         <% page.forms.each do |form| %>
-                            <p>
+                            <div>
                                 <b>
                                     Action: <%= html_encode form.action %>
                                     (method <%= form.method.to_s.upcase %>)
                                 </b>
                                 <ul>
                                     <% form.inputs.each do |k, v| %>
-                                        <li><%= k.inspect %> = <%= v.inspect %></li>
+                                        <li>
+                                          <code><%= html_encode k %></code> =
+                                          <code><%= html_encode v %></code>
+                                        </li>
                                     <% end %>
                                 </ul>
-                            </p>
+                            </div>
+
                             <hr />
                         <% end %>
                     </div>
+                  <% end %>
+
+                  <% if page.links.any? %>
                     <div class="well links">
                         <h2>Links</h2>
                         <% page.links.each do |link| %>
-                            <p>
+                            <div>
                                 <b>Action: <%= html_encode link.action %></b>
-                            <ul>
-                                <% link.inputs.each do |k, v| %>
-                                    <li><%= k.inspect %> = <%= v.inspect %></li>
-                                <% end %>
-                            </ul>
-                            </p>
+                                <ul>
+                                    <% link.inputs.each do |k, v| %>
+                                      <code><%= html_encode k %></code> =
+                                      <code><%= html_encode v %></code>
+                                    <% end %>
+                                </ul>
+                            </div>
+
                             <hr />
                         <% end %>
                     </div>
-                    <div class="well links">
+                  <% end %>
+
+                  <% if page.cookies.any? %>
+                    <div class="well cookies">
                         <h2>Cookies</h2>
                         <% page.cookies.each do |cookie| %>
-                            <p>
+                            <div>
                                 <b>Action: <%= html_encode cookie.action %></b>
-                            <ul>
-                                <% cookie.inputs.each do |k, v| %>
-                                    <li><%= k.inspect %> = <%= v.inspect %></li>
-                                <% end %>
-                            </ul>
-                            </p>
+                                <ul>
+                                    <% cookie.inputs.each do |k, v| %>
+                                      <code><%= html_encode k %></code> =
+                                      <code><%= html_encode v %></code>
+                                    <% end %>
+                                </ul>
+                            </div>
+
                             <hr />
                         <% end %>
                     </div>
-                    <div class="well links">
+                  <% end %>
+
+                  <% if page.jsons.any? %>
+                    <div class="well jsons">
                         <h2>JSONs</h2>
                         <% page.jsons.each do |json| %>
-                            <p>
-                                <b>Action: <%= html_encode json.action %></b>
-                            <ul>
-                                <% json.inputs.each do |k, v| %>
-                                    <li><%= k.inspect %> = <%= v.inspect %></li>
-                                <% end %>
-                            </ul>
-                            </p>
+                            <div>
+                              <b>Action: <%= html_encode json.action %></b>
+
+                              <ul>
+                                  <% json.inputs.each do |k, v| %>
+                                    <code><%= html_encode k %></code> =
+                                    <code><%= html_encode v %></code>
+                                  <% end %>
+                              </ul>
+                            </div>
+
                             <hr />
                         <% end %>
                     </div>
-                    <div class="well links">
+                  <% end %>
+
+                  <% if page.xmls.any? %>
+                    <div class="well xmls">
                         <h2>XMLs</h2>
                         <% page.xmls.each do |xml| %>
-                            <p>
+                            <div>
                                 <b>Action: <%= html_encode xml.action %></b>
-                            <ul>
-                                <% xml.inputs.each do |k, v| %>
-                                    <li><%= k.inspect %> = <%= v.inspect %></li>
-                                <% end %>
-                            </ul>
-                            </p>
+                                <ul>
+                                    <% xml.inputs.each do |k, v| %>
+                                      <code><%= html_encode k %></code> =
+                                      <code><%= html_encode v %></code>
+                                    <% end %>
+                                </ul>
+
+                            </div>
+
                             <hr />
                         <% end %>
                     </div>
+                  <% end %>
                 </div>
             </div>
         </div>