Class: Arachni::RPC::Server::Framework
- Includes:
- MultiInstance, Utilities
- Defined in:
- lib/arachni/rpc/server/framework.rb,
lib/arachni/rpc/server/framework/slave.rb,
lib/arachni/rpc/server/framework/master.rb,
lib/arachni/rpc/server/framework/distributor.rb,
lib/arachni/rpc/server/framework/multi_instance.rb
Overview
Ignore:
-
Inherited methods and attributes – only public methods of this class are
accessible over RPC.
-
‘block` parameters, they are an RPC implementation detail for methods which
perform asynchronous operations.
Wraps the framework of the local instance and the frameworks of all its slaves (when it is a Master in multi-Instance mode) into a neat, easy to handle package.
Defined Under Namespace
Modules: Distributor, Master, MultiInstance, Slave Classes: Error
Constant Summary
Constants included from Distributor
Constants inherited from Framework
Framework::AUDIT_PAGE_MAX_TRIES
Instance Attribute Summary
Attributes inherited from Framework
#checks, #failures, #http, #options, #plugins, #reporters, #session, #trainer
Instance Method Summary collapse
-
#busy?(&block) ⇒ Bool
‘true` If the system is scanning, `false` if #run hasn’t been called yet or if the scan has finished.
-
#clean_up(&block) ⇒ Object
If the scan needs to be aborted abruptly this method takes care of any unfinished business (like signaling running plug-ins to finish).
- #error_test(str, &block) ⇒ Object
-
#initialize ⇒ Framework
constructor
A new instance of Framework.
-
#issues ⇒ Array<Hash>
First variations of all discovered issues with generic info filled in from the parent as RPC data.
-
#issues_as_hash ⇒ Array<Hash>
#issues as an array of Hashes.
-
#list_checks ⇒ Array<Hash>
Information about all available Checks.
-
#list_plugins ⇒ Array<Hash>
Information about all available Plugins.
-
#list_reporters ⇒ Array<Hash>
Information about all available Arachni::Reporters.
- #report(&block) ⇒ Report
-
#run ⇒ Bool
Starts the scan.
-
#self_url ⇒ String
URL of this instance.
- #sitemap_entries(from_index = 0) ⇒ Hash<String=>Integer>
-
#token ⇒ String
This instance’s RPC token.
Methods included from MultiInstance
#errors, #multi_self_url, #progress, #solo?, #update_page_queue
Methods included from Master
#enslave, #has_slaves?, #master?, #set_as_master, #slave_sitrep
Methods included from Slave
#process_pages, #set_master, #slave?
Methods included from Distributor
#connect_to_instance, #each_slave, #iterator_for, #map_slaves, #slave_iterator
Methods included from Utilities
#available_port, #caller_name, #caller_path, #cookie_decode, #cookie_encode, #cookies_from_document, #cookies_from_file, #cookies_from_response, #exception_jail, #exclude_path?, #follow_protocol?, #form_decode, #form_encode, #forms_from_document, #forms_from_response, #generate_token, #get_path, #hms_to_seconds, #html_decode, #html_encode, #include_path?, #links_from_document, #links_from_response, #normalize_url, #page_from_response, #page_from_url, #parse_set_cookie, #path_in_domain?, #path_too_deep?, #port_available?, #rand_port, #random_seed, #redundant_path?, #remove_constants, #request_parse_body, #seconds_to_hms, #skip_page?, #skip_path?, #skip_resource?, #skip_response?, #to_absolute, #uri_decode, #uri_encode, #uri_parse, #uri_parse_query, #uri_parser, #uri_rewrite
Methods inherited from Framework
#abort, #abort?, #aborted?, #aborting?, #accepts_more_pages?, #after_page_audit, #audit_page, #browser_cluster, #browser_job_skip_states, #crawl?, #data, #host_has_browser?, #list_platforms, #on_page_audit, #page_limit_reached?, #page_queue_total_size, #pause, #pause?, #paused?, #pausing?, #push_to_page_queue, #push_to_url_queue, #report_as, reset, #reset, #reset_trainer, #restore, restore, #resume, #running?, #scanning?, #sitemap, #snapshot_path, #state, #statistics, #status, #status_messages, #suspend, #suspend?, #suspended?, #url_queue_total_size, #version, #wait_for_browser?
Methods included from Support::Mixins::Observable
Methods included from UI::Output
#debug?, #debug_off, #debug_on, #disable_only_positives, #included, #mute, #muted?, #only_positives, #only_positives?, #print_bad, #print_debug, #print_debug_backtrace, #print_debug_level_1, #print_debug_level_2, #print_debug_level_3, #print_error, #print_error_backtrace, #print_exception, #print_info, #print_line, #print_ok, #print_status, #print_verbose, #reroute_to_file, #reroute_to_file?, reset_output_options, #unmute, #verbose?, #verbose_on
Constructor Details
#initialize ⇒ Framework
Returns a new instance of Framework.
69 70 71 72 73 74 75 |
# File 'lib/arachni/rpc/server/framework.rb', line 69 def initialize( * ) super # Override standard framework components with their RPC-server counterparts. @checks = Check::Manager.new( self ) @plugins = Plugin::Manager.new( self ) end |
Instance Method Details
#busy?(&block) ⇒ Bool
Returns ‘true` If the system is scanning, `false` if #run hasn’t been called yet or if the scan has finished.
116 117 118 119 120 121 122 123 124 125 |
# File 'lib/arachni/rpc/server/framework.rb', line 116 def busy?( &block ) # If we have a block it means that it was called via RPC, so use the # status variable to determine if the scan is done. if block_given? block.call @prepared && status != :done return end !!@extended_running end |
#clean_up(&block) ⇒ Object
If the scan needs to be aborted abruptly this method takes care of any unfinished business (like signaling running plug-ins to finish).
Should be called before grabbing the #report, especially when running in multi-Instance mode, as it will take care of merging the plug-in results of all instances.
You don’t need to call this if you’ve let the scan complete.
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/arachni/rpc/server/framework.rb', line 169 def clean_up( &block ) if @rpc_cleaned_up # Don't shutdown the BrowserCluster here, its termination will be # handled by Instance#shutdown. block.call false if block_given? return false end @rpc_cleaned_up = true @extended_running = false r = super( false ) if !block_given? state.status = :done return r end if !has_slaves? state.status = :done block.call r return end foreach = proc do |instance, iter| instance.framework.clean_up do instance.plugins.results do |res| iter.return( !res.rpc_exception? ? res : nil ) end end end after = proc do |results| @plugins.merge_results( results.compact ) state.status = :done block.call true end map_slaves( foreach, after ) end |
#error_test(str, &block) ⇒ Object
244 245 246 247 248 249 250 |
# File 'lib/arachni/rpc/server/framework.rb', line 244 def error_test( str, &block ) print_error str.to_s return block.call if !has_slaves? each = proc { |instance, iter| instance.framework.error_test( str ) { iter.next } } each_slave( each, &block ) end |
#issues ⇒ Array<Hash>
Returns First variations of all discovered issues with generic info filled in from the parent as RPC data.
213 214 215 |
# File 'lib/arachni/rpc/server/framework.rb', line 213 def issues Data.issues.map { |issue| issue.variations.first.to_solo( issue ).to_rpc_data } end |
#issues_as_hash ⇒ Array<Hash>
Returns #issues as an array of Hashes.
221 222 223 |
# File 'lib/arachni/rpc/server/framework.rb', line 221 def issues_as_hash Data.issues.map { |issue| issue.variations.first.to_solo( issue ).to_h } end |
#list_checks ⇒ Array<Hash>
Returns Information about all available Checks.
106 107 108 109 110 111 |
# File 'lib/arachni/rpc/server/framework.rb', line 106 def list_checks super.map do |check| check[:issue][:severity] = check[:issue][:severity].to_s check end end |
#list_plugins ⇒ Array<Hash>
Returns Information about all available Plugins.
90 91 92 93 94 95 |
# File 'lib/arachni/rpc/server/framework.rb', line 90 def list_plugins super.map do |plugin| plugin[:options] = plugin[:options].map(&:to_h) plugin end end |
#list_reporters ⇒ Array<Hash>
Returns Information about all available Arachni::Reporters.
98 99 100 101 102 103 |
# File 'lib/arachni/rpc/server/framework.rb', line 98 def list_reporters super.map do |reporter| reporter[:options] = reporter[:options].map(&:to_h) reporter end end |
#report(&block) ⇒ Report
Returns Arachni::Report#to_rpc_data.
79 80 81 82 83 84 85 86 87 |
# File 'lib/arachni/rpc/server/framework.rb', line 79 def report( &block ) # If a block is given it means the call was form an RPC client. if block_given? block.call super.to_rpc_data return end super end |
#run ⇒ Bool
Starts the scan.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/arachni/rpc/server/framework.rb', line 139 def run # Return if we're already running. return false if busy? @extended_running = true # Prepare the local instance (runs plugins and starts the timer). prepare # Start the scan -- we can't block the RPC server so we're using a Thread. # Thread.abort_on_exception = true Thread.new do if !solo? multi_run else super end end true end |
#self_url ⇒ String
Returns URL of this instance.
229 230 231 232 233 234 235 |
# File 'lib/arachni/rpc/server/framework.rb', line 229 def self_url .dispatcher.external_address ||= .rpc.server_address @self_url ||= .dispatcher.external_address ? "#{.dispatcher.external_address }:#{.rpc.server_port}" : .rpc.server_socket end |
#sitemap_entries(from_index = 0) ⇒ Hash<String=>Integer>
131 132 133 |
# File 'lib/arachni/rpc/server/framework.rb', line 131 def sitemap_entries( from_index = 0 ) Hash[sitemap.to_a[from_index..-1] || {}] end |
#token ⇒ String
Returns This instance’s RPC token.
239 240 241 |
# File 'lib/arachni/rpc/server/framework.rb', line 239 def token .datastore.token end |