diff options
| author | Jake Hunsaker <jhunsake@redhat.com> | 2021-05-05 17:02:04 -0400 |
|---|---|---|
| committer | Jake Hunsaker <jhunsake@redhat.com> | 2021-06-15 10:31:03 -0400 |
| commit | 892bbd8114703f5a4d23aa77ba5829b7ba59446f (patch) | |
| tree | bfb0aadf56224f18d0d6fc1783baaaca3326a694 /man/en | |
| parent | 34d997ebaea769b31e577526613e3e9ccb0893f8 (diff) | |
| download | sos-892bbd8114703f5a4d23aa77ba5829b7ba59446f.tar.gz | |
[cleaner] Remove binary files by default
Binary files generally speaking cannot be obfuscated, and as such we
should remove them from archives being obfuscated by default so that
sensitive data is not mistakenly included in an obfuscated archive.
This commits adds a new `--keep-binary-files` option that if used will
keep any encountered binary files in the final archive. The default
option of `false` will ensure that encountered binary files are removed.
The number of removed binary files per archive is reported when
obfuscation is completed for that archive.
Closes: #2478
Resolves: #2524
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man/en')
| -rw-r--r-- | man/en/sos-clean.1 | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/man/en/sos-clean.1 b/man/en/sos-clean.1 index 4856b43b..b77bc63c 100644 --- a/man/en/sos-clean.1 +++ b/man/en/sos-clean.1 @@ -9,6 +9,7 @@ sos clean - Obfuscate sensitive data from one or more sosreports [\-\-map-file] [\-\-jobs] [\-\-no-update] + [\-\-keep-binary-files] .SH DESCRIPTION \fBsos clean\fR or \fBsos mask\fR is an sos subcommand used to obfuscate sensitive information from @@ -77,6 +78,17 @@ Default: 4 .TP .B \-\-no-update Do not write the mapping file contents to /etc/sos/cleaner/default_mapping +.TP +.B \-\-keep-binary-files +Keep unprocessable binary files in the archive, rather than removing them. + +Note that binary files cannot be obfuscated, and thus keeping them in the archive +may result in otherwise sensitive information being included in the final archive. +Users should review any archive that keeps binary files in place before sending to +a third party. + +Default: False (remove encountered binary files) + .SH SEE ALSO .BR sos (1) .BR sos-report (1) |