Module: Inspec::Impact

Defined in:
lib/inspec/impact.rb

Overview

Impact scores based off CVSS 3.0

Constant Summary collapse

IMPACT_SCORES = 
{
  'none'     => 0.0,
  'low'      => 0.01,
  'medium'   => 0.4,
  'high'     => 0.7,
  'critical' => 0.9,
}.freeze

Class Method Summary collapse

Class Method Details

.impact_from_string(value) ⇒ Object

Raises:



13
14
15
16
17
18
 
# File 'lib/inspec/impact.rb', line 13

def self.impact_from_string(value)
  # return if its a number
  return value if is_number?(value)
  raise Inspec::ImpactError, "'#{value}' is not a valid impact name. Valid impact names: none, low, medium, high, critical." unless IMPACT_SCORES.key?(value.downcase)
  IMPACT_SCORES[value]
end

.is_number?(value) ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
23
24
25
 
# File 'lib/inspec/impact.rb', line 20

def self.is_number?(value)
  Float(value)
  true
rescue
  false
end

.string_from_impact(value) ⇒ Object

Raises:



27
28
29
30
31
32
33
 
# File 'lib/inspec/impact.rb', line 27

def self.string_from_impact(value)
  value = value.to_f
  raise Inspec::ImpactError, "'#{value}' is not a valid impact score. Valid impact scores: [0.0 - 1.0]." if value < 0 || value > 1
  IMPACT_SCORES.reverse_each do |name, impact|
    return name if value >= impact
  end
end