openscap_parser 0.1.0 → 1.0.2

data/lib/openscap_parser/rule_identifier.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# RuleIdentifier interface as an object
+module OpenscapParser
+  class RuleIdentifier < XmlNode
+    def label
+      @label ||= @parsed_xml && @parsed_xml.text
+    end
+
+    def system
+      @system ||= @parsed_xml && @parsed_xml['system']
+    end
+
+    def to_h
+      {
+        :label => label,
+        :system => system
+      }
+    end
+  end
+end

data/lib/openscap_parser/rule_reference.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# RuleReference interface as an object
+module OpenscapParser
+  class RuleReference < XmlNode
+    def href
+      @href ||= @parsed_xml && @parsed_xml['href']
+    end
+
+    def label
+      @label ||= @parsed_xml && @parsed_xml.text
+    end
+  end
+end

data/lib/openscap_parser/rule_references.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/xml_file'
+require 'openscap_parser/rule_reference'
+
+module OpenscapParser
+  # Methods related to finding and saving rule references
+  module RuleReferences
+    def self.included(base)
+      base.class_eval do
+        def rule_reference_strings
+          @rule_reference_strings ||= rule_references.map do |rr|
+            "#{rr.label}#{rr.href}"
+          end
+        end
+
+        def rule_references
+          @rule_references ||= rule_reference_nodes.map do |node|
+            OpenscapParser::RuleReference.new(parsed_xml: node)
+          end.uniq do |reference|
+            [reference.label, reference.href]
+          end
+        end
+        alias :references :rule_references
+
+        def rule_reference_nodes(xpath = ".//Rule/reference")
+          xpath_nodes(xpath)
+        end
+      end
+    end
+  end
+end

data/lib/openscap_parser/rule_result.rb

@@ -1,8 +1,37 @@
 # frozen_string_literal: true
 
 module OpenscapParser
-  class RuleResult
-    attr_accessor :id, :result
+  class RuleResult < XmlNode
+    def id
+      @id ||= parsed_xml['idref']
+    end
+
+    def time
+      @time ||= parsed_xml['time']
+    end
+
+    def severity
+      @severity ||= parsed_xml['severity']
+    end
+
+    def weight
+      @weight ||= parsed_xml['weight']
+    end
+
+    def result
+      @result ||= parsed_xml.at_xpath('result') &&
+        parsed_xml.at_xpath('result').text || ''
+    end
+
+    def to_h
+      {
+        :id => id,
+        :time => time,
+        :severity => severity,
+        :weight => weight,
+        :result => result
+      }
+    end
   end
 end
 

data/lib/openscap_parser/rule_results.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/rule_result'
+
+module OpenscapParser
+  module RuleResults
+    def self.included(base)
+      base.class_eval do
+        def rule_result_nodes
+          @rule_result_nodes ||= parsed_xml.xpath('rule-result')
+        end
+
+        def rule_results
+          rule_result_nodes.map do |node|
+            RuleResult.new(parsed_xml: node)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openscap_parser/rules.rb

@@ -1,21 +1,22 @@
 # frozen_string_literal: true
 
+require 'openscap_parser/rule'
+
 module OpenscapParser
   # Methods related to parsing rules
   module Rules
     def self.included(base)
       base.class_eval do
-        def rule_ids
-          test_result_node.xpath('.//xmlns:rule-result/@idref').map(&:value)
-        end
-
         def rule_objects
-          return @rule_objects unless @rule_objects.nil?
-
-          @rule_objects ||= @report_xml.search('Rule').map do |rule|
-            Rule.new(rule_xml: rule)
+          @rule_objects ||= rule_nodes.map do |rule_node|
+            Rule.new(parsed_xml: rule_node)
           end
         end
+        alias :rules :rule_objects
+
+        def rule_nodes(xpath = ".//Rule")
+          xpath_nodes(xpath)
+        end
       end
     end
   end

data/lib/openscap_parser/selectors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/set_values'
+
+module OpenscapParser
+  module Selectors
+    include OpenscapParser::SetValues
+  end
+end

data/lib/openscap_parser/set_value.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'openscap_parser/xml_node'
+
+module OpenscapParser
+  class SetValue < XmlNode
+    def id
+      @id ||= @parsed_xml['idref']
+    end
+
+    def text
+      @text ||= @parsed_xml.text
+    end
+
+    def to_h
+      { :id => id, :text => text }
+    end
+  end
+end

data/lib/openscap_parser/set_values.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/set_value'
+
+module OpenscapParser
+  module SetValues
+    def self.included(base)
+      base.class_eval do
+        def set_values
+          @set_values ||= set_value_nodes.map do |set_value_node|
+            OpenscapParser::SetValue.new(parsed_xml: set_value_node)
+          end
+        end
+
+        def set_value_nodes(xpath = ".//set-value")
+          xpath_nodes(xpath)
+        end
+      end
+    end
+  end
+end

data/lib/openscap_parser/sub.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'openscap_parser/xml_node'
+
+module OpenscapParser
+  class Sub < XmlNode
+    def id
+      @id ||= @parsed_xml['idref']
+    end
+
+    def use
+      @use ||= @parsed_xml['use']
+    end
+
+    def to_h
+      { :id => id, :text => text, :use => use }
+    end
+  end
+end

data/lib/openscap_parser/subs.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/sub'
+
+module OpenscapParser
+  module Subs
+    def self.included(base)
+      base.class_eval do
+        def subs
+          return [] unless sub_nodes
+          @subs ||= sub_nodes.map do |xml|
+            Sub.new(parsed_xml: xml)
+          end
+        end
+
+        def sub_nodes(xpath = './/sub')
+          @sub_nodes ||= xpath_nodes(xpath)
+        end
+
+        def map_sub_nodes(children, set_values)
+          children.map do |child|
+            next child if child.name == 'text'
+            next replace_sub(Sub.new(parsed_xml: child), set_values) if child.name == 'sub'
+            child
+          end
+        end
+
+        private
+
+        def replace_sub(sub, set_values)
+          set_value = set_values.find { |set_value| set_value.id == sub.id }
+          return unless set_value
+          set_value.parsed_xml.children.first
+        end
+      end
+    end
+  end
+end

data/lib/openscap_parser/tailoring.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Mimics openscap-ruby Rule interface
+module OpenscapParser
+  class Tailoring < XmlNode
+    include OpenscapParser::Profiles
+
+    def id
+      @id ||= @parsed_xml['id']
+    end
+
+    def benchmark
+      @benchmark ||= @parsed_xml.at_xpath('benchmark/@href') &&
+        @parsed_xml.at_xpath('benchmark/@href').text
+    end
+
+    def version
+      @version ||= @parsed_xml.at_xpath('version') &&
+        @parsed_xml.at_xpath('version').text
+    end
+
+    def version_time
+      @version_time ||= @parsed_xml.at_xpath('version/@time') &&
+        @parsed_xml.at_xpath('version/@time').text
+    end
+  end
+end

data/lib/openscap_parser/tailoring_file.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/tailorings'
+
+module OpenscapParser
+  # A class to represent a tailoring XmlFile
+  class TailoringFile < XmlFile
+    include OpenscapParser::Tailorings
+
+    def valid?
+      return true if @parsed_xml.root.name == 'Tailoring' && namespaces.keys.include?('xmlns:xccdf')
+      false
+    end
+  end
+end

data/lib/openscap_parser/tailorings.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/tailoring'
+
+module OpenscapParser
+  # Methods related to parsing Xccdf Tailoring types
+  module Tailorings
+    def self.included(base)
+      base.class_eval do
+        def tailoring
+          @tailoring ||= OpenscapParser::Tailoring.new(
+            parsed_xml: tailoring_node
+          )
+        end
+
+        def tailoring_node(xpath = ".//Tailoring")
+          xpath_node(xpath)
+        end
+      end
+    end
+  end
+end

data/lib/openscap_parser/test_result.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/rule_results'
+require 'openscap_parser/selectors'
+
+module OpenscapParser
+  class TestResult < XmlNode
+    include OpenscapParser::RuleResults
+    include OpenscapParser::Selectors
+
+    def target
+      @target ||= parsed_xml.at_xpath('target') &&
+        parsed_xml.at_xpath('target').text || ''
+    end
+    alias :host :target
+
+    def target_fact_nodes
+      @target_fact_nodes ||= parsed_xml.xpath('target-facts/fact')
+    end
+
+    def platform_nodes
+      @platform_nodes ||= parsed_xml.xpath('platform')
+    end
+
+    def title
+      @title ||= parsed_xml.at_xpath('title') &&
+        parsed_xml.at_xpath('title').text || ''
+    end
+
+    def identity
+      @identity ||= parsed_xml.at_xpath('identity') &&
+        parsed_xml.at_xpath('identity').text || ''
+    end
+
+    def profile_id
+      @profile_id ||= parsed_xml.at_xpath('profile') &&
+        parsed_xml.at_xpath('profile')['idref'] || ''
+    end
+
+    def benchmark_id
+      @benchmark_id ||= parsed_xml.at_xpath('benchmark') &&
+        parsed_xml.at_xpath('benchmark')['id'] || ''
+    end
+
+    def set_value_nodes
+      @set_value_nodes ||= parsed_xml.xpath('set-value')
+    end
+
+    def score
+      @score ||= parsed_xml.at_xpath('score') &&
+        parsed_xml.at_xpath('score').text.to_f
+    end
+
+    def start_time
+      @start_time ||= DateTime.parse(parsed_xml['start-time'])
+    end
+
+    def end_time
+      @end_time ||= DateTime.parse(parsed_xml['end-time'])
+    end
+  end
+end

data/lib/openscap_parser/test_result_file.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'openscap_parser/xml_file'
+require 'openscap_parser/benchmarks'
+require 'openscap_parser/test_results'
+
+module OpenscapParser
+  # A class to represent an XmlFile which contains a <TestResult /> Xccdf type
+  class TestResultFile < XmlFile
+    include ::OpenscapParser::Benchmarks
+    include ::OpenscapParser::TestResults
+  end
+end

data/lib/openscap_parser/test_results.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/test_result'
+
+module OpenscapParser
+  module TestResults
+    def self.included(base)
+      base.class_eval do
+        def test_result
+          TestResult.new(parsed_xml: test_result_node)
+        end
+
+        def test_result_node
+          @test_result_node ||= xpath_node('.//TestResult')
+        end
+      end
+    end
+  end
+end

data/lib/openscap_parser/util.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Utility functions for OpenscapParser
+module OpenscapParser
+  module Util
+    def newline_to_whitespace(string)
+      string.gsub(/ *\n+/, " ").strip
+    end
+  end
+end