Current File : //lib/python3/dist-packages/sos/report/plugins/ovirt.py
# Copyright (C) 2021 Red Hat, Inc., Lev Veyde <lveyde@redhat.com>
# Copyright (C) 2014 Red Hat, Inc., Sandro Bonazzola <sbonazzo@redhat.com>
# Copyright (C) 2014 Red Hat, Inc., Bryn M. Reeves <bmr@redhat.com>
# Copyright (C) 2010 Red Hat, Inc.
# This file is part of the sos project: https://github.com/sosreport/sos
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# version 2 of the GNU General Public License.
#
# See the LICENSE file in the source distribution for further information.
import os
import re
import signal
from sos.report.plugins import Plugin, RedHatPlugin, PluginOpt
from sos.utilities import is_executable
# Class name must be the same as file name and method names must not change
class Ovirt(Plugin, RedHatPlugin):
short_desc = 'oVirt Engine'
plugin_name = "ovirt"
profiles = ('virt',)
packages = (
'ovirt-engine',
'ovirt-engine-dwh',
'ovirt-engine-reports',
'ovirt-engine-metrics',
'ovirt-engine-setup',
'ovirt-vmconsole',
'ovirt-scheduler-proxy',
'rhevm',
'rhevm-dwh',
'rhevm-reports'
)
DB_PASS_FILES = re.compile(
flags=re.VERBOSE,
pattern=r"""^/etc/
(rhevm|ovirt-engine|ovirt-engine-dwh)/
(engine.conf|ovirt-engine-dwhd.conf)
(\.d/.+.conf.*?)?$"""
)
DEFAULT_SENSITIVE_KEYS = (
'ENGINE_DB_PASSWORD:ENGINE_PKI_TRUST_STORE_PASSWORD:'
'ENGINE_PKI_ENGINE_STORE_PASSWORD:DWH_DB_PASSWORD'
)
option_list = [
PluginOpt('jbosstrace', default=True,
desc='Enable oVirt Engine JBoss stack trace collection'),
PluginOpt('sensitive_keys', default=DEFAULT_SENSITIVE_KEYS,
desc='Sensitive keys to be masked in post-processing'),
PluginOpt('heapdump', default=False,
desc='Collect heap dumps from /var/log/ovirt-engine/dump/')
]
def setup(self):
if self.get_option('jbosstrace') and self.is_installed('ovirt-engine'):
engine_pattern = r"^ovirt-engine\ -server.*jboss-modules.jar"
pgrep = "pgrep -f '%s'" % engine_pattern
r = self.exec_cmd(pgrep)
engine_pids = [int(x) for x in r['output'].splitlines()]
if not engine_pids:
self.soslog.error('Unable to get ovirt-engine pid')
self.add_alert('Unable to get ovirt-engine pid')
for pid in engine_pids:
try:
# backtrace written to '/var/log/ovirt-engine/console.log
os.kill(pid, signal.SIGQUIT)
except OSError as e:
self.soslog.error('Unable to send signal to %d' % pid, e)
self.add_forbidden_path([
'/etc/ovirt-engine/.pgpass',
'/etc/rhevm/.pgpass'
])
if not self.get_option('heapdump'):
self.add_forbidden_path('/var/log/ovirt-engine/dump')
self.add_cmd_output('ls -l /var/log/ovirt-engine/dump/')
certificates = [
'/etc/pki/ovirt-engine/ca.pem',
'/etc/pki/ovirt-engine/apache-ca.pem',
'/etc/pki/ovirt-engine/certs/engine.cer',
'/etc/pki/ovirt-engine/certs/apache.cer',
'/etc/pki/ovirt-engine/certs/websocket-proxy.cer',
'/etc/pki/ovirt-engine/certs/jboss.cer',
'/etc/pki/ovirt-engine/certs/imageio-proxy.cer',
'/etc/pki/ovirt-engine/certs/ovirt-provider-ovn.cer',
]
keystores = [
('mypass', '/etc/pki/ovirt-engine/.truststore'),
('changeit', '/var/lib/ovirt-engine/external_truststore'),
]
self.add_cmd_output([
# Copy all engine tunables and domain information
"engine-config --all",
# clearer diff from factory defaults (only on ovirt>=4.2.8)
"engine-config -d",
])
self.add_cmd_output([
# process certificate files
"openssl x509 -in %s -text -noout" % c for c in certificates
])
self.add_cmd_output([
# process TrustStore certificates
"keytool -list -storepass %s -rfc -keystore %s" %
(p, c) for (p, c) in keystores
])
# 3.x line uses engine-manage-domains, 4.x uses ovirt-aaa-jdbc-tool
manage_domains = 'engine-manage-domains'
extensions_tool = 'ovirt-engine-extensions-tool'
jdbc_tool = 'ovirt-aaa-jdbc-tool'
if is_executable(manage_domains):
self.add_cmd_output('%s list' % manage_domains)
if is_executable(extensions_tool):
self.add_cmd_output('%s info list-extensions' % extensions_tool)
if is_executable('ovirt-aaa-jdbc-tool'):
subcmds = [
'query --what=user',
'query --what=group',
'settings show'
]
self.add_cmd_output(['%s %s' % (jdbc_tool, sc) for sc in subcmds])
# Copy engine config files.
self.add_copy_spec([
"/etc/ovirt-engine",
"/etc/rhevm/",
"/etc/ovirt-engine-dwh",
"/etc/ovirt-engine-reports",
"/etc/ovirt-engine-metrics",
"/etc/ovirt-engine-setup",
"/etc/ovirt-vmconsole",
"/var/log/ovirt-engine",
"/var/log/ovirt-engine-dwh",
"/var/log/ovirt-engine-reports",
"/var/log/ovirt-scheduler-proxy",
"/var/log/rhevm",
"/etc/sysconfig/ovirt-engine",
"/usr/share/ovirt-engine/conf",
"/var/log/ovirt-guest-agent",
"/var/lib/ovirt-engine/setup-history.txt",
"/var/lib/ovirt-engine/setup/answers",
"/var/lib/ovirt-engine/external_truststore",
"/var/tmp/ovirt-engine/config",
"/var/lib/ovirt-engine/jboss_runtime/config",
"/var/lib/ovirt-engine-reports/jboss_runtime/config"
])
self.add_file_tags({
"/etc/ovirt-engine/engine.conf.d/.*":
"ovirt_engine_confd",
"/var/log/ovirt-engine/boot.log":
"ovirt_engine_boot_log",
"/var/log/ovirt-engine/console.log":
"ovirt_engine_console_log"
})
# Copying host certs; extra copy the hidden .truststore file
self.add_forbidden_path([
"/etc/pki/ovirt-engine/keys",
"/etc/pki/ovirt-engine/private"
])
self.add_copy_spec([
"/etc/pki/ovirt-engine/",
"/etc/pki/ovirt-engine/.truststore",
])
def postproc(self):
"""
Obfuscate sensitive keys.
"""
for f in ["/etc/ovirt-engine/engine-config/engine-config.properties",
"/etc/rhevm/rhevm-config/rhevm-config.properties"]:
self.do_file_sub(
f,
r"(Password.type)=(.*)",
r"\1=********"
)
engine_files = (
'ovirt-engine.xml',
'ovirt-engine_history/current/ovirt-engine.v1.xml',
'ovirt-engine_history/ovirt-engine.boot.xml',
'ovirt-engine_history/ovirt-engine.initial.xml',
'ovirt-engine_history/ovirt-engine.last.xml',
)
for filename in engine_files:
self.do_file_sub(
"/var/tmp/ovirt-engine/config/%s" % filename,
r"(<password>)(.*)(</password>)",
r"\1********\3"
)
self.do_file_sub(
"/etc/ovirt-engine/redhatsupportplugin.conf",
r"(proxyPassword)=(.*)",
r"\1=********"
)
passwd_files = [
"logcollector.conf",
"imageuploader.conf",
"isouploader.conf"
]
for conf_file in passwd_files:
conf_path = self.path_join("/etc/ovirt-engine", conf_file)
self.do_file_sub(
conf_path,
r"(passwd|pg-pass)=(.*)",
r"\1=********"
)
sensitive_keys = self.DEFAULT_SENSITIVE_KEYS
# Handle --alloptions case which set this to True.
keys_opt = self.get_option('sensitive_keys')
if keys_opt and keys_opt is not True:
sensitive_keys = keys_opt
key_list = [x for x in sensitive_keys.split(':') if x]
self.do_path_regex_sub(
self.DB_PASS_FILES,
r'(%s)=(.*)' % "|".join(key_list),
r'\1=********'
)
# Answer files contain passwords.
# Replace all keys that have 'password' in them, instead of hard-coding
# here the list of keys, which changes between versions.
# Sadly, the engine admin password prompt name does not contain
# 'password'... so neither does the env key.
for item in (
'password',
'OVESETUP_CONFIG_ADMIN_SETUP',
):
self.do_path_regex_sub(
r'/var/lib/ovirt-engine/setup/answers/.*',
r'(?P<key>[^=]*{item}[^=]*)=.*'.format(item=item),
r'\g<key>=********'
)
# aaa profiles contain passwords
protect_keys = [
"vars.password",
"pool.default.auth.simple.password",
"pool.default.ssl.truststore.password",
"config.datasource.dbpassword"
]
regexp = r"(^\s*#*(%s)\s*=\s*)(.*)" % "|".join(protect_keys)
self.do_path_regex_sub(r"/etc/ovirt-engine/aaa/.*\.properties", regexp,
r"\1*********")
# vim: expandtab tabstop=4 shiftwidth=4
Mini Shell