foreman_openscap 8.0.1 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bf645bb17178ebf3a7845c4955f6b100814e3fcae13f834bcaa4b94522e6d67
-  data.tar.gz: e5a773297d59f9d7f81c3a26085b73534424149aac6dec6a205798d98f3764e2
+  metadata.gz: 1332b15937eb430092240b50430503d12b494031dc357711cee88d422bfa0559
+  data.tar.gz: 5fd7b3e4e80187a99506caf214c97189944474fe8ea431b2c74f1454216b9992
 SHA512:
-  metadata.gz: c51175dfdebd026cf1cd0f75a77cb04b10ed2c1fbdb05c74557a5385ff390b6b6e979f5ec7433229e965fb35ab8528c7d817a368d16b3483ca8ac80f228f3341
-  data.tar.gz: df041f57fe9dfa77f4568579c0294f92d2c7ce16b391884cc35fce39c2c60447b0aa648ee2c9edb8bd3322dc0c6ae1bccbf9d8b6bca0296cd32a3b89f53c51b4
+  metadata.gz: 462a22ad2c6c44a85f408aed545640d28768941a239979bde967a8d52549db65a393fc7a10b2bef98a18d48eff686425ce3c1f431e2a97f3b8358e5ddae219ca
+  data.tar.gz: ae90d141280b390315a7681e7cd46069a997d811a011f4d66d49a793216f72895b777baeb51184066e5ad22a22b1c3aa85c9626061a8279c098e6b1e013049a3

data/README.md

@@ -19,7 +19,6 @@ of Foreman based infrastructure.
   + Waive known issues (one-time waivers, re-occurring, waivers)
   + Ad-hoc audit of given machine
   + Support for PreupgradeAssistant evaluation
-  + Vulnerability Assessment (processing OVAL CVE streams)
   + E-mail notifications
 
 ## Usage

data/app/lib/proxy_api/openscap.rb

@@ -1,5 +1,16 @@
 module ::ProxyAPI
   class Openscap < ::ProxyAPI::Resource
+    HTTP_ERRORS = [
+      EOFError,
+      Errno::ECONNRESET,
+      Errno::EINVAL,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+      Timeout::Error,
+      ProxyAPI::ProxyException
+    ].freeze
+
     def initialize(args)
       @url = args[:url] + '/compliance/'
       super args

data/app/models/concerns/foreman_openscap/data_stream_content.rb

@@ -10,11 +10,7 @@ module ForemanOpenscap
     end
 
     def proxy_url
-      @proxy_url ||= SmartProxy.with_features('Openscap').find do |proxy|
-        available = ProxyAPI::AvailableProxy.new(:url => proxy.url)
-        available.available?
-      end.try(:url)
-      @proxy_url
+      @proxy_url ||= SmartProxy.with_features('Openscap').find(&:ping)&.url
     end
 
     def create_profiles

data/app/services/foreman_openscap/client_config/ansible.rb

@@ -37,7 +37,7 @@ module ForemanOpenscap
       private
 
       def policy_types
-        [ForemanOpenscap::Policy, ForemanOpenscap::OvalPolicy]
+        [ForemanOpenscap::Policy]
       end
 
       def initialize_constants(policy_class)
@@ -59,15 +59,6 @@ module ForemanOpenscap
             )
           )
         end
-
-        if policy_class == ::ForemanOpenscap::OvalPolicy
-          @constants = OpenStruct.new(
-            base_constants.merge(
-              :policies_param => 'foreman_scap_client_oval_policies',
-              :policies_param_default_value => '<%= @host.oval_policies_enc %>'
-            )
-          )
-        end
       end
     end
   end

data/app/validators/foreman_openscap/data_stream_validator.rb

@@ -22,7 +22,7 @@ module ForemanOpenscap
           errors['errors'].each { |error| data_stream_content.errors.add(:scap_file, _(error)) }
           return false
         end
-      rescue *ProxyAPI::AvailableProxy::HTTP_ERRORS => e
+      rescue *ProxyAPI::Openscap::HTTP_ERRORS => e
         data_stream_content.errors.add(:base, _('No available proxy to validate. Returned with error: %s') % e)
         return false
       end

data/config/initializers/inflections.rb

@@ -7,6 +7,4 @@ ActiveSupport::Inflector.inflections do |inflect|
   #   inflect.singular /^(ox)en/i, '\1'
   #   inflect.irregular 'person', 'people'
   #   inflect.uncountable %w(fish sheep)
-
-  inflect.singular 'cves', 'cve'
 end

data/config/routes.rb

@@ -94,21 +94,6 @@ Rails.application.routes.draw do
 
         post 'arf_reports/:cname/:policy_id/:date', \
              :constraints => { :cname => /[^\/]+/ }, :to => 'arf_reports#create'
-
-        resources :oval_contents, :except => %i[new edit] do
-          collection do
-            post 'sync'
-          end
-        end
-
-        resources :oval_policies, :except => %i[new edit] do
-          member do
-            post 'assign_hostgroups'
-            post 'assign_hosts'
-            get 'oval_content'
-          end
-        end
-        post 'oval_reports/:cname/:oval_policy_id/:date', :constraints => { :cname => /[^\/]+/ }, :to => 'oval_reports#create'
       end
     end
   end

data/db/migrate/20240313111822_drop_oval.rb

@@ -0,0 +1,17 @@
+class DropOval < ActiveRecord::Migration[6.1]
+  def up
+    drop_table :foreman_openscap_host_cves
+    drop_table :foreman_openscap_oval_contents
+    drop_table :foreman_openscap_oval_policies
+    drop_table :foreman_openscap_hostgroup_oval_facet_oval_policies
+    drop_table :foreman_openscap_hostgroup_oval_facets
+    drop_table :foreman_openscap_oval_facet_oval_policies
+    drop_table :foreman_openscap_oval_facets
+    drop_table :foreman_openscap_cves
+
+    scope = ::HostStatus::Status.where(type: 'ForemanOpenscap::OvalStatus')
+    host_ids = scope.pluck(:host_id)
+    scope.delete_all
+    ::Host::Managed.where(id: host_ids).find_each(&:refresh_global_status!)
+  end
+end

data/lib/foreman_openscap/data_migration.rb

@@ -6,14 +6,15 @@ require 'tempfile'
 module ForemanOpenscap
   class DataMigration
     def initialize(proxy_id)
-      @proxy = ::SmartProxy.find(proxy_id)
-      puts "Found proxy #{@proxy.to_label}"
-      @url = @proxy.url
+      @proxy = ::SmartProxy.with_features('Openscap').where(id: proxy_id).first
+      if @proxy
+        puts "Found proxy #{@proxy.to_label}"
+        @url = @proxy.url
+      end
     end
 
     def available?
-      return false unless @proxy && @url
-      ::ProxyAPI::AvailableProxy.new(:url => @url).available? && foreman_available?
+      @proxy&.ping && foreman_available?
     end
 
     def migrate
@@ -47,7 +48,7 @@ module ForemanOpenscap
       foreman_status_url = Setting[:foreman_url] + '/status'
       response = JSON.parse(RestClient.get(foreman_status_url))
       return true if response["status"] == "ok"
-    rescue *::ProxyAPI::AvailableProxy::HTTP_ERRORS
+    rescue *::ProxyAPI::Openscap::HTTP_ERRORS
       return false
     end
 

data/lib/foreman_openscap/engine.rb

@@ -43,7 +43,7 @@ module ForemanOpenscap
     end
 
     initializer 'foreman_openscap.filter_large_params' do |app|
-      app.config.filter_parameters += %i[logs scap_file oval_results] if app.config.filter_parameters
+      app.config.filter_parameters += %i[logs scap_file] if app.config.filter_parameters
     end
 
     initializer 'foreman_openscap.register_plugin', :before => :finisher_hook do |app|
@@ -54,7 +54,6 @@ module ForemanOpenscap
         apipie_documented_controllers ["#{ForemanOpenscap::Engine.root}/app/controllers/api/v2/compliance/*.rb"]
 
         register_custom_status ForemanOpenscap::ComplianceStatus
-        register_custom_status ForemanOpenscap::OvalStatus
 
         # Add permissions
         security_block :foreman_openscap do
@@ -123,24 +122,6 @@ module ForemanOpenscap
                      :resource_type => 'ForemanOpenscap::TailoringFile'
           permission :view_openscap_proxies, { :openscap_proxies => [:openscap_spool] },
                      :resource_type => 'SmartProxy'
-          permission :view_oval_contents, { 'api/v2/compliance/oval_contents' => %i[index show] },
-                     :resource_type => 'ForemanOpenscap::OvalContent'
-          permission :edit_oval_contents, { 'api/v2/compliance/oval_contents' => %i[update sync] },
-                     :resource_type => 'ForemanOpenscap::OvalContent'
-          permission :create_oval_contents, { 'api/v2/compliance/oval_contents' => %i[create] },
-                     :resource_type => 'ForemanOpenscap::OvalContent'
-          permission :destroy_oval_contents, { 'api/v2/compliance/oval_contents' => %i[destroy] },
-                     :resource_type => 'ForemanOpenscap::OvalContent'
-          permission :view_oval_policies, { 'api/v2/compliance/oval_policies' => %i[index show oval_content] },
-                     :resource_type => 'ForemanOpenscap::OvalPolicy'
-          permission :edit_oval_policies, { 'api/v2/compliance/oval_policies' => %i[update assign_hosts assign_hostgroups] },
-                     :resource_type => 'ForemanOpenscap::OvalPolicy'
-          permission :create_oval_policies, { 'api/v2/compliance/oval_policies' => %i[create] },
-                     :resource_type => 'ForemanOpenscap::OvalPolicy'
-          permission :destroy_oval_policies, { 'api/v2/compliance/oval_policies' => %i[destroy] },
-                     :resource_type => 'ForemanOpenscap::OvalPolicy'
-          permission :create_oval_policies, { 'api/v2/compliance/oval_reports' => %i[create] },
-                     :resource_type => 'ForemanOpenscap::Cve'
         end
 
         role "Compliance viewer", %i[view_arf_reports view_policies view_scap_contents view_tailoring_files view_openscap_proxies],
@@ -169,15 +150,7 @@ module ForemanOpenscap
         menu :top_menu, :compliance_files, :caption => N_('Tailoring Files'),
                                            :url_hash => { :controller => :tailoring_files, :action => :index },
                                            :parent => :hosts_menu
-        menu :labs_menu, :oval_contents, :caption => N_('OVAL Contents'),
-                                         :url_hash => { :controller => 'react', :action => 'index' },
-                                         :url => '/experimental/compliance/oval_contents',
-                                         :parent => :lab_features_menu
-
-        menu :labs_menu, :oval_policies, :caption => N_('OVAL Policies'),
-                                         :url_hash => { :controller => 'react', :action => 'index' },
-                                         :url => '/experimental/compliance/oval_policies',
-                                         :parent => :lab_features_menu
+
         # add dashboard widget
         widget 'compliance_host_reports_widget',
                :name => N_('Latest Compliance Reports'), :sizex => 6, :sizey => 1
@@ -219,27 +192,6 @@ module ForemanOpenscap
 
         register_global_js_file 'global'
 
-        register_graphql_query_field :oval_contents, '::Types::OvalContent', :collection_field
-        register_graphql_query_field :oval_content, '::Types::OvalContent', :record_field
-        register_graphql_query_field :oval_policies, '::Types::OvalPolicy', :collection_field
-        register_graphql_query_field :oval_policy, '::Types::OvalPolicy', :record_field
-        register_graphql_query_field :cves, '::Types::Cve', :collection_field
-
-        register_graphql_mutation_field :delete_oval_policy, ::Mutations::OvalPolicies::Delete
-        register_graphql_mutation_field :delete_oval_content, ::Mutations::OvalContents::Delete
-        register_graphql_mutation_field :update_oval_policy, ::Mutations::OvalPolicies::Update
-        register_graphql_mutation_field :create_oval_policy, ::Mutations::OvalPolicies::Create
-
-        register_facet ForemanOpenscap::Host::OvalFacet, :oval_facet do
-          configure_host do
-            extend_model ForemanOpenscap::OvalFacetHostExtensions
-          end
-
-          configure_hostgroup(ForemanOpenscap::Hostgroup::OvalFacet) do
-            extend_model ForemanOpenscap::OvalFacetHostgroupExtensions
-          end
-        end
-
         describe_host do
           multiple_actions_provider :compliance_host_multiple_actions
           overview_buttons_provider :compliance_host_overview_button
@@ -271,10 +223,6 @@ module ForemanOpenscap
           :provided_inputs => "policies"
         }
 
-        oval_options = {
-          :description => N_("Run OVAL scan")
-        }
-
         ansible_remediation_options = {
           :description => N_("Run OpenSCAP remediation with Ansible"),
           :provided_inputs => ["tasks", "reboot"]
@@ -287,11 +235,9 @@ module ForemanOpenscap
 
         if Gem::Version.new(ForemanRemoteExecution::VERSION) >= Gem::Version.new('1.2.3')
           options[:host_action_button] = true
-          oval_options[:host_action_button] = (!::Foreman.in_rake? && ActiveRecord::Base.connection.table_exists?(:settings)) ? (Setting.find_by(:name => 'lab_features')&.value || false) : false
         end
 
         RemoteExecutionFeature.register(:foreman_openscap_run_scans, N_("Run OpenSCAP scan"), options)
-        RemoteExecutionFeature.register(:foreman_openscap_run_oval_scans, N_("Run OVAL scan"), oval_options)
         RemoteExecutionFeature.register(:ansible_run_openscap_remediation, N_("Run OpenSCAP remediation with Ansible"), ansible_remediation_options)
         RemoteExecutionFeature.register(:script_run_openscap_remediation, N_("Run OpenSCAP remediation with Shell"), script_remediation_options)
       end

data/lib/foreman_openscap/version.rb

@@ -1,3 +1,3 @@
 module ForemanOpenscap
-  VERSION = "8.0.1".freeze
+  VERSION = "9.0.0".freeze
 end

data/test/factories/compliance_host_factory.rb

@@ -16,16 +16,4 @@ FactoryBot.define do
     openscap_proxy { SmartProxy.unscoped.with_features('Openscap').first || FactoryBot.create(:openscap_proxy) }
     policies { [] }
   end
-
-  factory :oval_facet, :class => ForemanOpenscap::Host::OvalFacet
-
-  factory :oval_host, :class => Host::Managed do
-    sequence(:name) { |n| "host#{n}" }
-  end
-
-  factory :cve, :class => ForemanOpenscap::Cve do
-    sequence(:ref_id) { |n| "CVE-#{n}" }
-    sequence(:ref_url) { |n| "https://access.redhat.com/security/cve/CVE-#{n}" }
-    sequence(:definition_id) { |n| "oval:com.redhat.rhsa:def:202015#{n}" }
-  end
 end

data/test/test_plugin_helper.rb

@@ -8,8 +8,6 @@ FactoryBot.definition_file_paths << File.join(ForemanAnsible::Engine.root, '/tes
 FactoryBot.definition_file_paths << File.join(ForemanPuppet::Engine.root, '/test/factories') if defined?(ForemanPuppet::Engine)
 FactoryBot.reload
 
-require "#{ForemanOpenscap::Engine.root}/test/fixtures/cve_fixtures"
-
 module ScapClientPuppetclass
   def puppet_available?
     Foreman::Plugin.installed?("foreman_puppet")

data/test/unit/scap_content_test.rb

@@ -17,7 +17,6 @@ class ScapContentTest < ActiveSupport::TestCase
 
     test 'scap content should fail if no openscap proxy' do
       SmartProxy.stubs(:with_features).returns([])
-      ProxyAPI::AvailableProxy.any_instance.stubs(:available?).returns(false)
       scap_content = ForemanOpenscap::ScapContent.new(:title => 'Fedora', :scap_file => @scap_file)
       refute(scap_content.save)
       assert_includes(scap_content.errors.messages[:base], 'No proxy with OpenSCAP feature was found.')
@@ -26,8 +25,8 @@ class ScapContentTest < ActiveSupport::TestCase
     test 'proxy_url should return the first available proxy it finds' do
       available_proxy = SmartProxy.with_features('Openscap').first
       unavailable_proxy = FactoryBot.create(:smart_proxy, :url => 'http://proxy.example.com:8443', :features => [FactoryBot.create(:feature, :name => 'Openscap')])
-      available_proxy.stubs(:proxy_url).returns(available_proxy.url)
-      unavailable_proxy.stubs(:proxy_url).returns(nil)
+      SmartProxy.expects(:with_features).with('Openscap').returns([unavailable_proxy, available_proxy])
+      SmartProxy.any_instance.expects(:ping).twice.returns(false).then.returns(true)
       scap_content = ForemanOpenscap::ScapContent.new(:title => 'Fedora', :scap_file => @scap_file)
       assert_equal(available_proxy.url, scap_content.proxy_url)
     end

data/webpack/components/OpenscapRemediationWizard/ViewSelectedHostsLink.js

@@ -6,7 +6,7 @@ import { Button } from '@patternfly/react-core';
 
 import { translate as __ } from 'foremanReact/common/I18n';
 import { foremanUrl } from 'foremanReact/common/helpers';
-import { getHostsPageUrl } from 'foremanReact/Root/Context/ForemanContext';
+import { useForemanHostsPageUrl } from 'foremanReact/Root/Context/ForemanContext';
 
 const ViewSelectedHostsLink = ({
   hostIdsParam,
@@ -14,7 +14,7 @@ const ViewSelectedHostsLink = ({
   defaultFailedHostsSearch,
 }) => {
   const search = isAllHostsSelected ? defaultFailedHostsSearch : hostIdsParam;
-  const url = foremanUrl(`${getHostsPageUrl(false)}?search=${search}`);
+  const url = foremanUrl(`${useForemanHostsPageUrl()}?search=${search}`);
   return (
     <Button
       component="a"

data/webpack/components/OpenscapRemediationWizard/steps/ReviewHosts.js

@@ -7,6 +7,7 @@ import {
   ToolbarContent,
   ToolbarGroup,
   ToolbarItem,
+  Button,
 } from '@patternfly/react-core';
 import { Td } from '@patternfly/react-table';
 import { toArray } from 'lodash';
@@ -19,6 +20,7 @@ import { useBulkSelect } from 'foremanReact/components/PF4/TableIndexPage/Table/
 import { getPageStats } from 'foremanReact/components/PF4/TableIndexPage/Table/helpers';
 import { STATUS } from 'foremanReact/constants';
 import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
+import { useForemanHostDetailsPageUrl } from 'foremanReact/Root/Context/ForemanContext';
 
 import OpenscapRemediationWizardContext from '../OpenscapRemediationWizardContext';
 import WizardHeader from '../WizardHeader';
@@ -158,11 +160,19 @@ const ReviewHosts = () => {
     rowData: PropTypes.object.isRequired,
   };
 
+  const hostDetailsURL = useForemanHostDetailsPageUrl();
   const columns = {
     name: {
       title: __('Name'),
-      wrapper: ({ id, display_name: displayName }) => (
-        <a href={foremanUrl(`hosts/${id}`)}>{displayName}</a>
+      wrapper: ({ name, display_name: displayName }) => (
+        <Button
+          component="a"
+          variant="link"
+          target="_blank"
+          href={foremanUrl(`${hostDetailsURL}${name}`)}
+        >
+          {displayName}
+        </Button>
       ),
       isSorted: true,
       weight: 50,

data/webpack/components/OpenscapRemediationWizard/steps/ReviewRemediation.js

@@ -16,12 +16,15 @@ import { ExternalLinkSquareAltIcon } from '@patternfly/react-icons';
 
 import { translate as __ } from 'foremanReact/common/I18n';
 import { foremanUrl } from 'foremanReact/common/helpers';
-import { getHostsPageUrl } from 'foremanReact/Root/Context/ForemanContext';
+import {
+  useForemanHostsPageUrl,
+  useForemanHostDetailsPageUrl,
+} from 'foremanReact/Root/Context/ForemanContext';
 
 import OpenscapRemediationWizardContext from '../OpenscapRemediationWizardContext';
 import WizardHeader from '../WizardHeader';
 import ViewSelectedHostsLink from '../ViewSelectedHostsLink';
-import { HOSTS_PATH, FAIL_RULE_SEARCH } from '../constants';
+import { FAIL_RULE_SEARCH } from '../constants';
 import { findFixBySnippet } from '../helpers';
 
 import './ReviewRemediation.scss';
@@ -120,7 +123,7 @@ const ReviewRemediation = () => {
             iconPosition="right"
             target="_blank"
             component="a"
-            href={foremanUrl(`${getHostsPageUrl(true)}/${hostName}`)}
+            href={foremanUrl(`${useForemanHostDetailsPageUrl()}${hostName}`)}
           >
             {hostName}
           </Button>{' '}
@@ -133,7 +136,7 @@ const ReviewRemediation = () => {
             target="_blank"
             component="a"
             href={foremanUrl(
-              `${HOSTS_PATH}/?search=${FAIL_RULE_SEARCH} = ${source}`
+              `${useForemanHostsPageUrl()}?search=${FAIL_RULE_SEARCH} = ${source}`
             )}
           >
             {__('Other hosts failing this rule')}

data/webpack/global_index.js

@@ -1,10 +1,6 @@
 import React from 'react';
-import { registerRoutes } from 'foremanReact/routes/RoutingService';
 import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
 import HostKebabItems from './components/HostExtentions/HostKebabItems';
-import routes from './routes/routes';
-
-registerRoutes('foreman_openscap', routes);
 
 addGlobalFill(
   'host-details-kebab',