aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2022-04-18 15:18:20 -0400
committerJake Hunsaker <jhunsake@redhat.com>2022-06-15 16:01:14 -0400
commit56b72eff6cd578556dfc09a1a062e5ed18753c11 (patch)
treeae63d802aa6805b10fbadb2c0015326d8c838761 /man
parentc55d6b8fb0d90fba4182f7cdf6d753652f119fd9 (diff)
downloadsos-56b72eff6cd578556dfc09a1a062e5ed18753c11.tar.gz
[cleaner] Allow disabling specific parsers individually
Adds a new `--disable-parsers` option that allows users to selectively disable parsers for a given execution of `sos clean`. This may be useful in specific scenarios where obfuscation is not strictly needed for all the types of data we obfuscate, and where the user trusts whomever may be receiving the archive for review. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/en/sos-clean.112
1 files changed, 12 insertions, 0 deletions
diff --git a/man/en/sos-clean.1 b/man/en/sos-clean.1
index 358ec0cb..7fd2df08 100644
--- a/man/en/sos-clean.1
+++ b/man/en/sos-clean.1
@@ -4,6 +4,7 @@ sos clean - Obfuscate sensitive data from one or more sosreports
.SH SYNOPSIS
.B sos clean TARGET [options]
[\-\-domains]
+ [\-\-disable-parsers]
[\-\-keywords]
[\-\-keyword-file]
[\-\-map-file]
@@ -51,6 +52,17 @@ match a domain given via this option will also be obfuscated.
For example, if \fB\-\-domains redhat.com\fR is specified, then 'redhat.com' will
be obfuscated, as will 'www.redhat.com' and subdomains such as 'foo.redhat.com'.
.TP
+.B \-\-disable-parsers PARSERS
+Provide a comma-delimited list of parsers to disable when cleaning an archive. By
+default all parsers are enabled.
+
+Note that using this option is very likely to leave sensitive information in place in
+the target archive, so only use this option when absolutely necessary or you have complete
+trust in the party/parties that may handle the generated report.
+
+Valid values for this option are currently: \fBhostname\fR, \fBip\fR, \fBmac\fR, \fBkeyword\fR,
+and \fBusername\fR.
+.TP
.B \-\-keywords KEYWORDS
Provide a comma-delimited list of keywords to scrub in addition to the default parsers.