a big hairy fuzzy spider that crawls your site, wreaking havoc
a big hairy fuzzy spider that crawls your site, wreaking havoc
= Tarantula
== DESCRIPTION
Tarantula is a big fuzzy spider. It crawls your Rails 2.3 and 3.x applications, fuzzing data to see what breaks.
{}[http://travis-ci.org/relevance/tarantula]
== Usage
=== Installation
The latest and greatest version is always available on GitHub. (See the rakefile for dependencies, or just let RubyGems handle it). Add it to your Gemfile as normal:
gem "tarantula"
Or for Rails 3 applications:
gem 'tarantula', :require => 'tarantula-rails3'
=== Crawling Your App
Use the included rake task to create a Rails integration test that will allow Tarantula to crawl your app.
$ rake tarantula:setup
Take a moment to familiarize yourself with the generated test. If parts of your application require login, update the test to make sure Tarantula can access those parts of your app.
require "relevance/tarantula" require "test_helper"
class TarantulaTest 'quentin', :password => 'monkey' # follow_redirect!
tarantula_crawl(self)
end
end
If you want to set custom options, you can get access to the crawler and set properties before running it. For example, this would turn on HTMLTidy.
def test_tarantula post '/session', :login => 'kilgore', :password => 'trout' assert_response :redirect assert_redirected_to '/' follow_redirect!
t = tarantula_crawler(self)
t.handlers :xss,
:input => "
", :output => " ", }
Relevance::Tarantula::FormSubmission.attacks :sql_injection,
:input => "a'; DROP TABLE posts;",
}
t.handlers << Relevance::Tarantula::AttackHandler.new
t.times_to_crawl = 2
t.crawl "/posts"
endThis example adds custom attacks for both SQL injection and XSS. It also tells Tarantula to crawl the app 2 times. This is important for XSS attacks because the results won't appear until the second time Tarantula performs the crawl.
== Timeout
You can specify a timeout for each specific crawl that Tarantula runs. For example:
def test_tarantula t = tarantula_crawler(self) t.times_to_crawl = 2 t.crawl_timeout = 5.minutes t.crawl "/" end
The above will crawl your app twice, and each specific crawl will timeout if it takes longer then 5 minutes. You may need a timeout to keep the tarantula test time reasonable if your app is large or just happens to have a large amount of 'never-ending' links, such as with an any sort of "auto-admin" interface.
== Bugs/Requests
Please submit your bug reports, patches, or feature requests in Github Issues.
== License
Tarantula is released under the MIT license.
No open issues yet, or sync has not completed.