Architecture Overview¶
CHIPSEC Architecture¶
Core components¶
chipsec_main.pymain application logic and module execution
chipsec_util.pycommand-line access to CHIPSEC utility commands
chipsec/chipset.pychipset detection and CHIPSEC initialization
chipsec/command.pybase class for utility commands
chipsec/library/defines.pycommon constants and definitions
chipsec/library/file.pyfile and path utilities
chipsec/library/logger.pylogging functions
chipsec/module.pymodule discovery and loading
chipsec/module_common.pybase class for security modules
chipsec/library/result_deltas.pychecking result deltas between test runs
chipsec/testcase.pyresult reporting and XML/JSON output
chipsec/helper/basehelper.pyinterface implemented by OS helpers
chipsec/helper/oshelper.pydiscovers and selects an OS helper backend
chipsec/hal/hardware abstraction layer implementations
Commands¶
Implement functionality of chipsec_util.
CHIPSEC utilities provide the capability for manual testing and direct hardware access.
Warning
DIRECT HARDWARE ACCESS PROVIDED BY THESE UTILITIES COULD MAKE YOUR SYSTEM UNBOOTABLE. MAKE SURE YOU KNOW WHAT YOU ARE DOING!
Note
All numeric values in the instructions are in hex.
- List of Utility components
- chipsec.utilcmd.acpi_cmd module
- chipsec.utilcmd.chipset_cmd module
- chipsec.utilcmd.cmos_cmd module
- chipsec.utilcmd.config_cmd module
- chipsec.utilcmd.cpu_cmd module
- chipsec.utilcmd.decode_cmd module
- chipsec.utilcmd.deltas_cmd module
- chipsec.utilcmd.desc_cmd module
- chipsec.utilcmd.ec_cmd module
- chipsec.utilcmd.hals_cmd module
- chipsec.utilcmd.hob_cmd module
- chipsec.utilcmd.igd_cmd module
- chipsec.utilcmd.interrupts_cmd module
- chipsec.utilcmd.io_cmd module
- chipsec.utilcmd.iommu_cmd module
- chipsec.utilcmd.lock_check_cmd module
- chipsec.utilcmd.mem_cmd module
- chipsec.utilcmd.mm_msgbus_cmd module
- chipsec.utilcmd.mmcfg_base_cmd module
- chipsec.utilcmd.mmcfg_cmd module
- chipsec.utilcmd.mmio_cmd module
- chipsec.utilcmd.module_id_cmd module
- chipsec.utilcmd.msgbus_cmd module
- chipsec.utilcmd.msr_cmd module
- chipsec.utilcmd.pci_cmd module
- chipsec.utilcmd.reg_cmd module
- chipsec.utilcmd.smbios_cmd module
- chipsec.utilcmd.smbus_cmd module
- chipsec.utilcmd.spd_cmd module
- chipsec.utilcmd.spi_cmd module
- chipsec.utilcmd.spidesc_cmd module
- chipsec.utilcmd.tpm_cmd module
- chipsec.utilcmd.txt_cmd module
- chipsec.utilcmd.ucode_cmd module
- chipsec.utilcmd.uefi_cmd module
- chipsec.utilcmd.vmem_cmd module
- chipsec.utilcmd.vmm_cmd module
HAL (Hardware Abstraction Layer)¶
Useful abstractions for common tasks such as accessing the SPI.
- List of HAL components
- chipsec.hal.amd package
- chipsec.hal.common package
- chipsec.hal.common.acpi module
- chipsec.hal.common.cmos module
- chipsec.hal.common.cpuid module
- chipsec.hal.common.ec module
- chipsec.hal.common.hob module
- chipsec.hal.common.interrupts module
- chipsec.hal.common.io module
- chipsec.hal.common.iobar module
- chipsec.hal.common.iommu module
- chipsec.hal.common.locks module
- chipsec.hal.common.memrange module
- chipsec.hal.common.mmio module
- chipsec.hal.common.msr module
- chipsec.hal.common.pci module
- chipsec.hal.common.physmem module
- chipsec.hal.common.smbios module
- chipsec.hal.common.smbus module
- chipsec.hal.common.spd module
- chipsec.hal.common.tpm module
- chipsec.hal.common.uefi module
- chipsec.hal.common.virtmem module
- chipsec.hal.common.vmm module
- chipsec.hal.intel package
- chipsec.hal.hal_base module
- chipsec.hal.hals module
Fuzzing¶
CHIPSEC_MAIN Program Flow¶
Select OS Helpers and Drivers
Load Driver (optional)
Load Configuration Files
Load Modules
Run Loaded Modules
Report Results
Cleanup
CHIPSEC_UTIL Program Flow¶
Select OS Helpers and Drivers
Load Driver (optional)
Load Configuration Files
Load Utility Commands
Run Selected Command
Cleanup
Auxiliary components¶
setup.pysetup script to install CHIPSEC as a package
Executable build scripts¶
<CHIPSEC_ROOT>/scripts/build_exe_*.pymake files to build Windows executables