1man(8)                            soscleaner                            man(8)
2
3
4

NAME

6       soscleaner - clean sosreports of sensitive information
7

SYNOPSIS

9       soscleaner -l LOGLEVEL -d DOMAIN -f FILE -q
10

DESCRIPTION

12       soscleaner  is  an attempt to begin the process of cleaning potentially
13       sensitive hostnames and IPv4 addresses from an sosreport after  it  has
14       been  created.  It is NOT a full cleaning, but it attempts to be a good
15       starting point. If a Fully Qualified Domain Name is used for the  host‐
16       name,  it  can  substitute instances of hostnames on that domain with a
17       consistent substitution. If an FQDN is not used, it  will  replace  all
18       instances  of  the  short  hostname. It also replaces instances of IPv4
19       addresses with a randomly assignable IPv4 range.
20

OPTIONS

22       -d, --domain=DOMAIN
23              optional additional domains to be analyzed during the soscleaner
24              process
25
26       -f, --file=FILE
27              optional  additonal files to be analyzed. Can be used in addtion
28              to supplying an sosreport, or can be used without specifying  an
29              sosreport.  If  no  sosreport  is supplied, no hostnames will be
30              obfuscated usless the -d flag is used to add a domain for analy‐
31              sis
32
33       -l, --loglevel=LOGLEVEL
34              the  desired  loglevel  to be used. default is 'INFO' (including
35              quotes).  Options  are  'DEBUG','INFO','WARNING','ERROR'.    -q,
36              --quiet  Quiet  mode. Nothing will be output to STDOUT. logfiles
37              will still be created.
38

EXAMPLES

40       supply an sosreport
41              soscleaner /path/to/sosreport.tar.gz
42
43       change logging level
44              soscleaner -l DEBUG /path/to/sosreport.tar.gz (warning  -  DEBUG
45              level logging is extremely intensive.)
46
47       supply additonal domains
48              soscleaner -d foo.com -d google.com /path/to/sosreport.tar.gz
49
50       supply additional files
51              soscleaner  -f  /path/to/file1 -f /path/to/file2 /path/to/sosre‐
52              port.tar.gz
53
54       only analyze files
55              soscleaner -f /path/to/file1 -f /path/to/file2 -d foo.com (It is
56              highly recommended to use the -d flag if only scanning files, so
57              hostnames will be obfuscated.)
58

BUGS

60       Please  report  new  bugs   to   https://github.com/jduncan-rva/soscle‐
61       aner/issues
62

AUTHOR

64       Jamie Duncan (jduncan@redhat.com)
65
66
67
680.2.1                             20 Jul 2014                           man(8)