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):



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/adm/models/vulnerability.rb', line 112

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?

  self.matching_vulnerable_artifact_version_ranges = attributes[:'matchingVulnerableArtifactVersionRanges'] if attributes[:'matchingVulnerableArtifactVersionRanges']

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

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

  self.metrics = attributes[:'metrics'] if attributes[:'metrics']
end

Instance Attribute Details

#cvss_v2_score ⇒ Float

Common Vulnerability Scoring System (CVSS) Version 2, calculated from the metrics provided in the CVSS vector provided from the vulnerability source. This field is deprecated and will be removed in the future. The cvssV2Score can be obtained from the metrics field of the listVulnerabilities endpoint.

Returns:

  • (Float) 


35
36
37
 
# File 'lib/oci/adm/models/vulnerability.rb', line 35

def cvss_v2_score
  @cvss_v2_score
end

#cvss_v3_score ⇒ Float

Common Vulnerability Scoring System (CVSS) Version 3, calculated from the metrics provided in the CVSS vector provided from the vulnerability source. This field is deprecated and will be removed in the future. The cvssV3Score can be obtained from the metrics field of the listVulnerabilities endpoint.

Returns:

  • (Float) 


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

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) 


53
54
55
 
# File 'lib/oci/adm/models/vulnerability.rb', line 53

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) 


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

def is_ignored
  @is_ignored
end

#matching_vulnerable_artifact_version_ranges ⇒ Array<OCI::Adm::Models::VulnerableArtifactVersionRange>

List of artifact version ranges affected by a particular vulnerability.

Returns:



57
58
59
 
# File 'lib/oci/adm/models/vulnerability.rb', line 57

def matching_vulnerable_artifact_version_ranges
  @matching_vulnerable_artifact_version_ranges
end

#metrics ⇒ Array<OCI::Adm::Models::VulnerabilityMetric>

List of reported metrics by the source.

Returns:



61
62
63
 
# File 'lib/oci/adm/models/vulnerability.rb', line 61

def metrics
  @metrics
end

#severity ⇒ String

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

Returns:

  • (String) 


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

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.



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

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',
    'matching_vulnerable_artifact_version_ranges': :'matchingVulnerableArtifactVersionRanges',
    'metrics': :'metrics'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/adm/models/vulnerability.rb', line 81

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',
    'matching_vulnerable_artifact_version_ranges': :'Array<OCI::Adm::Models::VulnerableArtifactVersionRange>',
    'metrics': :'Array<OCI::Adm::Models::VulnerabilityMetric>'
    # 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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/adm/models/vulnerability.rb', line 177

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 &&
    matching_vulnerable_artifact_version_ranges == other.matching_vulnerable_artifact_version_ranges &&
    metrics == other.metrics
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/adm/models/vulnerability.rb', line 215

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


195
196
197
 
# File 'lib/oci/adm/models/vulnerability.rb', line 195

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/oci/adm/models/vulnerability.rb', line 204

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/adm/models/vulnerability.rb', line 248

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



242
243
244
 
# File 'lib/oci/adm/models/vulnerability.rb', line 242

def to_s
  to_hash.to_s
end