emasser 1.0.0

data/emass_client/swagger-codegen/ruby_template/configuration.mustache

@@ -0,0 +1,234 @@
+=begin
+{{> api_info}}
+=end
+
+module {{moduleName}}
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    ### TLS/SSL setting
+    # Client private key passphrase (for client certificate)
+    attr_accessor :key_password
+    
+	# Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    def initialize
+      @scheme = '{{scheme}}'
+      @host = '{{host}}'
+      @base_path = '{{basePath}}'
+      @api_key = {}
+      @api_key_prefix = {}
+      @timeout = 0
+      @client_side_validation = true
+      @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
+      @cert_file = nil
+      @key_file = nil
+      @key_password = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    def base_url
+      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+{{#authMethods}}
+{{#isApiKey}}
+        '{{name}}' =>
+          {
+            type: 'api_key',
+            in: {{#isKeyInHeader}}'header'{{/isKeyInHeader}}{{#isKeyInQuery}}'query'{{/isKeyInQuery}},
+            key: '{{keyParamName}}',
+            value: api_key_with_prefix('{{keyParamName}}')
+          },
+{{/isApiKey}}
+{{#isBasic}}
+        '{{name}}' =>
+          {
+            type: 'basic',
+            in: 'header',
+            key: 'Authorization',
+            value: basic_auth_token
+          },
+{{/isBasic}}
+{{#isBearer}}
+        '{{name}}' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token}"
+          },
+{{/isBearer}}
+{{#isOAuth}}
+        '{{name}}' =>
+          {
+            type: 'oauth2',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token}"
+          },
+{{/isOAuth}}
+{{/authMethods}}
+      }
+    end
+  end
+end

data/emass_client/swagger-codegen/ruby_template/gemspec.mustache

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+{{> api_info}}
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "{{gemName}}/version"
+
+Gem::Specification.new do |s|
+  s.name        = "{{gemName}}{{^gemName}}{{{appName}}}{{/gemName}}"
+  s.version     = {{moduleName}}::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["{{gemAuthor}}{{^gemAuthor}}Swagger-Codegen{{/gemAuthor}}"]
+  s.email       = ["{{gemAuthorEmail}}{{^gemAuthorEmail}}{{infoEmail}}{{/gemAuthorEmail}}"]
+  s.homepage    = "{{gemHomepage}}{{^gemHomepage}}https://github.com/swagger-api/swagger-codegen{{/gemHomepage}}"
+  s.summary     = "{{gemSummary}}{{^gemSummary}}{{{appName}}} Ruby Gem{{/gemSummary}}"
+  s.description = "{{gemDescription}}{{^gemDescription}}{{{appDescription}}}{{^appDescription}}{{{appName}}} Ruby Gem{{/appDescription}}{{/gemDescription}}"
+  {{#gemLicense}}
+  s.license     = '{{{gemLicense}}}'
+  {{/gemLicense}}
+  {{^gemLicense}}
+  s.license     = "Unlicense"
+  {{/gemLicense}}
+  s.required_ruby_version = "{{{gemRequiredRubyVersion}}}{{^gemRequiredRubyVersion}}>= 1.9{{/gemRequiredRubyVersion}}"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  #s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  #s.test_files    = `find spec/*`.split("\n")
+  s.files = Dir.glob('lib/**/*') + %w{Rakefile README.md}  
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/emasser.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/emasser/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'emasser'
+  spec.version = Emasser::VERSION
+  spec.authors = ['Amndeep Singh Mann', 'George Dias', 'Kyle Fagan', 'Robert Clark', 'Aaron Lippold']
+  spec.email = ['saf@mitre.org']
+
+  spec.summary = 'Provide an automated capability for invoving eMASS API endpoints'
+  spec.description = 'emasser can be used as a gem or used from the command line to access eMASS via thei API.'
+  spec.homepage = 'https://saf.mitre.org'
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'dotenv'
+  spec.add_runtime_dependency 'rubyzip'
+  spec.add_runtime_dependency 'swagger_client'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'bundler-audit', '~> 0.7'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rspec', '~>3.10.0'
+  spec.add_development_dependency 'yaml', '~>0.2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.7'
+  spec.add_development_dependency 'rubocop-minitest', '~> 0.10'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.11'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
+end

data/exe/emasser

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'dotenv/load'
+require 'emasser'

data/lib/emasser/cli.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Emasser
+  class CLI < Thor
+    package_name 'Emasser'
+
+    if ARGV[0].to_s.include? 'get'
+      require 'emasser/get'
+      register(Emasser::Get, 'get', 'get [RESOURCE]', 'Gets a resource')
+    elsif ARGV[0].to_s.include? 'post'
+      require 'emasser/post'
+      register(Emasser::Post, 'post', 'post [RESOURCE]', 'Posts resources')
+    elsif ARGV[0].to_s.include? 'put'
+      require 'emasser/put'
+      register(Emasser::Put, 'put', 'put [RESOURCE]', 'Puts resources')
+    elsif ARGV[0].to_s.include? 'del'
+      require 'emasser/delete'
+      register(Emasser::Delete, 'delete', 'delete [RESOURCE]', 'Deletes resources')
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+  end
+end

data/lib/emasser/configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Emasser
+  require 'emasser/errors'
+
+  class Configuration
+    # rubocop: disable Style/RaiseArgs
+    def self.raise_unless_present(env)
+      ENV.fetch(env) { raise Emasser::ConfigurationMissingError.new(env) }
+    rescue Emasser::ConfigurationMissingError => e
+      puts e.message.red
+      puts 'See emasser environment variables requirements in emasser CLI Features'
+      exit
+    end
+    # rubocop: enable Style/RaiseArgs
+
+    # rubocop: disable Style/TernaryParentheses, Style/IfWithBooleanLiteralBranches
+    SwaggerClient.configure do |config|
+      config.api_key['api-key'] = raise_unless_present('EMASSER_API_KEY_API_KEY')
+      config.api_key['user-uid'] = raise_unless_present('EMASSER_API_KEY_USER_UID')
+      config.scheme = 'https'
+      config.base_path = '/'
+      config.host = raise_unless_present('EMASSER_HOST')
+      config.key_file = raise_unless_present('EMASSER_KEY_FILE_PATH')
+      config.cert_file = raise_unless_present('EMASSER_CERT_FILE_PATH')
+      config.key_password = raise_unless_present('EMASSER_KEY_PASSWORD')
+      config.client_side_validation = (raise_unless_present('EMASSER_CLIENT_SIDE_VALIDATION') == 'false') ? false : true
+      config.verify_ssl = (raise_unless_present('EMASSER_VERIFY_SSL') == 'false') ? false : true
+      config.verify_ssl_host = (raise_unless_present('EMASSER_VERIFY_SSL_HOST') == 'false') ? false : true
+      config.debugging = (ENV.fetch('EMASSER_DEBUGGING', false) == 'true') ? true : false
+    end
+    # rubocop: enable Style/TernaryParentheses, Style/IfWithBooleanLiteralBranches
+  end
+end

data/lib/emasser/constants.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Emasser
+  GET_SYSTEM_ID_QUERY_PARAMS = {
+    include_package: false,
+    include_ditpr_metrics: false,
+    include_decommissioned: false,
+    return_type: 'SystemResponse' # This is used by swagger client only to format output
+  }.freeze
+
+  GET_SYSTEM_RETURN_TYPE = {
+    return_type: 'SystemResponse'
+  }.freeze
+
+  GET_ARTIFACTS_RETURN_TYPE = {
+    return_type: 'String'
+  }.freeze
+end

data/lib/emasser/delete.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+# Hack class that properly formats the CLI help
+class SubCommandBase < Thor
+  # include OptionsParser
+  # include InputConverters
+  include OutputConverters
+
+  # We do not control the method declaration for the banner
+
+  # rubocop:disable Style/OptionalBooleanParameter
+  def self.banner(command, _namespace = nil, subcommand = false)
+    # Use the $thor_runner (declared by the Thor CLI framework)
+    # to properly format the help text of sub-sub-commands.
+
+    # rubocop:disable Style/GlobalVars
+    if ancestors[0].to_s.include? '::Del'
+      "#{basename} #{command.formatted_usage(self, $thor_runner, subcommand)}"
+    else
+      "#{basename} delete #{command.formatted_usage(self, $thor_runner, subcommand)}"
+    end
+    # rubocop:enable Style/GlobalVars
+  end
+  # rubocop:enable Style/OptionalBooleanParameter
+end
+
+# Override thor's long_desc identation behavior
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, _options = {})
+        message = "\n#{message}\n" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+end
+
+module Emasser
+  # 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 Poams < SubCommandBase
+    def self.exit_on_failure?
+      true
+    end
+
+    # Delete a POAM -----------------------------------------------------------
+    desc 'remove', 'Add one or many POA&M items in a system'
+    long_desc Help.text(:poam_del_mapper)
+
+    # Required parameters/fields
+    option :systemId, type: :numeric, required: true, desc: 'A numeric value representing the system identification'
+    option :poamId,   type: :numeric, required: true, desc: 'A numeric value representing the poam identification'
+
+    def remove
+      body = SwaggerClient::DeletePoam.new
+      body.poam_id = options[:poamId]
+      body_array = Array.new(1, body)
+
+      result = SwaggerClient::POAMApi.new.delete_poam(body_array, options[:systemId])
+      puts to_output_hash(result).green
+    rescue SwaggerClient::ApiError => e
+      puts 'Exception when calling POAMApi->delete_poam'.red
+      puts to_output_hash(e)
+    end
+  end
+
+  # Remove one or more Milestones from a system for a POA
+  #
+  # Endpoint:
+  #  /api/systems/{systemId}/poam/{poamId}/milestones - Remove milestones in a system for one or many poa&m items
+  class Milestones < SubCommandBase
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'remove', 'Delete one or many POA&M MILSTONES in a system'
+    long_desc Help.text(:milestone_del_mapper)
+
+    # Required parameters/fields
+    option :systemId,    type: :numeric, required: true,
+                         desc: 'A numeric value representing the system identification'
+    option :poamId,      type: :numeric, required: true,
+                         desc: 'A numeric value representing the poam identification'
+    option :milestoneId, type: :numeric, required: true,
+                         desc: 'A numeric value representing the milestone identification'
+
+    def remove
+      body = SwaggerClient::DeleteMilestone.new
+      body.milestone_id = options[:milestoneId]
+      body_array = Array.new(1, body)
+
+      result = SwaggerClient::MilestonesApi.new.delete_milestone(body_array, options[:systemId], options[:poamId])
+      # The server returns an empty object upon successfully deleting a milestone.
+      puts to_output_hash(result).green
+    rescue SwaggerClient::ApiError => e
+      puts 'Exception when calling MilestonesApi->delete_milestone'.red
+      puts to_output_hash(e)
+    end
+  end
+
+  # Remove one or many artifacts in a system
+  #
+  # Endpoint:
+  #    /api/systems/{systemId}/artifacts - Delete one or more artifacts (files) from a system
+  class Artifacts < SubCommandBase
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'remove', 'Remove one or many artifacts in a system'
+    long_desc Help.text(:artifact_del_mapper)
+
+    # Required parameters/fields
+    option :systemId, type: :numeric, required: true, desc: 'A numeric value representing the system identification'
+    option :files, type: :array, required: true, desc: 'Artifact file(s) to remove from the given system'
+
+    def remove
+      body_array = []
+      options[:files].each do |file|
+        obj = {}
+        obj[:filename] = file
+        body_array << obj
+      end
+
+      result = SwaggerClient::ArtifactsApi.new.delete_artifact(body_array, options[:systemId])
+      puts to_output_hash(result).green
+    rescue SwaggerClient::ApiError => e
+      puts 'Exception when calling ArtifactsApi->delete_artifact'.red
+      puts to_output_hash(e)
+    end
+  end
+
+  class Delete < SubCommandBase
+    desc 'poams', 'Delete Plan of Action and Milestones (POA&M) items for a system'
+    subcommand 'poams', Poams
+
+    desc 'milestones', 'Delete Milestones from a Plan of Action ffrom a system'
+    subcommand 'milestones', Milestones
+
+    desc 'artifacts', 'Delete system Artifacts'
+    subcommand 'artifacts', Artifacts
+  end
+end

data/lib/emasser/errors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Emasser
+  class Error < StandardError; end
+
+  class ConfigurationMissingError < Error
+    attr_reader :config
+
+    def initialize(config = 'an option', message = 'No configuration was provided for variable:')
+      @config = config
+      super("#{message} #{@config}")
+    end
+  end
+end