Bug 2229209

Summary:	entries "epo" and "map" in hostname_map section of default_mappings change the "sosreport" file name
Product:	Red Hat Enterprise Linux 8	Reporter:	Carlos Santos <casantos>
Component:	sos	Assignee:	Pavel Moravec <pmoravec>
Status:	CLOSED MIGRATED	QA Contact:	Supportability QE <supportability-qe>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	8.8	CC:	agk, jcastillo, jjansky, plambri, sbradley, theute
Target Milestone:	rc	Keywords:	MigratedToJIRA
Target Release:	---	Flags:	pm-rhel: mirror+
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2023-09-06 13:53:40 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Carlos Santos 2023-08-04 16:02:29 UTC

Description of problem:

When the hostname_map section in /etc/sos/cleaner/default_mapping contains
entries like these,



Version-Release number of selected component (if applicable):


How reproducible:

Always

Steps to Reproduce:

1. Ensure that sos report will find hosts with name "epo" and "map"

   # echo 192.168.122.1 epo.map.example.com epo map >> /etc/hosts

2. Remove the existing default mapping

   # rm -f /etc/sos/cleaner/default_mapping

3. Generate the report

   # sos report --batch --case-id 00000000 --clean

Actual results:

[...]
sosreport-<hostname>-00000000-2023-08-04-zddhrim :   Beginning obfuscation...
sosreport-<hostname>-00000000-2023-08-04-zddhrim :   Obfuscation completed [removed 920 unprocessable files]

Successfully obfuscated 1 report(s)

Creating compressed archive...

A mapping of obfuscated elements is available at
	/var/tmp/sosrhost1rt-host140-00000000-2023-08-04-zddhrim-private_map

Your sosreport has been generated and saved in:
	/var/tmp/sosrhost141rt-host14140-00000000-2023-08-04-zddhrim-obfuscated.tar.xz

 Size	6.36MiB
 Owner	root
 sha256	3c9e8df05545a6d57c058e03ea0d474dbdf8720b6d59a8493d3985b309cf1b75

Please send this file to your support representative.

Expected results:

Your sosreport has been generated and saved in:
	/var/tmp/sosreport-host14140-00000000-2023-08-04-zddhrim-obfuscated.tar.xz

Additional info:

Comment 1 Pavel Moravec 2023-08-05 21:08:30 UTC

This is tricky.

Sos takes /etc/hosts for hostname mapping. So whatever string is there, it treats it as a sensitive information to obfuscate. So for e.g. "rep" in /etc/hosts, "sosreport" string is obfuscated - including tarball filename (as it usually contains host's shortname).

How to behave better? Obfuscate not (sub)strings blindly, but for each string STR to camouflage, find just strings matching [^|\W]STR[$|\W] regular expression? (i.e. start of line or non-alphanumeric character before the STR, and end of line or non-alphanumeric character after the STR)?

What about *not* obfuscating "rep01", then? Is it ok? (I feel so..)


sos cleaner has a few parsers/mappers, one for hostnames+domainnames, one for IPv4, one for IPv6, one for MAC addresses, usernames and keywords (provided by user via a config). I guess this feature "dont obfuscate substrings, just strings" should be applied only to:
- hostnames+domainnames
- usernames
- keywords

As only those are alphanumeric words.

Is that improvement sound?

Comment 2 Carlos Santos 2023-08-07 12:26:34 UTC

(In reply to Pavel Moravec from comment #1)

> sos cleaner has a few parsers/mappers, one for hostnames+domainnames, one
> for IPv4, one for IPv6, one for MAC addresses, usernames and keywords
> (provided by user via a config). I guess this feature "dont obfuscate
> substrings, just strings" should be applied only to:
> - hostnames+domainnames
> - usernames
> - keywords
> 
> As only those are alphanumeric words.
> 
> Is that improvement sound?

I will ask the customer in the associated support case if that's a satisfying
approach.

Comment 3 Carlos Santos 2023-08-08 16:34:51 UTC

(In reply to Pavel Moravec from comment #1)

> sos cleaner has a few parsers/mappers, one for hostnames+domainnames, one
> for IPv4, one for IPv6, one for MAC addresses, usernames and keywords
> (provided by user via a config). I guess this feature "dont obfuscate
> substrings, just strings" should be applied only to:
> - hostnames+domainnames
> - usernames
> - keywords
> 
> As only those are alphanumeric words.
> 
> Is that improvement sound?

According to the customer, that seems fine, but mostly concerning are the
single and double chars masking. It might lead to unknown issues, like
decreased time of cleaning, with wrong masking of insensitive chars.

---> "e": "host22",

Comment 4 RHEL Program Management 2023-09-06 13:50:53 UTC

Issue migration from Bugzilla to Jira is in process at this time. This will be the last message in Jira copied from the Bugzilla bug.

Comment 5 RHEL Program Management 2023-09-06 13:53:40 UTC

This BZ has been automatically migrated to the issues.redhat.com Red Hat Issue Tracker. All future work related to this report will be managed there.

Due to differences in account names between systems, some fields were not replicated.  Be sure to add yourself to Jira issue's "Watchers" field to continue receiving updates and add others to the "Need Info From" field to continue requesting information.

To find the migrated issue, look in the "Links" section for a direct link to the new issue location. The issue key will have an icon of 2 footprints next to it, and begin with "RHEL-" followed by an integer.  You can also find this issue by visiting https://issues.redhat.com/issues/?jql= and searching the "Bugzilla Bug" field for this BZ's number, e.g. a search like:

"Bugzilla Bug" = 1234567

In the event you have trouble locating or viewing this issue, you can file an issue by sending mail to rh-issues.