openscap_parser 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec101e20e8153fa638aa705ab0bfdcf48624a8c70e74670727454f3811adc175
-  data.tar.gz: 0b2fe6ab34ff284a586709cc6d4a91054d54e4f41749b1fdecffd8af3cc6a37e
+  metadata.gz: c5c95f01a6f86db68b3d0561858c9d39af294872d3d0e6689f0bc6d37d39e660
+  data.tar.gz: c14ce4fb133683267862decac1f6db27e84f8f504026b135a04e642d849bad52
 SHA512:
-  metadata.gz: b4dc7ff782e6d0b2dc61c066462291b039f649d70fc56adef4507c99d55e90626adc839c1ac23352e39b2401011f5e7196e8b63a066d1402b3754b2fee6d94e0
-  data.tar.gz: 0b9141c770ba031dadb3a720e80d61ef3077895c6d6356db39ee1be5b92338b13cf935e1e7a3f83cf4c77abb05a725cb34cef7d6e0fb0c5288ce8f66a45cd7d9
+  metadata.gz: 59ed3d7a867fe0b5b230943068be977ce2d4aadc5edc0df79df5b4ce2e7c817420a3251569c70155a7f4c9626d5c0b2f51e35883770f0aeb848b23d3e345adab
+  data.tar.gz: b0d13aabf1dd555a7a376ea74a7092815c91e591f5cb40457ff06ac6f195e379246d31a7a1a0d5bd650c087bf654d26de6ef2cf6002d2a3163ca51626f863221

data/lib/openscap_parser/benchmark.rb

@@ -5,6 +5,7 @@ require 'openscap_parser/xml_file'
 require 'openscap_parser/rules'
 require 'openscap_parser/profiles'
 require 'openscap_parser/rule_references'
+require 'openscap_parser/groups'
 
 # Mimics openscap-ruby Benchmark interface
 module OpenscapParser
@@ -13,6 +14,7 @@ module OpenscapParser
     include OpenscapParser::Rules
     include OpenscapParser::RuleReferences
     include OpenscapParser::Profiles
+    include OpenscapParser::Groups
 
     def id
       @id ||= @parsed_xml['id']

data/lib/openscap_parser/group.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+module OpenscapParser
+  class Group < XmlNode
+    include OpenscapParser::Util
+
+    def id
+      @id ||= parsed_xml['id']
+    end
+
+    def title
+      @title ||= parsed_xml.at_css('title') &&
+        parsed_xml.at_css('title').text
+    end
+
+    def description
+      @description ||= newline_to_whitespace(
+        parsed_xml.at_css('description') &&
+          parsed_xml.at_css('description').text || ''
+      )
+    end
+
+    def rationale
+      @rationale ||= newline_to_whitespace(
+        parsed_xml.at_css('rationale') &&
+          parsed_xml.at_css('rationale').text || ''
+      )
+    end
+
+    def requires
+      @requires ||= parsed_xml.xpath('./requires') &&
+        parsed_xml.xpath('./requires/@idref').flat_map do |r|
+          r.to_s&.split
+        end
+    end
+
+    def conflicts
+      @conflicts ||= parsed_xml.xpath('./conflicts') &&
+        parsed_xml.xpath('./conflicts/@idref').flat_map do |c|
+          c.to_s&.split
+        end
+    end
+
+    def selected
+      @selected ||= parsed_xml['selected']
+    end
+
+    def parent_id
+      @parent_id = parsed_xml.xpath('../@id').to_s
+    end
+
+    def parent_type
+      if parsed_xml.xpath("name(..)='Group'")
+        @parent_type = 'Group'
+      else
+        @parent_type = 'Benchmark'
+      end
+    end
+
+    def to_h
+      {
+        :id => id,
+        :title => title,
+        :description => description,
+        :requires => requires,
+        :conflicts => conflicts,
+        :rationale => rationale,
+        :selected => selected,
+        :parent_id => parent_id,
+        :parent_type => parent_type
+      }
+    end
+  end
+end

data/lib/openscap_parser/groups.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/group'
+
+module OpenscapParser
+  # Methods related to finding and saving rule references
+  module Groups
+    def self.included(base)
+      base.class_eval do
+        def groups
+          @groups ||= group_nodes.map do |group_node|
+            OpenscapParser::Group.new(parsed_xml: group_node)
+          end
+        end
+
+        def group_nodes(xpath = './/Group')
+          xpath_nodes(xpath)
+        end
+      end
+    end
+  end
+end

data/lib/openscap_parser/oval_report.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'openscap_parser/xml_file'
+require 'oval/definition_result'
+require 'oval/definition'
+
+module OpenscapParser
+  class OvalReport < XmlFile
+    def definition_results
+      @definition_results ||= definition_result_nodes.map { |node| ::Oval::DefinitionResult.new parsed_xml: node }
+    end
+
+    def definition_result_nodes(xpath = "./oval_results/results/system/definitions/definition")
+      xpath_nodes(xpath)
+    end
+
+    def definitions
+      @definitions ||= definition_nodes.map { |node| Oval::Definition.new parsed_xml: node }
+    end
+
+    def definition_nodes(xpath = "./oval_results/oval_definitions/definitions/definition")
+      xpath_nodes(xpath)
+    end
+  end
+end

data/lib/openscap_parser/profile.rb

@@ -1,3 +1,5 @@
+require 'openscap_parser/regex_handler'
+
 module OpenscapParser
   class Profile < XmlNode
     def id
@@ -20,7 +22,27 @@ module OpenscapParser
     end
 
     def selected_rule_ids
-      @selected_rule_ids ||= @parsed_xml.xpath("select[@selected='true']/@idref") &&
+      # Look for selected rule ids where the idref contains '_rule_' that is not preceded by 'group'
+      @selected_rule_ids ||= @parsed_xml.xpath("select[@selected='true']
+                                                      [regex(@idref, '^((?!_group_).)*?(_rule_).*$')]
+                                                      /@idref", RegexHandler) &&
+                             @parsed_xml.xpath("select[@selected='true']
+                                                      [regex(@idref, '^((?!_group_).)*?(_rule_).*$')]
+                                                      /@idref", RegexHandler).map(&:text)
+    end
+
+    def selected_group_ids
+      # Look for selected group ids where the idref contains '_group_' that is not preceded by 'rule'
+      @selected_group_ids ||= @parsed_xml.xpath("select[@selected='true']
+                                                       [regex(@idref, '^((?!_rule_).)*?(_group_).*$')]
+                                                       /@idref", RegexHandler) &&
+                              @parsed_xml.xpath("select[@selected='true']
+                                                       [regex(@idref, '^((?!_rule_).)*?(_group_).*$')]
+                                                       /@idref", RegexHandler).map(&:text)
+    end
+
+    def selected_entity_ids
+      @selected_entity_ids ||= @parsed_xml.xpath("select[@selected='true']/@idref") &&
         @parsed_xml.xpath("select[@selected='true']/@idref").map(&:text)
     end
 

data/lib/openscap_parser/regex_handler.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module OpenscapParser
+  class RegexHandler < XmlNode
+    def self.regex node_set, regex
+      node_set.find_all { |node| node.to_s =~ /#{regex}/ }
+    end
+  end
+end

data/lib/openscap_parser/rule.rb

@@ -29,6 +29,20 @@ module OpenscapParser
         parsed_xml.at_css('title').text
     end
 
+    def requires
+      @requires ||= parsed_xml.xpath('./requires') &&
+        parsed_xml.xpath('./requires/@idref').flat_map do |r|
+          r.to_s&.split
+        end
+    end
+
+    def conflicts
+      @conflicts ||= parsed_xml.xpath('./conflicts') &&
+        parsed_xml.xpath('./conflicts/@idref').flat_map do |c|
+          c.to_s&.split
+        end
+    end
+
     def description
       @description ||= newline_to_whitespace(
         parsed_xml.at_css('description') &&
@@ -57,15 +71,31 @@ module OpenscapParser
       @identifier_node ||= parsed_xml.at_xpath('ident')
     end
 
+    def parent_id
+      parsed_xml.xpath('../@id').to_s
+    end
+
+    def parent_type
+      if parsed_xml.xpath("name(..)='Group'")
+        @parent_type = 'Group'
+      else
+        @parent_type = 'Benchmark'
+      end
+    end
+
     def to_h
       {
         :id => id,
         :selected => selected,
         :severity => severity,
         :title => title,
+        :requires => requires,
+        :conflicts => conflicts,
         :description => description,
         :rationale => rationale,
-        :identifier => rule_identifier.to_h
+        :identifier => rule_identifier.to_h,
+        :parent_id => parent_id,
+        :parent_type => parent_type
       }
     end
   end

data/lib/openscap_parser/test_result_file.rb

@@ -1,4 +1,7 @@
 # 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

data/lib/openscap_parser/version.rb

@@ -1,3 +1,3 @@
 module OpenscapParser
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

data/lib/openscap_parser.rb

@@ -6,6 +6,7 @@ require 'openscap_parser/benchmarks'
 require 'openscap_parser/test_results'
 require 'openscap_parser/profiles'
 require 'openscap_parser/rules'
+require 'openscap_parser/groups'
 require 'openscap_parser/rule_results'
 require 'openscap_parser/tailorings'
 
@@ -13,6 +14,7 @@ require 'openscap_parser/xml_file'
 require 'openscap_parser/datastream_file'
 require 'openscap_parser/test_result_file'
 require 'openscap_parser/tailoring_file'
+require 'openscap_parser/oval_report'
 
 require 'date'
 require 'railtie' if defined?(Rails)

data/lib/oval/definition.rb

@@ -0,0 +1,47 @@
+require "openscap_parser/xml_node"
+require "oval/reference"
+
+module Oval
+  class Definition < ::OpenscapParser::XmlNode
+    def id
+      @id ||= @parsed_xml['id']
+    end
+
+    def version
+      @version ||= @parsed_xml['version']
+    end
+
+    def klass
+      @klass ||= @parsed_xml['class']
+    end
+
+    def title
+      xml = @parsed_xml.at_xpath("./metadata/title")
+      @title ||= xml && xml.text
+    end
+
+    def description
+      xml = @parsed_xml.at_xpath("./metadata/description")
+      @description ||= xml && xml.text
+    end
+
+    def reference_nodes
+      @reference_nodes ||= @parsed_xml.xpath("./metadata/reference")
+    end
+
+    def references
+      @references ||= reference_nodes.map { |node| Reference.new parsed_xml: node }
+    end
+
+    def to_h
+      {
+        :id => id,
+        :version => version,
+        :klass => klass,
+        :title => title,
+        :description => description,
+        :references => references.map(&:to_h)
+      }
+    end
+  end
+end

data/lib/oval/definition_result.rb

@@ -0,0 +1,17 @@
+require 'openscap_parser/xml_node'
+
+module Oval
+  class DefinitionResult < ::OpenscapParser::XmlNode
+    def definition_id
+      @definition_id ||= @parsed_xml['definition_id']
+    end
+
+    def result
+      @result ||= @parsed_xml['result']
+    end
+
+    def to_h
+      { :id => definition_id, :result => result }
+    end
+  end
+end

data/lib/oval/reference.rb

@@ -0,0 +1,21 @@
+require "openscap_parser/xml_node"
+
+module Oval
+  class Reference < ::OpenscapParser::XmlNode
+    def source
+      @source ||= @parsed_xml['source']
+    end
+
+    def ref_id
+      @ref_id ||= @parsed_xml['ref_id']
+    end
+
+    def ref_url
+      @ref_url ||= @parsed_xml['ref_url']
+    end
+
+    def to_h
+      { :source => source, :ref_id => ref_id, :ref_url => ref_url }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openscap_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Daniel Lobato Garcia
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -151,8 +151,12 @@ files:
 - lib/openscap_parser/datastream_file.rb
 - lib/openscap_parser/fix.rb
 - lib/openscap_parser/fixes.rb
+- lib/openscap_parser/group.rb
+- lib/openscap_parser/groups.rb
+- lib/openscap_parser/oval_report.rb
 - lib/openscap_parser/profile.rb
 - lib/openscap_parser/profiles.rb
+- lib/openscap_parser/regex_handler.rb
 - lib/openscap_parser/rule.rb
 - lib/openscap_parser/rule_identifier.rb
 - lib/openscap_parser/rule_reference.rb
@@ -175,6 +179,9 @@ files:
 - lib/openscap_parser/version.rb
 - lib/openscap_parser/xml_file.rb
 - lib/openscap_parser/xml_node.rb
+- lib/oval/definition.rb
+- lib/oval/definition_result.rb
+- lib/oval/reference.rb
 - lib/railtie.rb
 - lib/ssg.rb
 - lib/ssg/downloader.rb
@@ -200,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: Parse OpenSCAP content