Skip to content

Commit

Permalink
[plugins] Obfuscate http URL credentials
Browse files Browse the repository at this point in the history
HTTP_PROXY or similar env.variables can contain credentials we must
scrub. The variables or directly credentials of a http(s) URL can be
specified in several places the commit deals with.

Futher, update apt plugin to use the new do_paths_httpp_sub method.

Resolves: #3789

Signed-off-by: Pavel Moravec <[email protected]>
  • Loading branch information
pmoravec committed Sep 27, 2024
1 parent a0035b6 commit 7eb20e7
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 14 deletions.
15 changes: 15 additions & 0 deletions sos/report/plugins/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1313,6 +1313,21 @@ def do_file_sub(self, srcpath, regexp, subst):
replacements = 0
return replacements

def do_paths_http_sub(self, pathspecs):
""" Obfuscate credentials in *_PROXY variables in all files in the
given list. Proxy setting without protocol is ignored, since that
is not recommended setting and obfuscating that one can hit false
positives.
:param pathspecs: A filepath to obfuscate credentials in
:type pathspecs: ``str`` or a ``list`` of strings
"""
if isinstance(pathspecs, str):
pathspecs = [pathspecs]
for path in pathspecs:
self.do_path_regex_sub(
path, r"(http(s)?://)\S+:\S+(@.*)", r"\1******:******\3")

def do_path_regex_sub(self, pathexp, regexp, subst):
"""Apply a regexp substituation to a set of files archived by
sos. The set of files to be substituted is generated by matching
Expand Down
9 changes: 5 additions & 4 deletions sos/report/plugins/anaconda.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,21 @@ class Anaconda(Plugin, RedHatPlugin):

def setup(self):

paths = [
self.copypaths = [
"/root/anaconda-ks.cfg"
]

if self.path_isdir('/var/log/anaconda'):
# new anaconda
paths.append('/var/log/anaconda')
self.copypaths.append('/var/log/anaconda')
else:
paths = paths + [
self.copypaths = self.copypaths + [
"/var/log/anaconda.*",
"/root/install.log",
"/root/install.log.syslog"
]

self.add_copy_spec(paths)
self.add_copy_spec(self.copypaths)

def postproc(self):
self.do_file_sub(
Expand All @@ -51,5 +51,6 @@ def postproc(self):
r"(user.*--password=*\s*)\s*(\S*)",
r"\1********"
)
self.do_paths_http_sub(self.copypaths)

# vim: set et ts=4 sw=4 :
12 changes: 2 additions & 10 deletions sos/report/plugins/apt.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,11 @@ def setup(self):
def postproc(self):
super().postproc()

common_regex = r"(http(s)?://)\S+:\S+(@.*)"
common_replace = r"\1******:******\3"

files_to_sub = [
self.do_paths_http_sub([
"/etc/apt/sources.list",
"/etc/apt/sources.list.d/",
"/etc/apt/apt.conf",
"/etc/apt/apt.conf.d/",
]

for file in files_to_sub:
self.do_path_regex_sub(
file, common_regex, common_replace
)
])

# vim: set et ts=4 sw=4 :
6 changes: 6 additions & 0 deletions sos/report/plugins/system.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,11 @@ def setup(self):
"ld.so --list-tunables"
])

def postproc(self):
self.do_paths_http_sub([
"/etc/sysconfig",
"/etc/default",
"/etc/environment",
])

# vim: set et ts=4 sw=4 :
7 changes: 7 additions & 0 deletions sos/report/plugins/systemd.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,11 @@ def setup(self):
])
self.add_forbidden_path('/dev/null')

def postproc(self):
self.do_paths_http_sub([
"/etc/systemd/system",
"/lib/systemd/system",
"/run/systemd/system",
])

# vim: set et ts=4 sw=4 :

0 comments on commit 7eb20e7

Please sign in to comment.