dradis-qualys 3.18.0

data/README.md

@@ -0,0 +1,28 @@
+# Qualys plugin for Dradis
+
+[![Build Status](https://secure.travis-ci.org/dradis/dradis-qualys.png?branch=master)](http://travis-ci.org/dradis/dradis-qualys) [![Code Climate](https://codeclimate.com/github/dradis/dradis-qualys.png)](https://codeclimate.com/github/dradis/dradis-qualys.png)
+
+Upload Qualys files into Dradis.
+
+The add-on requires [Dradis CE](https://dradisframework.org/) > 3.0, or [Dradis Pro](https://dradisframework.com/pro/).
+
+
+
+## More information
+
+See the Dradis Framework's [README.md](https://github.com/dradis/dradisframework/blob/master/README.md)
+
+
+## Contributing
+
+See the Dradis Framework's [CONTRIBUTING.md](https://github.com/dradis/dradisframework/blob/master/CONTRIBUTING.md)
+
+
+## License
+
+Dradis Framework and all its components are released under [GNU General Public License version 2.0](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html) as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file.
+
+
+## Feature requests and bugs
+
+Please use the [Dradis Framework issue tracker](https://github.com/dradis/dradis-ce/issues) for add-on improvements and bug reports.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dradis-qualys.gemspec

@@ -0,0 +1,34 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'dradis/plugins/qualys/version'
+version = Dradis::Plugins::Qualys::VERSION::STRING
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.platform    = Gem::Platform::RUBY
+  spec.name        = 'dradis-qualys'
+  spec.version     = version
+  spec.summary     = 'Qualys add-on for the Dradis Framework.'
+  spec.description = 'This add-on allows you to upload and parse output produced from Qualys Vulnerability Scanner into Dradis.'
+
+  spec.license     = 'GPL-2'
+
+  spec.authors     = ['Daniel Martin']
+  spec.email       = ['etd@nomejortu.com']
+  spec.homepage    = 'http://dradisframework.org'
+
+  spec.files       = `git ls-files`.split($\)
+  spec.executables = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files  = spec.files.grep(%r{^(test|spec|features)/})
+
+  # By not including Rails as a dependency, we can use the gem with different
+  # versions of Rails (a sure recipe for disaster, I'm sure), which is needed
+  # until we bump Dradis Pro to 4.1.
+  # s.add_dependency 'rails', '~> 4.1.1'
+  spec.add_dependency 'dradis-plugins', '~> 3.6'
+  spec.add_dependency 'nokogiri', '~> 1.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'combustion', '~> 0.5.2'
+end

data/lib/dradis-qualys.rb

@@ -0,0 +1,8 @@
+# Hook to the framework base clases
+require 'dradis-plugins'
+
+# Load this add-on's engine
+require 'dradis/plugins/qualys'
+
+# Load supporting Qualys classes
+require 'qualys/element'

data/lib/dradis/plugins/qualys.rb

@@ -0,0 +1,11 @@
+module Dradis
+  module Plugins
+    module Qualys
+    end
+  end
+end
+
+require 'dradis/plugins/qualys/engine'
+require 'dradis/plugins/qualys/field_processor'
+require 'dradis/plugins/qualys/importer'
+require 'dradis/plugins/qualys/version'

data/lib/dradis/plugins/qualys/engine.rb

@@ -0,0 +1,13 @@
+module Dradis
+  module Plugins
+    module Qualys
+      class Engine < ::Rails::Engine
+        isolate_namespace Dradis::Plugins::Qualys
+
+        include ::Dradis::Plugins::Base
+        description 'Processes Qualys output'
+        provides :upload
+      end
+    end
+  end
+end

data/lib/dradis/plugins/qualys/field_processor.rb

@@ -0,0 +1,42 @@
+module Dradis
+  module Plugins
+    module Qualys
+      class FieldProcessor < Dradis::Plugins::Upload::FieldProcessor
+
+        def post_initialize(args={})
+          @cat_object = data
+          @qualys_object = ::Qualys::Element.new(data.elements.first)
+        end
+
+        def value(args={})
+          field = args[:field]
+
+          # Fields in the template are of the form <foo>.<field>, where <foo>
+          # is common across all fields for a given template (and meaningless).
+          _, name = field.split('.')
+
+          if %w{cat_fqdn cat_misc cat_port cat_protocol cat_value}.include?(name)
+            attribute = name[4..-1]
+            @cat_object[attribute] || 'n/a'
+          else
+
+            if name.end_with?('entries')
+              # qualys_object.bid_entries
+              # qualys_object.cve_entries
+              # qualys_object.xref_entries
+              entries = @qualys_object.try(name)
+              if entries.any?
+                entries.to_a.join("\n")
+              else
+                'n/a'
+              end
+            else
+              @qualys_object.try(name) || 'n/a'
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dradis/plugins/qualys/gem_version.rb

@@ -0,0 +1,19 @@
+module Dradis
+  module Plugins
+    module Qualys
+      # Returns the version of the currently loaded Qualys as a <tt>Gem::Version</tt>
+      def self.gem_version
+        Gem::Version.new VERSION::STRING
+      end
+
+      module VERSION
+        MAJOR = 3
+        MINOR = 18
+        TINY = 0
+        PRE = nil
+
+        STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+      end
+    end
+  end
+end

data/lib/dradis/plugins/qualys/importer.rb

@@ -0,0 +1,88 @@
+module Dradis::Plugins::Qualys
+  class Importer < Dradis::Plugins::Upload::Importer
+
+    attr_accessor :host_node
+
+    # The framework will call this function if the user selects this plugin from
+    # the dropdown list and uploads a file.
+    # @returns true if the operation was successful, false otherwise
+    def import(params={})
+      file_content = File.read( params[:file] )
+
+      logger.info{'Parsing Qualys output file...'}
+      @doc = Nokogiri::XML( file_content )
+      logger.info{'Done.'}
+
+      if @doc.root.name != 'SCAN'
+        error = "No scan results were detected in the uploaded file. Ensure you uploaded a Qualys XML file."
+        logger.fatal{ error }
+        content_service.create_note text: error
+        return false
+      end
+
+      @doc.xpath('SCAN/IP').each do |xml_host|
+        process_ip(xml_host)
+      end
+
+      return true
+    end
+
+    private
+
+    def process_ip(xml_host)
+      host_ip = xml_host['value']
+      logger.info{ "Host: %s" % host_ip }
+
+      self.host_node = content_service.create_node(label: host_ip, type: :host)
+
+      host_node.set_property(:ip, host_ip)
+      host_node.set_property(:hostname, xml_host['name'])
+      if (xml_os = xml_host.xpath('OS')) && xml_os.any?
+        host_node.set_property(:os, xml_os.text)
+      end
+      host_node.save
+
+      # We treat INFOS, SERVICES, PRACTICES, and VULNS the same way
+      # All of these are imported into Dradis as Issues
+      ['INFOS', 'SERVICES', 'PRACTICES', 'VULNS'].each do |collection|
+        xml_host.xpath(collection).each do |xml_collection|
+          process_collection(collection, xml_collection)
+        end
+      end
+    end
+
+    def process_collection(collection, xml_collection)
+      xml_cats = xml_collection.xpath('CAT')
+
+      xml_cats.each do |xml_cat|
+        logger.info{ "\t#{ collection } - #{ xml_cat['value'] }" }
+
+        empty_dup_xml_cat = xml_cat.dup
+        empty_dup_xml_cat.children.remove
+
+        # For each INFOS/CAT/INFO, SERVICES/CAT/SERVICE, VULNS/CAT/VULN, etc.
+        xml_cat.xpath(collection.chop).each do |xml_element|
+          dup_xml_cat = empty_dup_xml_cat.dup
+          dup_xml_cat.add_child(xml_element.dup)
+          cat_number = xml_element[:number]
+
+          process_vuln(collection, cat_number, dup_xml_cat)
+
+        end
+      end
+    end
+
+    # Takes a <CAT> element containing a single <VULN> element and processes an
+    # Issue and Evidence template out of it.
+    def process_vuln(collection, vuln_number, xml_cat)
+      logger.info{ "\t\t => Creating new issue (plugin_id: #{ vuln_number })" }
+      issue_text = template_service.process_template(template: 'element', data: xml_cat)
+      issue_text << "\n\n#[qualys_collection]#\n#{ collection }"
+      issue = content_service.create_issue(text: issue_text, id: vuln_number)
+
+      logger.info{ "\t\t => Creating new evidence" }
+      evidence_content = template_service.process_template(template: 'evidence', data: xml_cat)
+      content_service.create_evidence(issue: issue, node: self.host_node, content: evidence_content)
+    end
+  end
+end

data/lib/dradis/plugins/qualys/version.rb

@@ -0,0 +1,13 @@
+require_relative 'gem_version'
+
+module Dradis
+  module Plugins
+    module Qualys
+      # Returns the version of the currently loaded Qualys as a
+      # <tt>Gem::Version</tt>.
+      def self.version
+        gem_version
+      end
+    end
+  end
+end

data/lib/qualys/element.rb

@@ -0,0 +1,114 @@
+module Qualys
+  # This class represents each of the /SCAN/IP/[INFOS|SERVICES|VULNS|PRACTICES]/CAT/[INFO|SERVICE|VULN|PRACTICE]
+  # elements in the Qualys XML document.
+  #
+  # It provides a convenient way to access the information scattered all over
+  # the XML in attributes and nested tags.
+  #
+  # Instead of providing separate methods for each supported property we rely
+  # on Ruby's #method_missing to do most of the work.
+  class Element
+    # Accepts an XML node from Nokogiri::XML.
+    def initialize(xml_node)
+      @xml = xml_node
+    end
+
+    # List of supported tags. They can be attributes, simple descendans or
+    # collections (e.g. <references/>, <tags/>)
+    def supported_tags
+      [
+        # attributes
+        :number, :severity, :cveid,
+
+        # simple tags
+        :title, :last_update, :cvss_base, :cvss_temporal, :pci_flag, :diagnosis,
+        :consequence, :solution, :compliance, :result,
+
+        # multiple tags
+        :vendor_reference_list, :cve_id_list, :bugtraq_id_list
+      ]
+    end
+
+    # This allows external callers (and specs) to check for implemented
+    # properties
+    def respond_to?(method, include_private=false)
+      return true if supported_tags.include?(method.to_sym)
+      super
+    end
+
+    # This method is invoked by Ruby when a method that is not defined in this
+    # instance is called.
+    #
+    # In our case we inspect the @method@ parameter and try to find the
+    # attribute, simple descendent or collection that it maps to in the XML
+    # tree.
+    def method_missing(method, *args)
+      # We could remove this check and return nil for any non-recognized tag.
+      # The problem would be that it would make tricky to debug problems with
+      # typos. For instance: <>.potr would return nil instead of raising an
+      # exception
+      unless supported_tags.include?(method)
+        super
+        return
+      end
+
+      # First we try the attributes. In Ruby we use snake_case, but in XML
+      # CamelCase is used for some attributes
+      # translations_table = {
+      #   :nexpose_id => 'id',
+      #   :pci_severity => 'pciSeverity',
+      #   :cvss_score => 'cvssScore',
+      #   :cvss_vector =>'cvssVector'
+      # }
+      #
+      # method_name = translations_table.fetch(method, method.to_s)
+      method_name = method.to_s
+      return @xml.attributes[method_name].value if @xml.attributes.key?(method_name)
+
+      # Then we try simple children tags: TITLE, LAST_UPDATE, CVSS_BASE...
+      tag = @xml.xpath("./#{method_name.upcase}").first
+      if tag && !tag.text.blank?
+        if tags_with_html_content.include?(method)
+          return cleanup_html(tag.text)
+        else
+          return tag.text
+        end
+      else
+        'n/a'
+      end
+
+      # Finally the enumerations: vendor_reference_list, cve_id_list, bugtraq_id_list
+      if method_name == 'references'
+        # @xml.xpath("./references/reference").collect{|entry| {:source => entry['source'], :text => entry.text} }
+      elsif method == 'tags'
+        # @xml.xpath("./tags/tag").collect(&:text)
+      else
+        # nothing found, the tag is valid but not present in this ReportItem
+        return nil
+      end
+    end
+
+    private
+
+    def cleanup_html(source)
+      result = source.dup
+      result.gsub!(/&quot;/, '"')
+      result.gsub!(/&lt;/, '<')
+      result.gsub!(/&gt;/, '>')
+      
+      result.gsub!(/<p>/i, "\n\n")
+      result.gsub!(/<br>/i, "\n")
+      result.gsub!(/          /, "")
+      result.gsub!(/<a href=\"(.*?)\" target=\"_blank\">(.*?)<\/a>/i) { "\"#{$2.strip}\":#{$1.strip}" }
+      result.gsub!(/<pre>(.*?)<\/pre>/im) { |m| "\n\nbc.. #{$1.strip}\n\np.  \n" }
+      result.gsub!(/<b>(.*?)<\/b>/i) { "*#{$1.strip}*" }
+      result.gsub!(/<i>(.*?)<\/i>/i) { "_#{$1.strip}_" }
+      result
+    end
+
+    def tags_with_html_content
+      [:diagnosis, :solution]
+    end
+
+  end
+end

data/lib/tasks/thorfile.rb

@@ -0,0 +1,21 @@
+class QualysTasks < Thor
+  include Rails.application.config.dradis.thor_helper_module
+
+  namespace "dradis:plugins:qualys"
+
+  desc "upload FILE", "upload Qualys XML results"
+  def upload(file_path)
+    require 'config/environment'
+
+    unless File.exists?(file_path)
+      $stderr.puts "** the file [#{file_path}] does not exist"
+      exit -1
+    end
+
+    detect_and_set_project_scope
+
+    importer = Dradis::Plugins::Qualys::Importer.new(task_options)
+    importer.import(file: file_path)
+  end
+
+end

data/spec/fixtures/files/no_result.xml

@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<!DOCTYPE SCAN SYSTEM "https://qualysguard.qualys.de/scan-1.dtd">
+<SCAN value="scan/1327124089.959">
+
+<HEADER>
+  <KEY value="USERNAME">dradispro</KEY>
+  <KEY value="COMPANY"><![CDATA[Security Roots]]></KEY>
+  <KEY value="DATE">2011-12-20T12:00:00Z</KEY>
+  <KEY value="TITLE"><![CDATA[Sample_Test_Scan]]></KEY>
+  <KEY value="TARGET">10.0.155.157,10.0.155.160</KEY>
+  <KEY value="DURATION">03:42:36</KEY>
+  <KEY value="SCAN_HOST">62.210.136.186 (Scanner 4.14.30-1,Web 6.0 FR6 [build 6.3.94-1],Vulnsigs 1.22.62-1)</KEY>
+  <KEY value="NBHOST_ALIVE">2</KEY>
+  <KEY value="NBHOST_TOTAL">2</KEY>
+  <KEY value="REPORT_TYPE">Scheduled</KEY>
+  <KEY value="OPTIONS">Full TCP scan, Standard Password Brute Forcing, Load balancer detection OFF, Overall Performance: Custom, Hosts to Scan in Parallel - External Scanners: 1, Hosts to Scan in Parallel - Scanner Appliances: 1, Total Processes to Run in Parallel: 1, HTTP Processes to Run in Parallel: 1, Packet (Burst) Delay: Maximum</KEY>
+  <KEY value="STATUS">FINISHED</KEY>
+  <OPTION_PROFILE>
+    <OPTION_PROFILE_TITLE option_profile_default="0"><![CDATA[Payment Card Industry (PCI) Options]]></OPTION_PROFILE_TITLE>
+  </OPTION_PROFILE>
+</HEADER>
+
+<IP value="10.0.155.160" name="No registered hostname">
+  <OS><![CDATA[Linux 2.4-2.6]]></OS>
+  <VULNS>
+    <CAT value="TCP/IP">
+      <VULN number="82054" severity="2" cveid="CVE-2004-0230">
+        <TITLE><![CDATA[TCP Sequence Number Approximation Based Denial of Service]]></TITLE>
+        <LAST_UPDATE><![CDATA[2007-12-20T22:53:15Z]]></LAST_UPDATE>
+        <CVSS_BASE>5</CVSS_BASE>
+        <CVSS_TEMPORAL>4.2</CVSS_TEMPORAL>
+        <PCI_FLAG>0</PCI_FLAG>
+        <CVE_ID_LIST>
+          <CVE_ID>
+            <ID><![CDATA[CVE-2004-0230]]></ID>
+            <URL><![CDATA[http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2004-0230]]></URL>
+          </CVE_ID>
+        </CVE_ID_LIST>
+        <BUGTRAQ_ID_LIST>
+          <BUGTRAQ_ID>
+            <ID><![CDATA[10183]]></ID>
+            <URL><![CDATA[http://www.securityfocus.com/bid/10183]]></URL>
+          </BUGTRAQ_ID>
+        </BUGTRAQ_ID_LIST>
+        <DIAGNOSIS>
+          <![CDATA[TCP provides stateful communications between hosts on a network. TCP sessions are established by a three-way handshake and use random 32-bit sequence and acknowledgement numbers to ensure the validity of traffic. A vulnerability was reported that may permit TCP sequence numbers to be more easily approximated by remote attackers. This issue affects products released by multiple vendors.
+          <P>
+          The cause of the vulnerability is that affected implementations will accept TCP sequence numbers within a certain range, known as the acknowledgement range, of the expected sequence number for a packet in the session. This is determined by the TCP window size, which is negotiated during the three-way handshake for the session. Larger TCP window sizes may be set to allow for more throughput, but the larger the TCP window size, the more probable it is to guess a TCP sequence number that falls within an acceptable range. It was initially thought that guessing an acceptable sequence number was relatively difficult for most implementations given random distribution, making this type of attack impractical. However, some implementations may make it easier to successfully approximate an acceptable TCP sequence number, making these attacks possible with a number of protocols and implementations.
+          <P>
+          This is further compounded by the fact that some implementations may support the use of the TCP Window Scale Option, as described in RFC 1323, to extend the TCP window size to a maximum value of 1 billion.
+          <P>
+          This vulnerability will permit a remote attacker to inject a SYN or RST packet into the session, causing it to be reset and effectively allowing for denial of service attacks. An attacker would exploit this issue by sending a packet to a receiving implementation with an approximated sequence number and a forged source IP address and TCP port.
+          <P>
+          There are a few factors that may present viable target implementations, such as those which depend on long-lived TCP connections, those that have known or easily guessed IP address endpoints and those implementations with easily guessed TCP source ports. It has been noted that Border Gateway Protocol (BGP) is reported to be particularly vulnerable to this type of attack, due to the use of long-lived TCP sessions and the possibility that some implementations may use the TCP Window Scale Option. As a result, this issue is likely to affect a number of routing platforms.
+          <P>
+          Another factor to consider is the relative difficulty of injecting packets into TCP sessions, as a number of receiving implementations will reassemble packets in order, dropping any duplicates. This may make some implementations more resistant to attacks than others.
+          <P>
+          It should be noted that while a number of vendors have confirmed this issue in various products, investigations are ongoing and it is likely that many other vendors and products will turn out to be vulnerable as the issue is investigated further.]]>
+        </DIAGNOSIS>
+        <CONSEQUENCE><![CDATA[Successful exploitation of this issue could lead to denial of service attacks on the TCP based services of target hosts. Other consequences may also result, such as man-in-the-middle attacks.]]></CONSEQUENCE>
+        <SOLUTION>
+          <![CDATA[Please first check the results section below for the port number on which this vulnerability was detected. If that port number is known to be used for port-forwarding, then it is the backend host that is really vulnerable.
+          <P>
+          Various implementations and products including Check Point, Cisco, Cray Inc, Hitachi, Internet Initiative Japan, Inc (IIJ), Juniper Networks, NEC, Polycom, and Yamaha are currently undergoing review. Contact the vendors to obtain more information about affected products and fixes. <A HREF="http://packetstormsecurity.org/0404-advisories/246929.html" TARGET="_blank">NISCC Advisory 236929 - Vulnerability Issues in TCP</A> details the vendor patch status as of the time of the advisory, and identifies resolutions and workarounds.
+          <P>
+          The Internet Engineering Task Force (IETF) has developed an Internet-Draft titled <A HREF="http://www3.ietf.org/proceedings/05mar/slides/tcpm-4.pdf" TARGET="_blank">Transmission Control Protocol Security Considerations</A> that addresses this issue.
+          <P>
+          Workaround:
+          <P>
+          The following BGP-specific workaround information has been provided.
+          <P>
+          For BGP implementations that support it, the TCP MD5 Signature Option should be enabled. Passwords that the MD5 checksum is applied to should be set to strong values and changed on a regular basis.
+          <P>
+          Secure BGP configuration instructions have been provided for Cisco and Juniper at these locations:
+          <BR>
+          <A HREF="http://www.cymru.com/Documents/secure-bgp-template.html" TARGET="_blank">http://www.cymru.com/Documents/secure-bgp-template.html</A>
+          <BR>
+          <A HREF="http://www.qorbit.net/documents/junos-bgp-template.pdf" TARGET="_blank">http://www.qorbit.net/documents/junos-bgp-template.pdf</A>
+          ]]>
+        </SOLUTION>
+        <!--
+        This is the real test. We want to make sure the parse doesn't cry if this is missing.
+        <RESULT><![CDATA[Tested on port 80 with an injected SYN/RST offset by 16 bytes.]]></RESULT>
+        -->
+      </VULN>
+    </CAT>
+  </VULNS>
+</IP>
+</SCAN>
+<!-- CONFIDENTIAL AND PROPRIETARY INFORMATION. Qualys provides the QualysGuard Service "As Is," without any warranty of any kind. Qualys makes no warranty that the information contained in this report is complete or error-free. Copyright 2008, Qualys, Inc. //-->