Class: IronDome::Sarif::Output

Inherits:
Object
  • Object
show all
Defined in:
lib/iron_dome/sarif/output.rb

Overview

this class deal with sarif output

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Output

Returns a new instance of Output.



7
 
# File 'lib/iron_dome/sarif/output.rb', line 7

def initialize; end

Instance Method Details

#build_physical_location(vuln) ⇒ Object 



35
36
37
38
39
40
41
42
43
 
# File 'lib/iron_dome/sarif/output.rb', line 35

def build_physical_location(vuln)
  affected_package = vuln["affected"][0]["package"]
  {
    physicalLocation: {
      artifactLocation: { uri: affected_package["purl"] },
      region: { startLine: nil, startColumn: nil }
    }
  }
end

#build_references(vuln) ⇒ Object 



45
46
47
 
# File 'lib/iron_dome/sarif/output.rb', line 45

def build_references(vuln)
  vuln["references"].map { |ref| { type: "WEB", url: ref["url"] } }
end

#build_run_info ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/iron_dome/sarif/output.rb', line 57

def build_run_info
  {
    tool: {
      driver: {
        name: "OSv.dev API",
        version: "1.0"
      }
    },
    results: []
  }
end

#convert_to_sarif(result) ⇒ Object 



14
15
16
17
18
 
# File 'lib/iron_dome/sarif/output.rb', line 14

def convert_to_sarif(result)
  sarif_result = sarif_schema
  result.each { |vulnerability| process_vulnerability(sarif_result, vulnerability) }
  JSON.pretty_generate(sarif_result)
end

#generate_sarif_result(vuln) ⇒ Object 



26
27
28
29
30
31
32
33
 
# File 'lib/iron_dome/sarif/output.rb', line 26

def generate_sarif_result(vuln)
  {
    ruleId: vuln["id"],
    message: { text: vuln["summary"] },
    locations: build_physical_location(vuln),
    references: build_references(vuln)
  }
end

#output_report(result) ⇒ Object 



9
10
11
12
 
# File 'lib/iron_dome/sarif/output.rb', line 9

def output_report(result)
  sarif_json = convert_to_sarif(result)
  File.write("result.sarif", JSON.pretty_generate(sarif_json))
end

#process_vulnerability(sarif_result, vulnerability) ⇒ Object 



20
21
22
23
24
 
# File 'lib/iron_dome/sarif/output.rb', line 20

def process_vulnerability(sarif_result, vulnerability)
  vulnerability["vulns"].each do |vuln|
    sarif_result[:runs][0][:results] << generate_sarif_result(vuln)
  end
end

#sarif_schema ⇒ Object 



49
50
51
52
53
54
55
 
# File 'lib/iron_dome/sarif/output.rb', line 49

def sarif_schema
  {
    schema: "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
    version: "2.1.0",
    runs: [build_run_info]
  }
end