SOSCleaner

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.

Index

• 1. Overview
  • 1.1. Purpose
  • 1.2. Important Links
  • 1.3. Obfuscated data types
• 2. Network Obfuscation
  • 2.1. Network Obfuscation Overview
  • 2.2. IPv4 Network database
  • 2.3. IPv4 address database
  • 2.4. Obfuscating IPv4 addresses
  • 2.5. IPv4 metadata
  • 2.6. IPv4 limitations and assumptions
  • 2.7. Network report
• 3. Host and domain obfuscation
  • 3.1. Host and domain obfuscation overview
  • 3.2. Domain database
  • 3.3. Hostname database
  • 3.4. Hostname and Domainname reports
• 4. MAC Address obfuscation
  • 4.1. MAC address overview
  • 4.2. Filing MAC bugs
  • 4.3. MAC address report
• 5. Keyword obfuscation
  • 5.1. Filing keyword bugs
  • 5.2. How soscleaner handles keywords
  • 5.3. Keyword report
• 6. User obfuscation
  • 6.1. User obfuscation overview
  • 6.2. Username report
• 7. Contributing
  • 7.1. Code contributions
  • 7.2. Commit format
  • 7.3. Testing
  • 7.4. Bugs and QA
  • 7.5. Documentation
• 8. Using soscleaner
  • 8.1. CLI quickstart
  • 8.2. Using a config file
  • 8.3. Using within a python prompt
• 9. Annotated Source Code
• 10. Proposals and Roadmap
  • 10.1. Python 3
  • 10.2. API
  • 10.3. Interacting with Kubernetes
• 11. Licensing