Rakefile

require 'rubygems'
require 'backports'
require 'csv'
require 'fileutils'
require 'open-uri'
require 'rake/testtask'
require 'rdoc/task'
require 'uri'

namespace :docs do
    RDoc::Task.new do |rdoc|
      files         = [
          'lib/models/vulnscanner.rb',
          'lib/models/poi.rb',
          'lib/models/signature.rb'
      ]
      rdoc.rdoc_files.add(files)

      rdoc.main     = 'README.rdoc'
      rdoc.title    = 'WatchTower rdocs'
      rdoc.rdoc_dir = 'doc'
      rdoc.options << '--line-numbers'
    end
    
    desc "Builds the example reports"
    task :examples do
        puts 'Generating example reports...'
        
        # mark the current directory
        cwd = File.expand_path File.dirname(__FILE__)
        
        # download and extract DVWA to build some sample reports
        print 'Downloading the Damn Vulnerable Web Applciation...'
        `cd /tmp/; wget 'http://dvwa.googlecode.com/files/DVWA-1.0.7.zip'; unzip '/tmp/DVWA-1.0.7.zip'` 
        puts 'Done.'
        
        # build sample reports for all file types
        project = 'Damn Vulnerable Web Application'
        ## plain text ##
        print 'Generating a plain-text report...'
        `#{cwd}/watchtower -s /tmp/dvwa/ -p '#{project}' -C 7 -o txt > #{cwd}/examples/report.txt`
        puts 'Done.'

        ## csv ##
        print 'Generating a CSV report...'
        `#{cwd}/watchtower -s /tmp/dvwa/ -p '#{project}' -C 7 -o csv > #{cwd}/examples/report.csv`
        puts 'Done.'

        ## xml ##
        print 'Generating an XML report...'
        `#{cwd}/watchtower -s /tmp/dvwa/ -p '#{project}' -C 7 -o xml > #{cwd}/examples/report.xml`
        puts 'Done.'

        ## markdown ##
        print 'Generating a Markdown report...'
        `#{cwd}/watchtower -s /tmp/dvwa/ -p '#{project}' -C 7 -o markdown > #{cwd}/examples/report.markdown`
        puts 'Done.'

        ## html ##
        print 'Generating an HTML report...'
        `#{cwd}/watchtower -s /tmp/dvwa/ -p '#{project}' -C 7 -o html > #{cwd}/examples/report.html`
        puts 'Done.'
        
        # clean up
        puts 'Cleaning up...'
        `rm '/tmp/DVWA-1.0.7.zip'`
        `rm -rf '/tmp/dvwa/'`
        
        puts 'The example reports have been generated.'
    end 
end


namespace :sigs do

    desc "Generates signatures files based off of known malware domains and IP addresses"
    task :generate_blocklists do

        # download the entire Malware Domain List
        puts 'Downloading updated blocklist from malwaredomainlist.com...'        
        csv = open('http://www.malwaredomainlist.com/mdlcsv.php').read
        
        # generate the blocklists
        puts 'Download complete. Generating blocklists...'
        
        # track the ips and domains
        ips     = {}
        domains = {}
        
        # buffer the signatures produced
        ip_signatures     = ''
        domain_signatures = '';
        
        # iterate over the downloaded signatures file
        CSV.parse(csv) do |row|
            # parse out the domain and IP address
            domain =  row[3].chomp unless row[3].nil?
            
            # this regex isn't quite correct, but it's good enough
            # for our purposes here
            ip = row[2].chomp.match(/\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/) unless row[2].nil?
            
            # process the domain
            if !domain.nil? and !domain.eql? '-' and !domain.eql? '.' and !domains.has_key? domain.to_s
                # buffer the signature
                domain_signatures += "\tSignature.new({:literal => '#{domain}'}),\n"
                # track that this domain exists
                domains[domain.to_s] = true
            end
            
            # process the ip address
            if !ip.nil? and !ip.eql? '-' and !ips.has_key? ip.to_s
                # buffer the signature
                ip_signatures += "\tSignature.new({:literal => '#{ip}'}),\n"
                # track that this IP exists
                ips[ip.to_s] = true
            end
        end
        
        # strip the trailing whitespace from the buffers
        domain_signatures.chomp!
        ip_signatures.chomp!
        
        # assemble the Ruby for the signatures file
        ruby = <<-sigs
$signatures[:blocklists] ||= {}

$signatures[:blocklists][:malicious_domains] = [
#{domain_signatures}
]

$signatures[:blocklists][:malicious_ips] = [
#{ip_signatures}
]
sigs

        # flush the buffers to a signatures file
        puts 'Flushing buffers to file...'
        File.open('./signatures/blocklist.rb', 'w') {|f| f.write(ruby) }
        puts 'Complete.'
    end
end

namespace :lint do
    desc "Runs JavaScript files through jshint"
    task :js do
        puts 'Linting JavaScript files...'
        js_files = `find ./lib/static/js/ -name '*.js.erb' | grep -v 'vendor'`.split "\n"
        js_files.each do |f|
            lint_out = `jshint --extra-ext .erb --config ./test/jshint-config.json #{f}`
            # don't output empty lines which would otherwise be outputted
            # when a file contains no errors
            puts lint_out unless lint_out.strip!.to_s.empty?
        end
    end
end

desc 'Builds the project'
task :build do
    puts 'Building project...'
    Rake::Task['sigs:generate_blocklists'].execute
    Rake::Task['docs:examples'].execute
    Rake::Task['docs:rerdoc'].execute
    puts 'Build complete. Did you remember to update the version number if necessary?'
end

Rake::TestTask.new do |test|
	test.libs << 'test'
	test.test_files = ['test/test_poi.rb', 'test/test_vulnscanner.rb', 'test/test_signature.rb', 'test/test_reports.rb']
	test.verbose = false
end