Fixes #36738 - Add remediation wizard (#546)

* Fixes #36738 - Add remediation wizard

* Refs #36738 - Re-use host selection box from core

* Refs #36738 - Remove searchbar

* Refs #36738 - Return SelectNone option

* Refs #36738 - Use relative import for ExternalLink icon

* Refs #36738 - Return SelectAll option

* Refs #36738 - Change Select none to Select default

* Refs #36738 - Improve help strings

app/assets/javascripts/foreman_openscap/reports.js

@@ -4,3 +4,8 @@ function showReportDetails(log_id, event) {
   showDetails.is(':visible') ? $(event).find('span').attr('class', 'glyphicon glyphicon-collapse-up') : $(event).find('span').attr('class', 'glyphicon glyphicon-collapse-down');
 }
 
+function showRemediationWizard(log_id) {
+  var wizard_button = $('#openscapRemediationWizardButton');
+  wizard_button.attr('data-log-id', log_id);
+  wizard_button.click();
+}

app/controllers/arf_reports_controller.rb

@@ -2,7 +2,7 @@ class ArfReportsController < ApplicationController
   include Foreman::Controller::AutoCompleteSearch
   include ForemanOpenscap::ArfReportsControllerCommonExtensions
 
-  before_action :find_arf_report, :only => %i[show show_html destroy parse_html parse_bzip download_html]
+  before_action :find_arf_report, :only => %i[show show_html destroy parse_html parse_bzip download_html show_log]
   before_action :find_multiple, :only => %i[delete_multiple submit_delete_multiple]
 
   def model_of_controller
@@ -72,6 +72,27 @@ def submit_delete_multiple
     end
   end
 
+  def show_log
+    return not_found unless @arf_report # TODO: use Message/Log model directly instead?
+
+    log = @arf_report.logs.find(params[:log_id])
+    return not_found unless log
+
+    respond_to do |format|
+      format.json do
+        render json: {
+          log: {
+            source: log.source,
+            message: {
+              value: log.message.value,
+              fixes: log.message.fixes,
+            }
+          },
+        }, status: :ok
+      end
+    end
+  end
+
   private
 
   def find_arf_report
@@ -99,7 +120,7 @@ def find_multiple
 
   def action_permission
     case params[:action]
-    when 'show_html', 'parse_html', 'parse_bzip', 'download_html'
+    when 'show_html', 'parse_html', 'parse_bzip', 'download_html', 'show_log'
       :view
     when 'delete_multiple', 'submit_delete_multiple'
       :destroy

app/helpers/arf_reports_helper.rb

@@ -62,9 +62,22 @@ def reported_info(arf_report)
     msg.html_safe
   end
 
-  def host_search_by_rule_result_buttons(source)
-    action_buttons(display_link_if_authorized(_('Hosts failing this rule'), hash_for_hosts_path(:search => "fails_xccdf_rule = #{source}")),
-                   display_link_if_authorized(_('Hosts passing this rule'), hash_for_hosts_path(:search => "passes_xccdf_rule = #{source}")),
-                   display_link_if_authorized(_('Hosts othering this rule'), hash_for_hosts_path(:search => "others_xccdf_rule = #{source}")))
+  def host_search_by_rule_result_buttons(log)
+    buttons = [
+      display_link_if_authorized(_('Hosts failing this rule'), hash_for_hosts_path(:search => "fails_xccdf_rule = #{log.source}")),
+      display_link_if_authorized(_('Hosts passing this rule'), hash_for_hosts_path(:search => "passes_xccdf_rule = #{log.source}")),
+      display_link_if_authorized(_('Hosts othering this rule'), hash_for_hosts_path(:search => "others_xccdf_rule = #{log.source}")),
+    ]
+    if log.result == 'fail' && log.message.fixes.present?
+      buttons << link_to_function_if_authorized(_('Remediation'), "showRemediationWizard(#{log.id})", hash_for_show_log_arf_report_path(id: log.report.id))
+    end
+    action_buttons(buttons)
+  end
+
+  def supported_remediation_snippets
+    snippets = []
+    snippets << 'urn:xccdf:fix:script:sh' if ForemanOpenscap.with_remote_execution?
+    snippets << 'urn:xccdf:fix:script:ansible' if ForemanOpenscap.with_ansible?
+    snippets
   end
 end

app/models/foreman_openscap/arf_report.rb

@@ -131,14 +131,16 @@ def self.create_arf(asset, proxy, params)
                   :severity => log[:severity],
                   :description => newline_to_space(log[:description]),
                   :rationale => newline_to_space(log[:rationale]),
-                  :scap_references => references_links(log[:references])
+                  :scap_references => references_links(log[:references]),
+                  :fixes => fixes(log[:fixes])
                 }
               else
                 msg = Message.new(:value => N_(log[:title]),
                                   :severity => log[:severity],
                                   :description => newline_to_space(log[:description]),
                                   :rationale => newline_to_space(log[:rationale]),
-                                  :scap_references => references_links(log[:references]))
+                                  :scap_references => references_links(log[:references]),
+                                  :fixes => fixes(log[:fixes]))
               end
               msg.save!
             end
@@ -222,12 +224,19 @@ def self.references_links(references)
       html_links.join(', ')
     end
 
+    def self.fixes(raw_fixes)
+      return if raw_fixes.empty?
+
+      JSON.fast_generate(raw_fixes)
+    end
+
     def self.update_msg_with_changes(msg, incoming_data)
       msg.severity = incoming_data['severity']
       msg.description = incoming_data['description']
       msg.rationale = incoming_data['rationale']
       msg.scap_references = incoming_data['references']
       msg.value = incoming_data['title']
+      msg.fixes = fixes(incoming_data['fixes'])
 
       return unless msg.changed?
       msg.save

app/views/arf_reports/_output.html.erb

@@ -25,7 +25,7 @@
         </td>
         <td><%= log.source %></td>
         <td><%= react_component 'RuleSeverity', { :severity => log.message.severity.downcase } %></td>
-        <td><%= host_search_by_rule_result_buttons(log.source) %></td>
+        <td><%= host_search_by_rule_result_buttons(log) %></td>
       </tr>
     <% end %>
     <tr id='ntsh' <%= "style='display: none;'".html_safe if logs.size > 0%>>
@@ -35,3 +35,7 @@
     </tr>
   </tbody>
 </table>
+<%= react_component 'OpenscapRemediationWizard',
+                    { report_id: @arf_report.id,
+                      host: { name: @arf_report.host.name, id: @arf_report.host.id },
+                      supported_remediation_snippets: supported_remediation_snippets } %>

app/views/job_templates/run_openscap_remediation_-_ansible_default.erb

@@ -0,0 +1,27 @@
+<%#
+name: Run OpenSCAP remediation - Ansible Default
+job_category: OpenSCAP Ansible Commands
+description_format: Run OpenSCAP remediation on given host. Please note, it is not meant to be used directly.
+snippet: false
+provider_type: Ansible
+kind: job_template
+model: JobTemplate
+feature: ansible_run_openscap_remediation
+template_inputs:
+- name: tasks
+  description: Tasks to run on the host
+  input_type: user
+  required: true
+- name: reboot
+  description: Indicate wether the host should be rebooted after all the remediation
+  input_type: user
+  required: false
+%>
+---
+- hosts: all
+  tasks:
+<%= indent(4) { input('tasks') } -%>
+<% if truthy?(input('reboot')) %>
+    - name: Reboot the machine
+      reboot:
+<% end %>

app/views/job_templates/run_openscap_remediation_-_script_default.erb

@@ -0,0 +1,24 @@
+<%#
+name: Run OpenSCAP remediation - Script Default
+job_category: OpenSCAP
+description_format: Run OpenSCAP remediation on given host. Please note, it is not meant to be used directly.
+snippet: false
+provider_type: script
+kind: job_template
+model: JobTemplate
+feature: script_run_openscap_remediation
+template_inputs:
+- name: command
+  description: Command to run on the host
+  input_type: user
+  required: true
+- name: reboot
+  description: Indicate wether the host should be rebooted after the remediation
+  input_type: user
+  required: false
+%>
+<%= input('command') %>
+<% if truthy?(input('reboot')) -%>
+echo "A reboot is required to finish the remediation. The system is going to reboot now."
+<%= render_template('Power Action - Script Default', action: 'restart') %>
+<% end -%>

config/routes.rb

@@ -9,6 +9,7 @@
         get 'parse_html'
         get 'parse_bzip'
         get 'download_html'
+        get 'show_log'
       end
       collection do
         get 'auto_complete_search'

db/migrate/20230912122310_add_fixes_to_message.rb

@@ -0,0 +1,5 @@
+class AddFixesToMessage < ActiveRecord::Migration[6.1]
+  def change
+    add_column :messages, :fixes, :text
+  end
+end

lib/foreman_openscap/engine.rb

@@ -48,7 +48,7 @@ class Engine < ::Rails::Engine
 
     initializer 'foreman_openscap.register_plugin', :before => :finisher_hook do |app|
       Foreman::Plugin.register :foreman_openscap do
-        requires_foreman '>= 3.7'
+        requires_foreman '>= 3.11'
         register_gettext
 
         apipie_documented_controllers ["#{ForemanOpenscap::Engine.root}/app/controllers/api/v2/compliance/*.rb"]
@@ -58,7 +58,7 @@ class Engine < ::Rails::Engine
 
         # Add permissions
         security_block :foreman_openscap do
-          permission :view_arf_reports, { :arf_reports => %i[index show parse_html show_html
+          permission :view_arf_reports, { :arf_reports => %i[index show parse_html show_html show_log
                                                              parse_bzip auto_complete_search download_html],
                                           'api/v2/compliance/arf_reports' => %i[index show download download_html],
                                           :compliance_hosts => [:show] },
@@ -275,13 +275,25 @@ class Engine < ::Rails::Engine
           :description => N_("Run OVAL scan")
         }
 
+        ansible_remediation_options = {
+          :description => N_("Run OpenSCAP remediation with Ansible"),
+          :provided_inputs => ["tasks", "reboot"]
+        }
+
+        script_remediation_options = {
+          :description => N_("Run OpenSCAP remediation with Shell"),
+          :provided_inputs => ["command", "reboot"]
+        }
+
         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
     end
 
@@ -303,4 +315,8 @@ def self.use_relative_model_naming?
   def self.with_remote_execution?
     RemoteExecutionFeature rescue false
   end
+
+  def self.with_ansible?
+    ForemanAnsible rescue false
+  end
 end

webpack/components/EmptyState.js

@@ -56,8 +56,12 @@ EmptyStateIcon.defaultProps = {
 
 EmptyState.propTypes = {
   title: PropTypes.string,
-  body: PropTypes.string,
-  error: PropTypes.oneOfType([PropTypes.shape({}), PropTypes.string]),
+  body: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
+  error: PropTypes.oneOfType([
+    PropTypes.shape({}),
+    PropTypes.string,
+    PropTypes.bool,
+  ]),
   search: PropTypes.bool,
   lock: PropTypes.bool,
   primaryButton: PropTypes.node,

webpack/components/OpenscapRemediationWizard/OpenscapRemediationSelectors.js

@@ -0,0 +1,16 @@
+import {
+  selectAPIError,
+  selectAPIResponse,
+  selectAPIStatus,
+} from 'foremanReact/redux/API/APISelectors';
+import { STATUS } from 'foremanReact/constants';
+import { REPORT_LOG_REQUEST_KEY } from './constants';
+
+export const selectLogResponse = state =>
+  selectAPIResponse(state, REPORT_LOG_REQUEST_KEY);
+
+export const selectLogStatus = state =>
+  selectAPIStatus(state, REPORT_LOG_REQUEST_KEY) || STATUS.PENDING;
+
+export const selectLogError = state =>
+  selectAPIError(state, REPORT_LOG_REQUEST_KEY);

webpack/components/OpenscapRemediationWizard/OpenscapRemediationWizardContext.js

@@ -0,0 +1,4 @@
+import { createContext } from 'react';
+
+const OpenscapRemediationWizardContext = createContext({});
+export default OpenscapRemediationWizardContext;

webpack/components/OpenscapRemediationWizard/ViewSelectedHostsLink.js

@@ -0,0 +1,38 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+import { ExternalLinkSquareAltIcon } from '@patternfly/react-icons';
+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';
+
+const ViewSelectedHostsLink = ({
+  hostIdsParam,
+  isAllHostsSelected,
+  defaultFailedHostsSearch,
+}) => {
+  const search = isAllHostsSelected ? defaultFailedHostsSearch : hostIdsParam;
+  const url = foremanUrl(`${getHostsPageUrl(false)}?search=${search}`);
+  return (
+    <Button
+      component="a"
+      variant="link"
+      icon={<ExternalLinkSquareAltIcon />}
+      iconPosition="right"
+      target="_blank"
+      href={url}
+    >
+      {__('View selected hosts')}
+    </Button>
+  );
+};
+
+ViewSelectedHostsLink.propTypes = {
+  isAllHostsSelected: PropTypes.bool.isRequired,
+  defaultFailedHostsSearch: PropTypes.string.isRequired,
+  hostIdsParam: PropTypes.string.isRequired,
+};
+
+export default ViewSelectedHostsLink;

webpack/components/OpenscapRemediationWizard/WizardHeader.js

@@ -0,0 +1,43 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import {
+  Grid,
+  TextContent,
+  Text,
+  TextVariants,
+  Flex,
+  FlexItem,
+} from '@patternfly/react-core';
+
+const WizardHeader = ({ title, description }) => (
+  <Grid style={{ gridGap: '24px' }}>
+    {title && (
+      <TextContent>
+        <Text ouiaId="wizard-header-text" component={TextVariants.h2}>
+          {title}
+        </Text>
+      </TextContent>
+    )}
+    {description && (
+      <TextContent>
+        <Flex flex={{ default: 'inlineFlex' }}>
+          <FlexItem>
+            <TextContent>{description}</TextContent>
+          </FlexItem>
+        </Flex>
+      </TextContent>
+    )}
+  </Grid>
+);
+
+WizardHeader.propTypes = {
+  title: PropTypes.oneOfType([PropTypes.node, PropTypes.string]),
+  description: PropTypes.oneOfType([PropTypes.node, PropTypes.string]),
+};
+
+WizardHeader.defaultProps = {
+  title: undefined,
+  description: undefined,
+};
+
+export default WizardHeader;

webpack/components/OpenscapRemediationWizard/constants.js

@@ -0,0 +1,14 @@
+export const OPENSCAP_REMEDIATION_MODAL_ID = 'openscapRemediationModal';
+export const HOSTS_PATH = '/hosts';
+export const FAIL_RULE_SEARCH = 'fails_xccdf_rule';
+
+export const HOSTS_API_PATH = '/api/hosts';
+export const HOSTS_API_REQUEST_KEY = 'HOSTS';
+export const REPORT_LOG_REQUEST_KEY = 'ARF_REPORT_LOG';
+
+export const JOB_INVOCATION_PATH = '/job_invocations';
+export const JOB_INVOCATION_API_PATH = '/api/job_invocations';
+export const JOB_INVOCATION_API_REQUEST_KEY = 'OPENSCAP_REX_JOB_INVOCATIONS';
+
+export const SNIPPET_SH = 'urn:xccdf:fix:script:sh';
+export const SNIPPET_ANSIBLE = 'urn:xccdf:fix:script:ansible';