mirror of
https://github.com/chipsec/chipsec
synced 2026-06-08 13:31:00 +00:00
Remove filehelper
Signed-off-by: Nathaniel Mitchell <nathaniel.p.mitchell@intel.com>
This commit is contained in:
Nathaniel Mitchell
committed by
dscott90
dscott90
parent
9b4c5d1427
commit
99f9052438
+2
-2
@@ -196,10 +196,10 @@ class Chipset:
|
||||
else:
|
||||
return f'{extfamily:02X}{ret}'
|
||||
|
||||
def init(self, platform_code, req_pch_code, start_driver, driver_exists=None, to_file=None, from_file=None):
|
||||
def init(self, platform_code, req_pch_code, start_driver, driver_exists=None):
|
||||
_unknown_platform = False
|
||||
self.reqs_pch = None
|
||||
self.helper.start(start_driver, driver_exists, to_file, from_file)
|
||||
self.helper.start(start_driver, driver_exists)
|
||||
api_mode_str = 'using OS native API (not using CHIPSEC kernel module)' if self.use_native_api() else 'using CHIPSEC kernel module API'
|
||||
logger().log(f'[CHIPSEC] API mode: {api_mode_str}')
|
||||
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
# CHIPSEC: Platform Security Assessment Framework
|
||||
# Copyright (c) 2019, Intel Corporation
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License
|
||||
# as published by the Free Software Foundation; Version 2.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
#
|
||||
# Contact information:
|
||||
# chipsec@intel.com
|
||||
#
|
||||
|
||||
|
||||
__all__ = ["filehelper"]
|
||||
@@ -1,290 +0,0 @@
|
||||
# CHIPSEC: Platform Security Assessment Framework
|
||||
# Copyright (c) 2018-2021, Intel Corporation
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License
|
||||
# as published by the Free Software Foundation; Version 2.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
#
|
||||
# Contact information:
|
||||
# chipsec@intel.com
|
||||
#
|
||||
|
||||
"""
|
||||
Use results from a json file
|
||||
"""
|
||||
import json
|
||||
|
||||
import chipsec.file
|
||||
from chipsec.logger import logger
|
||||
from chipsec.exceptions import OsHelperError, UnimplementedAPIError
|
||||
from chipsec.helper.basehelper import Helper
|
||||
from chipsec.defines import bytestostring
|
||||
|
||||
|
||||
class FileCmds:
|
||||
def __init__(self, filename):
|
||||
self.data = {}
|
||||
if filename == "":
|
||||
self.filename = "replay.json"
|
||||
else:
|
||||
self.filename = filename
|
||||
|
||||
def AddElement(self, cmd, args, ret):
|
||||
try:
|
||||
margs = '({})'.format(','.join(str(i) for i in args))
|
||||
except:
|
||||
margs = str(args)
|
||||
if isinstance(ret, bytes):
|
||||
ret = bytestostring(ret)
|
||||
if str(cmd) in self.data:
|
||||
if margs in self.data[str(cmd)]:
|
||||
# using insert opposed to append so that it creates last in first out when using pop command within getElement
|
||||
self.data[str(cmd)][margs].insert(0, str(ret))
|
||||
else:
|
||||
self.data[str(cmd)][margs] = [str(ret)]
|
||||
else:
|
||||
self.data[str(cmd)] = {margs: [str(ret)]}
|
||||
|
||||
def Save(self):
|
||||
js = json.dumps(self.data, sort_keys=False, indent=2, separators=(',', ': '))
|
||||
chipsec.file.write_file(self.filename, js)
|
||||
|
||||
def Load(self):
|
||||
file_data = chipsec.file.read_file(self.filename)
|
||||
if file_data == 0:
|
||||
logger().log_error("Unable to open JSON file: {}".format(self.filename))
|
||||
raise OsHelperError("Unable to open JSON file: {}".format(self.filename), 1)
|
||||
try:
|
||||
self.data = json.loads(file_data)
|
||||
except:
|
||||
logger().log_error("Unable to load JSON file: {}".format(self.filename))
|
||||
raise OsHelperError("Unable to open JSON file: {}".format(self.filename), 1)
|
||||
|
||||
def getElement(self, cmd, args):
|
||||
try:
|
||||
targs = '({})'.format(','.join(str(i) for i in args))
|
||||
except:
|
||||
targs = str(args)
|
||||
margs = targs.encode('latin_1')
|
||||
if str(cmd) in self.data:
|
||||
if margs in self.data[str(cmd)]:
|
||||
return self.data[cmd][margs].pop()
|
||||
logger().log_error("Missing entry for {} {}".format(str(cmd), margs))
|
||||
|
||||
|
||||
class FileHelper(Helper):
|
||||
def __init__(self):
|
||||
super(FileHelper, self).__init__()
|
||||
self.os_system = "File"
|
||||
self.os_release = "0.0"
|
||||
self.os_version = "0.0"
|
||||
self.os_machine = "N/A"
|
||||
self.name = "FileHelper"
|
||||
|
||||
def create(self, start_driver):
|
||||
if logger().VERBOSE:
|
||||
logger().log("[helper] File Helper created")
|
||||
return True
|
||||
|
||||
def start(self, start_driver, from_file=None):
|
||||
self.filecmds = FileCmds(from_file)
|
||||
self.filecmds.Load()
|
||||
return True
|
||||
|
||||
def stop(self, start_driver):
|
||||
if logger().VERBOSE:
|
||||
logger().log("[helper] File Helper stopped/unloaded")
|
||||
return True
|
||||
|
||||
def delete(self, start_driver):
|
||||
if logger().VERBOSE:
|
||||
logger().log("[helper] File Helper deleted")
|
||||
return True
|
||||
|
||||
#################################################################################################
|
||||
# Actual OS helper functionality accessible to HAL components
|
||||
|
||||
#
|
||||
# Read/Write PCI configuration registers via legacy CF8/CFC ports
|
||||
#
|
||||
def read_pci_reg(self, bus, device, function, address, size):
|
||||
"""Read PCI configuration registers via legacy CF8/CFC ports"""
|
||||
if (0 != (address & (size - 1))):
|
||||
logger().log_warning("Config register address is not naturally aligned")
|
||||
return self.filecmds.getElement("read_pci_reg", (bus, device, function, address, size))
|
||||
|
||||
def write_pci_reg(self, bus, device, function, address, value, size):
|
||||
"""Write PCI configuration registers via legacy CF8/CFC ports"""
|
||||
if (0 != (address & (size - 1))):
|
||||
logger().log_warning("Config register address is not naturally aligned")
|
||||
|
||||
return self.filecmds.getElement("write_pci_reg", (bus, device, function, address, size))
|
||||
|
||||
#
|
||||
# read/write mmio
|
||||
#
|
||||
def read_mmio_reg(self, phys_address, size):
|
||||
return self.filecmds.getElement("read_mmio_reg", (phys_address, size))
|
||||
|
||||
def write_mmio_reg(self, phys_address, size, value):
|
||||
return self.filecmds.getElement("write_mmio_reg", (phys_address, size, value))
|
||||
|
||||
#
|
||||
# physical_address is 64 bit integer
|
||||
#
|
||||
def read_phys_mem(self, phys_address_hi, phys_address_lo, length):
|
||||
ret = self.filecmds.getElement("read_physical_mem", (phys_address_hi, phys_address_lo, length))
|
||||
return ret.encode("latin_1")
|
||||
|
||||
def write_phys_mem(self, phys_address_hi, phys_address_lo, length, buf):
|
||||
return self.filecmds.getElement("write_physical_mem", (phys_address_hi, phys_address_lo, length, buf))
|
||||
|
||||
def alloc_phys_mem(self, length, max_phys_address):
|
||||
return self.filecmds.getElement("alloc_physical_mem", (length, max_phys_address))
|
||||
|
||||
def free_phys_mem(self, physical_address):
|
||||
return self.filecmds.getElement("free_physical_mem", (physical_address))
|
||||
|
||||
def va2pa(self, va):
|
||||
return self.filecmds.getElement("va2pa", (va))
|
||||
|
||||
def map_io_space(self, physical_address, length, cache_type):
|
||||
try:
|
||||
return self.filecmds.getElement("map_io_space", (physical_address, length, cache_type))
|
||||
except NotImplementedError:
|
||||
pass
|
||||
raise UnimplementedAPIError('map_io_space')
|
||||
|
||||
#
|
||||
# Read/Write I/O portline 462,
|
||||
#
|
||||
def read_io_port(self, io_port, size):
|
||||
return self.filecmds.getElement("read_io_port", (io_port, size))
|
||||
|
||||
def write_io_port(self, io_port, value, size):
|
||||
return self.filecmds.getElement("write_io_port", (io_port, value, size))
|
||||
|
||||
#
|
||||
# Read/Write CR registers
|
||||
#
|
||||
def read_cr(self, cpu_thread_id, cr_number):
|
||||
return self.filecmds.getElement("read_cr", (cpu_thread_id, cr_number))
|
||||
|
||||
def write_cr(self, cpu_thread_id, cr_number, value):
|
||||
return self.filecmds.getElement("write_cr", (cpu_thread_id, cr_number, value))
|
||||
|
||||
#
|
||||
# Read/Write MSR on a specific CPU thread
|
||||
#
|
||||
def read_msr(self, cpu_thread_id, msr_addr):
|
||||
return self.filecmds.getElement("read_msr", (cpu_thread_id, msr_addr))
|
||||
|
||||
def write_msr(self, cpu_thread_id, msr_addr, eax, edx):
|
||||
return self.filecmds.getElement("write_msr", (cpu_thread_id, msr_addr, eax, edx))
|
||||
|
||||
#
|
||||
# Load CPU microcode update on a specific CPU thread
|
||||
#
|
||||
def load_ucode_update(self, cpu_thread_id, ucode_update_buf):
|
||||
return self.filecmds.getElement("load_ucode_update", (cpu_thread_id, ucode_update_buf))
|
||||
|
||||
#
|
||||
# Read IDTR/GDTR/LDTR on a specific CPU thread
|
||||
#
|
||||
def get_descriptor_table(self, cpu_thread_id, desc_table_code):
|
||||
return self.filecmds.getElement("get_descriptor_table", (cpu_thread_id, desc_table_code))
|
||||
|
||||
#
|
||||
# EFI Variable API
|
||||
#
|
||||
def EFI_supported(self):
|
||||
return self.filecmds.getElement("EFI_supported", ())
|
||||
|
||||
def get_EFI_variable(self, name, guid):
|
||||
return self.filecmds.getElement("get_EFI_variable", (name, guid))
|
||||
|
||||
def set_EFI_variable(self, name, guid, data, datasize=None, attrs=None):
|
||||
return self.filecmds.getElement("set_EFI_variable", (name, guid, data, datasize, attrs))
|
||||
|
||||
def delete_EFI_variable(self, name, guid):
|
||||
return self.filecmds.getElement("delete_EFI_variable", (name, guid))
|
||||
|
||||
def list_EFI_variables(self):
|
||||
return self.filecmds.getElement("list_EFI_variables", ())
|
||||
|
||||
#
|
||||
# ACPI
|
||||
#
|
||||
def get_ACPI_SDT(self):
|
||||
return self.filecmds.getElement("get_ACPI_SDT", ())
|
||||
|
||||
def get_ACPI_table(self, table_name):
|
||||
return self.filecmds.getElement("get_ACPI_table", (table_name))
|
||||
|
||||
#
|
||||
# CPUID
|
||||
#
|
||||
def cpuid(self, eax, ecx):
|
||||
return self.filecmds.getElement("cpuid", (eax, ecx))
|
||||
|
||||
#
|
||||
# IOSF Message Bus access
|
||||
#
|
||||
|
||||
def msgbus_send_read_message(self, mcr, mcrx):
|
||||
return self.filecmds.getElement("msgbus_send_read_message", (mcr, mcrx))
|
||||
|
||||
def msgbus_send_write_message(self, mcr, mcrx, mdr):
|
||||
return self.filecmds.getElement("msgbus_send_write_message", (mcr, mcrx, mdr))
|
||||
|
||||
def msgbus_send_message(self, mcr, mcrx, mdr):
|
||||
return self.filecmds.getElement("msgbus_send_message", (mcr, mcrx, mdr))
|
||||
|
||||
#
|
||||
# Affinity
|
||||
#
|
||||
def get_affinity(self):
|
||||
return self.filecmds.getElement("get_affinity", ())
|
||||
|
||||
def set_affinity(self, value):
|
||||
return self.filecmds.getElement("set_affinity", (value))
|
||||
|
||||
#
|
||||
# Logical CPU count
|
||||
#
|
||||
def get_threads_count(self):
|
||||
return self.filecmds.getElement("get_threads_count", ())
|
||||
|
||||
#
|
||||
# Send SW SMI
|
||||
#
|
||||
def send_sw_smi(self, cpu_thread_id, SMI_code_data, _rax, _rbx, _rcx, _rdx, _rsi, _rdi):
|
||||
return self.filecmds.getElement("send_sw_smi", (cpu_thread_id, SMI_code_data, _rax, _rbx, _rcx, _rdx, _rsi, _rdi))
|
||||
|
||||
#
|
||||
# Hypercall
|
||||
#
|
||||
def hypercall(self, rcx=0, rdx=0, r8=0, r9=0, r10=0, r11=0, rax=0, rbx=0, rdi=0, rsi=0, xmm_buffer=0):
|
||||
return self.filecmds.getElement("hypercall", (rcx, rdx, r8, r9, r10, r11, rax, rbx, rdi, rsi, xmm_buffer))
|
||||
|
||||
#
|
||||
# File system
|
||||
#
|
||||
def getcwd(self):
|
||||
return self.filecmds.getElement("getcwd", ())
|
||||
|
||||
|
||||
_helper = None
|
||||
|
||||
|
||||
def get_helper():
|
||||
return FileHelper()
|
||||
@@ -27,4 +27,3 @@ from chipsec.helper.efi import *
|
||||
from chipsec.helper.linux import *
|
||||
from chipsec.helper.osx import *
|
||||
from chipsec.helper.windows import *
|
||||
from chipsec.helper.file import *
|
||||
|
||||
@@ -121,10 +121,7 @@ class OsHelper:
|
||||
ret = self.getBaseHelper()
|
||||
return ret
|
||||
|
||||
def start(self, start_driver: bool, driver_exists: Optional[bool] = None, to_file: Optional[bool] = None, from_file: Optional[bool] = False) -> None:
|
||||
if to_file is not None:
|
||||
from chipsec.helper.file.filehelper import FileCmds
|
||||
self.filecmds = FileCmds(to_file)
|
||||
def start(self, start_driver: bool, driver_exists: Optional[bool] = None) -> None:
|
||||
if driver_exists is not None:
|
||||
for name in self.avail_helpers:
|
||||
if name == driver_exists:
|
||||
@@ -132,7 +129,7 @@ class OsHelper:
|
||||
try:
|
||||
if not self.helper.create(start_driver):
|
||||
raise OsHelperError("failed to create OS helper", 1)
|
||||
if not self.helper.start(start_driver, from_file):
|
||||
if not self.helper.start(start_driver):
|
||||
raise OsHelperError("failed to start OS helper", 1)
|
||||
except Exception as msg:
|
||||
if logger().DEBUG:
|
||||
|
||||
+1
-6
@@ -90,8 +90,6 @@ def parse_args(argv: Sequence[str]) -> Optional[Dict[str, Any]]:
|
||||
adv_options.add_argument('--failfast', help="fail on any exception and exit (don't mask exceptions)", action='store_true')
|
||||
adv_options.add_argument('--no_time', help="don't log timestamps", action='store_true')
|
||||
adv_options.add_argument('--deltas', dest='_deltas_file', help='specifies a JSON log file to compute result deltas from')
|
||||
adv_options.add_argument('--record', dest='_to_file', help='run chipsec and clone helper results into JSON file')
|
||||
adv_options.add_argument('--replay', dest='_from_file', help='replay a chipsec run with JSON file')
|
||||
adv_options.add_argument('--helper', dest='_driver_exists', help='specify OS Helper', choices=[i for i in helper().getAvailableHelpers()])
|
||||
adv_options.add_argument('-nb', '--no_banner', dest='_show_banner', action='store_false', help="chipsec won't display banner information")
|
||||
adv_options.add_argument('--skip_config', dest='_load_config', action='store_false', help='skip configuration and driver loading')
|
||||
@@ -395,8 +393,6 @@ class ChipsecMain:
|
||||
self.logger.log_warning("Ignoring unsupported platform warning and continue execution.")
|
||||
self.logger.log_warning("Most results cannot be trusted.")
|
||||
self.logger.log_warning("Unless a platform independent module is being run, do not file issues against this run.")
|
||||
if self._from_file:
|
||||
self._driver_exists = "FileHelper"
|
||||
|
||||
def properties(self):
|
||||
ret = OrderedDict()
|
||||
@@ -428,8 +424,7 @@ class ChipsecMain:
|
||||
|
||||
if self._load_config:
|
||||
try:
|
||||
self._cs.init(self._platform, self._pch, (not self._no_driver), self._driver_exists,
|
||||
self._to_file, self._from_file)
|
||||
self._cs.init(self._platform, self._pch, (not self._no_driver), self._driver_exists)
|
||||
except UnknownChipsetError as msg:
|
||||
self.logger.log_error("Platform is not supported ({}).".format(str(msg)))
|
||||
if self._unknownPlatform:
|
||||
|
||||
Reference in New Issue
Block a user