Class: OCI::Adm::Models::Vulnerability

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/adm/models/vulnerability.rb

Overview

A vulnerability is a weakness or error in an artifact. A vulnerability is a generalization of a CVE (every CVE is a vulnerability, but not every vulnerability has a CVE).

Constant Summary collapse

SEVERITY_ENUM = 
[
  SEVERITY_NONE = 'NONE'.freeze,
  SEVERITY_LOW = 'LOW'.freeze,
  SEVERITY_MEDIUM = 'MEDIUM'.freeze,
  SEVERITY_HIGH = 'HIGH'.freeze,
  SEVERITY_CRITICAL = 'CRITICAL'.freeze,
  SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Vulnerability

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :source (String) —

    The value to assign to the #source property

  • :cvss_v2_score (Float) —

    The value to assign to the #cvss_v2_score property

  • :cvss_v3_score (Float) —

    The value to assign to the #cvss_v3_score property

  • :severity (String) —

    The value to assign to the #severity property

  • :is_ignored (BOOLEAN) —

    The value to assign to the #is_ignored property

  • :is_false_positive (BOOLEAN) —

    The value to assign to the #is_false_positive property

[View source]

94
95
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
128
129
 
# File 'lib/oci/adm/models/vulnerability.rb', line 94

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.source = attributes[:'source'] if attributes[:'source']

  self.cvss_v2_score = attributes[:'cvssV2Score'] if attributes[:'cvssV2Score']

  raise 'You cannot provide both :cvssV2Score and :cvss_v2_score' if attributes.key?(:'cvssV2Score') && attributes.key?(:'cvss_v2_score')

  self.cvss_v2_score = attributes[:'cvss_v2_score'] if attributes[:'cvss_v2_score']

  self.cvss_v3_score = attributes[:'cvssV3Score'] if attributes[:'cvssV3Score']

  raise 'You cannot provide both :cvssV3Score and :cvss_v3_score' if attributes.key?(:'cvssV3Score') && attributes.key?(:'cvss_v3_score')

  self.cvss_v3_score = attributes[:'cvss_v3_score'] if attributes[:'cvss_v3_score']

  self.severity = attributes[:'severity'] if attributes[:'severity']

  self.is_ignored = attributes[:'isIgnored'] unless attributes[:'isIgnored'].nil?

  raise 'You cannot provide both :isIgnored and :is_ignored' if attributes.key?(:'isIgnored') && attributes.key?(:'is_ignored')

  self.is_ignored = attributes[:'is_ignored'] unless attributes[:'is_ignored'].nil?

  self.is_false_positive = attributes[:'isFalsePositive'] unless attributes[:'isFalsePositive'].nil?

  raise 'You cannot provide both :isFalsePositive and :is_false_positive' if attributes.key?(:'isFalsePositive') && attributes.key?(:'is_false_positive')

  self.is_false_positive = attributes[:'is_false_positive'] unless attributes[:'is_false_positive'].nil?
end

Instance Attribute Details

#cvss_v2_score ⇒ Float

Common Vulnerability Scoring System (CVSS) Version 2.

Returns:

  • (Float) 

33
34
35
 
# File 'lib/oci/adm/models/vulnerability.rb', line 33

def cvss_v2_score
  @cvss_v2_score
end

#cvss_v3_score ⇒ Float

Common Vulnerability Scoring System (CVSS) Version 3.

Returns:

  • (Float) 

37
38
39
 
# File 'lib/oci/adm/models/vulnerability.rb', line 37

def cvss_v3_score
  @cvss_v3_score
end

#id ⇒ String

[Required] Unique vulnerability identifier, e.g. CVE-1999-0067.

Returns:

  • (String) 

25
26
27
 
# File 'lib/oci/adm/models/vulnerability.rb', line 25

def id
  @id
end

#is_false_positive ⇒ BOOLEAN

Indicates if the vulnerability is a false positive according to the usage data. If no usage data was provided or the service cannot infer usage of the vulnerable code then this property is null.

Returns:

  • (BOOLEAN) 

49
50
51
 
# File 'lib/oci/adm/models/vulnerability.rb', line 49

def is_false_positive
  @is_false_positive
end

#is_ignored ⇒ BOOLEAN

[Required] Indicates if the vulnerability was ignored according to the audit configuration.

Returns:

  • (BOOLEAN) 

45
46
47
 
# File 'lib/oci/adm/models/vulnerability.rb', line 45

def is_ignored
  @is_ignored
end

#severity ⇒ String

ADM qualitative severity score. Can be either NONE, LOW, MEDIUM, HIGH or CRITICAL.

Returns:

  • (String) 

41
42
43
 
# File 'lib/oci/adm/models/vulnerability.rb', line 41

def severity
  @severity
end

#source ⇒ String

Source that published the vulnerability

Returns:

  • (String) 

29
30
31
 
# File 'lib/oci/adm/models/vulnerability.rb', line 29

def source
  @source
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.

[View source]

52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/adm/models/vulnerability.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'source': :'source',
    'cvss_v2_score': :'cvssV2Score',
    'cvss_v3_score': :'cvssV3Score',
    'severity': :'severity',
    'is_ignored': :'isIgnored',
    'is_false_positive': :'isFalsePositive'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/adm/models/vulnerability.rb', line 67

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'source': :'String',
    'cvss_v2_score': :'Float',
    'cvss_v3_score': :'Float',
    'severity': :'String',
    'is_ignored': :'BOOLEAN',
    'is_false_positive': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared

[View source]

151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/adm/models/vulnerability.rb', line 151

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    source == other.source &&
    cvss_v2_score == other.cvss_v2_score &&
    cvss_v3_score == other.cvss_v3_score &&
    severity == other.severity &&
    is_ignored == other.is_ignored &&
    is_false_positive == other.is_false_positive
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself

[View source]

187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/adm/models/vulnerability.rb', line 187

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method
[View source]

167
168
169
 
# File 'lib/oci/adm/models/vulnerability.rb', line 167

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

176
177
178
 
# File 'lib/oci/adm/models/vulnerability.rb', line 176

def hash
  [id, source, cvss_v2_score, cvss_v3_score, severity, is_ignored, is_false_positive].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

220
221
222
223
224
225
226
227
228
229
 
# File 'lib/oci/adm/models/vulnerability.rb', line 220

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object

[View source]

214
215
216
 
# File 'lib/oci/adm/models/vulnerability.rb', line 214

def to_s
  to_hash.to_s
end