soscleaner man page

soscleaner — clean sosreports of sensitive information

Synopsis

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

Description

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

Options

-d, --domain=DOMAIN

optional additional domains to be analyzed during the soscleaner process

-f, --file=FILE

optional additonal files to be analyzed. Can be used in addtion to supplying an sosreport, or can be used without specifying an sosreport. If no sosreport is supplied, no hostnames will be obfuscated usless the -d flag is used to add a domain for analysis

-l, --loglevel=LOGLEVEL

the desired loglevel to be used. default is 'INFO' (including quotes). Options are 'DEBUG','INFO','WARNING','ERROR'. -q, --quiet Quiet mode. Nothing will be output to STDOUT. logfiles will still be created.

Examples

supply an sosreport

soscleaner /path/to/sosreport.tar.gz

change logging level

soscleaner -l DEBUG /path/to/sosreport.tar.gz (warning - DEBUG level logging is extremely intensive.)

supply additonal domains

soscleaner -d foo.com -d google.com /path/to/sosreport.tar.gz

supply additional files

soscleaner -f /path/to/file1 -f /path/to/file2 /path/to/sosreport.tar.gz

only analyze files

soscleaner -f /path/to/file1 -f /path/to/file2 -d foo.com (It is highly recommended to use the -d flag if only scanning files, so hostnames will be obfuscated.)

Bugs

Please report new bugs to https://github.com/jduncan-rva/soscleaner/issues

Author

Jamie Duncan (jduncan@redhat.com)

Info

20 Jul 2014 0.2.1 soscleaner