openscap 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31f300d3cdcf9b72dcc0e552f4ce9c6113d54b1f9b5316441bff1133a09106ed
-  data.tar.gz: fdcb823bf21e22ed25cdd77f0bf534227db14af84f0f7383d7f74c65cf690932
+  metadata.gz: 9c8eddf3fa5a4c04f1655827ba4f4b8422f32f314a20f888b36c5ef85e2e04cf
+  data.tar.gz: 3e9d497efc4543111a4fee03d8db323c85b96360e31e23cd9ebc4387ec354d17
 SHA512:
-  metadata.gz: a21ae53d6e42bd055058423e54615780483bec7f8c0514a55dfa953ef6e37d88256c0404135a432e964339a9e26fb0a79ba9963e51ffd0317ba28428d7a70c5a
-  data.tar.gz: 790d230ca7fc2b54f9188f5362851d428152000d84d30f935222a323a8276838b491c640a81708f11b592d0c48dfa759f90718d7b80ae1201c9a4344b37513e4
+  metadata.gz: 601b6ee58372cd9f943918611c5f10df28cf1245d1149547d2889531e4b623b3787fb70cc06c1b4a17d4fca7e4202dd27dcacc7a69eba5c99d156fcc7e2529f3
+  data.tar.gz: 3a47312203579d8735b19032cfe427f76ede2467bbfb63b806dbd47edd79a8442ebd40fc61062fb4ece7b51742c38350e73c69d8677aafed5a5d8aef0d473db2

data/lib/openscap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenSCAP
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/lib/openscap/xccdf/benchmark.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require 'openscap/source'
-require 'openscap/xccdf/profile'
-require 'openscap/xccdf/item'
-require 'openscap/xccdf/item_common'
-require 'openscap/xccdf/value'
-require 'openscap/xccdf/status'
+require_relative 'profile'
+require_relative 'item'
+require_relative 'item_common'
+require_relative 'value'
+require_relative 'status'
 
 module OpenSCAP
   module Xccdf
@@ -13,7 +13,7 @@ module OpenSCAP
       include ItemCommon
       attr_reader :raw
 
-      def initialize(p)
+      def initialize p
         case p
         when OpenSCAP::Source
           @raw = OpenSCAP.xccdf_benchmark_import_source p.raw
@@ -35,7 +35,7 @@ module OpenSCAP
       end
 
       def status_current
-        Status.new OpenSCAP.xccdf_benchmark_get_status_current(raw)
+        Status.new OpenSCAP.xccdf_benchmark_get_status_current(@raw)
       end
 
       def profiles
@@ -65,12 +65,12 @@ module OpenSCAP
       end
 
       def policy_model
-        @policy_model ||= PolicyModel.new(self)
+        @policy_model ||= PolicyModel.new self
       end
 
       def schema_version
-        pointer = OpenSCAP.xccdf_benchmark_get_schema_version(@raw)
-        OpenSCAP.xccdf_version_info_get_version(pointer)
+        pointer = OpenSCAP.xccdf_benchmark_get_schema_version @raw
+        OpenSCAP.xccdf_version_info_get_version pointer
       end
 
       def destroy

data/lib/openscap/xccdf/fix.rb

@@ -3,37 +3,30 @@
 module OpenSCAP
   module Xccdf
     class Fix
-      def initialize(raw)
-        raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} with '#{raw}'" \
-          unless raw.is_a?(FFI::Pointer)
+      def initialize raw
+        raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} with '#{raw}'" unless raw.is_a? FFI::Pointer
 
         @raw = raw
       end
 
       def id
-        OpenSCAP.xccdf_fix_get_id(@raw)
+        OpenSCAP.xccdf_fix_get_id @raw
       end
 
       def platform
-        OpenSCAP.xccdf_fix_get_platform(@raw)
+        OpenSCAP.xccdf_fix_get_platform @raw
       end
 
-      # system is a reserved word in Rails, so didn't use it
       def fix_system
-        OpenSCAP.xccdf_fix_get_system(@raw)
+        OpenSCAP.xccdf_fix_get_system @raw
       end
 
       def content
-        OpenSCAP.xccdf_fix_get_content(@raw)
+        OpenSCAP.xccdf_fix_get_content @raw
       end
 
       def to_hash
-        {
-          id:,
-          platform:,
-          system: fix_system,
-          content:
-        }
+        { id:, platform:, system: fix_system, content: }
       end
     end
   end

data/lib/openscap/xccdf/fixtext.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module OpenSCAP
+  module Xccdf
+    class Fixtext
+      def initialize(raw)
+        raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} with '#{raw}'" unless raw.is_a?(FFI::Pointer)
+
+        @raw = raw
+      end
+
+      def text
+        Text.new(OpenSCAP.xccdf_fixtext_get_text(@raw)).text
+      end
+    end
+  end
+
+  attach_function :xccdf_fixtext_get_text, [:pointer], :pointer
+end

data/lib/openscap/xccdf/group.rb

@@ -2,7 +2,7 @@
 
 require 'openscap/exceptions'
 require 'openscap/xccdf'
-require 'openscap/xccdf/item'
+require_relative 'item'
 
 module OpenSCAP
   module Xccdf
@@ -20,18 +20,12 @@ module OpenSCAP
       end
 
       def sub_items
-        @sub_items ||= sub_items_init
-      end
-
-      private
-
-      def sub_items_init
-        collect = {}
-        each_child do |item|
-          collect.merge! item.sub_items
-          collect[item.id] = item
+        @sub_items ||= {}.tap do |sub_items|
+          each_child do |item|
+            sub_items.merge! item.sub_items
+            sub_items[item.id] = item
+          end
         end
-        collect
       end
     end
   end

data/lib/openscap/xccdf/ident.rb

@@ -3,20 +3,14 @@
 module OpenSCAP
   module Xccdf
     class Ident
-      def initialize(raw)
-        raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} with '#{raw}'" \
-          unless raw.is_a?(FFI::Pointer)
+      def initialize raw
+        raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} with '#{raw}'" unless raw.is_a?(FFI::Pointer)
 
         @raw = raw
       end
 
-      def system
-        OpenSCAP.xccdf_ident_get_system(@raw)
-      end
-
-      def id
-        OpenSCAP.xccdf_ident_get_id(@raw)
-      end
+      def system = OpenSCAP.xccdf_ident_get_system @raw
+      def id = OpenSCAP.xccdf_ident_get_id @raw
     end
   end
   attach_function :xccdf_ident_get_system, [:pointer], :string

data/lib/openscap/xccdf/item.rb

@@ -2,16 +2,16 @@
 
 require 'openscap/exceptions'
 require 'openscap/text'
-require 'openscap/xccdf/item_common'
-require 'openscap/xccdf/group'
-require 'openscap/xccdf/rule'
+require_relative 'item_common'
+require_relative 'group'
+require_relative 'rule'
 
 module OpenSCAP
   module Xccdf
     class Item
       include ItemCommon # reflects OpenSCAP's struct xccdf_item (thus operates with Benchmark, Profile, Group, Rule, and Value)
 
-      def self.build(t)
+      def self.build t
         raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} with #{t}" \
           unless t.is_a?(FFI::Pointer)
 
@@ -26,13 +26,13 @@ module OpenSCAP
         end
       end
 
-      def initialize(t)
+      def initialize t
         raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} abstract base class." if instance_of?(OpenSCAP::Xccdf::Item)
 
         @raw = t
       end
 
-      def rationale(prefered_lang = nil, markup: false)
+      def rationale prefered_lang = nil, markup: false
         TextList.extract(OpenSCAP.xccdf_item_get_rationale(@raw), lang: prefered_lang, markup:)
       end
 

data/lib/openscap/xccdf/item_common.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'openscap/text'
-require 'openscap/xccdf/reference'
+require_relative 'reference'
 
 module OpenSCAP
   module Xccdf

data/lib/openscap/xccdf/policy.rb

@@ -12,21 +12,20 @@ module OpenSCAP
         when FFI::Pointer
           @raw = p
         else
-          raise OpenSCAP::OpenSCAPError,
-                "Cannot initialize OpenSCAP::Xccdf::Policy with '#{p}'"
+          raise OpenSCAP::OpenSCAPError, "Cannot initialize OpenSCAP::Xccdf::Policy with '#{p}'"
         end
         OpenSCAP.raise! if @raw.null?
       end
 
       def id
-        OpenSCAP.xccdf_policy_get_id raw
+        OpenSCAP.xccdf_policy_get_id @raw
       end
 
       def profile
         Profile.new OpenSCAP.xccdf_policy_get_profile @raw
       end
 
-      def selects_item?(item_idref)
+      def selects_item? item_idref
         OpenSCAP.xccdf_policy_is_item_selected @raw, item_idref
       end
     end

data/lib/openscap/xccdf/policy_model.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 require 'openscap/exceptions'
-require 'openscap/xccdf/benchmark'
-require 'openscap/xccdf/policy'
+require_relative 'benchmark'
+require_relative 'policy'
 
 module OpenSCAP
   module Xccdf
     class PolicyModel
       attr_reader :raw
 
-      def initialize(b)
+      def initialize b
         case b
         when OpenSCAP::Xccdf::Benchmark
           @raw = OpenSCAP.xccdf_policy_model_new(b.raw)
@@ -27,7 +27,9 @@ module OpenSCAP
       end
 
       def policies
-        @policies ||= policies_init
+        @policies ||= {}.tap do |policies|
+          each_policy { |p| policies[p.id] = p }
+        end
       end
 
       def destroy
@@ -42,16 +44,6 @@ module OpenSCAP
           yield OpenSCAP::Xccdf::Policy.new pointer
         end
       end
-
-      private
-
-      def policies_init
-        policies = {}
-        each_policy do |policy|
-          policies[policy.id] = policy
-        end
-        policies
-      end
     end
   end
 

data/lib/openscap/xccdf/profile.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'openscap/text'
-require 'openscap/xccdf/item_common'
+require_relative 'item_common'
 
 module OpenSCAP
   module Xccdf
@@ -9,7 +9,7 @@ module OpenSCAP
       include ItemCommon
       attr_reader :raw
 
-      def initialize(p)
+      def initialize p
         case p
         when FFI::Pointer
           @raw = p

data/lib/openscap/xccdf/reference.rb

@@ -4,31 +4,15 @@ module OpenSCAP
   module Xccdf
     class Reference
       def initialize(raw)
-        raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} with '#{raw}'" \
-          unless raw.is_a?(FFI::Pointer)
+        raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} with '#{raw}'" unless raw.is_a?(FFI::Pointer)
 
         @raw = raw
       end
 
-      def title
-        OpenSCAP.oscap_reference_get_title(@raw)
-      end
-
-      def href
-        OpenSCAP.oscap_reference_get_href(@raw)
-      end
-
-      def html_link
-        "<a href='#{href}'>#{title}</a>"
-      end
-
-      def to_hash
-        {
-          title:,
-          href:,
-          html_link:
-        }
-      end
+      def title = OpenSCAP.oscap_reference_get_title @raw
+      def href = OpenSCAP.oscap_reference_get_href @raw
+      def html_link = "<a href='#{href}'>#{title}</a>"
+      def to_hash = { title:, href:, html_link: }
     end
   end
   attach_function :oscap_reference_get_href, [:pointer], :string

data/lib/openscap/xccdf/rule.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
 require 'openscap/exceptions'
-require 'openscap/xccdf/item'
-require 'openscap/xccdf/fix'
-require 'openscap/xccdf/ident'
+require_relative 'item'
+require_relative 'fix'
+require_relative 'fixtext'
+require_relative 'ident'
 
 module OpenSCAP
   module Xccdf
     class Rule < Item
       def severity
-        severity = OpenSCAP.xccdf_rule_get_severity(@raw)
+        severity = OpenSCAP.xccdf_rule_get_severity @raw
         severity_mapping = {
           xccdf_level_not_defined: 'Not defined',
           xccdf_unknown: 'Unknown',
@@ -21,12 +22,30 @@ module OpenSCAP
         severity_mapping[severity] || severity_mapping[:xccdf_unknown]
       end
 
-      def fixes
-        fixes = []
+      def each_fix(&)
         OpenSCAP._iterate over: OpenSCAP.xccdf_rule_get_fixes(@raw), as: 'xccdf_fix' do |pointer|
-          fixes << OpenSCAP::Xccdf::Fix.new(pointer)
+          yield OpenSCAP::Xccdf::Fix.new pointer
+        end
+      end
+
+      def each_fixtext(&)
+        OpenSCAP._iterate over: OpenSCAP.xccdf_rule_get_fixtexts(@raw), as: 'xccdf_fixtext' do |pointer|
+          yield OpenSCAP::Xccdf::Fixtext.new pointer
+        end
+      end
+
+      def fixtexts
+        @fixtexts ||= [].tap do |fixtexts|
+          each_fixtext { |ft| fixtexts << ft }
+        end
+      end
+
+      def fixes
+        @fixes ||= [].tap do |fixes|
+          each_fix do |fix|
+            fixes << fix
+          end
         end
-        fixes
       end
 
       def idents
@@ -52,6 +71,11 @@ module OpenSCAP
   attach_function :xccdf_fix_iterator_next, [:pointer], :pointer
   attach_function :xccdf_fix_iterator_free, [:pointer], :void
 
+  attach_function :xccdf_rule_get_fixtexts, [:pointer], :pointer
+  attach_function :xccdf_fixtext_iterator_has_more, [:pointer], :bool
+  attach_function :xccdf_fixtext_iterator_next, [:pointer], :pointer
+  attach_function :xccdf_fixtext_iterator_free, [:pointer], :void
+
   attach_function :xccdf_rule_get_idents, [:pointer], :pointer
   attach_function :xccdf_ident_iterator_has_more, [:pointer], :bool
   attach_function :xccdf_ident_iterator_next, [:pointer], :pointer

data/lib/openscap/xccdf/ruleresult.rb

@@ -6,7 +6,7 @@ require 'openscap/text'
 module OpenSCAP
   module Xccdf
     class RuleResult
-      def initialize(t)
+      def initialize t
         case t
         when FFI::Pointer
           @rr = t
@@ -20,11 +20,10 @@ module OpenSCAP
       end
 
       def result
-        OpenSCAP.xccdf_test_result_type_get_text \
-          OpenSCAP.xccdf_rule_result_get_result(@rr)
+        OpenSCAP.xccdf_test_result_type_get_text OpenSCAP.xccdf_rule_result_get_result(@rr)
       end
 
-      def override!(param)
+      def override! param
         validate_xccdf_result! param[:new_result]
         t = OpenSCAP::Text.new
         t.text = param[:raw_text]
@@ -41,7 +40,7 @@ module OpenSCAP
 
       private
 
-      def validate_xccdf_result!(result_label)
+      def validate_xccdf_result! result_label
         if OpenSCAP::XccdfResult[result_label] > OpenSCAP::XccdfResult[:fixed]
           raise OpenSCAPError, "Could not recognize result type: '#{result_label}'"
         end
@@ -63,6 +62,5 @@ module OpenSCAP
                      :notselected,
                      :informational,
                      :fixed)
-  attach_function :xccdf_rule_result_override,
-                  [:pointer, XccdfResult, :string, :string, :pointer], :bool
+  attach_function :xccdf_rule_result_override, [:pointer, XccdfResult, :string, :string, :pointer], :bool
 end

data/lib/openscap/xccdf/session.rb

@@ -3,7 +3,7 @@
 module OpenSCAP
   module Xccdf
     class Session
-      def initialize(input_filename)
+      def initialize input_filename
         raise OpenSCAPError, 'No filename specified!' unless input_filename
 
         @input_filename = input_filename
@@ -12,25 +12,25 @@ module OpenSCAP
       end
 
       def sds?
-        OpenSCAP.xccdf_session_is_sds(@s)
+        OpenSCAP.xccdf_session_is_sds @s
       end
 
-      def load(opts = {})
+      def load opts = {}
         o = {
           datastream_id: nil,
           component_id: nil
-        }.merge(opts)
+        }.merge opts
         if sds?
-          OpenSCAP.xccdf_session_set_datastream_id(@s, o[:datastream_id])
-          OpenSCAP.xccdf_session_set_component_id(@s, o[:component_id])
+          OpenSCAP.xccdf_session_set_datastream_id @s, o[:datastream_id]
+          OpenSCAP.xccdf_session_set_component_id @s, o[:component_id]
         end
         OpenSCAP.raise! unless OpenSCAP.xccdf_session_load(@s).zero?
         OpenSCAP.raise! unless OpenSCAP.xccdf_session_load_check_engine_plugins(@s).zero?
       end
 
-      def profile=(p)
+      def profile= p
         @profile = p
-        raise OpenSCAPError, "No profile '#{p}' found" if OpenSCAP.xccdf_session_set_profile_id(@s, p) == false
+        raise OpenSCAPError, "No profile '#{p}' found" unless OpenSCAP.xccdf_session_set_profile_id(@s, p)
       end
 
       def evaluate
@@ -49,13 +49,13 @@ module OpenSCAP
           oval_results: false,
           oval_variables: false,
           engines_results: false
-        }.merge!(opts)
+        }.merge! opts
         export_targets o
         export
       end
 
       def destroy
-        OpenSCAP.xccdf_session_free(@s)
+        OpenSCAP.xccdf_session_free @s
         @s = nil
       end
 
@@ -68,7 +68,7 @@ module OpenSCAP
         OpenSCAP.raise! unless OpenSCAP.xccdf_session_export_arf(@s).zero?
       end
 
-      def export_targets(opts = {})
+      def export_targets opts = {}
         OpenSCAP.raise! unless OpenSCAP.xccdf_session_set_arf_export(@s, opts[:rds_file])
         OpenSCAP.raise! unless OpenSCAP.xccdf_session_set_xccdf_export(@s, opts[:xccdf_file])
         OpenSCAP.raise! unless OpenSCAP.xccdf_session_set_report_export(@s, opts[:report_file])

data/lib/openscap/xccdf/status.rb

@@ -4,8 +4,7 @@ module OpenSCAP
   module Xccdf
     class Status
       def initialize(raw)
-        raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} with '#{raw}'" \
-          unless raw.is_a?(FFI::Pointer)
+        raise OpenSCAP::OpenSCAPError, "Cannot initialize #{self.class.name} with '#{raw}'" unless raw.is_a?(FFI::Pointer)
 
         @raw = raw
       end

data/lib/openscap/xccdf/tailoring.rb

@@ -19,24 +19,18 @@ module OpenSCAP
       end
 
       def profiles
-        @profiles ||= profiles_init
+        @profiles ||= {}.tap do |profiles|
+          OpenSCAP._iterate over: OpenSCAP.xccdf_tailoring_get_profiles(@raw), as: 'xccdf_profile' do |pointer|
+            profile = OpenSCAP::Xccdf::Profile.new pointer
+            profiles[profile.id] = profile
+          end
+        end
       end
 
       def destroy
         OpenSCAP.xccdf_tailoring_free @raw
         @raw = nil
       end
-
-      private
-
-      def profiles_init
-        profiles = {}
-        OpenSCAP._iterate over: OpenSCAP.xccdf_tailoring_get_profiles(@raw), as: 'xccdf_profile' do |pointer|
-          profile = OpenSCAP::Xccdf::Profile.new pointer
-          profiles[profile.id] = profile
-        end
-        profiles
-      end
     end
   end
 

data/lib/openscap/xccdf/testresult.rb

@@ -10,7 +10,7 @@ module OpenSCAP
     class TestResult
       attr_reader :rr, :raw
 
-      def initialize(t)
+      def initialize t
         case t
         when OpenSCAP::Source
           @raw = OpenSCAP.xccdf_result_import_source(t.raw)
@@ -25,15 +25,23 @@ module OpenSCAP
       end
 
       def id
-        OpenSCAP.xccdf_result_get_id(@raw)
+        OpenSCAP.xccdf_result_get_id @raw
       end
 
       def profile
-        OpenSCAP.xccdf_result_get_profile(@raw)
+        OpenSCAP.xccdf_result_get_profile @raw
       end
 
       def score
-        @score ||= score_init
+        @score ||= {}.tap do |scores|
+          OpenSCAP._iterate over: OpenSCAP.xccdf_result_get_scores(@raw), as: 'xccdf_score' do |s|
+            scores[OpenSCAP.xccdf_score_get_system(s)] = {
+              system: OpenSCAP.xccdf_score_get_system(s),
+              value: OpenSCAP.xccdf_score_get_score(s),
+              max: OpenSCAP.xccdf_score_get_maximum(s)
+            }
+          end
+        end
       end
 
       def score!(benchmark)
@@ -63,18 +71,6 @@ module OpenSCAP
           @rr[rr.id] = rr
         end
       end
-
-      def score_init
-        scores = {}
-        OpenSCAP._iterate over: OpenSCAP.xccdf_result_get_scores(@raw), as: 'xccdf_score' do |s|
-          scores[OpenSCAP.xccdf_score_get_system(s)] = {
-            system: OpenSCAP.xccdf_score_get_system(s),
-            value: OpenSCAP.xccdf_score_get_score(s),
-            max: OpenSCAP.xccdf_score_get_maximum(s)
-          }
-        end
-        scores
-      end
     end
   end
 

data/lib/openscap/xccdf/value.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'openscap/exceptions'
-require 'openscap/xccdf/item'
+require_relative 'item'
 
 module OpenSCAP
   module Xccdf