foreman_openscap 7.1.0 → 8.0.0

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;

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

@@ -0,0 +1,217 @@
+import React, { useContext, useState, useEffect } from 'react';
+import PropTypes from 'prop-types';
+import {
+  Spinner,
+  Toolbar,
+  ToolbarContent,
+  ToolbarGroup,
+  ToolbarItem,
+} from '@patternfly/react-core';
+import { Td } from '@patternfly/react-table';
+import { toArray } from 'lodash';
+
+import { foremanUrl } from 'foremanReact/common/helpers';
+import { translate as __ } from 'foremanReact/common/I18n';
+import SelectAllCheckbox from 'foremanReact/components/PF4/TableIndexPage/Table/SelectAllCheckbox';
+import { Table } from 'foremanReact/components/PF4/TableIndexPage/Table/Table';
+import { useBulkSelect } from 'foremanReact/components/PF4/TableIndexPage/Table/TableHooks';
+import { getPageStats } from 'foremanReact/components/PF4/TableIndexPage/Table/helpers';
+import { STATUS } from 'foremanReact/constants';
+import { useAPI } from 'foremanReact/common/hooks/API/APIHooks';
+
+import OpenscapRemediationWizardContext from '../OpenscapRemediationWizardContext';
+import WizardHeader from '../WizardHeader';
+import { HOSTS_API_PATH, HOSTS_API_REQUEST_KEY } from '../constants';
+
+const ReviewHosts = () => {
+  const {
+    hostId,
+    setHostIdsParam,
+    defaultFailedHostsSearch,
+    setIsAllHostsSelected,
+    savedHostSelectionsRef,
+  } = useContext(OpenscapRemediationWizardContext);
+
+  const defaultParams = {
+    search: defaultFailedHostsSearch,
+  };
+  const defaultHostsArry = [hostId];
+
+  const [params, setParams] = useState(defaultParams);
+
+  const response = useAPI('get', `${HOSTS_API_PATH}?include_permissions=true`, {
+    key: HOSTS_API_REQUEST_KEY,
+    params: defaultParams,
+  });
+  const {
+    response: {
+      search: apiSearchQuery,
+      results,
+      per_page: perPage,
+      page,
+      subtotal,
+      message: errorMessage,
+    },
+    status = STATUS.PENDING,
+    setAPIOptions,
+  } = response;
+
+  const subtotalCount = Number(subtotal ?? 0);
+
+  const setParamsAndAPI = newParams => {
+    setParams(newParams);
+    setAPIOptions({ key: HOSTS_API_REQUEST_KEY, params: newParams });
+  };
+
+  const { pageRowCount } = getPageStats({
+    total: subtotalCount,
+    page,
+    perPage,
+  });
+  const { fetchBulkParams, ...selectAllOptions } = useBulkSelect({
+    results,
+    metadata: { total: subtotalCount, page },
+    initialSearchQuery: apiSearchQuery || defaultFailedHostsSearch,
+    isSelectable: () => true,
+    defaultArry: defaultHostsArry,
+    initialArry: toArray(
+      savedHostSelectionsRef.current.inclusionSet || defaultHostsArry
+    ),
+    initialExclusionArry: toArray(
+      savedHostSelectionsRef.current.exclusionSet || []
+    ),
+    initialSelectAllMode: savedHostSelectionsRef.current.selectAllMode || false,
+  });
+  const {
+    selectPage,
+    selectedCount,
+    selectOne,
+    selectNone,
+    selectDefault,
+    selectAll,
+    areAllRowsOnPageSelected,
+    areAllRowsSelected,
+    isSelected,
+    inclusionSet,
+    exclusionSet,
+    selectAllMode,
+  } = selectAllOptions;
+
+  useEffect(() => {
+    if (selectedCount) {
+      setHostIdsParam(fetchBulkParams());
+      savedHostSelectionsRef.current = {
+        inclusionSet,
+        exclusionSet,
+        selectAllMode,
+      };
+    }
+  }, [selectedCount, fetchBulkParams, setHostIdsParam]);
+
+  const selectionToolbar = (
+    <ToolbarItem key="selectAll">
+      <SelectAllCheckbox
+        {...{
+          selectAll: () => {
+            selectAll(true);
+            setIsAllHostsSelected(true);
+          },
+          selectPage: () => {
+            selectPage();
+            setIsAllHostsSelected(false);
+          },
+          selectDefault: () => {
+            selectDefault();
+            setIsAllHostsSelected(false);
+          },
+          selectNone: () => {
+            selectNone();
+            setIsAllHostsSelected(false);
+          },
+          selectedCount,
+          pageRowCount,
+        }}
+        totalCount={subtotalCount}
+        selectedDefaultCount={1} // The default host (hostId) is always selected
+        areAllRowsOnPageSelected={areAllRowsOnPageSelected()}
+        areAllRowsSelected={areAllRowsSelected()}
+      />
+    </ToolbarItem>
+  );
+
+  const RowSelectTd = ({ rowData }) => (
+    <Td
+      select={{
+        rowIndex: rowData.id,
+        onSelect: (_event, isSelecting) => {
+          selectOne(isSelecting, rowData.id, rowData);
+          // If at least one was unselected, then it's not all selected
+          if (!isSelecting) setIsAllHostsSelected(false);
+        },
+        isSelected: rowData.id === hostId || isSelected(rowData.id),
+        disable: rowData.id === hostId || false,
+      }}
+    />
+  );
+  RowSelectTd.propTypes = {
+    rowData: PropTypes.object.isRequired,
+  };
+
+  const columns = {
+    name: {
+      title: __('Name'),
+      wrapper: ({ id, name }) => <a href={foremanUrl(`hosts/${id}`)}>{name}</a>,
+      isSorted: true,
+    },
+    operatingsystem_name: {
+      title: __('OS'),
+    },
+  };
+
+  return (
+    <>
+      <WizardHeader
+        title={__('Review hosts')}
+        description={__(
+          'By default, remediation is applied to the current host. Optionally, remediate any additional hosts that fail the rule.'
+        )}
+      />
+      <Toolbar ouiaId="table-toolbar" className="table-toolbar">
+        <ToolbarContent>
+          <ToolbarGroup>
+            {selectionToolbar}
+            {status === STATUS.PENDING && (
+              <ToolbarItem>
+                <Spinner size="sm" />
+              </ToolbarItem>
+            )}
+          </ToolbarGroup>
+        </ToolbarContent>
+      </Toolbar>
+      <Table
+        ouiaId="hosts-review-table"
+        isEmbedded
+        params={params}
+        setParams={setParamsAndAPI}
+        itemCount={subtotalCount}
+        results={results}
+        url={HOSTS_API_PATH}
+        refreshData={() =>
+          setAPIOptions({
+            key: HOSTS_API_REQUEST_KEY,
+            params: { defaultFailedHostsSearch },
+          })
+        }
+        columns={columns}
+        errorMessage={
+          status === STATUS.ERROR && errorMessage ? errorMessage : null
+        }
+        isPending={status === STATUS.PENDING}
+        showCheckboxes
+        rowSelectTd={RowSelectTd}
+      />
+    </>
+  );
+};
+
+export default ReviewHosts;

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

@@ -0,0 +1,176 @@
+/* eslint-disable camelcase */
+import React, { useContext, useState } from 'react';
+import { some } from 'lodash';
+import {
+  CodeBlock,
+  CodeBlockAction,
+  CodeBlockCode,
+  ClipboardCopyButton,
+  Button,
+  Grid,
+  GridItem,
+  Alert,
+  Checkbox,
+} from '@patternfly/react-core';
+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 OpenscapRemediationWizardContext from '../OpenscapRemediationWizardContext';
+import WizardHeader from '../WizardHeader';
+import ViewSelectedHostsLink from '../ViewSelectedHostsLink';
+import { HOSTS_PATH, FAIL_RULE_SEARCH } from '../constants';
+import { findFixBySnippet } from '../helpers';
+
+import './ReviewRemediation.scss';
+
+const ReviewRemediation = () => {
+  const {
+    fixes,
+    snippet,
+    method,
+    hostName,
+    source,
+    isRebootSelected,
+    setIsRebootSelected,
+    isAllHostsSelected,
+    hostIdsParam,
+    defaultFailedHostsSearch,
+  } = useContext(OpenscapRemediationWizardContext);
+  const [copied, setCopied] = useState(false);
+  const selectedFix = findFixBySnippet(fixes, snippet);
+  const snippetText = selectedFix?.full_text;
+  // can be one of null, "true", "false"
+  // if null, it may indicate that reboot might be needed
+  const checkForReboot = () => !some(fixes, { reboot: 'false' });
+  const isRebootRequired = () => some(fixes, { reboot: 'true' });
+
+  const copyToClipboard = (e, text) => {
+    navigator.clipboard.writeText(text.toString());
+  };
+
+  const onCopyClick = (e, text) => {
+    copyToClipboard(e, text);
+    setCopied(true);
+  };
+
+  const description =
+    method === 'manual'
+      ? __('Review the remediation snippet and apply it to the host manually.')
+      : __(
+          'Review the remediation snippet that will be applied to selected host(s).'
+        );
+
+  const rebootAlertTitle = isRebootRequired()
+    ? __('A reboot is required after applying remediation.')
+    : __('A reboot might be required after applying remediation.');
+
+  const actions = (
+    <React.Fragment>
+      <CodeBlockAction>
+        <ClipboardCopyButton
+          id="basic-copy-button"
+          textId="code-content"
+          aria-label="Copy to clipboard"
+          onClick={e => onCopyClick(e, snippetText)}
+          exitDelay={copied ? 1500 : 600}
+          maxWidth="110px"
+          variant="plain"
+          onTooltipHidden={() => setCopied(false)}
+        >
+          {copied
+            ? __('Successfully copied to clipboard!')
+            : __('Copy to clipboard')}
+        </ClipboardCopyButton>
+      </CodeBlockAction>
+    </React.Fragment>
+  );
+
+  return (
+    <>
+      <WizardHeader
+        title={__('Review remediation')}
+        description={description}
+      />
+      <Grid hasGutter>
+        <br />
+        <GridItem>
+          <Alert
+            ouiaId="review-alert"
+            variant="danger"
+            title={`${__(
+              'Do not implement any of the recommended remedial actions or scripts without first testing them in a non-production environment.'
+            )}
+              ${__('Remediation might render the system non-functional.')}`}
+          />
+        </GridItem>
+        <GridItem md={12} span={4} rowSpan={1}>
+          <ViewSelectedHostsLink
+            isAllHostsSelected={isAllHostsSelected}
+            hostIdsParam={hostIdsParam}
+            defaultFailedHostsSearch={defaultFailedHostsSearch}
+          />
+        </GridItem>
+        <GridItem md={12} span={4} rowSpan={1}>
+          <Button
+            variant="link"
+            icon={<ExternalLinkSquareAltIcon />}
+            iconPosition="right"
+            target="_blank"
+            component="a"
+            href={foremanUrl(`${getHostsPageUrl(true)}/${hostName}`)}
+          >
+            {hostName}
+          </Button>{' '}
+        </GridItem>
+        <GridItem md={12} span={8} rowSpan={1}>
+          <Button
+            variant="link"
+            icon={<ExternalLinkSquareAltIcon />}
+            iconPosition="right"
+            target="_blank"
+            component="a"
+            href={foremanUrl(
+              `${HOSTS_PATH}/?search=${FAIL_RULE_SEARCH} = ${source}`
+            )}
+          >
+            {__('Other hosts failing this rule')}
+          </Button>
+        </GridItem>
+        {checkForReboot() ? (
+          <>
+            <GridItem span={12} rowSpan={1}>
+              <Alert
+                ouiaId="reboot-alert"
+                variant={isRebootRequired() ? 'warning' : 'info'}
+                title={rebootAlertTitle}
+              />
+            </GridItem>
+            {method === 'manual' ? null : (
+              <GridItem span={4} rowSpan={1}>
+                <Checkbox
+                  id="reboot-checkbox"
+                  label={__('Reboot the system(s)')}
+                  name="reboot-checkbox"
+                  isChecked={isRebootSelected}
+                  onChange={selected => setIsRebootSelected(selected)}
+                />
+              </GridItem>
+            )}
+          </>
+        ) : null}
+        <GridItem>
+          <CodeBlock actions={actions}>
+            <CodeBlockCode id="code-content" className="remediation-code">
+              {snippetText}
+            </CodeBlockCode>
+          </CodeBlock>
+        </GridItem>
+      </Grid>
+    </>
+  );
+};
+
+export default ReviewRemediation;

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

@@ -0,0 +1,4 @@
+pre.remediation-code {
+  border: none;
+  border-radius: none;
+}