Class: Falcon::QuickScanPro

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/quick_scan_pro.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ QuickScanPro

Returns a new instance of QuickScanPro.



36
37
38
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 36

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#delete_file(ids, opts = {}) ⇒ QuickscanproDeleteFileResponse

Deletes file by its sha256 identifier.

Parameters:

  • ids (Array<String>) —

    File&#39;s SHA256

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

    the optional parameters

Returns:



43
44
45
46
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 43

def delete_file(ids, opts = {})
  data, _status_code, _headers = delete_file_with_http_info(ids, opts)
  data
end

#delete_file_with_http_info(ids, opts = {}) ⇒ Array<(QuickscanproDeleteFileResponse, Integer, Hash)>

Deletes file by its sha256 identifier.

Parameters:

  • ids (Array<String>) —

    File&#39;s SHA256

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

    the optional parameters

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 52

def delete_file_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuickScanPro.delete_file ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling QuickScanPro.delete_file"
  end
  # resource path
  local_var_path = '/quickscanpro/entities/files/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'QuickscanproDeleteFileResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"QuickScanPro.delete_file",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuickScanPro#delete_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_scan_result(ids, opts = {}) ⇒ MsaspecQueryResponse

Deletes the result of an QuickScan Pro scan.

Parameters:

  • ids (Array<String>) —

    Scan job IDs previously created by LaunchScan

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

    the optional parameters

Returns:



105
106
107
108
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 105

def delete_scan_result(ids, opts = {})
  data, _status_code, _headers = delete_scan_result_with_http_info(ids, opts)
  data
end

#delete_scan_result_with_http_info(ids, opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Deletes the result of an QuickScan Pro scan.

Parameters:

  • ids (Array<String>) —

    Scan job IDs previously created by LaunchScan

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

    the optional parameters

Returns:

  • (Array<(MsaspecQueryResponse, Integer, Hash)>) —

    MsaspecQueryResponse data, response status code and response headers



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
156
157
158
159
160
161
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 114

def delete_scan_result_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuickScanPro.delete_scan_result ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling QuickScanPro.delete_scan_result"
  end
  # resource path
  local_var_path = '/quickscanpro/entities/scans/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MsaspecQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"QuickScanPro.delete_scan_result",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuickScanPro#delete_scan_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scan_result(ids, opts = {}) ⇒ QuickscanproGetScanResultResponse

Gets the result of an QuickScan Pro scan.

Parameters:

  • ids (Array<String>) —

    Scan job IDs previously created by LaunchScan

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

    the optional parameters

Returns:



167
168
169
170
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 167

def get_scan_result(ids, opts = {})
  data, _status_code, _headers = get_scan_result_with_http_info(ids, opts)
  data
end

#get_scan_result_with_http_info(ids, opts = {}) ⇒ Array<(QuickscanproGetScanResultResponse, Integer, Hash)>

Gets the result of an QuickScan Pro scan.

Parameters:

  • ids (Array<String>) —

    Scan job IDs previously created by LaunchScan

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

    the optional parameters

Returns:



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
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 176

def get_scan_result_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuickScanPro.get_scan_result ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling QuickScanPro.get_scan_result"
  end
  # resource path
  local_var_path = '/quickscanpro/entities/scans/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'QuickscanproGetScanResultResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"QuickScanPro.get_scan_result",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuickScanPro#get_scan_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#launch_scan(body, opts = {}) ⇒ QuickscanproLaunchScanResponse

Starts scanning a file uploaded through ‘/quickscanpro/entities/files/v1’.

Parameters:

Returns:



229
230
231
232
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 229

def launch_scan(body, opts = {})
  data, _status_code, _headers = launch_scan_with_http_info(body, opts)
  data
end

#launch_scan_with_http_info(body, opts = {}) ⇒ Array<(QuickscanproLaunchScanResponse, Integer, Hash)>

Starts scanning a file uploaded through &#39;/quickscanpro/entities/files/v1&#39;.

Parameters:

Returns:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 238

def launch_scan_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuickScanPro.launch_scan ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QuickScanPro.launch_scan"
  end
  # resource path
  local_var_path = '/quickscanpro/entities/scans/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'QuickscanproLaunchScanResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"QuickScanPro.launch_scan",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuickScanPro#launch_scan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_scan_results(filter, opts = {}) ⇒ QuickscanproQueryScanResultsResponse

FQL query specifying the filter parameters

Parameters:

  • filter (String) —

    Empty value means to not filter on anything Available filter fields that supports match (~): _all, mitre_attacks.description Available filter fields that supports exact match: cid,sha256,id,status,type,entity,executor,verdict,verdict_reason,verdict_source,artifacts.file_artifacts.sha256,artifacts.file_artifacts.filename,artifacts.file_artifacts.verdict,artifacts.file_artifacts.verdict_reasons,artifacts.url_artifacts.url,artifacts.url_artifacts.verdict,artifacts.url_artifacts.verdict_reasons,mitre_attacks.attack_id,mitre_attacks.attack_id_wiki,mitre_attacks.tactic,mitre_attacks.technique,mitre_attacks.capec_id,mitre_attacks.parent.attack_id,mitre_attacks.parent.attack_id_wiki,mitre_attacks.parent.technique Available filter fields that supports wildcard (*): mitre_attacks.description Available filter fields that supports range comparisons (&gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;): created_timestamp, updated_timestamp All filter fields and operations supports negation (!). _all field is used to search between all fields.

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving ids from.

  • :limit (Integer) —

    Maximum number of IDs to return. Max: 5000. (default to 50)

  • :sort (String) —

    Sort order: &#x60;asc&#x60; or &#x60;desc&#x60;. Sort supported fields &#x60;created_timestamp&#x60;

Returns:



298
299
300
301
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 298

def query_scan_results(filter, opts = {})
  data, _status_code, _headers = query_scan_results_with_http_info(filter, opts)
  data
end

#query_scan_results_with_http_info(filter, opts = {}) ⇒ Array<(QuickscanproQueryScanResultsResponse, Integer, Hash)>

FQL query specifying the filter parameters

Parameters:

  • filter (String) —

    Empty value means to not filter on anything Available filter fields that supports match (~): _all, mitre_attacks.description Available filter fields that supports exact match: cid,sha256,id,status,type,entity,executor,verdict,verdict_reason,verdict_source,artifacts.file_artifacts.sha256,artifacts.file_artifacts.filename,artifacts.file_artifacts.verdict,artifacts.file_artifacts.verdict_reasons,artifacts.url_artifacts.url,artifacts.url_artifacts.verdict,artifacts.url_artifacts.verdict_reasons,mitre_attacks.attack_id,mitre_attacks.attack_id_wiki,mitre_attacks.tactic,mitre_attacks.technique,mitre_attacks.capec_id,mitre_attacks.parent.attack_id,mitre_attacks.parent.attack_id_wiki,mitre_attacks.parent.technique Available filter fields that supports wildcard (*): mitre_attacks.description Available filter fields that supports range comparisons (&gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;): created_timestamp, updated_timestamp All filter fields and operations supports negation (!). _all field is used to search between all fields.

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving ids from.

  • :limit (Integer) —

    Maximum number of IDs to return. Max: 5000. (default to 50)

  • :sort (String) —

    Sort order: &#x60;asc&#x60; or &#x60;desc&#x60;. Sort supported fields &#x60;created_timestamp&#x60;

Returns:



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
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
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 310

def query_scan_results_with_http_info(filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuickScanPro.query_scan_results ...'
  end
  # verify the required parameter 'filter' is set
  if @api_client.config.client_side_validation && filter.nil?
    fail ArgumentError, "Missing the required parameter 'filter' when calling QuickScanPro.query_scan_results"
  end
  # resource path
  local_var_path = '/quickscanpro/queries/scans/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = filter
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'QuickscanproQueryScanResultsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"QuickScanPro.query_scan_results",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuickScanPro#query_scan_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_file_quick_scan_pro(file, opts = {}) ⇒ QuickscanproFileUploadResponse

Uploads a file to be further analyzed with QuickScan Pro. The samples expire according to the Retention Policies set.

Parameters:

  • file (File) —

    Binary file to be uploaded. Max file size: 256 MB.

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

    the optional parameters

Options Hash (opts):

  • :scan (Boolean) —

    If true, after upload, it starts scanning immediately. Default scan mode is &#39;false&#39; (default to false)

Returns:



367
368
369
370
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 367

def upload_file_quick_scan_pro(file, opts = {})
  data, _status_code, _headers = upload_file_quick_scan_pro_with_http_info(file, opts)
  data
end

#upload_file_quick_scan_pro_with_http_info(file, opts = {}) ⇒ Array<(QuickscanproFileUploadResponse, Integer, Hash)>

Uploads a file to be further analyzed with QuickScan Pro. The samples expire according to the Retention Policies set.

Parameters:

  • file (File) —

    Binary file to be uploaded. Max file size: 256 MB.

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

    the optional parameters

Options Hash (opts):

  • :scan (Boolean) —

    If true, after upload, it starts scanning immediately. Default scan mode is &#39;false&#39; (default to false)

Returns:



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/crimson-falcon/api/quick_scan_pro.rb', line 377

def upload_file_quick_scan_pro_with_http_info(file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuickScanPro.upload_file_quick_scan_pro ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling QuickScanPro.upload_file_quick_scan_pro"
  end
  # resource path
  local_var_path = '/quickscanpro/entities/files/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = file
  form_params['scan'] = opts[:'scan'] if !opts[:'scan'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'QuickscanproFileUploadResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"QuickScanPro.upload_file_quick_scan_pro",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuickScanPro#upload_file_quick_scan_pro\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end