* Package name : soscleaner Version : v0.4.3 Upstream Author : jduncan <jduncan@redhat.com> * URL : https://github.com/jduncan-rva/soscleaner * License : GPL-2+ Programming Lang: Python Description : Python application to clean sensitive and un-wanted data from an existing sosreport Soscleaner is an open-source tool to take an sosreport, or any arbitrary dataset, and sanely obfuscate potentially sensitive information so it can be shared with outside parties for support. An unaltered copy of the data is maintained by the user so data can be mapped and suggestions supplied by a support team can still be actionable, even without the sensitive information. https://soscleaner.readthedocs.io/ * Why is this pacakge useful/relevant ? This tool allow users to sanitise a sosreport before sharing it with outside parties for support by obfuscating every occurences of a hostname, ip, mac address and user. This is relevant for users who doesn't want to share such sensible information and are concern about confidentiality. * Is it a dependency for another package ? The goal is to have soscleaner sanitizing existing sosreport collection, so soscleaner will depend on sosreport which is already found in the archive. * Do you use it ? Yes, I've been testing it and used it, and I know that others will be interested to use it also. * If there are other packages providing similar function No, this package is very specific to sosreport, maybe other tool can do something similar but most likely not as good as soscleaner does. Its main focus is sanitizing sosreport. It's also made by the same upstream group. * How do you plan to maintain it ? I'm planning to maintain and/or co-maintain it. I'm already an uploader for sosreport, and planning to maintain sosreport as well to make the release of both package smooth. * Do you need a sponsor ? Yes, until I get my DM permissions.
Hi Eric, Please excuse this drive-thru comment but I think this description etc. could be dramatically improved if it mentioned what a "sos" report is. :) Best wishes,
Chris Lamb wrote: FYI, eric.desrocher@canonical.com (removed from CC in this message) bounces for me. Regards,
sosreport is a unified tool for collecting system logs and other debug information on a given system. Its collecting the data and then prepare a tarball ready to be send to outside parties for support. Reference: https://sos.readthedocs.io/en/latest/ https://github.com/sosreport/sos
Please let's put this ITP on hold for now. Robie Basak kindly offered to review it once I'll be ready to resume the review for this ITP. The reasons behind this is because there is a few upstream bugs I would like to be addressed/merged before we continue with review for soscleaner to land in debian. Regards, Eric
Quick update: In a couple of days, upstream should make a new release available, including some fixes of mine. I will wait until it is released and then will ask Robie Basak (DD) to review as we both agreed in previous irc conversation. Will update the bug with the new soscleaner release number once released. - Eric
Upstream just released the new version (0.4.4): https://github.com/jduncan-rva/soscleaner/releases Please disregard version "0.4.3" in favour of "0.4.4" version from now on. I will package soscleaner, test, ... and once ready I'll ask for DD sponsorship as stated in previous updates. - Eric
As per my conversation with Robie about this ITP: Did you end up documenting why it can't be part of sosreport anywhere? All the details can be found here : https://github.com/sosreport/sos/issues/1557 Thanks Eric
In order to help the sponsorship: [Verification] # dpkg -L soscleaner /. /usr /usr/bin /usr/bin/soscleaner /usr/lib /usr/lib/python2.7 /usr/lib/python2.7/dist-packages /usr/lib/python2.7/dist-packages/soscleaner-0.4.4.egg-info /usr/lib/python2.7/dist-packages/soscleaner-0.4.4.egg-info/PKG-INFO /usr/lib/python2.7/dist-packages/soscleaner-0.4.4.egg-info/dependency_links.txt /usr/lib/python2.7/dist-packages/soscleaner-0.4.4.egg-info/requires.txt /usr/lib/python2.7/dist-packages/soscleaner-0.4.4.egg-info/top_level.txt /usr/lib/python2.7/dist-packages/soscleaner.py /usr/share /usr/share/doc /usr/share/doc/soscleaner /usr/share/doc/soscleaner/changelog.Debian.gz /usr/share/doc/soscleaner/copyright /usr/share/doc/soscleaner/examples /usr/share/doc/soscleaner/examples/soscleaner.conf /usr/share/man /usr/share/man/man5 /usr/share/man/man5/soscleaner.conf.5.gz /usr/share/man/man8 /usr/share/man/man8/soscleaner.8.gz # lintian -I --pedantic ../soscleaner_0.4.4-1.dsc I: soscleaner source: testsuite-autopkgtest-missing * I think it's fine for now to not have autopkgtest but will surely work on that eventually. It's definitely a must to have for the future. [Other informations] * soscleaner can use an optional config file if place in /etc/soscleaner.conf. I created an example in /usr/share/doc/soscleaner/examples/ to accomodate users who would want to use the config file. [soscleaner run] Working as expected: # sosreport -a # Generate a sosreport for soscleaner. # soscleaner /tmp/sosreport-debianlxc-20190702153526.tar.xz 07-02 15:35:38 soscleaner CONSOLE: Log File Created at /tmp/soscleaner-2454186531359549.log 07-02 15:35:38 soscleaner WARNING: soscleaner is a tool to help obfuscate sensitive information from an existing sosreport. 07-02 15:35:38 soscleaner WARNING: Please review the content before passing it along to any third party. 07-02 15:35:38 soscleaner CONSOLE: Creating Loopback Network Entry 07-02 15:35:38 soscleaner CONSOLE: Beginning SOSReport Extraction 07-02 15:36:16 soscleaner CONSOLE: Created New Obfuscated Network - 129.0.0.0/24 07-02 15:36:16 soscleaner CONSOLE: Adding new obfuscated domain - redhat.com 07-02 15:36:16 soscleaner CONSOLE: Adding new obfuscated domain - localhost.localdomain > ofuscateddomain2.com 07-02 15:36:16 soscleaner CONSOLE: Adding new obfuscated domain - localdomain > ofuscateddomain3.com 07-02 15:36:16 soscleaner CONSOLE: Adding new obfuscated domain - localhost 07-02 15:36:16 soscleaner CONSOLE: Processing output from user file - /tmp/soscleaner-2454186531359549/sos_commands/last/lastlog 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user Username 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user root 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user daemon 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user bin 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user sys 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user sync 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user games 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user man 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user lp 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user mail 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user news 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user uucp 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user proxy 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user www-data 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user backup 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user list 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user irc 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user gnats 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user nobody 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user _apt 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user systemd-timesync 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user systemd-network 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user systemd-resolve 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user messagebus 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user systemd-coredump 07-02 15:36:16 soscleaner CONSOLE: Obfuscating user Debian-exim 07-02 15:36:16 soscleaner CONSOLE: IP Obfuscation Network Created - 128.0.0.0/8 07-02 15:36:16 soscleaner CONSOLE: *** SOSCleaner Processing *** 07-02 15:36:30 soscleaner CONSOLE: *** SOSCleaner Statistics *** 07-02 15:36:30 soscleaner CONSOLE: IP Addresses Obfuscated - 23 07-02 15:36:30 soscleaner CONSOLE: Hostnames Obfuscated - 4 07-02 15:36:30 soscleaner CONSOLE: Domains Obfuscated - 4 07-02 15:36:30 soscleaner CONSOLE: Users Obfuscated - 26 07-02 15:36:30 soscleaner CONSOLE: Keywords Obfuscated - 0 07-02 15:36:30 soscleaner CONSOLE: Total Files Analyzed - 6311 07-02 15:36:30 soscleaner CONSOLE: *** SOSCleaner Artifacts *** 07-02 15:36:30 soscleaner CONSOLE: Creating IP Report - /tmp/soscleaner-2454186531359549-ip.csv 07-02 15:36:30 soscleaner CONSOLE: Creating Hostname Report - /tmp/soscleaner-2454186531359549-hostname.csv 07-02 15:36:30 soscleaner CONSOLE: Creating Domainname Report - /tmp/soscleaner-2454186531359549-dn.csv 07-02 15:36:30 soscleaner CONSOLE: Creating Userfname Report - /tmp/soscleaner-2454186531359549-username.csv 07-02 15:36:30 soscleaner CONSOLE: Creating MAC address Report - /tmp/soscleaner-2454186531359549-mac.csv 07-02 15:36:30 soscleaner CONSOLE: Creating keyword address Report - /tmp/soscleaner-2454186531359549-kw.csv 07-02 15:36:30 soscleaner CONSOLE: Creating SOSCleaner Archive - /tmp/soscleaner-2454186531359549.tar.gz 07-02 15:36:32 soscleaner CONSOLE: SOSCleaner Complete
Please don't add new python2 packages now. The Python teams are planning to remove python2 during this release cycle. Please ask upstream to Port to python3 and put this off until that's available. Scott K