51a1eb112b
Signed-off-by: maipbui <maibui@microsoft.com> Dependency: [PR (#12065)](https://github.com/sonic-net/sonic-buildimage/pull/12065) needs to merge first. #### Why I did it 1. `eval()` - not secure against maliciously constructed input, can be dangerous if used to evaluate dynamic content. This may be a code injection vulnerability. 2. `subprocess()` - when using with `shell=True` is dangerous. Using subprocess function without a static string can lead to command injection. 3. `os` - not secure against maliciously constructed input and dangerous if used to evaluate dynamic content. 4. `is` operator - string comparison should not be used with reference equality. 5. `globals()` - extremely dangerous because it may allow an attacker to execute arbitrary code on the system #### How I did it 1. `eval()` - use `literal_eval()` 2. `subprocess()` - use `shell=False` instead. use an array string. Ref: [https://semgrep.dev/docs/cheat-sheets/python-command-injection/#mitigation](https://semgrep.dev/docs/cheat-sheets/python-command-injection/#mitigation) 3. `os` - use with `subprocess` 4. `is` - replace by `==` operator for value equality 5. `globals()` - avoid the use of globals()
119 lines
3.8 KiB
Python
119 lines
3.8 KiB
Python
#############################################################################
|
|
# Celestica
|
|
#
|
|
# Component contains an implementation of SONiC Platform Base API and
|
|
# provides the components firmware management function
|
|
#
|
|
#############################################################################
|
|
|
|
import os.path
|
|
|
|
try:
|
|
from sonic_platform_base.component_base import ComponentBase
|
|
from .helper import APIHelper
|
|
except ImportError as e:
|
|
raise ImportError(str(e) + "- required module not found")
|
|
|
|
COMPONENT_LIST = [
|
|
("BIOS", "Basic Input/Output System"),
|
|
("BMC", "Baseboard Management Controller"),
|
|
("SWITCH_CPLD", "Switch board CPLD"),
|
|
("BASE_CPLD", "Base board CPLD"),
|
|
("FPGA", "Field-programmable gate array")
|
|
]
|
|
SW_CPLD_VER_PATH = "/sys/module/switch_cpld/version"
|
|
BASE_CPLD_VER_PATH = "/sys/module/baseboard_lpc/version"
|
|
BIOS_VER_PATH = "/sys/class/dmi/id/bios_version"
|
|
BMC_VER_CMD1 = ["ipmitool", "mc", "info"]
|
|
BMC_VER_CMD2 = ["grep", "Firmware Revision"]
|
|
CFUFLASH_FW_UPGRADE_CMD = ["CFUFLASH", "-cd", "-d", "", "-mse", "3", ""]
|
|
MEM_PCI_RESOURCE = "/sys/bus/pci/devices/0000:09:00.0/resource0"
|
|
FPGA_VER_MEM_OFFSET = 0
|
|
UPGRADE_OPT = {
|
|
'BMC': '1',
|
|
'BIOS': '2',
|
|
'SWITCH_CPLD': '4',
|
|
'BASE_CPLD': '4'
|
|
}
|
|
|
|
|
|
class Component(ComponentBase):
|
|
"""Platform-specific Component class"""
|
|
|
|
DEVICE_TYPE = "component"
|
|
|
|
def __init__(self, component_index):
|
|
ComponentBase.__init__(self)
|
|
self.index = component_index
|
|
self.name = self.get_name()
|
|
self._api_helper = APIHelper()
|
|
|
|
def __get_bmc_ver(self):
|
|
bmc_ver = "Unknown"
|
|
status, raw_bmc_data = self._api_helper.run_command(BMC_VER_CMD1, BMC_VER_CMD2)
|
|
if status:
|
|
bmc_ver_data = raw_bmc_data.split(":")
|
|
bmc_ver = bmc_ver_data[-1].strip() if len(
|
|
bmc_ver_data) > 1 else bmc_ver
|
|
return bmc_ver
|
|
|
|
def __get_fpga_ver(self):
|
|
fpga_ver = "Unknown"
|
|
status, reg_val = self._api_helper.pci_get_value(
|
|
MEM_PCI_RESOURCE, FPGA_VER_MEM_OFFSET)
|
|
if status:
|
|
major = reg_val[0] >> 16
|
|
minor = int(bin(reg_val[0])[16:32], 2)
|
|
fpga_ver = '{}.{}'.format(major, minor)
|
|
return fpga_ver
|
|
|
|
def get_name(self):
|
|
"""
|
|
Retrieves the name of the component
|
|
Returns:
|
|
A string containing the name of the component
|
|
"""
|
|
return COMPONENT_LIST[self.index][0]
|
|
|
|
def get_description(self):
|
|
"""
|
|
Retrieves the description of the component
|
|
Returns:
|
|
A string containing the description of the component
|
|
"""
|
|
return COMPONENT_LIST[self.index][1]
|
|
|
|
def get_firmware_version(self):
|
|
"""
|
|
Retrieves the firmware version of module
|
|
Returns:
|
|
string: The firmware versions of the module
|
|
"""
|
|
fw_version = {
|
|
"BIOS": self._api_helper.read_txt_file(BIOS_VER_PATH),
|
|
"BMC": self.__get_bmc_ver(),
|
|
"FPGA": self.__get_fpga_ver(),
|
|
"SWITCH_CPLD": self._api_helper.read_txt_file(SW_CPLD_VER_PATH),
|
|
"BASE_CPLD": self._api_helper.read_txt_file(BASE_CPLD_VER_PATH),
|
|
}.get(self.name, "Unknown")
|
|
|
|
return fw_version
|
|
|
|
def install_firmware(self, image_path):
|
|
"""
|
|
Install firmware to module
|
|
Args:
|
|
image_path: A string, path to firmware image
|
|
Returns:
|
|
A boolean, True if install successfully, False if not
|
|
"""
|
|
CFUFLASH_FW_UPGRADE_CMD[3] = UPGRADE_OPT.get(self.name)
|
|
CFUFLASH_FW_UPGRADE_CMD[6] = image_path
|
|
|
|
if not os.path.isfile(image_path):
|
|
return False
|
|
|
|
# print(install_command)
|
|
status = self._api_helper.run_interactive_command(CFUFLASH_FW_UPGRADE_CMD)
|
|
return status
|