openscap 0.4.9 → 0.5.1

data/lib/openscap/xccdf/item_common.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'openscap/text'
+require_relative 'reference'
+
+module OpenSCAP
+  module Xccdf
+    module ItemCommon
+      def id
+        OpenSCAP.xccdf_item_get_id @raw
+      end
+
+      def version
+        OpenSCAP.xccdf_item_get_version @raw
+      end
+
+      def title lang: nil
+        TextList.extract OpenSCAP.xccdf_item_get_title(@raw), lang:, markup: false
+      end
+
+      def description prefered_lang: nil, markup: true
+        TextList.extract(OpenSCAP.xccdf_item_get_description(@raw), lang: prefered_lang, markup:)
+      end
+
+      def references
+        refs = []
+        OpenSCAP._iterate over: OpenSCAP.xccdf_item_get_references(@raw), as: 'oscap_reference' do |pointer|
+          refs << OpenSCAP::Xccdf::Reference.new(pointer)
+        end
+        refs
+      end
+    end
+  end
+
+  attach_function :xccdf_item_get_id, [:pointer], :string
+  attach_function :xccdf_item_get_title, [:pointer], :pointer
+  attach_function :xccdf_item_get_description, [:pointer], :pointer
+  attach_function :xccdf_item_get_references, [:pointer], :pointer
+  attach_function :xccdf_item_get_version, [:pointer], :string
+end

data/lib/openscap/xccdf/policy.rb

@@ -12,17 +12,26 @@ 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
+        OpenSCAP.xccdf_policy_is_item_selected @raw, item_idref
       end
     end
   end
 
   attach_function :xccdf_policy_get_id, [:pointer], :string
+  attach_function :xccdf_policy_get_profile, [:pointer], :pointer
+  attach_function :xccdf_policy_is_item_selected, %i[pointer string], :bool
 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)
@@ -18,10 +18,18 @@ module OpenSCAP
                 "Cannot initialize OpenSCAP::Xccdf::PolicyModel with '#{b}'"
         end
         OpenSCAP.raise! if @raw.null?
+
+        begin
+          yield self
+        ensure
+          destroy
+        end if block_given?
       end
 
       def policies
-        @policies ||= policies_init
+        @policies ||= {}.tap do |policies|
+          each_policy { |p| policies[p.id] = p }
+        end
       end
 
       def destroy
@@ -29,19 +37,12 @@ module OpenSCAP
         @raw = nil
       end
 
-      private
-
-      def policies_init
-        policies = {}
+      def each_policy(&)
         OpenSCAP.raise! unless OpenSCAP.xccdf_policy_model_build_all_useful_policies(raw).zero?
-        polit = OpenSCAP.xccdf_policy_model_get_policies raw
-        while OpenSCAP.xccdf_policy_iterator_has_more polit
-          policy_p = OpenSCAP.xccdf_policy_iterator_next polit
-          policy = OpenSCAP::Xccdf::Policy.new policy_p
-          policies[policy.id] = policy
+        OpenSCAP._iterate over: OpenSCAP.xccdf_policy_model_get_policies(@raw),
+                          as: 'xccdf_policy' do |pointer|
+          yield OpenSCAP::Xccdf::Policy.new pointer
         end
-        OpenSCAP.xccdf_policy_iterator_free polit
-        policies
       end
     end
   end

data/lib/openscap/xccdf/profile.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 require 'openscap/text'
+require_relative 'item_common'
 
 module OpenSCAP
   module Xccdf
     class Profile
+      include ItemCommon
       attr_reader :raw
 
-      def initialize(p)
+      def initialize p
         case p
         when FFI::Pointer
           @raw = p
@@ -16,19 +18,17 @@ module OpenSCAP
         end
       end
 
-      def id
-        OpenSCAP.xccdf_profile_get_id raw
+      def status_current
+        pointer = OpenSCAP.xccdf_profile_get_status_current @raw
+        Status.new pointer unless pointer.null?
       end
 
-      def title(prefered_lang = nil)
-        textlist = OpenSCAP::TextList.new(OpenSCAP.xccdf_profile_get_title(@raw))
-        title = textlist.plaintext(prefered_lang)
-        textlist.destroy
-        title
+      def abstract?
+        OpenSCAP.xccdf_profile_get_abstract @raw
       end
     end
   end
 
-  attach_function :xccdf_profile_get_id, [:pointer], :string
-  attach_function :xccdf_profile_get_title, [:pointer], :pointer
+  attach_function :xccdf_profile_get_status_current, [:pointer], :pointer
+  attach_function :xccdf_profile_get_abstract, [:pointer], :bool
 end

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 => title,
-          :href => href,
-          :html_link => 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,43 +1,58 @@
 # 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',
-          :xccdf_info => 'Info',
-          :xccdf_low => 'Low',
-          :xccdf_medium => 'Medium',
-          :xccdf_high => 'High'
+          xccdf_level_not_defined: 'Not defined',
+          xccdf_unknown: 'Unknown',
+          xccdf_info: 'Info',
+          xccdf_low: 'Low',
+          xccdf_medium: 'Medium',
+          xccdf_high: 'High'
         }
         severity_mapping[severity] || severity_mapping[:xccdf_unknown]
       end
 
+      def each_fix(&)
+        OpenSCAP._iterate over: OpenSCAP.xccdf_rule_get_fixes(@raw), as: 'xccdf_fix' do |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 = []
-        items_it = OpenSCAP.xccdf_rule_get_fixes(@raw)
-        while OpenSCAP.xccdf_fix_iterator_has_more items_it
-          fixes << OpenSCAP::Xccdf::Fix.new(OpenSCAP.xccdf_fix_iterator_next(items_it))
+        @fixes ||= [].tap do |fixes|
+          each_fix do |fix|
+            fixes << fix
+          end
         end
-        OpenSCAP.xccdf_fix_iterator_free items_it
-        fixes
       end
 
       def idents
         idents = []
-        idents_it = OpenSCAP.xccdf_rule_get_idents(@raw)
-        while OpenSCAP.xccdf_ident_iterator_has_more idents_it
-          idents << OpenSCAP::Xccdf::Ident.new(OpenSCAP.xccdf_ident_iterator_next(idents_it))
+        OpenSCAP._iterate over: OpenSCAP.xccdf_rule_get_idents(@raw), as: 'xccdf_ident' do |pointer|
+          idents << OpenSCAP::Xccdf::Ident.new(pointer)
         end
-        OpenSCAP.xccdf_ident_iterator_free idents_it
         idents
       end
     end
@@ -56,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,27 +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)
+          datastream_id: nil,
+          component_id: nil
+        }.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
-        if OpenSCAP.xccdf_session_set_profile_id(@s, p) == false
-          raise OpenSCAPError, "No profile '" + p + "' found"
-        end
+        raise OpenSCAPError, "No profile '#{p}' found" unless OpenSCAP.xccdf_session_set_profile_id(@s, p)
       end
 
       def evaluate
@@ -45,19 +43,19 @@ module OpenSCAP
 
       def export_results(opts = {})
         o = {
-          :rds_file => nil,
-          :xccdf_file => nil,
-          :report_file => nil,
-          :oval_results => false,
-          :oval_variables => false,
-          :engines_results => false
-        }.merge!(opts)
+          rds_file: nil,
+          xccdf_file: nil,
+          report_file: nil,
+          oval_results: false,
+          oval_variables: false,
+          engines_results: false
+        }.merge! opts
         export_targets o
         export
       end
 
       def destroy
-        OpenSCAP.xccdf_session_free(@s)
+        OpenSCAP.xccdf_session_free @s
         @s = nil
       end
 
@@ -70,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])
@@ -94,13 +92,13 @@ module OpenSCAP
 
   attach_function :xccdf_session_is_sds, [:pointer], :bool
 
-  attach_function :xccdf_session_set_profile_id, [:pointer, :string], :bool
-  attach_function :xccdf_session_set_datastream_id, [:pointer, :string], :void
-  attach_function :xccdf_session_set_component_id, [:pointer, :string], :void
-  attach_function :xccdf_session_set_arf_export, [:pointer, :string], :bool
-  attach_function :xccdf_session_set_xccdf_export, [:pointer, :string], :bool
-  attach_function :xccdf_session_set_report_export, [:pointer, :string], :bool
-  attach_function :xccdf_session_set_oval_variables_export, [:pointer, :bool], :void
-  attach_function :xccdf_session_set_oval_results_export, [:pointer, :bool], :void
-  attach_function :xccdf_session_set_check_engine_plugins_results_export, [:pointer, :bool], :void
+  attach_function :xccdf_session_set_profile_id, %i[pointer string], :bool
+  attach_function :xccdf_session_set_datastream_id, %i[pointer string], :void
+  attach_function :xccdf_session_set_component_id, %i[pointer string], :void
+  attach_function :xccdf_session_set_arf_export, %i[pointer string], :bool
+  attach_function :xccdf_session_set_xccdf_export, %i[pointer string], :bool
+  attach_function :xccdf_session_set_report_export, %i[pointer string], :bool
+  attach_function :xccdf_session_set_oval_variables_export, %i[pointer bool], :void
+  attach_function :xccdf_session_set_oval_results_export, %i[pointer bool], :void
+  attach_function :xccdf_session_set_check_engine_plugins_results_export, %i[pointer bool], :void
 end

data/lib/openscap/xccdf/status.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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)
+
+        @raw = raw
+      end
+
+      def status
+        OpenSCAP.xccdf_status_get_status @raw
+      end
+
+      def date
+        unix_t = OpenSCAP.xccdf_status_get_date @raw
+        Time.at unix_t
+      end
+    end
+  end
+
+  enum :xccdf_status_type_t, [
+    :not_specified, # empty value
+    :accepted,
+    :deprecated,
+    :draft,
+    :incomplete,
+    :interim
+  ]
+
+  attach_function :xccdf_status_get_status, [:pointer], :xccdf_status_type_t
+  attach_function :xccdf_status_get_date, [:pointer], :time_t
+end

data/lib/openscap/xccdf/tailoring.rb

@@ -19,31 +19,22 @@ 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 = {}
-        profit = OpenSCAP.xccdf_tailoring_get_profiles raw
-        while OpenSCAP.xccdf_profile_iterator_has_more profit
-          profile_p = OpenSCAP.xccdf_profile_iterator_next profit
-          profile = OpenSCAP::Xccdf::Profile.new profile_p
-          profiles[profile.id] = profile
-        end
-        OpenSCAP.xccdf_profile_iterator_free profit
-        profiles
-      end
     end
   end
 
-  attach_function :xccdf_tailoring_import_source, [:pointer, :pointer], :pointer
+  attach_function :xccdf_tailoring_import_source, %i[pointer pointer], :pointer
   attach_function :xccdf_tailoring_free, [:pointer], :void
 
   attach_function :xccdf_tailoring_get_profiles, [:pointer], :pointer

data/lib/openscap/xccdf/testresult.rb

@@ -8,10 +8,9 @@ require 'openscap/xccdf/ruleresult'
 module OpenSCAP
   module Xccdf
     class TestResult
-      attr_reader :rr
-      attr_reader :raw
+      attr_reader :rr, :raw
 
-      def initialize(t)
+      def initialize t
         case t
         when OpenSCAP::Source
           @raw = OpenSCAP.xccdf_result_import_source(t.raw)
@@ -26,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)
@@ -58,28 +65,11 @@ module OpenSCAP
 
       def init_ruleresults
         @rr = {}
-        rr_it = OpenSCAP.xccdf_result_get_rule_results(@raw)
-        while OpenSCAP.xccdf_rule_result_iterator_has_more(rr_it)
-          rr_raw = OpenSCAP.xccdf_rule_result_iterator_next(rr_it)
-          rr = OpenSCAP::Xccdf::RuleResult.new rr_raw
+        OpenSCAP._iterate over: OpenSCAP.xccdf_result_get_rule_results(@raw),
+                          as: 'xccdf_rule_result' do |pointer|
+          rr = OpenSCAP::Xccdf::RuleResult.new pointer
           @rr[rr.id] = rr
         end
-        OpenSCAP.xccdf_rule_result_iterator_free(rr_it)
-      end
-
-      def score_init
-        scores = {}
-        scorit = OpenSCAP.xccdf_result_get_scores(@raw)
-        while OpenSCAP.xccdf_score_iterator_has_more(scorit)
-          s = OpenSCAP.xccdf_score_iterator_next(scorit)
-          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
-        OpenSCAP.xccdf_score_iterator_free(scorit)
-        scores
       end
     end
   end
@@ -88,8 +78,8 @@ module OpenSCAP
   attach_function :xccdf_result_free, [:pointer], :void
   attach_function :xccdf_result_get_id, [:pointer], :string
   attach_function :xccdf_result_get_profile, [:pointer], :string
-  attach_function :xccdf_result_recalculate_scores, [:pointer, :pointer], :int
-  attach_function :xccdf_result_export_source, [:pointer, :string], :pointer
+  attach_function :xccdf_result_recalculate_scores, %i[pointer pointer], :int
+  attach_function :xccdf_result_export_source, %i[pointer string], :pointer
 
   attach_function :xccdf_result_get_rule_results, [:pointer], :pointer
   attach_function :xccdf_rule_result_iterator_has_more, [:pointer], :bool

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

data/lib/openscap/xccdf.rb

@@ -6,7 +6,7 @@ module OpenSCAP
   module Xccdf
     NUMERIC = :float
 
-    class Item
+    class Item # rubocop:disable Lint/EmptyClass
     end
   end
 end