1SOS(CLEAN) SOS(CLEAN)
2
6 sos clean - Obfuscate sensitive data from one or more sosreports
7
9 sos clean TARGET [options]
10 [--domains]
11 [--map]
12 [--jobs]
13 [--no-update]
14
17 sos clean or sos mask is an sos subcommand used to obfuscate sensitive
18 information from previously generated sosreports that is not covered by
19 the standard plugin-based post processing executed during report gener‐
20 ation, for example IP addresses.
21 Data obfuscated via this utility is done so consistently, meaning for
23 example an IP address of 192.168.1.1 in an unprocessed sosreport that
24 gets obfuscated to, for example, 100.0.0.1, will be changed to
25 100.0.0.1 in all occurrences found in the report.
26 Additionally, by default all such obfuscations are stored in "maps"
28 that will be persistently saved to /etc/sos/cleaner/default_mapping and
29 be re-used on subsequent runs.
30 This utility may also be used in-line with sos report and sos collect
32 by specifying the --clean or --mask option.
33 When called directly via sos clean, the obfuscated archive is written
35 as an additional file, meaning the original unprocessed report still
36 remains on the filesystem. When called via report or collect, the
37 changes are done in-line and thus only an obfuscated archive is written
38 and available. In either case, a mapping file containing the relation‐
39 ships between unprocessed and obfuscated elements will be written in
40 the same location as the resulting archive. This mapping file should be
41 kept private by system administrators.
42
45 TARGET
46 The path to the archive that is to be obfuscated. This may be an ar‐
48 chive or an unbuilt sos temporary
49 directory. If an archive, it will first be extracted and then
50 after obfuscation is complete re-compressed using the same com‐
51 pression method as the original.
52
55 --domains DOMAINS
56 Provide a comma-delimited list of domain names to obfuscate, in
57 addition to those matching the hostname of the system that cre‐
58 ated the sosreport. Subdomains that match a domain given via
59 this option will also be obfuscated.
60 For example, if --domains redhat.com is specified, then 'red‐
62 hat.com' will be obfuscated, as will 'www.redhat.com' and subdo‐
63 mains such as 'foo.redhat.com'.
64 --keywords KEYWORDS
66 Provide a comma-delimited list of keywords to scrub in addition
67 to the default parsers.
68 Keywords provided by this option will be obfuscated as "obfus‐
70 catedwordX" where X is an integer based on the keyword's index
71 in the parser. Note that keywords will be replaced as both
72 standalone words and in substring matches.
73 --map FILE
75 Provide a location to a valid mapping file to use as a reference
76 for existing obfuscation pairs. If one is found, the contents
77 are loaded before parsing is started. This allows consistency
78 between runs of this command for obfuscated pairs. By default,
79 sos will write the generated private map file to
80 /etc/sos/cleaner/default_mapping so that consistency is main‐
81 tained by default. Users may use this option to reference a map
82 file from a different run (perhaps one that was done on another
83 system).
84 Default: /etc/sos/cleaner/default_mapping
86 --jobs JOBS
88 The number of concurrent archives to process, if more than one.
89 If this utility is called by sos collect then the value of the
90 jobs option for that utility will be used here.
91 Default: 4
93 --no-update
95 Do not write the mapping file contents to
96 /etc/sos/cleaner/default_mapping
97
99 Jake Hunsaker <jhunsake@redhat.com>
100
102 See AUTHORS file in the package documentation.
103Thu May 21 2020 1 SOS(CLEAN)