diff options
| author | Jake Hunsaker <jhunsake@redhat.com> | 2021-09-01 00:28:58 -0400 |
|---|---|---|
| committer | Jake Hunsaker <jhunsake@redhat.com> | 2021-09-13 10:47:04 -0400 |
| commit | decd39b7799a0579ea085b0da0728b6eabd49b38 (patch) | |
| tree | fdb55757592367a0f9ac61d2eef9d3f66ab84d22 /man | |
| parent | 9f739f98114633ae2f2813f348eef3cd599aa516 (diff) | |
| download | sos-decd39b7799a0579ea085b0da0728b6eabd49b38.tar.gz | |
[clean] Provide archive abstractions to obfuscate more than sos archives
This commit removes the restriction imposed on `sos clean` since its
introduction in sos-4.0 to only work against known sos report archives
or build directories. This is because there has been interest in using
the obfuscation bits of sos in other data-collector projects.
The `SoSObfuscationArchive()` class has been revamped to now be an
abstraction for different types of archives, and the cleaner logic has
been updated to leverage this new abstraction rather than assuming we're
working on an sos archive.
Abstractions are added for our own native use cases - that being `sos
report` and `sos collect` for at-runtime obfuscation, as well as
standalone archives previously generated. Further generic abstractions
are available for plain directories and tarballs however these will not
provide the same level of coverage as fully supported archive types, as
is noted in the manpage for sos-clean.
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/en/sos-clean.1 | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/man/en/sos-clean.1 b/man/en/sos-clean.1 index b77bc63c..54026713 100644 --- a/man/en/sos-clean.1 +++ b/man/en/sos-clean.1 @@ -10,6 +10,7 @@ sos clean - Obfuscate sensitive data from one or more sosreports [\-\-jobs] [\-\-no-update] [\-\-keep-binary-files] + [\-\-archive-type] .SH DESCRIPTION \fBsos clean\fR or \fBsos mask\fR is an sos subcommand used to obfuscate sensitive information from @@ -88,6 +89,30 @@ Users should review any archive that keeps binary files in place before sending a third party. Default: False (remove encountered binary files) +.TP +.B \-\-archive-type TYPE +Specify the type of archive that TARGET was generated as. +When sos inspects a TARGET archive, it tries to identify what type of archive it is. +For example, it may be a report generated by \fBsos report\fR, or a collection of those +reports generated by \fBsos collect\fR, which require separate approaches. + +This option may be useful if a given TARGET archive is known to be of a specific type, +but due to unknown reasons or some malformed/missing information in the archive directly, +that is not properly identified by sos. + +The following are accepted values for this option: + + \fBauto\fR Automatically detect the archive type + \fBreport\fR An archive generated by \fBsos report\fR + \fBcollect\fR An archive generated by \fBsos collect\fR + +The following may also be used, however note that these do not attempt to pre-load +any information from the archives into the parsers. This means that, among other limitations, +items like host and domain names may not be obfuscated unless an obfuscated mapping already exists +on the system from a previous execution. + + \fBdata-dir\fR A plain directory on the filesystem. + \fBtarball\fR A generic tar archive not associated with any known tool .SH SEE ALSO .BR sos (1) |