openscap_parser 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bbc310b2adc402a398f0b9e8524199a91c06e0b74c2f2757a9fdae292c645c5
-  data.tar.gz: 1d8314602c86e916aff3b19b09d88a858892635beaee738bd79177bf38434abb
+  metadata.gz: 159fcf26b6fe71666a9d057d89d772589ac8436d783b7773556121b6b5c11654
+  data.tar.gz: f8181135885961c284b2dabfd4de0408d8888e7cf4271da699f0e42fc0e30bf6
 SHA512:
-  metadata.gz: f2d316e18f0d82b9597b24b306dbae8615a044648102c085170005d1eaa9737263c11ec6a3c4e8af4e355cc59a9e57f78f560fe46f11c0e2cabfd134220153d7
-  data.tar.gz: 59f11993820161a4ece0d23df623ea3412cfb90d1895a5dd7a11fd1fa519e8eb3afbd0812c9a4a78ba1d254c74bcb58578f849ec773ace989ca91b07cffa4fab
+  metadata.gz: be89da681f6a355591027ce73b0dd3a68bcbd73bcc442a2d4e21c2a51485a9e841d493bafef8757aff5f85025e0a5251d3b1519801b2fdb1343fe070b165fe6b
+  data.tar.gz: 8949839744c203ec9074e3069097a3d98739eb65c7a76841c117f456eb02c55c3eee1576cf3b550501012b52f549d8aaaac0f601350d5f92e37a79e2a6602117

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/fix.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+require 'openscap_parser/xml_node'
+require 'openscap_parser/subs'
+
+module OpenscapParser
+  class Fix < XmlNode
+    include OpenscapParser::Subs
+
+    def id
+      @id ||= @parsed_xml['id']
+    end
+
+    def system
+      @system ||= @parsed_xml['system']
+    end
+
+    def complexity
+      @complexity ||= @parsed_xml['complexity']
+    end
+
+    def disruption
+      @disruption ||= @parsed_xml['disruption']
+    end
+
+    def strategy
+      @strategy ||= @parsed_xml['strategy']
+    end
+
+    def full_text(set_values)
+      full_text_lines(set_values).join('')
+    end
+
+    def full_text_lines(set_values)
+      map_child_nodes(set_values).map do |text_node|
+        text_node.respond_to?(:text) ? text_node.text : ''
+      end
+    end
+
+    def map_child_nodes(set_values = [])
+      map_sub_nodes @parsed_xml.children, set_values
+    end
+
+    def to_h
+      {
+        :id => id,
+        :system => system,
+        :complexity => complexity,
+        :disruption => disruption,
+        :strategy => strategy,
+        :text => text,
+        :subs => subs.map(&:to_h)
+      }
+    end
+  end
+end

data/lib/openscap_parser/fixes.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/fix'
+
+module OpenscapParser
+  module Fixes
+    def self.included(base)
+      base.class_eval do
+        def fixes
+          @fixes ||= fix_nodes.map do |fix_node|
+            OpenscapParser::Fix.new(parsed_xml: fix_node)
+          end
+        end
+
+        def fix_nodes(xpath = ".//fix")
+          xpath_nodes(xpath)
+        end
+      end
+    end
+  end
+end

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

@@ -24,13 +24,6 @@ module OpenscapParser
         @parsed_xml.xpath("select[@selected='true']/@idref").map(&:text)
     end
 
-    def set_values
-      @set_values ||= @parsed_xml.xpath("set-value") &&
-        @parsed_xml.xpath("set-value").map do |set_value|
-        [set_value['idref'], set_value.text]
-      end.to_h
-    end
-
     def to_h
       { :id => id, :title => title, :description => description }
     end

data/lib/openscap_parser/rule.rb

@@ -2,6 +2,7 @@
 
 require 'openscap_parser/rule_identifier'
 require 'openscap_parser/rule_references'
+require 'openscap_parser/fixes'
 require 'openscap_parser/xml_file'
 
 # Mimics openscap-ruby Rule interface
@@ -9,6 +10,7 @@ module OpenscapParser
   class Rule < XmlNode
     include OpenscapParser::Util
     include OpenscapParser::RuleReferences
+    include OpenscapParser::Fixes
 
     def id
       @id ||= parsed_xml['id']
@@ -27,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') &&
@@ -54,5 +70,33 @@ module OpenscapParser
     def identifier_node
       @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,
+        :parent_id => parent_id,
+        :parent_type => parent_type
+      }
+    end
   end
 end

data/lib/openscap_parser/rule_identifier.rb

@@ -10,5 +10,12 @@ module OpenscapParser
     def system
       @system ||= @parsed_xml && @parsed_xml['system']
     end
+
+    def to_h
+      {
+        :label => label,
+        :system => system
+      }
+    end
   end
 end

data/lib/openscap_parser/rule_result.rb

@@ -22,6 +22,16 @@ module OpenscapParser
       @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/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_file.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'openscap_parser/tailorings'
+
 module OpenscapParser
   # A class to represent a tailoring XmlFile
   class TailoringFile < XmlFile

data/lib/openscap_parser/test_result.rb

@@ -1,10 +1,12 @@
 # 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') &&

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.0"
+  VERSION = "1.1.0"
 end

data/lib/openscap_parser/xml_node.rb

@@ -19,6 +19,10 @@ module OpenscapParser
       @parsed_xml.remove_namespaces!
     end
 
+    def text
+      @parsed_xml.text
+    end
+
     def xpath_node(xpath)
       parsed_xml && parsed_xml.at_xpath(xpath)
     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

data/openscap_parser.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Parse OpenSCAP content}
   spec.description   = %q{This gem is a Ruby interface into SCAP content. It can parse SCAP datastream files (i.e. ssg-rhel7-ds.xml), scan result files output by oscap eval, and tailoring files.}
-  spec.homepage      = 'https://github.com/dLobatog/openscap_parser'
+  spec.homepage      = 'https://github.com/OpenSCAP/openscap_parser'
   spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openscap_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Lobato Garcia
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-15 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -149,6 +149,11 @@ files:
 - lib/openscap_parser/benchmark.rb
 - lib/openscap_parser/benchmarks.rb
 - 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/rule.rb
@@ -158,6 +163,11 @@ files:
 - lib/openscap_parser/rule_result.rb
 - lib/openscap_parser/rule_results.rb
 - lib/openscap_parser/rules.rb
+- lib/openscap_parser/selectors.rb
+- lib/openscap_parser/set_value.rb
+- lib/openscap_parser/set_values.rb
+- lib/openscap_parser/sub.rb
+- lib/openscap_parser/subs.rb
 - lib/openscap_parser/tailoring.rb
 - lib/openscap_parser/tailoring_file.rb
 - lib/openscap_parser/tailorings.rb
@@ -168,13 +178,16 @@ 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
 - lib/ssg/unarchiver.rb
 - lib/tasks/ssg.rake
 - openscap_parser.gemspec
-homepage: https://github.com/dLobatog/openscap_parser
+homepage: https://github.com/OpenSCAP/openscap_parser
 licenses:
 - MIT
 metadata: {}
@@ -193,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: Parse OpenSCAP content