sonic-buildimage/device/dell/x86_64-dellemc_s5232f_c3538-r0/plugins/psuutil.py
Mai Bui 06e1a0bc14
[device/dell] Mitigation for security vulnerability (#11875)
Dependency: [PR (#12065)](https://github.com/sonic-net/sonic-buildimage/pull/12065) needs to merge first.

#### Why I did it
`commands` module is not protected against malicious input
`getstatusoutput` is detected without a static string, uses `shell=True`
#### How I did it
Eliminate the use of `commands`
Use `subprocess.run()`, commands in `subprorcess.run()` are totally static
Fix indentation
#### How to verify it
Tested on DUT
[dell_log.txt](https://github.com/sonic-net/sonic-buildimage/files/9561332/dell_log.txt)
2023-01-05 16:22:09 -08:00

140 lines
4.2 KiB
Python

#
# psuutil.py
# Platform-specific PSU status interface for SONiC
#
import logging
import sys
from sonic_py_common.general import getstatusoutput_noshell_pipe
S5232F_MAX_PSUS = 2
IPMI_PSU1_DATA = ["docker", "exec", "-it", "pmon", "ipmitool", "raw", "0x04", "0x2d", "0x31"]
IPMI_PSU1_DATA_DOCKER = ["ipmitool", "raw", "0x04", "0x2d", "0x31"]
IPMI_PSU2_DATA = ["docker", "exec", "-it", "pmon", "ipmitool", "raw", "0x04", "0x2d", "0x32"]
IPMI_PSU2_DATA_DOCKER = ["ipmitool", "raw", "0x04", "0x2d", "0x32"]
PSU_PRESENCE = "PSU{0}_stat"
awk_cmd = ['awk', '{print substr($0,9,1)}']
# Use this for older firmware
# PSU_PRESENCE="PSU{0}_prsnt"
try:
from sonic_psu.psu_base import PsuBase
except ImportError as e:
raise ImportError(str(e) + "- required module not found")
class PsuUtil(PsuBase):
"""Platform-specific PSUutil class"""
def __init__(self):
PsuBase.__init__(self)
def isDockerEnv(self):
num_docker = open('/proc/self/cgroup', 'r').read().count(":/docker")
if num_docker > 0:
return True
else:
return False
# Fetch a BMC register
def get_pmc_register(self, index):
status = 1
ipmi_cmd = ''
dockerenv = self.isDockerEnv()
if dockerenv == True:
if index == 1:
ipmi_cmd = IPMI_PSU1_DATA_DOCKER
elif index == 2:
ipmi_cmd = IPMI_PSU2_DATA_DOCKER
else:
if index == 1:
ipmi_cmd = IPMI_PSU1_DATA
elif index == 2:
ipmi_cmd = IPMI_PSU2_DATA
if ipmi_cmd != '':
status, ipmi_sdr_list = getstatusoutput_noshell_pipe(ipmi_cmd, awk_cmd)
if status:
logging.error('Failed to execute ipmitool')
sys.exit(0)
output = ipmi_sdr_list
return output
def get_num_psus(self):
"""
Retrieves the number of PSUs available on the device
:return: An integer, the number of PSUs available on the device
"""
S5232F_MAX_PSUS = 2
return S5232F_MAX_PSUS
def get_psu_status(self, index):
"""
Retrieves the oprational status of power supply unit (PSU) defined
by index <index>
:param index: An integer, index of the PSU of which to query status
:return: Boolean, True if PSU is operating properly, False if PSU is\
faulty
"""
# Until psu_status is implemented this is hardcoded temporarily
psu_status = ''
ret_status = 1
ipmi_cmd = ''
dockerenv = self.isDockerEnv()
if dockerenv == True:
if index == 1:
ipmi_cmd = IPMI_PSU1_DATA_DOCKER
elif index == 2:
ipmi_cmd = IPMI_PSU2_DATA_DOCKER
else:
if index == 1:
ipmi_cmd = IPMI_PSU1_DATA
elif index == 2:
ipmi_cmd = IPMI_PSU2_DATA
if ipmi_cmd != '':
ret_status, ipmi_sdr_list = getstatusoutput_noshell_pipe(ipmi_cmd, awk_cmd)
if ret_status:
logging.error('Failed to execute ipmitool')
sys.exit(0)
psu_status = ipmi_sdr_list
return (not int(psu_status, 16) > 1)
def get_psu_presence(self, index):
"""
Retrieves the presence status of power supply unit (PSU) defined
by index <index>
:param index: An integer, index of the PSU of which to query status
:return: Boolean, True if PSU is plugged, False if not
"""
psu_status = '0'
ret_status = 1
ipmi_cmd = ''
dockerenv = self.isDockerEnv()
if dockerenv == True:
if index == 1:
ipmi_cmd = IPMI_PSU1_DATA_DOCKER
elif index == 2:
ipmi_cmd = IPMI_PSU2_DATA_DOCKER
else:
if index == 1:
ipmi_cmd = IPMI_PSU1_DATA
elif index == 2:
ipmi_cmd = IPMI_PSU2_DATA
if ipmi_cmd != '':
ret_status, ipmi_sdr_list = getstatusoutput_noshell_pipe(ipmi_cmd, awk_cmd)
if ret_status:
logging.error('Failed to execute ipmitool')
sys.exit(0)
psu_status = ipmi_sdr_list
return (int(psu_status, 16) & 1)