Class: Falcon::DomainAPIVulnerabilityCVEDetailsFacetV2

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainAPIVulnerabilityCVEDetailsFacetV2

Initializes the object

Parameters:

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

    Model attributes in the form of hash



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 148

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::DomainAPIVulnerabilityCVEDetailsFacetV2` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Falcon::DomainAPIVulnerabilityCVEDetailsFacetV2`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'actors')
    if (value = attributes[:'actors']).is_a?(Array)
      self.actors = value
    end
  end

  if attributes.key?(:'base_score')
    self.base_score = attributes[:'base_score']
  end

  if attributes.key?(:'cisa_info')
    self.cisa_info = attributes[:'cisa_info']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'exploit_status')
    self.exploit_status = attributes[:'exploit_status']
  end

  if attributes.key?(:'exploitability_score')
    self.exploitability_score = attributes[:'exploitability_score']
  end

  if attributes.key?(:'exprt_rating')
    self.exprt_rating = attributes[:'exprt_rating']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'impact_score')
    self.impact_score = attributes[:'impact_score']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'published_date')
    self.published_date = attributes[:'published_date']
  end

  if attributes.key?(:'references')
    if (value = attributes[:'references']).is_a?(Array)
      self.references = value
    end
  end

  if attributes.key?(:'remediation_level')
    self.remediation_level = attributes[:'remediation_level']
  end

  if attributes.key?(:'severity')
    self.severity = attributes[:'severity']
  end

  if attributes.key?(:'spotlight_published_date')
    self.spotlight_published_date = attributes[:'spotlight_published_date']
  end

  if attributes.key?(:'types')
    if (value = attributes[:'types']).is_a?(Array)
      self.types = value
    end
  end

  if attributes.key?(:'vector')
    self.vector = attributes[:'vector']
  end

  if attributes.key?(:'vendor_advisory')
    if (value = attributes[:'vendor_advisory']).is_a?(Array)
      self.vendor_advisory = value
    end
  end
end

Instance Attribute Details

#actorsObject

Contains a list of actors that are known for exploiting this vulnerability ot in the wild



36
37
38
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 36

def actors
  @actors
end

#base_scoreObject

The base score for a Common Vulnerability Enumeration (CVE) is a numerical value that represents the intrinsic severity and impact of a security vulnerability.



39
40
41
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 39

def base_score
  @base_score
end

#cisa_infoObject

Returns the value of attribute cisa_info.



41
42
43
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 41

def cisa_info
  @cisa_info
end

#descriptionObject

Refers to description of the vulnerability



44
45
46
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 44

def description
  @description
end

#exploit_statusObject

Exploit status refers to the current state or availability of known exploits for a specific vulnerability, indicating whether there are known techniques or tools to leverage the vulnerability in an attack.



47
48
49
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 47

def exploit_status
  @exploit_status
end

#exploitability_scoreObject

Represents a numerical value that indicates the relative ease or difficulty for an attacker to exploit a vulnerability



50
51
52
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 50

def exploitability_score
  @exploitability_score
end

#exprt_ratingObject

Expert.AI score on the vulnerability



53
54
55
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 53

def exprt_rating
  @exprt_rating
end

#idObject

Returns the value of attribute id.



55
56
57
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 55

def id
  @id
end

#impact_scoreObject

Refers to a numerical value that represents the potential impact or severity of a vulnerability when it is successfully exploited



58
59
60
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 58

def impact_score
  @impact_score
end

#nameObject

Vulnerability name



61
62
63
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 61

def name
  @name
end

#published_dateObject

Refers to a point in time when the vulnerability has been disclosed



64
65
66
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 64

def published_date
  @published_date
end

#referencesObject

Refers to one or more references with more details about the vulnerability



67
68
69
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 67

def references
  @references
end

#remediation_levelObject

Remediation level indicates the required effort to mitigate a security vulnerability, ranging from official fixes to unavailable remedies



70
71
72
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 70

def remediation_level
  @remediation_level
end

#severityObject

Severity refers to the level of impact or potential harm caused by a security vulnerability. It is often assessed using metrics such as the CVSS base score, which takes into account factors such as exploitability, impact on confidentiality, integrity, and availability, and other relevant parameters to determine the severity level of a vulnerability.



73
74
75
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 73

def severity
  @severity
end

#spotlight_published_dateObject

Corresponds to a point in time when Spotlight offered support for detecting a specific vulnerability



76
77
78
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 76

def spotlight_published_date
  @spotlight_published_date
end

#typesObject

The types of vulnerability. Can be of: Vulnerability, Misconfiguration, and Unsupported software



79
80
81
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 79

def types
  @types
end

#vectorObject

Refers to the vector of attack or the specific method or path through which an attacker can exploit a vulnerability



82
83
84
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 82

def vector
  @vector
end

#vendor_advisoryObject

Refers to one or more URLs that points to vendor advisories



85
86
87
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 85

def vendor_advisory
  @vendor_advisory
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



112
113
114
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 112

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 88

def self.attribute_map
  {
    :'actors' => :'actors',
    :'base_score' => :'base_score',
    :'cisa_info' => :'cisa_info',
    :'description' => :'description',
    :'exploit_status' => :'exploit_status',
    :'exploitability_score' => :'exploitability_score',
    :'exprt_rating' => :'exprt_rating',
    :'id' => :'id',
    :'impact_score' => :'impact_score',
    :'name' => :'name',
    :'published_date' => :'published_date',
    :'references' => :'references',
    :'remediation_level' => :'remediation_level',
    :'severity' => :'severity',
    :'spotlight_published_date' => :'spotlight_published_date',
    :'types' => :'types',
    :'vector' => :'vector',
    :'vendor_advisory' => :'vendor_advisory'
  }
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



300
301
302
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 300

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



141
142
143
144
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 141

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 117

def self.openapi_types
  {
    :'actors' => :'Array<String>',
    :'base_score' => :'Float',
    :'cisa_info' => :'DomainAPIVulnerabilityCVECISAInfo',
    :'description' => :'String',
    :'exploit_status' => :'Integer',
    :'exploitability_score' => :'Float',
    :'exprt_rating' => :'String',
    :'id' => :'String',
    :'impact_score' => :'Float',
    :'name' => :'String',
    :'published_date' => :'String',
    :'references' => :'Array<String>',
    :'remediation_level' => :'String',
    :'severity' => :'String',
    :'spotlight_published_date' => :'String',
    :'types' => :'Array<String>',
    :'vector' => :'String',
    :'vendor_advisory' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      actors == o.actors &&
      base_score == o.base_score &&
      cisa_info == o.cisa_info &&
      description == o.description &&
      exploit_status == o.exploit_status &&
      exploitability_score == o.exploitability_score &&
      exprt_rating == o.exprt_rating &&
      id == o.id &&
      impact_score == o.impact_score &&
      name == o.name &&
      published_date == o.published_date &&
      references == o.references &&
      remediation_level == o.remediation_level &&
      severity == o.severity &&
      spotlight_published_date == o.spotlight_published_date &&
      types == o.types &&
      vector == o.vector &&
      vendor_advisory == o.vendor_advisory
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 331

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Falcon.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



402
403
404
405
406
407
408
409
410
411
412
413
414
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 402

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 307

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


287
288
289
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 287

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



293
294
295
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 293

def hash
  [actors, base_score, cisa_info, description, exploit_status, exploitability_score, exprt_rating, id, impact_score, name, published_date, references, remediation_level, severity, spotlight_published_date, types, vector, vendor_advisory].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



244
245
246
247
248
249
250
251
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 244

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



378
379
380
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 378

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



384
385
386
387
388
389
390
391
392
393
394
395
396
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 384

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



372
373
374
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 372

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



255
256
257
258
# File 'lib/crimson-falcon/models/domain_api_vulnerability_cve_details_facet_v2.rb', line 255

def valid?
  return false if @id.nil?
  true
end