Architecture Overview¶

Core components¶

chipsec_main.py

main application logic and automation functions

chipsec_util.py

utility functions (access to various hardware resources)

chipsec/chipset.py

chipset detection

chipsec/command.py

base class for util commands

chipsec/defines.py

common defines

chipsec/file.py

reading from/writing to files

chipsec/logger.py

logging functions

chipsec/module.py

generic functions to import and load modules

chipsec/module_common.py

base class for modules

chipsec/result_deltas.py

supports checking result deltas between test runs

chipsec/testcase.py

support for XML and JSON log file output

chipsec/helper/helpers.py

registry of supported OS helpers

chipsec/helper/oshelper.py

OS helper: wrapper around platform specific code that invokes kernel driver

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

HAL (Hardware Abstraction Layer)¶

Useful abstractions for common tasks such as accessing the SPI.

List of HAL components

Fuzzing¶

List of Fuzzing components
- chipsec.fuzzing.primitives module

CHIPSEC_MAIN Program Flow¶

Select OS Helpers and Drivers
- Load Driver (optional)
Detect Platform
Load Configuration Files
Load Modules
Run Loaded Modules
Report Results
Cleanup

CHIPSEC_UTIL Program Flow¶

Select OS Helpers and Drivers
- Load Driver (optional)
Detect Platform
Load Configuration Files
Load Utility Commands
Run Selected Command
Cleanup

Auxiliary components¶

setup.py setup script to install CHIPSEC as a package

Executable build scripts¶

<CHIPSEC_ROOT>/scripts/build_exe_*.py make files to build Windows executables

Architecture Overview¶

Core components¶

Commands¶

HAL (Hardware Abstraction Layer)¶

Fuzzing¶

CHIPSEC_MAIN Program Flow¶

CHIPSEC_UTIL Program Flow¶

Auxiliary components¶

Executable build scripts¶

Table of Contents

Previous topic

Next topic

`chipsec_main.py`	main application logic and automation functions
`chipsec_util.py`	utility functions (access to various hardware resources)
`chipsec/chipset.py`	chipset detection
`chipsec/command.py`	base class for util commands
`chipsec/defines.py`	common defines
`chipsec/file.py`	reading from/writing to files
`chipsec/logger.py`	logging functions
`chipsec/module.py`	generic functions to import and load modules
`chipsec/module_common.py`	base class for modules
`chipsec/result_deltas.py`	supports checking result deltas between test runs
`chipsec/testcase.py`	support for XML and JSON log file output
`chipsec/helper/helpers.py`	registry of supported OS helpers
`chipsec/helper/oshelper.py`	OS helper: wrapper around platform specific code that invokes kernel driver