Skip to content
This repository was archived by the owner on Sep 27, 2024. It is now read-only.

Commit bc27782

Browse files
committed
Added description of the remediation role file export feature.
1 parent 67a5314 commit bc27782

File tree

1 file changed

+45
-1
lines changed

1 file changed

+45
-1
lines changed

doc/user_manual.adoc

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,24 @@ to remediate each of them.
380380

381381
The rules that were remediated will show up as *fixed* in the rule result list.
382382

383+
=== Export remediation role for the selected profile
384+
385+
After you select a profile, you can export a remediation role to a file.
386+
Bash scripts, Ansible playbooks and Puppet manifests are the formats supported.
387+
The output file will contain all remediations for rules selected by the profile
388+
that are available.
389+
As the content of the remediation role solely depends on the profile,
390+
it is referred to as profile-based remediation role.
391+
392+
The possibility to save remediations to a file puts you in charge -
393+
you can examine it, edit it and decide what remediations to apply.
394+
However, the result-based remediations export produces output
395+
that fits your system better.
396+
See <<View-and-Analyze-Results>> to learn more about it.
397+
398+
Be aware that remediations may not be implemented in all formats.
399+
The most widely supported formats are bash scripts and Ansible playbooks.
400+
383401
=== Evaluate
384402

385403
Everything is set up we can now start the evaluation. Click the *Scan*
@@ -424,7 +442,8 @@ which will clear all results.
424442

425443
=== View and Analyze Results
426444

427-
After evaluation finishes, you should see three new buttons: *Clear*, *Save Results* and *Show Report*.
445+
After evaluation finishes, you should see three new buttons:
446+
*Clear*, *Save Results*, *Generate remediation role* and *Show Report*.
428447

429448
****
430449
Pressing Clear will *permanently* destroy scan results! This action cannot
@@ -434,6 +453,17 @@ be undone.
434453
Pressing *Show Report* will open the HTML report of the evaluation in your
435454
internet browser.
436455

456+
Opening the *Generate remediation role* pop-up menu will let you to save
457+
result-based remediations to a file.
458+
The output file will contain all available remediations for rules
459+
that have failed the scan, so it should fit your needs better
460+
than profile-based remediations.
461+
As the saved content is based on actual scan results,
462+
it is referred to as results-based remediation role.
463+
464+
If you scan with a customized profile, you may encounter an error -
465+
see <<Known-issues>> for a workaround.
466+
437467
****
438468
SCAP Workbench will open the report in the default web browser set in your
439469
desktop environment. Make sure you have a browser installed.
@@ -494,6 +524,20 @@ Both while opening the files and when scanning. This option is discouraged and
494524
should only be used by content creators and/or people who really know what they
495525
are doing.
496526

527+
== Known issues
528+
529+
=== Result-based remediations of tailored profiles
530+
531+
Saving remediation roles to the disk may not work for a customized profile. Specifically, it won't work if you add additional rules to it.
532+
If this limitation affects you, follow these steps:
533+
534+
Remark: You will need to use the oscap command-line utility, which is bundled together with scap-workbench.
535+
536+
1. Save the scan results
537+
2. Save your profile customization to a file using the "File->Save customization only" option.
538+
3. Run this command: oscap xccdf generate fix --output <role filename> --result-id '' --tailoring-file <saved-customization> <saved-result>.
539+
Refer to oscap xccdf generate fix -h if you want other than Bash output.
540+
497541
== Where to Get Help?
498542

499543
You ask for help with the application using

0 commit comments

Comments
 (0)