sosreport / sos

A unified tool for collecting system logs and other debug information
http://sos.rtfd.org
GNU General Public License v2.0
508 stars 542 forks source link

sos report masking not working if we not used following plugins - host, login, networking. #3433

Open gholakemohit opened 10 months ago

gholakemohit commented 10 months ago

When we tried customized sos report collection with following plugins in disabled mode - host, login, networking. Then we found that "hostname_map" and "username_map" is not generated in default_mapping of sos_cleaner and private mapping per sos report collection. Is this expected behaviour. If yes, where can I found the documentation for this?

login: https://github.com/sosreport/sos/blob/ffeb7d99ffec2ed0c29e67293af5528dc11d7587/sos/cleaner/preppers/usernames.py#L39 host: for host -> https://github.com/sosreport/sos/blob/ffeb7d99ffec2ed0c29e67293af5528dc11d7587/sos/cleaner/preppers/hostname.py#L32 networking: for mac : https://github.com/sosreport/sos/blob/ffeb7d99ffec2ed0c29e67293af5528dc11d7587/sos/cleaner/preppers/mac.py#L23

Thanks

arif-ali commented 10 months ago

the concept of sos clean is that it will grab the details that it grabbed from the system, and will obfuscate the data based on this, as you can also run sos clean <sos-tar-ball> too.

If it is not collecting the host, login or networking details, then it is not allowed to collect that data, and possibly not allow to grab this information from the system.

something to note is that with sos clean or sos report --clean, the obfuscation takes place after the fact the data is collected

But, I also understand, that if we ignore those plugins, and we are running sos report --clean, we should be potentially expecting to obfuscate the data, maybe collect the same information separately, but not include the data in the sos report. So doing slightly different with in-flight clean may be something we can do. I'll let others chime in on this

NikhilKakade-1 commented 6 months ago

+1 On in-flight required files for obfuscation with --clean.

pmoravec commented 6 months ago

Just a warning: the in-flight data collection must be run only on the original system where the sos report was run. Roughly speaking, we can perform it only for sos report --clean executions, but not to sos clean ones.

Assume a case we run sos report on one system, move the file else-where and run sos clean with in-flight obfuscation. We will clean some sensitive data like hostnames, but definitely not necessarily (all) the required ones. While user's perception might be different.