foreman_openscap 7.1.1 → 8.0.0

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;
+}

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

@@ -0,0 +1,160 @@
+import React, { useContext } from 'react';
+import { map, split, capitalize, join, slice, isEmpty } from 'lodash';
+import {
+  Form,
+  FormGroup,
+  FormSelect,
+  FormSelectOption,
+  Radio,
+  Alert,
+} from '@patternfly/react-core';
+
+import { translate as __ } from 'foremanReact/common/I18n';
+import { STATUS } from 'foremanReact/constants';
+import Loading from 'foremanReact/components/Loading';
+
+import OpenscapRemediationWizardContext from '../OpenscapRemediationWizardContext';
+import WizardHeader from '../WizardHeader';
+import EmptyState from '../../EmptyState';
+import { errorMsg, supportedRemediationSnippets } from '../helpers';
+
+const SnippetSelect = () => {
+  const {
+    fixes,
+    snippet,
+    setSnippet,
+    method,
+    setMethod,
+    logStatus,
+    logError,
+    supportedJobSnippets,
+  } = useContext(OpenscapRemediationWizardContext);
+
+  const snippetNameMap = {
+    'urn:xccdf:fix:script:ansible': 'Ansible',
+    'urn:xccdf:fix:script:puppet': 'Puppet',
+    'urn:xccdf:fix:script:sh': 'Shell',
+    'urn:xccdf:fix:script:kubernetes': 'Kubernetes',
+    'urn:redhat:anaconda:pre': 'Anaconda',
+    'urn:redhat:osbuild:blueprint': 'OSBuild Blueprint',
+  };
+
+  const snippetName = system => {
+    const mapped = snippetNameMap[system];
+    if (mapped) return mapped;
+
+    return join(
+      map(slice(split(system, ':'), -2), n => capitalize(n)),
+      ' '
+    );
+  };
+
+  const resetSnippet = meth => {
+    const snip = supportedRemediationSnippets(
+      fixes,
+      meth,
+      supportedJobSnippets
+    )[0];
+    setSnippet(snip);
+    return snip;
+  };
+
+  const setMethodResetSnippet = meth => {
+    setMethod(meth);
+    resetSnippet(meth);
+  };
+
+  const body =
+    logStatus === STATUS.RESOLVED ? (
+      <Form>
+        <FormGroup
+          label={__('Method')}
+          type="string"
+          fieldId="method"
+          isRequired={false}
+        >
+          <Radio
+            label={__('Remote job')}
+            id="job"
+            name="job"
+            ouiaId="job"
+            aria-label="job"
+            isChecked={method === 'job'}
+            onChange={() => setMethodResetSnippet('job')}
+          />
+          <Radio
+            label={__('Manual')}
+            id="manual"
+            name="manual"
+            ouiaId="manual"
+            aria-label="manual"
+            isChecked={method === 'manual'}
+            onChange={() => setMethodResetSnippet('manual')}
+          />
+        </FormGroup>
+        {isEmpty(
+          supportedRemediationSnippets(fixes, method, supportedJobSnippets)
+        ) ? (
+          <Alert
+            ouiaId="snippet-alert"
+            variant="info"
+            title={__(
+              'There is no job to remediate with. Please remediate manually.'
+            )}
+          />
+        ) : (
+          <FormGroup
+            label={__('Snippet')}
+            type="string"
+            fieldId="snippet"
+            isRequired
+          >
+            <FormSelect
+              ouiaId="snippet-select"
+              isRequired
+              value={snippet}
+              onChange={value => setSnippet(value)}
+              aria-label="FormSelect Input"
+            >
+              <FormSelectOption
+                isDisabled
+                key={0}
+                value=""
+                label={__('Select snippet')}
+              />
+              {map(
+                supportedRemediationSnippets(
+                  fixes,
+                  method,
+                  supportedJobSnippets
+                ),
+                fix => (
+                  <FormSelectOption
+                    key={fix}
+                    value={fix}
+                    label={snippetName(fix)}
+                  />
+                )
+              )}
+            </FormSelect>
+          </FormGroup>
+        )}
+      </Form>
+    ) : (
+      <EmptyState error title={__('Error!')} body={errorMsg(logError)} />
+    );
+
+  return (
+    <>
+      <WizardHeader
+        title={__('Select remediation method')}
+        description={__(
+          'You can remediate by running a remote job or you can display a snippet for manual remediation.'
+        )}
+      />
+      {logStatus === STATUS.PENDING ? <Loading /> : body}
+    </>
+  );
+};
+
+export default SnippetSelect;

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

@@ -0,0 +1,4 @@
+export { default as SnippetSelect } from './SnippetSelect';
+export { default as ReviewHosts } from './ReviewHosts';
+export { default as ReviewRemediation } from './ReviewRemediation';
+export { default as Finish } from './Finish';

data/webpack/index.js

@@ -1,8 +1,13 @@
 import componentRegistry from 'foremanReact/components/componentRegistry';
 
 import RuleSeverity from './components/RuleSeverity';
+import OpenscapRemediationWizard from './components/OpenscapRemediationWizard';
 
-componentRegistry.register({
-  name: 'RuleSeverity',
-  type: RuleSeverity,
+const components = [
+  { name: 'RuleSeverity', type: RuleSeverity },
+  { name: 'OpenscapRemediationWizard', type: OpenscapRemediationWizard },
+];
+
+components.forEach(component => {
+  componentRegistry.register(component);
 });

data/webpack/testHelper.js

@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useState } from 'react';
 import { Provider } from 'react-redux';
 import store from 'foremanReact/redux';
 import { MockedProvider } from '@apollo/react-testing';
@@ -19,20 +19,21 @@ export const withRouter = Component => props => (
 );
 
 export const withMockedProvider = Component => props => {
-  const ForemanContext = getForemanContext(ctx);
   // eslint-disable-next-line react/prop-types
   const { mocks, ...rest } = props;
 
-  const ctx = {
+  const [context, setContext] = useState({
     metadata: {
       UISettings: {
         perPage: 20,
       },
     },
-  };
+  });
 
+  const contextData = { context, setContext };
+  const ForemanContext = getForemanContext(contextData);
   return (
-    <ForemanContext.Provider value={ctx}>
+    <ForemanContext.Provider value={contextData}>
       <MockedProvider mocks={mocks}>
         <Component {...rest} />
       </MockedProvider>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_openscap
 version: !ruby/object:Gem::Version
-  version: 7.1.1
+  version: 8.0.0
 platform: ruby
 authors:
 - slukasik@redhat.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -224,6 +224,8 @@ files:
 - app/views/foreman_openscap/policy_mailer/_policy.erb
 - app/views/foreman_openscap/policy_mailer/policy_summary.erb
 - app/views/hosts/select_multiple_openscap_proxy.html.erb
+- app/views/job_templates/run_openscap_remediation_-_ansible_default.erb
+- app/views/job_templates/run_openscap_remediation_-_script_default.erb
 - app/views/job_templates/run_openscap_scans.erb
 - app/views/job_templates/run_oval_scans.erb
 - app/views/policies/_form.html.erb
@@ -323,6 +325,7 @@ files:
 - db/migrate/20201217161511_add_url_to_oval_content.rb
 - db/migrate/20210409095625_add_oval_policy_reference_to_cve.rb
 - db/migrate/20210819143316_drop_unused_tables.rb
+- db/migrate/20230912122310_add_fixes_to_message.rb
 - db/seeds.d/75-job_templates.rb
 - db/seeds.d/openscap_feature.rb
 - db/seeds.d/openscap_policy_notification.rb
@@ -376,6 +379,7 @@ files:
 - locale/ka/LC_MESSAGES/foreman_openscap.mo
 - locale/ka/foreman_openscap.edit.po
 - locale/ka/foreman_openscap.po
+- locale/ka/foreman_openscap.po.time_stamp
 - locale/ko/LC_MESSAGES/foreman_openscap.mo
 - locale/ko/foreman_openscap.edit.po
 - locale/ko/foreman_openscap.po
@@ -474,6 +478,19 @@ files:
 - webpack/components/IndexTable/IndexTableHelper.js
 - webpack/components/IndexTable/index.js
 - webpack/components/LinkButton.js
+- webpack/components/OpenscapRemediationWizard/OpenscapRemediationSelectors.js
+- webpack/components/OpenscapRemediationWizard/OpenscapRemediationWizardContext.js
+- webpack/components/OpenscapRemediationWizard/ViewSelectedHostsLink.js
+- webpack/components/OpenscapRemediationWizard/WizardHeader.js
+- webpack/components/OpenscapRemediationWizard/constants.js
+- webpack/components/OpenscapRemediationWizard/helpers.js
+- webpack/components/OpenscapRemediationWizard/index.js
+- webpack/components/OpenscapRemediationWizard/steps/Finish.js
+- webpack/components/OpenscapRemediationWizard/steps/ReviewHosts.js
+- webpack/components/OpenscapRemediationWizard/steps/ReviewRemediation.js
+- webpack/components/OpenscapRemediationWizard/steps/ReviewRemediation.scss
+- webpack/components/OpenscapRemediationWizard/steps/SnippetSelect.js
+- webpack/components/OpenscapRemediationWizard/steps/index.js
 - webpack/components/RuleSeverity/RuleSeverity.scss
 - webpack/components/RuleSeverity/RuleSeverity.test.js
 - webpack/components/RuleSeverity/__snapshots__/RuleSeverity.test.js.snap
@@ -570,7 +587,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Foreman plug-in for displaying OpenSCAP audit reports