appfolio/gemsurance

View on GitHub
lib/gemsurance/runner.rb

Summary

Maintainability
A
2 hrs
Test Coverage
module Gemsurance
  class Runner
    attr_reader :gem_infos

    def initialize(options = {})
      @formatter   = options.delete(:formatter) || :html
      @output_file = options.delete(:output_file) || "gemsurance_report.#{@formatter}"
      @options     = options

      whitelist_file = options.delete(:whitelist_file) || '.gemsurance.yml'
      @whitelist = File.exist?(whitelist_file) ? YAML.load_file(whitelist_file) : false
    end

    def run
      build_gem_infos
      self
    end

    def report
      unless @gem_infos_loaded
        puts "Error: gem infos not yet loaded."
        exit 1
      end

      generate_report
      if @gem_infos.any? { |info| info.vulnerable? }
        exit 1
      elsif @gem_infos.any? { |info| info.outdated? } && @options[:fail_outdated]
        exit 2
      end
    end

  private
    def build_gem_infos
      @gem_infos = retrieve_bundled_gem_infos
      retrieve_vulnerability_data
      add_vulnerability_data

      @gem_infos_loaded = true
    end

    def retrieve_bundled_gem_infos
      puts "Retrieving gem version information..."

      bundler = Bundler.load
      current_specs = bundler.specs
      dependencies = bundler.dependencies

      GemInfoRetriever.new(current_specs, dependencies, resolved_definition).retrieve(:pre => @options[:pre])
    end

    def retrieve_vulnerability_data
      puts "Retrieving latest vulnerability data..."

      if File.exist?('./tmp/vulnerabilities')
        g = Git.open('./tmp/vulnerabilities')
        g.pull
      else
        Git.clone('https://github.com/rubysec/ruby-advisory-db', './tmp/vulnerabilities')
      end
    end

    def add_vulnerability_data(vulnerabilities_directory = './tmp/vulnerabilities/gems')
      puts "Reading vulnerability data..."

      @gem_infos.each do |gem_info|
        vulnerability_directory = File.join(vulnerabilities_directory, gem_info.name)
        if File.exist?(vulnerability_directory)
          Dir.foreach(vulnerability_directory) do |yaml_file|
            next if yaml_file =~ /\A\./
            vulnerability = Vulnerability.new(File.read(File.join(vulnerability_directory, yaml_file)))

            # are we impacted? if so, add details to gem_data
            current_version_satisfies_requirement = lambda do |version|
              Gem::Requirement.new(version.split(',')).satisfied_by?(gem_info.current_version)
            end

            current_version_is_affected = (vulnerability.unaffected_versions || []).none?(&current_version_satisfies_requirement)
            current_version_isnt_patched = (vulnerability.patched_versions || []).none?(&current_version_satisfies_requirement)
            current_version_isnt_whitelisted = if (whitelisted_versions = fetch_whitelisted_versions_for(gem_info.name,
                                                                                                         vulnerability.cve,
                                                                                                         vulnerability.osvdb))
              (whitelisted_versions || []).none?(&current_version_satisfies_requirement)
            else
              true
            end

            if current_version_is_affected && current_version_isnt_patched && current_version_isnt_whitelisted
              gem_info.add_vulnerability!(vulnerability)
            end
          end
        end
      end
    end

    def generate_report
      puts "Generating report..."

      output_data = Gemsurance::Formatters.const_get(:"#{@formatter.to_s.capitalize}").new(@gem_infos).format

      File.open(@output_file, "w+") do |file|
        file.puts output_data
      end
      puts "Generated report #{@output_file}."
    end

    def fetch_whitelisted_versions_for(gem, cve = nil, osvdb = nil)
      if @whitelist && (whitelisted_gem = @whitelist[gem])
        if cve
          whitelisted_gem["CVE-#{cve}"]
        elsif osvdb
          whitelisted_gem["OSVDB-#{osvdb}"]
        else
          # There are is no CVE or OSVDB for this vulnerability
        end
      end
    end

    def resolved_definition
      # Need to temporarily unfrozen Bundler (when the gems have been installed with --deployment option e.g.)
      if Bundler.settings[:frozen]
        unfrozen_bundler = true
        Bundler.settings.set_local(:frozen, "0")
      end

      Bundler.definition(true).tap do |definition|
        definition.resolve_remotely!
      end

    ensure
      Bundler.settings.set_local(:frozen, "1") if unfrozen_bundler
    end
  end
end