foreman_openscap 7.1.1 → 8.0.0

data/locale/zh_TW/foreman_openscap.po

@@ -62,6 +62,12 @@ msgstr ""
 msgid "<b>Foreman</b> OpenSCAP summary"
 msgstr ""
 
+msgid "A reboot is required after applying remediation."
+msgstr ""
+
+msgid "A reboot might be required after applying remediation."
+msgstr ""
+
 msgid "A summary of reports for OpenSCAP policies"
 msgstr ""
 
@@ -113,6 +119,9 @@ msgstr ""
 msgid "Back"
 msgstr "上一頁"
 
+msgid "By default, remediation is applied to the current host. Optionally, remediate any additional hosts that fail the rule."
+msgstr ""
+
 msgid "CVEs"
 msgstr ""
 
@@ -158,6 +167,9 @@ msgstr "選擇期間"
 msgid "Choose weekday"
 msgstr "選擇星期幾"
 
+msgid "Close"
+msgstr ""
+
 msgid "Compliance"
 msgstr "合規"
 
@@ -191,6 +203,9 @@ msgstr ""
 msgid "Content"
 msgstr ""
 
+msgid "Copy to clipboard"
+msgstr ""
+
 msgid "Could not find host identified by: %s"
 msgstr ""
 
@@ -302,9 +317,15 @@ msgstr ""
 msgid "Directory to upload when using \"directory\" upload type"
 msgstr ""
 
+msgid "Do not implement any of the recommended remedial actions or scripts without first testing them in a non-production environment."
+msgstr ""
+
 msgid "Documentation"
 msgstr "文件"
 
+msgid "Done"
+msgstr ""
+
 msgid "Download"
 msgstr "下載"
 
@@ -505,6 +526,9 @@ msgstr ""
 msgid "It may sometimes be required to adjust the security policy to your specific needs. "
 msgstr ""
 
+msgid "Job details"
+msgstr ""
+
 msgid "Latest Compliance Reports"
 msgstr ""
 
@@ -538,9 +562,15 @@ msgstr "載入中…"
 msgid "Locations"
 msgstr "位置"
 
+msgid "Manual"
+msgstr ""
+
 msgid "Message"
 msgstr "訊息"
 
+msgid "Method"
+msgstr ""
+
 msgid "Monthly, day of month: %s"
 msgstr ""
 
@@ -676,6 +706,9 @@ msgstr "事件數量"
 msgid "Number of a day in month, note that not all months have same count of days"
 msgstr "月份中的日子，請注意並不是所有月份都有同樣的天數"
 
+msgid "OS"
+msgstr ""
+
 msgid "OVAL Content"
 msgstr ""
 
@@ -775,6 +808,9 @@ msgstr ""
 msgid "Other"
 msgstr "其他"
 
+msgid "Other hosts failing this rule"
+msgstr ""
+
 msgid "Othered"
 msgstr "其它"
 
@@ -867,6 +903,9 @@ msgstr "Puppet 類別"
 msgid "Rationale"
 msgstr "理由"
 
+msgid "Reboot the system(s)"
+msgstr ""
+
 msgid "Red Hat %s default content"
 msgstr ""
 
@@ -876,9 +915,21 @@ msgstr ""
 msgid "References"
 msgstr "參照"
 
+msgid "Remediate %s rule"
+msgstr ""
+
+msgid "Remediation"
+msgstr ""
+
+msgid "Remediation might render the system non-functional."
+msgstr ""
+
 msgid "Remote action:"
 msgstr "遠端動作："
 
+msgid "Remote job"
+msgstr ""
+
 msgid "Report Metrics"
 msgstr "報告計量"
 
@@ -915,12 +966,33 @@ msgstr "資源"
 msgid "Result"
 msgstr "結果"
 
+msgid "Review hosts"
+msgstr ""
+
+msgid "Review remediation"
+msgstr ""
+
+msgid "Review the remediation snippet and apply it to the host manually."
+msgstr ""
+
+msgid "Review the remediation snippet that will be applied to selected host(s)."
+msgstr ""
+
 msgid "Rule Results"
 msgstr ""
 
+msgid "Run"
+msgstr ""
+
 msgid "Run OVAL scan"
 msgstr ""
 
+msgid "Run OpenSCAP remediation with Ansible"
+msgstr ""
+
+msgid "Run OpenSCAP remediation with Shell"
+msgstr ""
+
 msgid "Run OpenSCAP scan"
 msgstr ""
 
@@ -963,6 +1035,12 @@ msgstr ""
 msgid "Select all items in this page"
 msgstr "選擇這頁中的所有項目"
 
+msgid "Select remediation method"
+msgstr ""
+
+msgid "Select snippet"
+msgstr ""
+
 msgid "Severity"
 msgstr "嚴重性"
 
@@ -1005,6 +1083,9 @@ msgstr "顯示日誌訊息："
 msgid "Smart Class Parameters"
 msgstr ""
 
+msgid "Snippet"
+msgstr ""
+
 msgid "Something went wrong while selecting compliance reports - %s"
 msgstr "選擇合規報告時發生了錯誤 - %s"
 
@@ -1023,6 +1104,9 @@ msgstr "狀態表"
 msgid "Submit"
 msgstr "提交"
 
+msgid "Successfully copied to clipboard!"
+msgstr ""
+
 msgid "Successfully deleted %s compliance reports"
 msgstr "刪除 %s 合規報告成功"
 
@@ -1085,9 +1169,15 @@ msgstr ""
 msgid "The identifier of the host"
 msgstr ""
 
+msgid "The job has started on selected host(s), you can check the status on the job details page."
+msgstr ""
+
 msgid "There are significant differences in deployment options."
 msgstr ""
 
+msgid "There is no job to remediate with. Please remediate manually."
+msgstr ""
+
 msgid "There was a following error when deleting %(name)s: %(error)s"
 msgstr ""
 
@@ -1210,6 +1300,9 @@ msgstr "檢視報告"
 msgid "View full report"
 msgstr "檢視完整報告"
 
+msgid "View selected hosts"
+msgstr ""
+
 msgid "Was %s configured successfully?"
 msgstr ""
 
@@ -1240,6 +1333,9 @@ msgstr "是"
 msgid "You are not authorized to view the page. "
 msgstr ""
 
+msgid "You can remediate by running a remote job or you can display a snippet for manual remediation."
+msgstr ""
+
 msgid "You can specify custom cron line, e.g. \"0  3  *  *  *\", separate each of 5 values by space"
 msgstr "您可指定自訂的 cron 行，例如\"0  3  *  *  *\"，五個數值均由空格隔開"
 

data/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,

data/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);

data/webpack/components/OpenscapRemediationWizard/OpenscapRemediationWizardContext.js

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

data/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;

data/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;

data/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';

data/webpack/components/OpenscapRemediationWizard/helpers.js

@@ -0,0 +1,33 @@
+import { join, find, map, compact, includes, filter, isString } from 'lodash';
+
+const getResponseErrorMsgs = ({ data } = {}) => {
+  if (data) {
+    const messages =
+      data.displayMessage || data.message || data.errors || data.error?.message;
+    return Array.isArray(messages) ? messages : [messages];
+  }
+  return [];
+};
+
+export const errorMsg = data => {
+  if (isString(data)) return data;
+
+  return join(getResponseErrorMsgs({ data }), '\n');
+};
+
+export const findFixBySnippet = (fixes, snippet) =>
+  find(fixes, fix => fix.system === snippet);
+
+export const supportedRemediationSnippets = (
+  fixes,
+  meth,
+  supportedJobSnippets
+) => {
+  if (meth === 'manual') return map(fixes, f => f.system);
+  return compact(
+    map(
+      filter(fixes, fix => includes(supportedJobSnippets, fix.system)),
+      f => f.system
+    )
+  );
+};

data/webpack/components/OpenscapRemediationWizard/index.js

@@ -0,0 +1,160 @@
+import React, { useState, useRef } from 'react';
+import { useDispatch, useSelector } from 'react-redux';
+import PropTypes from 'prop-types';
+import { Button, Wizard } from '@patternfly/react-core';
+
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
+import { API_OPERATIONS, get } from 'foremanReact/redux/API';
+
+import OpenscapRemediationWizardContext from './OpenscapRemediationWizardContext';
+import {
+  selectLogResponse,
+  selectLogError,
+  selectLogStatus,
+} from './OpenscapRemediationSelectors';
+import { REPORT_LOG_REQUEST_KEY, FAIL_RULE_SEARCH } from './constants';
+import { SnippetSelect, ReviewHosts, ReviewRemediation, Finish } from './steps';
+
+const OpenscapRemediationWizard = ({
+  report_id: reportId,
+  host: { id: hostId, name: hostName },
+  supported_remediation_snippets: supportedJobSnippets,
+}) => {
+  const dispatch = useDispatch();
+  const log = useSelector(state => selectLogResponse(state))?.log;
+  const logStatus = useSelector(state => selectLogStatus(state));
+  const logError = useSelector(state => selectLogError(state));
+
+  const fixes = JSON.parse(log?.message?.fixes || null) || [];
+  const source = log?.source?.value || '';
+  const title = log?.message?.value || '';
+  const defaultHostIdsParam = `id ^ (${hostId})`;
+  const defaultFailedHostsSearch = `${FAIL_RULE_SEARCH} = ${source}`;
+
+  const [isRemediationWizardOpen, setIsRemediationWizardOpen] = useState(false);
+  const [snippet, setSnippet] = useState('');
+  const [method, setMethod] = useState('job');
+  const [hostIdsParam, setHostIdsParam] = useState(defaultHostIdsParam);
+  const [isRebootSelected, setIsRebootSelected] = useState(false);
+  const [isAllHostsSelected, setIsAllHostsSelected] = useState(false);
+
+  const savedHostSelectionsRef = useRef({});
+
+  const onModalButtonClick = e => {
+    e.preventDefault();
+    const logId = e.target.getAttribute('data-log-id');
+    dispatch(
+      get({
+        type: API_OPERATIONS.GET,
+        key: REPORT_LOG_REQUEST_KEY,
+        url: `/compliance/arf_reports/${reportId}/show_log`,
+        params: { log_id: logId },
+      })
+    );
+    setIsRemediationWizardOpen(true);
+  };
+
+  const onWizardClose = () => {
+    // Reset to defaults
+    setHostIdsParam(defaultHostIdsParam);
+    setSnippet('');
+    setMethod('job');
+    setIsRebootSelected(false);
+    setIsRemediationWizardOpen(false);
+    savedHostSelectionsRef.current = {};
+  };
+
+  const reviewHostsStep = {
+    id: 2,
+    name: __('Review hosts'),
+    component: <ReviewHosts />,
+    canJumpTo: Boolean(snippet && method === 'job'),
+    enableNext: Boolean(snippet && method),
+  };
+  const steps = [
+    {
+      id: 1,
+      name: __('Select snippet'),
+      component: <SnippetSelect />,
+      canJumpTo: true,
+      enableNext: Boolean(snippet && method),
+    },
+    ...(snippet && method === 'job' ? [reviewHostsStep] : []),
+    {
+      id: 3,
+      name: __('Review remediation'),
+      component: <ReviewRemediation />,
+      canJumpTo: Boolean(snippet && method),
+      enableNext: method === 'job',
+      nextButtonText: __('Run'),
+    },
+    {
+      id: 4,
+      name: __('Done'),
+      component: <Finish onClose={onWizardClose} />,
+      isFinishedStep: true,
+    },
+  ];
+
+  return (
+    <>
+      {isRemediationWizardOpen && (
+        <OpenscapRemediationWizardContext.Provider
+          value={{
+            fixes,
+            snippet,
+            setSnippet,
+            method,
+            setMethod,
+            hostName,
+            source,
+            logStatus,
+            logError,
+            supportedJobSnippets,
+            isRebootSelected,
+            setIsRebootSelected,
+            hostId,
+            hostIdsParam,
+            setHostIdsParam,
+            isAllHostsSelected,
+            setIsAllHostsSelected,
+            defaultFailedHostsSearch,
+            savedHostSelectionsRef,
+          }}
+        >
+          <Wizard
+            title={title}
+            description={sprintf(__('Remediate %s rule'), source)}
+            isOpen={isRemediationWizardOpen}
+            steps={steps}
+            onClose={onWizardClose}
+          />
+        </OpenscapRemediationWizardContext.Provider>
+      )}
+      <Button
+        id="openscapRemediationWizardButton"
+        variant="link"
+        isInline
+        component="span"
+        onClick={e => onModalButtonClick(e)}
+      />
+    </>
+  );
+};
+
+OpenscapRemediationWizard.propTypes = {
+  report_id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+  host: PropTypes.shape({
+    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    name: PropTypes.string,
+  }),
+  supported_remediation_snippets: PropTypes.array,
+};
+
+OpenscapRemediationWizard.defaultProps = {
+  report_id: '',
+  host: {},
+  supported_remediation_snippets: [],
+};
+
+export default OpenscapRemediationWizard;

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

@@ -0,0 +1,131 @@
+/* eslint-disable camelcase */
+import React, { useContext } from 'react';
+import PropTypes from 'prop-types';
+import { Button, Bullseye } from '@patternfly/react-core';
+import { ExternalLinkSquareAltIcon } from '@patternfly/react-icons';
+
+import { translate as __ } from 'foremanReact/common/I18n';
+import { foremanUrl } from 'foremanReact/common/helpers';
+import { STATUS } from 'foremanReact/constants';
+import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
+import Loading from 'foremanReact/components/Loading';
+import PermissionDenied from 'foremanReact/components/PermissionDenied';
+
+import OpenscapRemediationWizardContext from '../OpenscapRemediationWizardContext';
+import EmptyState from '../../EmptyState';
+import ViewSelectedHostsLink from '../ViewSelectedHostsLink';
+import { errorMsg, findFixBySnippet } from '../helpers';
+
+import {
+  JOB_INVOCATION_PATH,
+  JOB_INVOCATION_API_PATH,
+  JOB_INVOCATION_API_REQUEST_KEY,
+  SNIPPET_SH,
+  SNIPPET_ANSIBLE,
+} from '../constants';
+
+const Finish = ({ onClose }) => {
+  const {
+    fixes,
+    snippet,
+    isRebootSelected,
+    hostIdsParam,
+    isAllHostsSelected,
+    defaultFailedHostsSearch,
+  } = useContext(OpenscapRemediationWizardContext);
+
+  const snippetText = findFixBySnippet(fixes, snippet)?.full_text;
+
+  const remediationJobParams = () => {
+    let feature = 'script_run_openscap_remediation';
+    const inputs = {};
+    switch (snippet) {
+      case SNIPPET_ANSIBLE:
+        feature = 'ansible_run_openscap_remediation';
+        inputs.tasks = snippetText;
+        inputs.reboot = isRebootSelected;
+        break;
+      case SNIPPET_SH:
+      default:
+        feature = 'script_run_openscap_remediation';
+        inputs.command = snippetText;
+        inputs.reboot = isRebootSelected;
+    }
+
+    return {
+      job_invocation: {
+        feature,
+        inputs,
+        search_query: isAllHostsSelected
+          ? defaultFailedHostsSearch
+          : hostIdsParam,
+      },
+    };
+  };
+
+  const response = useAPI('post', JOB_INVOCATION_API_PATH, {
+    key: JOB_INVOCATION_API_REQUEST_KEY,
+    params: remediationJobParams(),
+  });
+  const {
+    response: { response: { status: statusCode, data } = {} },
+    status = STATUS.PENDING,
+  } = response;
+
+  const linkToJob = (
+    <Button
+      variant="link"
+      icon={<ExternalLinkSquareAltIcon />}
+      iconPosition="right"
+      target="_blank"
+      component="a"
+      href={foremanUrl(`${JOB_INVOCATION_PATH}/${response?.response?.id}`)}
+    >
+      {__('Job details')}
+    </Button>
+  );
+  const closeBtn = <Button onClick={onClose}>{__('Close')}</Button>;
+  const errorComponent =
+    statusCode === 403 ? (
+      <PermissionDenied
+        missingPermissions={data?.error?.missing_permissions}
+        primaryButton={closeBtn}
+      />
+    ) : (
+      <EmptyState
+        error
+        title={__('Error!')}
+        body={errorMsg(data)}
+        primaryButton={closeBtn}
+      />
+    );
+  const body =
+    status === STATUS.RESOLVED ? (
+      <EmptyState
+        title={__(
+          'The job has started on selected host(s), you can check the status on the job details page.'
+        )}
+        body={
+          <>
+            {linkToJob}
+            <ViewSelectedHostsLink
+              isAllHostsSelected={isAllHostsSelected}
+              hostIdsParam={hostIdsParam}
+              defaultFailedHostsSearch={defaultFailedHostsSearch}
+            />
+          </>
+        }
+        primaryButton={closeBtn}
+      />
+    ) : (
+      errorComponent
+    );
+
+  return <Bullseye>{status === STATUS.PENDING ? <Loading /> : body}</Bullseye>;
+};
+
+Finish.propTypes = {
+  onClose: PropTypes.func.isRequired,
+};
+
+export default Finish;