abide_dev_utils 0.1.0

data/lib/abide_dev_utils/utils/general.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AbideDevUtils
+  module Utils
+    def self.deep_copy(hash_obj)
+      Marshal.load(Marshal.dump(hash_obj))
+    end
+  end
+end

data/lib/abide_dev_utils/validate.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/errors'
+
+module AbideDevUtils
+  module Validate
+    def self.filesystem_path(path)
+      raise AbideDevUtils::Errors::FileNotFoundError, path unless File.exist?(path)
+    end
+
+    def self.file(path)
+      filesystem_path(path)
+      raise AbideDevUtils::Errors::PathNotFileError, path unless File.file?(path)
+    end
+
+    def self.directory(path)
+      filesystem_path(path)
+      raise AbideDevUtils::Errors::PathNotDirectoryError, path unless File.directory?(path)
+    end
+
+    def self.not_empty(thing, msg)
+      raise AbideDevUtils::Errors::ObjectEmptyError, msg if thing.empty?
+    end
+
+    def self.hashable(obj)
+      return if obj.respond_to?(:to_hash) || obj.respond_to?(:to_h)
+
+      raise AbideDevUtils::Errors::NotHashableError, obj
+    end
+  end
+end

data/lib/abide_dev_utils/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AbideDevUtils
+  VERSION = "0.1.0"
+end

data/lib/abide_dev_utils/xccdf.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/output'
+require 'abide_dev_utils/validate'
+require 'abide_dev_utils/xccdf/cis'
+
+module AbideDevUtils
+  module XCCDF
+    def self.parse(xccdf_file)
+      AbideDevUtils::Validate.file(xccdf_file)
+      Nokogiri.XML(File.open(xccdf_file))
+    end
+
+    def self.to_hiera(xccdf_file, opts = {})
+      type = opts.fetch(:type, 'cis')
+      case type.downcase
+      when 'cis'
+        AbideDevUtils::XCCDF::CIS::Hiera.new(xccdf_file, parent_key_prefix: opts[:parent_key_prefix])
+      else
+        AbideDevUtils::Output.simple("XCCDF type #{type} is unsupported!")
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/xccdf/cis.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/xccdf/cis/hiera'

data/lib/abide_dev_utils/xccdf/cis/hiera.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'nokogiri'
+require 'abide_dev_utils/errors'
+
+module AbideDevUtils
+  module XCCDF
+    module CIS
+      # Creates a Hiera structure by parsing a CIS XCCDF benchmark
+      # @!attribute [r] title
+      # @!attribute [r] version
+      # @!attribute [r] yaml_title
+      class Hiera
+        CONTROL_PREFIX = /^[\d.]+_/.freeze
+        XPATHS = {
+          benchmark: {
+            all: 'xccdf:Benchmark',
+            title: 'xccdf:Benchmark/xccdf:title',
+            version: 'xccdf:Benchmark/xccdf:version'
+          },
+          profiles: {
+            all: 'xccdf:Benchmark/xccdf:Profile',
+            relative_title: './xccdf:title',
+            relative_select: './xccdf:select'
+          }
+        }.freeze
+
+        attr_reader :title, :version
+
+        # Creates a new Hiera object
+        # @param xccdf_file [String] path to an XCCDF file
+        # @param parent_key_prefix [String] a string to be prepended to the
+        #   top-level key in the Hiera structure. Useful for namespacing
+        #   the top-level key.
+        def initialize(xccdf_file, parent_key_prefix: nil)
+          @doc = parse(xccdf_file)
+          @title = xpath(XPATHS[:benchmark][:title]).children.to_s
+          @version = xpath(XPATHS[:benchmark][:version]).children.to_s
+          @profiles = xpath(XPATHS[:profiles][:all])
+          @parent_key = make_parent_key(@doc, parent_key_prefix)
+          @hash = make_hash(@doc, @parent_key)
+        end
+
+        def yaml_title
+          normalize_str(@title)
+        end
+
+        # Convert the Hiera object to a hash
+        # @return [Hash]
+        def to_h
+          @hash
+        end
+
+        # Convert the Hiera object to a string
+        # @return [String]
+        def to_s
+          @hash.inspect
+        end
+
+        # Convert the Hiera object to YAML string
+        # @return [String] YAML-formatted string
+        def to_yaml
+          yh = @hash[@parent_key.to_sym].transform_keys do |k|
+            "#{@parent_key}::#{k}"
+          end
+          yh.to_yaml
+        end
+
+        # If a method gets called on the Hiera object which is not defined,
+        # this sends that method call to hash, then doc, then super.
+        def method_missing(method, *args, &block)
+          return true if ['exist?', 'exists?'].include?(method.to_s)
+
+          return @hash.send(method, *args, &block) if @hash.respond_to?(method)
+
+          return @doc.send(method, *args, &block) if @doc.respond_to?(method)
+
+          super(method, *args, &block)
+        end
+
+        # Checks the respond_to? of hash, doc, or super
+        def respond_to_missing?(method_name, include_private = false)
+          return true if ['exist?', 'exists?'].include?(method_name.to_s)
+
+          @hash || @doc || super
+        end
+
+        private
+
+        attr_accessor :doc, :parent_key, :hash, :profiles
+
+        def parse(xccdf_file)
+          raise AbideDevUtils::Errors::FileNotFoundError, xccdf_file unless File.file?(xccdf_file)
+
+          Nokogiri.XML(File.open(xccdf_file))
+        end
+
+        def make_hash(doc, parent_key)
+          hash = { parent_key.to_sym => { title: @title, version: @version } }
+          profiles = doc.xpath('xccdf:Benchmark/xccdf:Profile')
+          profiles.each do |p|
+            title = normalize_profile_name(p.xpath('./xccdf:title').children.to_s)
+            hash[parent_key.to_sym][title.to_sym] = []
+            selects = p.xpath('./xccdf:select')
+            selects.each do |s|
+              hash[parent_key.to_sym][title.to_sym] << normalize_ctrl_name(s['idref'].to_s)
+            end
+          end
+          hash
+        end
+
+        def normalize_str(str)
+          str.delete('-').gsub(/\s/, '_').downcase
+        end
+
+        def normalize_profile_name(prof)
+          normalize_str("profile_#{prof}")
+        end
+
+        def normalize_ctrl_name(ctrl)
+          new_ctrl = ctrl.split('_rule_')[-1].gsub(CONTROL_PREFIX, '')
+          normalize_str(new_ctrl.gsub(/\./, '_'))
+        end
+
+        def make_parent_key(doc, prefix)
+          doc_title = normalize_str(doc.xpath(XPATHS[:benchmark][:title]).children.to_s)
+          if prefix.nil?
+            doc_title
+          else
+            sepped_prefix = prefix.end_with?('::') ? prefix : "#{prefix}::"
+            "#{sepped_prefix.chomp}#{doc_title}"
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,266 @@
+--- !ruby/object:Gem::Specification
+name: abide_dev_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Heston Snodgrass
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: cmdparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.19'
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fast_gettext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Provides a CLI with helpful utilities for developing Abide
+email:
+- hsnodgrass3@gmail.com
+executables:
+- abide
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- abide_dev_utils.gemspec
+- bin/abide.rb
+- bin/console
+- bin/setup
+- exe/abide
+- lib/abide_dev_utils.rb
+- lib/abide_dev_utils/cli.rb
+- lib/abide_dev_utils/cli/jira.rb
+- lib/abide_dev_utils/cli/puppet.rb
+- lib/abide_dev_utils/cli/test.rb
+- lib/abide_dev_utils/cli/xccdf.rb
+- lib/abide_dev_utils/config.rb
+- lib/abide_dev_utils/constants.rb
+- lib/abide_dev_utils/errors.rb
+- lib/abide_dev_utils/errors/base.rb
+- lib/abide_dev_utils/errors/general.rb
+- lib/abide_dev_utils/errors/jira.rb
+- lib/abide_dev_utils/errors/xccdf.rb
+- lib/abide_dev_utils/files.rb
+- lib/abide_dev_utils/jira.rb
+- lib/abide_dev_utils/output.rb
+- lib/abide_dev_utils/ppt.rb
+- lib/abide_dev_utils/prompt.rb
+- lib/abide_dev_utils/utils/general.rb
+- lib/abide_dev_utils/validate.rb
+- lib/abide_dev_utils/version.rb
+- lib/abide_dev_utils/xccdf.rb
+- lib/abide_dev_utils/xccdf/cis.rb
+- lib/abide_dev_utils/xccdf/cis/hiera.rb
+homepage: https://github.com/hsnodgrass/abide_dev_utils
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hsnodgrass/abide_dev_utils
+  source_code_uri: https://github.com/hsnodgrass/abide_dev_utils
+  changelog_uri: https://github.com/hsnodgrass/abide_dev_utils
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Helper utilities for developing Abide
+test_files: []