Class: SemgrepWebApp::FindingRule

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/semgrep_web_app/models/finding_rule.rb

Overview

Rule that applies to this finding

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(category: SKIP, confidence: SKIP, cwe_names: SKIP, message: SKIP, name: SKIP, owasp_names: SKIP, subcategories: SKIP, vulnerability_classes: SKIP, additional_properties: nil) ⇒ FindingRule

Returns a new instance of FindingRule.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 77

def initialize(category: SKIP, confidence: SKIP, cwe_names: SKIP,
               message: SKIP, name: SKIP, owasp_names: SKIP,
               subcategories: SKIP, vulnerability_classes: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @category = category unless category == SKIP
  @confidence = confidence unless confidence == SKIP
  @cwe_names = cwe_names unless cwe_names == SKIP
  @message = message unless message == SKIP
  @name = name unless name == SKIP
  @owasp_names = owasp_names unless owasp_names == SKIP
  @subcategories = subcategories unless subcategories == SKIP
  @vulnerability_classes = vulnerability_classes unless vulnerability_classes == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#category ⇒ String

Category the rule is associated with

Returns:

  • (String) 


14
15
16
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 14

def category
  @category
end

#confidence ⇒ Confidence2

Confidence level of the rule

Returns:



18
19
20
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 18

def confidence
  @confidence
end

#cwe_names ⇒ Array[String]

CWE names associated with the rule

Returns:

  • (Array[String]) 


22
23
24
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 22

def cwe_names
  @cwe_names
end

#message ⇒ String

Rule message

Returns:

  • (String) 


26
27
28
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 26

def message
  @message
end

#name ⇒ String

Name of the rule

Returns:

  • (String) 


30
31
32
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 30

def name
  @name
end

#owasp_names ⇒ Array[String]

OWASP names associated with the rule

Returns:

  • (Array[String]) 


34
35
36
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 34

def owasp_names
  @owasp_names
end

#subcategories ⇒ Array[String]

Subcategories of the rule

Returns:

  • (Array[String]) 


38
39
40
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 38

def subcategories
  @subcategories
end

#vulnerability_classes ⇒ Array[String]

Vulnerability classes the rule is associated with

Returns:

  • (Array[String]) 


42
43
44
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 42

def vulnerability_classes
  @vulnerability_classes
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 96

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  category = hash.key?('category') ? hash['category'] : SKIP
  confidence = hash.key?('confidence') ? hash['confidence'] : SKIP
  cwe_names = hash.key?('cwe_names') ? hash['cwe_names'] : SKIP
  message = hash.key?('message') ? hash['message'] : SKIP
  name = hash.key?('name') ? hash['name'] : SKIP
  owasp_names = hash.key?('owasp_names') ? hash['owasp_names'] : SKIP
  subcategories = hash.key?('subcategories') ? hash['subcategories'] : SKIP
  vulnerability_classes =
    hash.key?('vulnerability_classes') ? hash['vulnerability_classes'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  FindingRule.new(category: category,
                  confidence: confidence,
                  cwe_names: cwe_names,
                  message: message,
                  name: name,
                  owasp_names: owasp_names,
                  subcategories: subcategories,
                  vulnerability_classes: vulnerability_classes,
                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 45

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['category'] = 'category'
  @_hash['confidence'] = 'confidence'
  @_hash['cwe_names'] = 'cwe_names'
  @_hash['message'] = 'message'
  @_hash['name'] = 'name'
  @_hash['owasp_names'] = 'owasp_names'
  @_hash['subcategories'] = 'subcategories'
  @_hash['vulnerability_classes'] = 'vulnerability_classes'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



73
74
75
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 73

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 59

def self.optionals
  %w[
    category
    confidence
    cwe_names
    message
    name
    owasp_names
    subcategories
    vulnerability_classes
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (FindingRule | Hash) —

    value against the validation is performed.



131
132
133
134
135
136
137
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 131

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



149
150
151
152
153
154
155
156
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 149

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} category: #{@category.inspect}, confidence: #{@confidence.inspect},"\
  " cwe_names: #{@cwe_names.inspect}, message: #{@message.inspect}, name: #{@name.inspect},"\
  " owasp_names: #{@owasp_names.inspect}, subcategories: #{@subcategories.inspect},"\
  " vulnerability_classes: #{@vulnerability_classes.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



140
141
142
143
144
145
146
 
# File 'lib/semgrep_web_app/models/finding_rule.rb', line 140

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} category: #{@category}, confidence: #{@confidence}, cwe_names:"\
  " #{@cwe_names}, message: #{@message}, name: #{@name}, owasp_names: #{@owasp_names},"\
  " subcategories: #{@subcategories}, vulnerability_classes: #{@vulnerability_classes},"\
  " additional_properties: #{@additional_properties}>"
end