Class: Falcon::DomainVulnerability

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainVulnerability

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
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
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 130

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::DomainVulnerability` 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::DomainVulnerability`. 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?(:'affected_products')
    if (value = attributes[:'affected_products']).is_a?(Array)
      self.affected_products = value
    end
  end

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

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

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

  if attributes.key?(:'cvss_v3_base')
    self.cvss_v3_base = attributes[:'cvss_v3_base']
  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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

Instance Attribute Details

#affected_productsObject

List of products affected by vulnerability, specifying product and vendor


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

def affected_products
  @affected_products
end

#community_identifiersObject

Vulnerability community identifiers, which is usually populated for the most popular vulnerabilities


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

def community_identifiers
  @community_identifiers
end

#cveObject

CVE ID number with four or more digits in the sequence number portion of the ID, examples: CVE-1999-0067, CVE-2014-12345, CVE-2016-7654321


42
43
44
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 42

def cve
  @cve
end

#cvss_v2_baseObject

Vulnerability severity score, according to Common Vulnerability Scoring System V2


45
46
47
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 45

def cvss_v2_base
  @cvss_v2_base
end

#cvss_v3_baseObject

Vulnerability severity score, according to Common Vulnerability Scoring System V3


48
49
50
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 48

def cvss_v3_base
  @cvss_v3_base
end

#descriptionObject

Text description of the vulnerability


51
52
53
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 51

def description
  @description
end

#exploit_statusObject

Exploit status of vulnerability, one of: unproven, available, easilyaccessible, activelyused


54
55
56
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 54

def exploit_status
  @exploit_status
end

#nameObject

legacy field, not populated


57
58
59
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 57

def name
  @name
end

#publish_dateObject

Date when the vulnerability was published


60
61
62
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 60

def publish_date
  @publish_date
end

Threat actors that exploits vulnerability


63
64
65
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 63

def related_actors
  @related_actors
end

Related finished Intelligence Reports to vulnerability, which usually describes the exploitation or attacks using those


66
67
68
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 66

def related_reports
  @related_reports
end

Malware Families (threats) that are known to be related to the vulnerability


69
70
71
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 69

def related_threats
  @related_threats
end

#severityObject

Severity of the vulnerability, can be empty or one of: LOW, MEDIUM, HIGH, CRITICAL


72
73
74
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 72

def severity
  @severity
end

#updated_timestampObject

Date when the vulnerability was last time updated in the CrowdStrike’s database


75
76
77
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 75

def updated_timestamp
  @updated_timestamp
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about


98
99
100
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 78

def self.attribute_map
  {
    :'affected_products' => :'affected_products',
    :'community_identifiers' => :'community_identifiers',
    :'cve' => :'cve',
    :'cvss_v2_base' => :'cvss_v2_base',
    :'cvss_v3_base' => :'cvss_v3_base',
    :'description' => :'description',
    :'exploit_status' => :'exploit_status',
    :'name' => :'name',
    :'publish_date' => :'publish_date',
    :'related_actors' => :'related_actors',
    :'related_reports' => :'related_reports',
    :'related_threats' => :'related_threats',
    :'severity' => :'severity',
    :'updated_timestamp' => :'updated_timestamp'
  }
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


264
265
266
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 264

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

.openapi_nullableObject

List of attributes with nullable: true


123
124
125
126
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 123

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

.openapi_typesObject

Attribute type mapping.


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 103

def self.openapi_types
  {
    :'affected_products' => :'Array<DomainVulnerabilityAffectedProduct>',
    :'community_identifiers' => :'Array<String>',
    :'cve' => :'String',
    :'cvss_v2_base' => :'String',
    :'cvss_v3_base' => :'String',
    :'description' => :'String',
    :'exploit_status' => :'String',
    :'name' => :'String',
    :'publish_date' => :'String',
    :'related_actors' => :'Array<DomainVulnerabilityActor>',
    :'related_reports' => :'Array<DomainVulnerabilityReport>',
    :'related_threats' => :'Array<DomainVulnerabilityRelatedThreat>',
    :'severity' => :'String',
    :'updated_timestamp' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      affected_products == o.affected_products &&
      community_identifiers == o.community_identifiers &&
      cve == o.cve &&
      cvss_v2_base == o.cvss_v2_base &&
      cvss_v3_base == o.cvss_v3_base &&
      description == o.description &&
      exploit_status == o.exploit_status &&
      name == o.name &&
      publish_date == o.publish_date &&
      related_actors == o.related_actors &&
      related_reports == o.related_reports &&
      related_threats == o.related_threats &&
      severity == o.severity &&
      updated_timestamp == o.updated_timestamp
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


295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 295

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


366
367
368
369
370
371
372
373
374
375
376
377
378
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 366

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


271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 271

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

251
252
253
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 251

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


257
258
259
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 257

def hash
  [affected_products, community_identifiers, cve, cvss_v2_base, cvss_v3_base, description, exploit_status, name, publish_date, related_actors, related_reports, related_threats, severity, updated_timestamp].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


212
213
214
215
216
217
218
219
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 212

def list_invalid_properties
  invalid_properties = Array.new
  if @cve.nil?
    invalid_properties.push('invalid value for "cve", cve 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


342
343
344
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 342

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


348
349
350
351
352
353
354
355
356
357
358
359
360
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 348

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


336
337
338
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 336

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


223
224
225
226
# File 'lib/crimson-falcon/models/domain_vulnerability.rb', line 223

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