Class: Emasser::Poams

Inherits:
SubCommandBase show all
Defined in:
lib/emasser/get.rb,
lib/emasser/put.rb,
lib/emasser/post.rb,
lib/emasser/delete.rb

Overview

Remove one or more POA&M from a system

Endpoint:

/api/systems/{systemId}/poams - Remove one or many poa&m items in a system

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SubCommandBase

banner

Methods included from OutputConverters

#change_to_datetime, #to_output_hash

Methods included from InputConverters

#to_input_hash

Methods included from OptionsParser

#optional_options, #required_options

Class Method Details

.exit_on_failure? ⇒ Boolean

Returns:

  • (Boolean) 


288
289
290
 
# File 'lib/emasser/get.rb', line 288

def self.exit_on_failure?
  true
end

Instance Method Details

#add ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize



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
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
 
# File 'lib/emasser/post.rb', line 204

def add
  # Check if business logic is satisfied
  process_business_logic

  # Required fields
  require_fields = EmassClient::PoamRequiredFields.new
  require_fields.status = options[:status]
  require_fields.vulnerability_description = options[:vulnerabilityDescription]
  require_fields.source_identifying_vulnerability = options[:sourceIdentifyingVulnerability]
  require_fields.poc_organization = options[:pocOrganization]
  require_fields.resources = options[:resources]
  # Required for VA, optional for Army and USCG. - defaults to false
  require_fields.identified_in_cfo_audit_or_other_review = options[:identifiedInCFOAuditOrOtherReview] if options[:identifiedInCFOAuditOrOtherReview]

  # Add conditional fields
  conditional_fields = EmassClient::PoamConditionalFields.new
  conditional_fields.poc_first_name = options[:pocFirstName] if options[:pocFirstName]
  conditional_fields.poc_last_name = options[:pocLastName] if options[:pocLastName]
  conditional_fields.poc_email = options[:pocEmail] if options[:pocEmail]
  conditional_fields.poc_phone_number = options[:pocPhoneNumber] if options[:pocPhoneNumber]
  conditional_fields.severity = options[:severity] if options[:severity]
  conditional_fields.scheduled_completion_date = options[:scheduledCompletionDate] if options[:scheduledCompletionDate]
  conditional_fields.completion_date = options[:completionDate] if options[:completionDate]
  conditional_fields.comments = options[:comments] if options[:comments]
  conditional_fields.personnel_resources_funded_base_hours = options[:personnelResourcesFundedBaseHours] if options[:personnelResourcesFundedBaseHours]
  conditional_fields.personnel_resources_cost_code = options[:personnelResourcesCostCode] if options[:personnelResourcesCostCode]
  conditional_fields.personnel_resources_unfunded_base_hours = options[:personnelResourcesUnfundedBaseHours] if options[:personnelResourcesUnfundedBaseHours]
  conditional_fields.personnel_resources_nonfunding_obstacle = options[:personnelResourcesNonfundingObstacle] if options[:personnelResourcesNonfundingObstacle]
  conditional_fields.personnel_resources_nonfunding_obstacle_other_reason = options[:personnelResourcesNonfundingObstacleOtherReason] if options[:personnelResourcesNonfundingObstacleOtherReason]
  conditional_fields.non_personnel_resources_funded_amount = options[:nonPersonnelResourcesFundedAmount] if options[:nonPersonnelResourcesFundedAmount]
  conditional_fields.non_personnel_resources_cost_code = options[:nonPersonnelResourcesCostCode] if options[:nonPersonnelResourcesCostCode]
  conditional_fields.non_personnel_resources_unfunded_amount = options[:nonPersonnelResourcesUnfundedAmount] if options[:nonPersonnelResourcesUnfundedAmount]
  conditional_fields.non_personnel_resources_nonfunding_obstacle = options[:nonPersonnelResourcesNonfundingObstacle] if options[:nonPersonnelResourcesNonfundingObstacle]
  conditional_fields.non_personnel_resources_nonfunding_obstacle_other_reason = options[:nonPersonnelResourcesNonfundingObstacleOtherReason] if options[:nonPersonnelResourcesNonfundingObstacleOtherReason]

  # Add optional fields
  optional_fields = EmassClient::PoamOptionalFields.new
  optional_fields.external_uid = options[:externalUid] if options[:externalUid]
  optional_fields.control_acronym = options[:controlAcronym] if options[:controlAcronym]
  optional_fields.assessment_procedure = options[:assessmentProcedure] if options[:assessmentProcedure]
  optional_fields.security_checks = options[:securityChecks] if options[:securityChecks]
  optional_fields.raw_severity = options[:rawSeverity] if options[:rawSeverity]
  optional_fields.relevance_of_threat = options[:relevanceOfThreat] if options[:relevanceOfThreat]
  optional_fields.likelihood = options[:likelihood] if options[:likelihood]
  optional_fields.impact = options[:impact] if options[:impact]
  optional_fields.impact_description = options[:impactDescription] if options[:impactDescription]
  optional_fields.residual_risk_level = options[:residualRiskLevel] if options[:residualRiskLevel]
  optional_fields.recommendations = options[:recommendations] if options[:recommendations]
  optional_fields.mitigations = options[:mitigations] if options[:mitigations]
  optional_fields.resulting_residual_risk_level_after_proposed_mitigations = options[:resultingResidualRiskLevelAfterProposedMitigations] if options[:resultingResidualRiskLevelAfterProposedMitigations]
  optional_fields.predisposing_conditions = options[:predisposingConditions] if options[:predisposingConditions]
  optional_fields.threat_description = options[:threatDescription] if options[:threatDescription]
  optional_fields.devices_affected = options[:devicesAffected] if options[:devicesAffected]

  # Build the milestones object array
  milestone = {}
  milestone['description'] = options[:milestone]['description'] if options[:milestone]['description']
  milestone['scheduledCompletionDate'] = options[:milestone]['scheduledCompletionDate'].to_f if options[:milestone]['scheduledCompletionDate']
  milestone_array = Array.new(1, milestone)

  # Build the request body
  body = {}
  body = body.merge(require_fields)
  body = body.merge(optional_fields)
  body = body.merge(conditional_fields)
  body = body.merge({ milestones: milestone_array })
  body_array = Array.new(1, body)

  begin
    result = EmassClient::POAMApi.new.add_poam_by_system_id(options[:systemId], body_array)
    puts to_output_hash(result).green
  rescue EmassClient::ApiError => e
    puts 'Exception when calling POAMApi->add_poam_by_system_id'.red
    puts to_output_hash(e)
  end
end

#byPoamId ⇒ Object 



329
330
331
332
333
334
335
 
# File 'lib/emasser/get.rb', line 329

def byPoamId
  result = EmassClient::POAMApi.new.get_system_poams_by_poam_id(options[:systemId], options[:poamId])
  puts to_output_hash(result).green
rescue EmassClient::ApiError => e
  puts 'Exception when calling POAMApi->get_system_poams_by_poam_id'.red
  puts to_output_hash(e)
end

#forSystem ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/emasser/get.rb', line 308

def forSystem
  optional_options_keys = optional_options(@_initializer).keys
  optional_options = to_input_hash(optional_options_keys, options)

  begin
    result = EmassClient::POAMApi.new.get_system_poams(options[:systemId], optional_options)
    puts to_output_hash(result).green
  rescue EmassClient::ApiError => e
    puts 'Exception when calling POAMApi->get_system_poams'.red
    puts to_output_hash(e)
  end
end

#remove ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/emasser/delete.rb', line 57

def remove
  body = EmassClient::PoamRequestDeleteBodyInner.new
  body.poam_id = options[:poamId]
  body_array = Array.new(1, body)

  result = EmassClient::POAMApi.new.delete_poam(options[:systemId], body_array)
  puts to_output_hash(result).green
rescue EmassClient::ApiError => e
  puts 'Exception when calling POAMApi->delete_poam'.red
  puts to_output_hash(e)
end

#update ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize



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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
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
 
# File 'lib/emasser/put.rb', line 327

def update
  # Check if business logic is satisfied
  process_business_logic

  # Required fields
  require_id_fields = EmassClient::PoamIds.new
  require_id_fields.poam_id = options[:poamId]
  # API spec states that the displayPoamId is a required field, by backend does not require it
  require_id_fields.display_poam_id = options[:displayPoamId] if options[:displayPoamId]

  require_fields = EmassClient::PoamRequiredFields.new
  require_fields.status = options[:status]
  require_fields.vulnerability_description = options[:vulnerabilityDescription]
  require_fields.source_identifying_vulnerability = options[:sourceIdentifyingVulnerability]
  require_fields.poc_organization = options[:pocOrganization]
  require_fields.resources = options[:resources]
  # Required for VA, optional for Army and USCG. - defaults to false
  require_fields.identified_in_cfo_audit_or_other_review = options[:identifiedInCFOAuditOrOtherReview] if options[:identifiedInCFOAuditOrOtherReview]

  # Add conditional fields
  conditional_fields = EmassClient::PoamConditionalFields.new
  conditional_fields.poc_first_name = options[:pocFirstName] if options[:pocFirstName]
  conditional_fields.poc_last_name = options[:pocLastName] if options[:pocLastName]
  conditional_fields.poc_email = options[:pocEmail] if options[:pocEmail]
  conditional_fields.poc_phone_number = options[:pocPhoneNumber] if options[:pocPhoneNumber]
  conditional_fields.severity = options[:severity] if options[:severity]
  conditional_fields.scheduled_completion_date = options[:scheduledCompletionDate] if options[:scheduledCompletionDate]
  conditional_fields.completion_date = options[:completionDate] if options[:completionDate]
  conditional_fields.comments = options[:comments] if options[:comments]
  conditional_fields.personnel_resources_funded_base_hours = options[:personnelResourcesFundedBaseHours] if options[:personnelResourcesFundedBaseHours]
  conditional_fields.personnel_resources_cost_code = options[:personnelResourcesCostCode] if options[:personnelResourcesCostCode]
  conditional_fields.personnel_resources_unfunded_base_hours = options[:personnelResourcesUnfundedBaseHours] if options[:personnelResourcesUnfundedBaseHours]
  conditional_fields.personnel_resources_nonfunding_obstacle = options[:personnelResourcesNonfundingObstacle] if options[:personnelResourcesNonfundingObstacle]
  conditional_fields.personnel_resources_nonfunding_obstacle_other_reason = options[:personnelResourcesNonfundingObstacleOtherReason] if options[:personnelResourcesNonfundingObstacleOtherReason]
  conditional_fields.non_personnel_resources_funded_amount = options[:nonPersonnelResourcesFundedAmount] if options[:nonPersonnelResourcesFundedAmount]
  conditional_fields.non_personnel_resources_cost_code = options[:nonPersonnelResourcesCostCode] if options[:nonPersonnelResourcesCostCode]
  conditional_fields.non_personnel_resources_unfunded_amount = options[:nonPersonnelResourcesUnfundedAmount] if options[:nonPersonnelResourcesUnfundedAmount]
  conditional_fields.non_personnel_resources_nonfunding_obstacle = options[:nonPersonnelResourcesNonfundingObstacle] if options[:nonPersonnelResourcesNonfundingObstacle]
  conditional_fields.non_personnel_resources_nonfunding_obstacle_other_reason = options[:nonPersonnelResourcesNonfundingObstacleOtherReason] if options[:nonPersonnelResourcesNonfundingObstacleOtherReason]

  # Add optional fields
  optional_fields = EmassClient::PoamOptionalFields.new
  optional_fields.external_uid = options[:externalUid] if options[:externalUid]
  optional_fields.control_acronym = options[:controlAcronym] if options[:controlAcronym]
  optional_fields.assessment_procedure = options[:assessmentProcedure] if options[:assessmentProcedure]
  optional_fields.security_checks = options[:securityChecks] if options[:securityChecks]
  optional_fields.raw_severity = options[:rawSeverity] if options[:rawSeverity]
  optional_fields.relevance_of_threat = options[:relevanceOfThreat] if options[:relevanceOfThreat]
  optional_fields.likelihood = options[:likelihood] if options[:likelihood]
  optional_fields.impact = options[:impact] if options[:impact]
  optional_fields.impact_description = options[:impactDescription] if options[:impactDescription]
  optional_fields.residual_risk_level = options[:residualRiskLevel] if options[:residualRiskLevel]
  optional_fields.recommendations = options[:recommendations] if options[:recommendations]
  optional_fields.mitigations = options[:mitigations] if options[:mitigations]
  optional_fields.resulting_residual_risk_level_after_proposed_mitigations = options[:resultingResidualRiskLevelAfterProposedMitigations] if options[:resultingResidualRiskLevelAfterProposedMitigations]
  optional_fields.predisposing_conditions = options[:predisposingConditions] if options[:predisposingConditions]
  optional_fields.threat_description = options[:threatDescription] if options[:threatDescription]
  optional_fields.devices_affected = options[:devicesAffected] if options[:devicesAffected]

  # Build the milestones object array
  milestone = {}
  milestone['milestoneId'] = options[:milestone]['milestoneId'].to_i if options[:milestone]['milestoneId']
  milestone['description'] = options[:milestone]['description'] if options[:milestone]['description']
  milestone['scheduledCompletionDate'] = options[:milestone]['scheduledCompletionDate'].to_f if options[:milestone]['scheduledCompletionDate']
  milestone_array = Array.new(1, milestone)

  # Build the request body
  body = {}
  body = body.merge(require_id_fields)
  body = body.merge(require_fields)
  body = body.merge(optional_fields)
  body = body.merge(conditional_fields)
  body = body.merge({ milestones: milestone_array })
  body_array = Array.new(1, body)

  begin
    result = EmassClient::POAMApi.new.update_poam_by_system_id(options[:systemId], body_array)
    puts to_output_hash(result).green
  rescue EmassClient::ApiError => e
    puts 'Exception when calling POAMApi->update_poam_by_system_id'.red
    puts to_output_hash(e)
  end
end